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 );
28 use C4::Stats qw( UpdateStats );
29 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest ItemsAnyAvailableAndNotRestricted );
30 use C4::Biblio qw( UpdateTotalIssues );
31 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
33 use C4::ItemCirculationAlertPreference;
35 use C4::Log qw( logaction ); # logaction
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits qw( CheckDigits );
40 use Data::Dumper qw( Dumper );
42 use Koha::AuthorisedValues;
43 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
44 use Koha::Biblioitems;
45 use Koha::DateUtils qw( dt_from_string output_pref );
48 use Koha::Illrequests;
51 use Koha::Patron::Debarments qw( DelUniqueDebarment AddUniqueDebarment );
54 use Koha::Account::Lines;
56 use Koha::Account::Lines;
57 use Koha::Account::Offsets;
58 use Koha::Config::SysPrefs;
59 use Koha::Charges::Fees;
60 use Koha::Config::SysPref;
61 use Koha::Checkouts::ReturnClaims;
62 use Koha::SearchEngine::Indexer;
63 use Koha::Exceptions::Checkout;
67 use List::MoreUtils qw( any );
68 use Scalar::Util qw( looks_like_number blessed );
69 use Date::Calc qw( Date_to_Days );
70 our (@ISA, @EXPORT_OK);
76 # FIXME subs that should probably be elsewhere
81 GetPendingOnSiteCheckouts
92 GetLatestAutoRenewDate
95 GetBranchBorrowerCircRule
113 IsBranchTransferAllowed
114 CreateBranchTransferLimit
115 DeleteBranchTransferLimits
121 DeleteOfflineOperation
122 ProcessOfflineOperation
123 ProcessOfflinePayment
126 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
131 C4::Circulation - Koha circulation module
139 The functions in this module deal with circulation, issues, and
140 returns, as well as general information about the library.
141 Also deals with inventory.
147 $str = &barcodedecode($barcode, [$filter]);
149 Generic filter function for barcode string.
150 Called on every circ if the System Pref itemBarcodeInputFilter is set.
151 Will do some manipulation of the barcode for systems that deliver a barcode
152 to circulation.pl that differs from the barcode stored for the item.
153 For proper functioning of this filter, calling the function on the
154 correct barcode string (items.barcode) should return an unaltered barcode.
155 Barcode is going to be automatically trimmed of leading/trailing whitespaces.
157 The optional $filter argument is to allow for testing or explicit
158 behavior that ignores the System Pref. Valid values are the same as the
163 # FIXME -- the &decode fcn below should be wrapped into this one.
164 # FIXME -- these plugins should be moved out of Circulation.pm
167 my ($barcode, $filter) = @_;
169 return unless defined $barcode;
171 my $branch = C4::Context::mybranch();
172 $barcode =~ s/^\s+|\s+$//g;
173 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
174 Koha::Plugins->call('item_barcode_transform', \$barcode );
175 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
176 if ($filter eq 'whitespace') {
178 } elsif ($filter eq 'cuecat') {
180 my @fields = split( /\./, $barcode );
181 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
182 ($#results == 2) and return $results[2];
183 } elsif ($filter eq 'T-prefix') {
184 if ($barcode =~ /^[Tt](\d)/) {
185 (defined($1) and $1 eq '0') and return $barcode;
186 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
188 return sprintf("T%07d", $barcode);
189 # FIXME: $barcode could be "T1", causing warning: substr outside of string
190 # Why drop the nonzero digit after the T?
191 # Why pass non-digits (or empty string) to "T%07d"?
192 } elsif ($filter eq 'libsuite8') {
193 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
194 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
195 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
197 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
200 } elsif ($filter eq 'EAN13') {
201 my $ean = CheckDigits('ean');
202 if ( $ean->is_valid($barcode) ) {
203 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
204 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
206 warn "# [$barcode] not valid EAN-13/UPC-A\n";
209 return $barcode; # return barcode, modified or not
214 $str = &_decode($chunk);
216 Decodes a segment of a string emitted by a CueCat barcode scanner and
219 FIXME: Should be replaced with Barcode::Cuecat from CPAN
220 or Javascript based decoding on the client side.
227 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
228 my @s = map { index( $seq, $_ ); } split( //, $encoded );
229 my $l = ( $#s + 1 ) % 4;
232 # warn "Error: Cuecat decode parsing failed!";
240 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
242 chr( ( $n >> 16 ) ^ 67 )
243 .chr( ( $n >> 8 & 255 ) ^ 67 )
244 .chr( ( $n & 255 ) ^ 67 );
247 $r = substr( $r, 0, length($r) - $l );
253 ($dotransfer, $messages, $iteminformation) = &transferbook({
254 from_branch => $frombranch
255 to_branch => $tobranch,
257 ignore_reserves => $ignore_reserves,
261 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
263 C<$fbr> is the code for the branch initiating the transfer.
264 C<$tbr> is the code for the branch to which the item should be transferred.
266 C<$barcode> is the barcode of the item to be transferred.
268 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
269 Otherwise, if an item is reserved, the transfer fails.
271 C<$trigger> is the enum value for what triggered the transfer.
273 Returns three values:
279 is true if the transfer was successful.
283 is a reference-to-hash which may have any of the following keys:
289 There is no item in the catalog with the given barcode. The value is C<$barcode>.
291 =item C<DestinationEqualsHolding>
293 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.
297 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.
301 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>.
303 =item C<WasTransferred>
305 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
307 =item C<RecallPlacedAtHoldingBranch>
309 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.
313 A recall for this item was found, and the item needs to be transferred to the recall's pickup branch.
323 my $tbr = $params->{to_branch};
324 my $fbr = $params->{from_branch};
325 my $ignoreRs = $params->{ignore_reserves};
326 my $barcode = $params->{barcode};
327 my $trigger = $params->{trigger};
330 my $item = Koha::Items->find( { barcode => $barcode } );
332 Koha::Exceptions::MissingParameter->throw(
333 "Missing mandatory parameter: from_branch")
336 Koha::Exceptions::MissingParameter->throw(
337 "Missing mandatory parameter: to_branch")
342 $messages->{'BadBarcode'} = $barcode;
344 return ( $dotransfer, $messages );
347 my $itemnumber = $item->itemnumber;
348 # get branches of book...
349 my $hbr = $item->homebranch;
351 # if using Branch Transfer Limits
352 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
353 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
354 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
355 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
356 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
359 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
360 $messages->{'NotAllowed'} = $tbr . "::" . $code;
365 # can't transfer book if is already there....
366 if ( $fbr eq $tbr ) {
367 $messages->{'DestinationEqualsHolding'} = 1;
371 # check if it is still issued to someone, return it...
372 my $issue = $item->checkout;
374 AddReturn( $barcode, $fbr );
375 $messages->{'WasReturned'} = $issue->borrowernumber;
379 # That'll save a database query.
380 my ( $resfound, $resrec, undef ) =
381 CheckReserves( $item );
383 $resrec->{'ResFound'} = $resfound;
384 $messages->{'ResFound'} = $resrec;
385 $dotransfer = 0 unless $ignoreRs;
389 if ( C4::Context->preference('UseRecalls') ) {
390 my $recall = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
391 if ( defined $recall ) {
392 # do a transfer if the recall branch is different to the item holding branch
393 if ( $recall->pickup_library_id eq $fbr ) {
395 $messages->{'RecallPlacedAtHoldingBranch'} = 1;
398 $messages->{'RecallFound'} = $recall;
403 #actually do the transfer....
405 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
407 # don't need to update MARC anymore, we do it in batch now
408 $messages->{'WasTransfered'} = $tbr;
411 ModDateLastSeen( $itemnumber );
412 return ( $dotransfer, $messages );
417 my $borrower = shift;
418 my $item_object = shift;
420 my $onsite_checkout = $params->{onsite_checkout} || 0;
421 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
422 my $cat_borrower = $borrower->{'categorycode'};
423 my $dbh = C4::Context->dbh;
424 # Get which branchcode we need
425 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
426 my $type = $item_object->effective_itemtype;
428 my ($type_object, $parent_type, $parent_maxissueqty_rule);
429 $type_object = Koha::ItemTypes->find( $type );
430 $parent_type = $type_object->parent_type if $type_object;
431 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
432 # Find any children if we are a parent_type;
434 # given branch, patron category, and item type, determine
435 # applicable issuing rule
437 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
439 categorycode => $cat_borrower,
440 itemtype => $parent_type,
441 branchcode => $branch,
442 rule_name => 'maxissueqty',
445 # If the parent rule is for default type we discount it
446 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
448 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
450 categorycode => $cat_borrower,
452 branchcode => $branch,
453 rule_name => 'maxissueqty',
457 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
459 categorycode => $cat_borrower,
461 branchcode => $branch,
462 rule_name => 'maxonsiteissueqty',
467 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
468 # if a rule is found and has a loan limit set, count
469 # how many loans the patron already has that meet that
471 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
474 if ( $maxissueqty_rule->branchcode ) {
475 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
476 $checkouts = $patron->checkouts->search(
477 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
478 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
479 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
481 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
482 $checkouts = $patron->checkouts->search(
483 { "item.$branch_type" => $maxissueqty_rule->branchcode } );
486 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
488 $checkouts = $checkouts->search(undef, { prefetch => 'item' });
491 my $rule_itemtype = $maxissueqty_rule->itemtype;
494 unless ( $rule_itemtype ) {
495 # matching rule has the default item type, so count only
496 # those existing loans that don't fall under a more
498 @types = Koha::CirculationRules->search(
500 branchcode => $maxissueqty_rule->branchcode,
501 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
502 itemtype => { '!=' => undef },
503 rule_name => 'maxissueqty'
505 )->get_column('itemtype');
507 if ( $parent_maxissueqty_rule ) {
508 # if we have a parent item type then we count loans of the
509 # specific item type or its siblings or parent
510 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
511 @types = $children->get_column('itemtype');
512 push @types, $parent_type;
513 } elsif ( $child_types ) {
514 # If we are a parent type, we need to count all child types and our own type
515 @types = $child_types->get_column('itemtype');
516 push @types, $type; # And don't forget to count our own types
518 # Otherwise only count the specific itemtype
523 while ( my $c = $checkouts->next ) {
524 my $itemtype = $c->item->effective_itemtype;
526 unless ( $rule_itemtype ) {
527 next if grep {$_ eq $itemtype} @types;
529 next unless grep {$_ eq $itemtype} @types;
532 $sum_checkouts->{total}++;
533 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
534 $sum_checkouts->{itemtype}->{$itemtype}++;
537 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
538 my $checkout_count = $sum_checkouts->{total} || 0;
539 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
541 my $checkout_rules = {
542 checkout_count => $checkout_count,
543 onsite_checkout_count => $onsite_checkout_count,
544 onsite_checkout => $onsite_checkout,
545 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
546 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
547 switch_onsite_checkout => $switch_onsite_checkout,
549 # If parent rules exists
550 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
551 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
552 my $qty_over = _check_max_qty($checkout_rules);
553 return $qty_over if defined $qty_over;
555 # If the parent rule is less than or equal to the child, we only need check the parent
556 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
557 $checkout_rules->{checkout_count} = $checkout_count_type;
558 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
559 my $qty_over = _check_max_qty($checkout_rules);
560 return $qty_over if defined $qty_over;
563 my $qty_over = _check_max_qty($checkout_rules);
564 return $qty_over if defined $qty_over;
568 # Now count total loans against the limit for the branch
569 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
570 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
572 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
573 $checkouts = $patron->checkouts->search(
574 { 'me.branchcode' => $branch} );
575 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
576 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
578 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
579 $checkouts = $patron->checkouts->search(
580 { "item.$branch_type" => $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} = $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(
820 branch => C4::Context->userenv->{'branch'},
822 itemnumber => $item_object->itemnumber,
823 itemtype => $effective_itemtype,
824 borrowernumber => $patron->borrowernumber,
825 ccode => $item_object->ccode,
826 categorycode => $patron->categorycode,
827 location => $item_object->location,
828 interface => C4::Context->interface,
831 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
832 return( { STATS => 1 }, {});
835 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
836 $issuingimpossible{GNA} = 1;
839 if ( $patron->lost && $patron->lost == 1 ) {
840 $issuingimpossible{CARD_LOST} = 1;
842 if ( $patron->is_debarred ) {
843 $issuingimpossible{DEBARRED} = 1;
846 if ( $patron->is_expired ) {
847 $issuingimpossible{EXPIRED} = 1;
855 my $account = $patron->account;
856 my $balance = $account->balance;
857 my $non_issues_charges = $account->non_issues_charges;
858 my $other_charges = $balance - $non_issues_charges;
860 my $amountlimit = C4::Context->preference("noissuescharge");
861 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
862 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
864 # Check the debt of this patrons guarantees
865 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
866 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
867 if ( defined $no_issues_charge_guarantees ) {
868 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
869 my $guarantees_non_issues_charges = 0;
870 foreach my $g ( @guarantees ) {
871 $guarantees_non_issues_charges += $g->account->non_issues_charges;
874 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
875 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
876 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
877 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
878 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
879 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
883 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
884 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
885 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
886 if ( defined $no_issues_charge_guarantors ) {
887 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
889 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
890 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
891 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
892 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
893 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
894 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
898 if ( C4::Context->preference("IssuingInProcess") ) {
899 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
900 $issuingimpossible{DEBT} = $non_issues_charges;
901 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
902 $needsconfirmation{DEBT} = $non_issues_charges;
903 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
904 $needsconfirmation{DEBT} = $non_issues_charges;
908 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
909 $needsconfirmation{DEBT} = $non_issues_charges;
910 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
911 $issuingimpossible{DEBT} = $non_issues_charges;
912 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
913 $needsconfirmation{DEBT} = $non_issues_charges;
917 if ($balance > 0 && $other_charges > 0) {
918 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
921 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
922 $patron_unblessed = $patron->unblessed;
924 if ( my $debarred_date = $patron->is_debarred ) {
925 # patron has accrued fine days or has a restriction. $count is a date
926 if ($debarred_date eq '9999-12-31') {
927 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
930 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
932 } elsif ( my $num_overdues = $patron->has_overdues ) {
933 ## patron has outstanding overdue loans
934 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
935 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
937 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
938 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
942 # Additional Materials Check
943 if ( C4::Context->preference("CircConfirmItemParts")
944 && $item_object->materials )
946 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
950 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
952 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
954 # Already issued to current borrower.
955 # If it is an on-site checkout if it can be switched to a normal checkout
956 # or ask whether the loan should be renewed
958 if ( $issue->onsite_checkout
959 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
960 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
962 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed($patron, $issue);
963 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
964 if ( $renewerror eq 'onsite_checkout' ) {
965 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
968 $issuingimpossible{NO_MORE_RENEWALS} = 1;
972 $needsconfirmation{RENEW_ISSUE} = 1;
978 # issued to someone else
980 my $patron = Koha::Patrons->find( $issue->borrowernumber );
982 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
984 if ( !$can_be_returned ) {
985 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
986 $issuingimpossible{branch_to_return} = $message;
988 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
989 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
992 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
993 $needsconfirmation{issued_firstname} = $patron->firstname;
994 $needsconfirmation{issued_surname} = $patron->surname;
995 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
996 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
1001 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1003 my $switch_onsite_checkout = (
1004 C4::Context->preference('SwitchOnSiteCheckouts')
1006 and $issue->onsite_checkout
1007 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1008 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1009 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1010 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1011 if ( $toomany->{max_allowed} == 0 ) {
1012 $needsconfirmation{PATRON_CANT} = 1;
1014 if ( C4::Context->preference("AllowTooManyOverride") ) {
1015 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1016 $needsconfirmation{current_loan_count} = $toomany->{count};
1017 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1019 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1020 $issuingimpossible{current_loan_count} = $toomany->{count};
1021 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1026 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1028 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1029 if ( $patron->wants_check_for_previous_checkout && $patron->do_check_for_previous_checkout($item_unblessed) ) {
1030 $needsconfirmation{PREVISSUE} = 1;
1036 if ( $item_object->notforloan )
1038 if(!C4::Context->preference("AllowNotForLoanOverride")){
1039 $issuingimpossible{NOT_FOR_LOAN} = 1;
1040 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1042 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1043 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1047 # we have to check itemtypes.notforloan also
1048 if (C4::Context->preference('item-level_itypes')){
1049 # this should probably be a subroutine
1050 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1051 $sth->execute($effective_itemtype);
1052 my $notforloan=$sth->fetchrow_hashref();
1053 if ($notforloan->{'notforloan'}) {
1054 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1055 $issuingimpossible{NOT_FOR_LOAN} = 1;
1056 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1058 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1059 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1064 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1065 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1066 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1067 $issuingimpossible{NOT_FOR_LOAN} = 1;
1068 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1070 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1071 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1076 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1078 $issuingimpossible{WTHDRAWN} = 1;
1080 if ( $item_object->restricted
1081 && $item_object->restricted == 1 )
1083 $issuingimpossible{RESTRICTED} = 1;
1085 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1086 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1087 my $code = $av->count ? $av->next->lib : '';
1088 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1089 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1091 if ( C4::Context->preference("IndependentBranches") ) {
1092 my $userenv = C4::Context->userenv;
1093 unless ( C4::Context->IsSuperLibrarian() ) {
1094 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1095 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1096 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1097 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1099 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1100 if ( $patron->branchcode ne $userenv->{branch} );
1105 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1107 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1108 if ($rentalConfirmation) {
1109 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1111 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1112 if ($itemtype_object) {
1113 my $accumulate_charge = $fees->accumulate_rentalcharge();
1114 if ( $accumulate_charge > 0 ) {
1115 $rentalCharge += $accumulate_charge;
1119 if ( $rentalCharge > 0 ) {
1120 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1125 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1126 # Only bother doing this if UseRecalls is enabled and the item is recallable
1127 # Don't look at recalls that are in transit
1128 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1129 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1131 foreach my $r ( @recalls ) {
1132 if ( $r->item_id and
1133 $r->item_id == $item_object->itemnumber and
1134 $r->patron_id == $patron->borrowernumber and
1135 ( $r->waiting or $r->requested ) ) {
1136 $messages{RECALLED} = $r->id;
1138 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1141 elsif ( $r->item_id and
1142 $r->item_id == $item_object->itemnumber and
1144 # recalled item is in transit
1145 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1147 elsif ( $r->item_level and
1148 $r->item_id == $item_object->itemnumber and
1149 $r->patron_id != $patron->borrowernumber and
1151 # this specific item has been recalled by a different patron
1152 $needsconfirmation{RECALLED} = $r;
1156 elsif ( !$r->item_level and
1157 $r->patron_id != $patron->borrowernumber and
1159 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1160 $needsconfirmation{RECALLED} = $r;
1167 unless ( $ignore_reserves and defined $recall ) {
1168 # See if the item is on reserve.
1169 my ( $restype, $res ) = CheckReserves( $item_object );
1171 my $resbor = $res->{'borrowernumber'};
1172 if ( $resbor ne $patron->borrowernumber ) {
1173 my $patron = Koha::Patrons->find( $resbor );
1174 if ( $restype eq "Waiting" )
1176 # The item is on reserve and waiting, but has been
1177 # reserved by some other patron.
1178 $needsconfirmation{RESERVE_WAITING} = 1;
1179 $needsconfirmation{'resfirstname'} = $patron->firstname;
1180 $needsconfirmation{'ressurname'} = $patron->surname;
1181 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1182 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1183 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1184 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1185 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1187 elsif ( $restype eq "Reserved" ) {
1188 # The item is on reserve for someone else.
1189 $needsconfirmation{RESERVED} = 1;
1190 $needsconfirmation{'resfirstname'} = $patron->firstname;
1191 $needsconfirmation{'ressurname'} = $patron->surname;
1192 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1193 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1194 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1195 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1196 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1198 elsif ( $restype eq "Transferred" ) {
1199 # The item is determined hold being transferred for someone else.
1200 $needsconfirmation{TRANSFERRED} = 1;
1201 $needsconfirmation{'resfirstname'} = $patron->firstname;
1202 $needsconfirmation{'ressurname'} = $patron->surname;
1203 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1204 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1205 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1206 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1207 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1209 elsif ( $restype eq "Processing" ) {
1210 # The item is determined hold being processed for someone else.
1211 $needsconfirmation{PROCESSING} = 1;
1212 $needsconfirmation{'resfirstname'} = $patron->firstname;
1213 $needsconfirmation{'ressurname'} = $patron->surname;
1214 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1215 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1216 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1217 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1218 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1224 ## CHECK AGE RESTRICTION
1225 my $agerestriction = $biblioitem->agerestriction;
1226 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1227 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1228 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1229 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1232 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1236 ## check for high holds decreasing loan period
1237 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1238 my $check = checkHighHolds( $item_object, $patron );
1240 if ( $check->{exceeded} ) {
1242 num_holds => $check->{outstanding},
1243 duration => $check->{duration},
1244 returndate => $check->{due_date},
1246 if ($override_high_holds) {
1247 $alerts{HIGHHOLDS} = $highholds;
1250 $needsconfirmation{HIGHHOLDS} = $highholds;
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 );
1358 # Count holds on this record, ignoring the borrowers own holds as they would be filled by the checkout
1359 my $holds = Koha::Holds->search({
1360 biblionumber => $item->biblionumber,
1361 borrowernumber => { '!=' => $patron->borrowernumber }
1364 if ( $holds->count() ) {
1365 $return_data->{outstanding} = $holds->count();
1367 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1368 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1369 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1371 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1373 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1375 # static means just more than a given number of holds on the record
1377 # If the number of holds is not above the threshold, we can stop here
1378 if ( $holds->count() <= $decreaseLoanHighHoldsValue ) {
1379 return $return_data;
1382 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1384 # dynamic means X more than the number of holdable items on the record
1386 # let's get the items
1387 my @items = $holds->next()->biblio()->items()->as_list;
1389 # Remove any items with status defined to be ignored even if the would not make item unholdable
1390 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1391 @items = grep { !$_->$status } @items;
1394 # Remove any items that are not holdable for this patron
1395 # We need to ignore hold counts as the borrower's own hold that will be filled by the checkout
1396 # could prevent them from placing further holds
1397 @items = grep { CanItemBeReserved( $patron, $_, undef, { ignore_hold_counts => 1 } )->{status} eq 'OK' } @items;
1399 my $items_count = scalar @items;
1401 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1403 # If the number of holds is less than the count of items we have
1404 # plus the number of holds allowed above that count, we can stop here
1405 if ( $holds->count() <= $threshold ) {
1406 return $return_data;
1410 my $issuedate = dt_from_string();
1412 my $itype = $item->effective_itemtype;
1413 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1415 categorycode => $patron->categorycode,
1417 branchcode => $branchcode,
1420 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1422 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1424 my $rule = Koha::CirculationRules->get_effective_rule_value(
1426 categorycode => $patron->categorycode,
1427 itemtype => $item->effective_itemtype,
1428 branchcode => $branchcode,
1429 rule_name => 'decreaseloanholds',
1434 if ( defined($rule) && $rule ne '' ){
1435 # overrides decreaseLoanHighHoldsDuration syspref
1438 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1440 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1441 $reduced_datedue->set_hour($orig_due->hour);
1442 $reduced_datedue->set_minute($orig_due->minute);
1443 $reduced_datedue->truncate( to => 'minute' );
1445 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1446 $return_data->{exceeded} = 1;
1447 $return_data->{duration} = $duration;
1448 $return_data->{due_date} = $reduced_datedue;
1452 return $return_data;
1457 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1459 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1463 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1465 =item C<$barcode> is the barcode of the item being issued.
1467 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1468 Calculated if empty.
1470 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1472 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1475 AddIssue does the following things :
1477 - step 01: check that there is a borrowernumber & a barcode provided
1478 - check for RENEWAL (book issued & being issued to the same patron)
1479 - renewal YES = Calculate Charge & renew
1481 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1483 - fill reserve if reserve to this patron
1484 - cancel reserve or not, otherwise
1486 - fill recall if recall to this patron
1487 - cancel recall or not
1488 - revert recall's waiting status or not
1489 * TRANSFERT PENDING ?
1490 - complete the transfert
1498 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1500 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1501 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1502 my $auto_renew = $params && $params->{auto_renew};
1503 my $cancel_recall = $params && $params->{cancel_recall};
1504 my $recall_id = $params && $params->{recall_id};
1505 my $dbh = C4::Context->dbh;
1506 my $barcodecheck = CheckValidBarcode($barcode);
1510 if ( $datedue && ref $datedue ne 'DateTime' ) {
1511 $datedue = dt_from_string($datedue);
1514 # $issuedate defaults to today.
1515 if ( !defined $issuedate ) {
1516 $issuedate = dt_from_string();
1519 if ( ref $issuedate ne 'DateTime' ) {
1520 $issuedate = dt_from_string($issuedate);
1525 # Stop here if the patron or barcode doesn't exist
1526 if ( $borrower && $barcode && $barcodecheck ) {
1527 # find which item we issue
1528 my $item_object = Koha::Items->find({ barcode => $barcode })
1529 or return; # if we don't get an Item, abort.
1530 my $item_unblessed = $item_object->unblessed;
1532 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1534 # get actual issuing if there is one
1535 my $actualissue = $item_object->checkout;
1537 # check if we just renew the issue.
1538 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1539 and not $switch_onsite_checkout ) {
1540 $datedue = AddRenewal(
1541 $borrower->{'borrowernumber'},
1542 $item_object->itemnumber,
1545 $issuedate, # here interpreted as the renewal date
1551 my $itype = $item_object->effective_itemtype;
1552 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1556 # Check if we need to use an exact due date set by the ILL module
1557 if ( C4::Context->preference('ILLModule') ) {
1558 # Check if there is an ILL connected with the biblio of the item we are issuing
1559 my $ill_request = Koha::Illrequests->search({
1560 biblio_id => $item_object->biblionumber,
1561 borrowernumber => $borrower->{'borrowernumber'},
1563 due_date => { '!=', undef },
1566 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1567 my $ill_dt = dt_from_string( $ill_request->due_date );
1568 $ill_dt->set_hour(23);
1569 $ill_dt->set_minute(59);
1574 $datedue->truncate( to => 'minute' );
1576 my $patron = Koha::Patrons->find( $borrower );
1577 my $library = Koha::Libraries->find( $branchcode );
1578 my $fees = Koha::Charges::Fees->new(
1581 library => $library,
1582 item => $item_object,
1583 to_date => $datedue,
1587 # it's NOT a renewal
1588 if ( $actualissue and not $switch_onsite_checkout ) {
1589 # This book is currently on loan, but not to the person
1590 # who wants to borrow it now. mark it returned before issuing to the new borrower
1591 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1592 return unless $allowed;
1593 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1594 # AddReturn certainly has side-effects, like onloan => undef
1595 $item_object->discard_changes;
1598 if ( C4::Context->preference('UseRecalls') ) {
1599 Koha::Recalls->move_recall(
1601 action => $cancel_recall,
1602 recall_id => $recall_id,
1603 item => $item_object,
1604 borrowernumber => $borrower->{borrowernumber},
1609 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1611 # Starting process for transfer job (checking transfert and validate it if we have one)
1612 if ( my $transfer = $item_object->get_transfer ) {
1613 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1616 datearrived => dt_from_string,
1617 tobranch => C4::Context->userenv->{branch},
1618 comments => 'Forced branchtransfer'
1621 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1622 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1623 if ( $hold ) { # Is this really needed?
1624 $hold->set( { found => undef } )->store;
1625 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1630 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1631 unless ($auto_renew) {
1632 my $rule = Koha::CirculationRules->get_effective_rule_value(
1634 categorycode => $borrower->{categorycode},
1635 itemtype => $item_object->effective_itemtype,
1636 branchcode => $branchcode,
1637 rule_name => 'auto_renew'
1641 $auto_renew = $rule if defined $rule && $rule ne '';
1644 my $issue_attributes = {
1645 borrowernumber => $borrower->{'borrowernumber'},
1646 issuedate => $issuedate,
1647 date_due => $datedue,
1648 branchcode => C4::Context->userenv->{'branch'},
1649 onsite_checkout => $onsite_checkout,
1650 auto_renew => $auto_renew ? 1 : 0,
1653 # Get ID of logged in user. if called from a batch job,
1654 # no user session exists and C4::Context->userenv() returns
1655 # the scalar '0'. Only do this if the syspref says so
1656 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1657 my $userenv = C4::Context->userenv();
1658 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1660 $issue_attributes->{issuer_id} = $usernumber;
1664 # In the case that the borrower has an on-site checkout
1665 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1666 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1668 $issue->set($issue_attributes)->store;
1671 $issue = Koha::Checkout->new(
1673 itemnumber => $item_object->itemnumber,
1678 $issue->discard_changes;
1679 C4::Auth::track_login_daily( $borrower->{userid} );
1680 if ( $item_object->location && $item_object->location eq 'CART'
1681 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1682 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1683 CartToShelf( $item_object->itemnumber );
1686 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1687 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1690 # Record if item was lost
1691 my $was_lost = $item_object->itemlost;
1693 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1694 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1695 $item_object->itemlost(0);
1696 $item_object->onloan($datedue->ymd());
1697 $item_object->datelastborrowed( dt_from_string()->ymd() );
1698 $item_object->datelastseen( dt_from_string() );
1699 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1701 # If the item was lost, it has now been found, charge the overdue if necessary
1703 if ( $item_object->{_charge} ) {
1704 $actualissue //= Koha::Old::Checkouts->search(
1705 { itemnumber => $item_unblessed->{itemnumber} },
1707 order_by => { '-desc' => 'returndate' },
1711 unless ( exists( $borrower->{branchcode} ) ) {
1712 my $patron = $actualissue->patron;
1713 $borrower = $patron->unblessed;
1715 _CalculateAndUpdateFine(
1717 issue => $actualissue,
1718 item => $item_unblessed,
1719 borrower => $borrower,
1720 return_date => $issuedate
1723 _FixOverduesOnReturn( $borrower->{borrowernumber},
1724 $item_object->itemnumber, undef, 'RENEWED' );
1728 # If it costs to borrow this book, charge it to the patron's account.
1729 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1730 if ( $charge && $charge > 0 ) {
1731 AddIssuingCharge( $issue, $charge, 'RENT' );
1734 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1735 if ( $itemtype_object ) {
1736 my $accumulate_charge = $fees->accumulate_rentalcharge();
1737 if ( $accumulate_charge > 0 ) {
1738 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1739 $charge += $accumulate_charge;
1740 $item_unblessed->{charge} = $charge;
1744 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckout');
1746 $yaml = "$yaml\n\n";
1749 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
1751 warn "Unable to parse UpdateNotForLoanStatusOnCheckout syspref : $@";
1754 foreach my $key ( keys %$rules ) {
1755 if ( $item_object->notforloan eq $key ) {
1756 $item_object->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
1763 # Record the fact that this book was issued.
1764 C4::Stats::UpdateStats(
1766 branch => C4::Context->userenv->{'branch'},
1767 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1769 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1770 itemnumber => $item_object->itemnumber,
1771 itemtype => $item_object->effective_itemtype,
1772 location => $item_object->location,
1773 borrowernumber => $borrower->{'borrowernumber'},
1774 ccode => $item_object->ccode,
1775 categorycode => $borrower->{'categorycode'},
1776 interface => C4::Context->interface,
1780 # Send a checkout slip.
1781 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1783 branchcode => $branchcode,
1784 categorycode => $borrower->{categorycode},
1785 item_type => $item_object->effective_itemtype,
1786 notification => 'CHECKOUT',
1788 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1789 SendCirculationAlert(
1792 item => $item_object->unblessed,
1793 borrower => $borrower,
1794 branch => $branchcode,
1799 "CIRCULATION", "ISSUE",
1800 $borrower->{'borrowernumber'},
1801 $item_object->itemnumber,
1802 ) if C4::Context->preference("IssueLog");
1804 Koha::Plugins->call('after_circ_action', {
1805 action => 'checkout',
1807 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1808 checkout => $issue->get_from_storage
1812 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1814 biblio_ids => [ $item_object->biblionumber ]
1816 ) if C4::Context->preference('RealTimeHoldsQueue');
1822 =head2 GetLoanLength
1824 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1826 Get loan length for an itemtype, a borrower type and a branch
1831 my ( $categorycode, $itemtype, $branchcode ) = @_;
1833 # Initialize default values
1837 lengthunit => 'days',
1840 my $found = Koha::CirculationRules->get_effective_rules( {
1841 branchcode => $branchcode,
1842 categorycode => $categorycode,
1843 itemtype => $itemtype,
1852 foreach my $rule_name (keys %$found) {
1853 $rules->{$rule_name} = $found->{$rule_name};
1860 =head2 GetHardDueDate
1862 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1864 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1868 sub GetHardDueDate {
1869 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1871 my $rules = Koha::CirculationRules->get_effective_rules(
1873 categorycode => $borrowertype,
1874 itemtype => $itemtype,
1875 branchcode => $branchcode,
1876 rules => [ 'hardduedate', 'hardduedatecompare' ],
1880 if ( defined( $rules->{hardduedate} ) ) {
1881 if ( $rules->{hardduedate} ) {
1882 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1885 return ( undef, undef );
1890 =head2 GetBranchBorrowerCircRule
1892 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1894 Retrieves circulation rule attributes that apply to the given
1895 branch and patron category, regardless of item type.
1896 The return value is a hashref containing the following key:
1898 patron_maxissueqty - maximum number of loans that a
1899 patron of the given category can have at the given
1900 branch. If the value is undef, no limit.
1902 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1903 patron of the given category can have at the given
1904 branch. If the value is undef, no limit.
1906 This will check for different branch/category combinations in the following order:
1910 default branch and category
1912 If no rule has been found in the database, it will default to
1915 patron_maxissueqty - undef
1916 patron_maxonsiteissueqty - undef
1918 C<$branchcode> and C<$categorycode> should contain the
1919 literal branch code and patron category code, respectively - no
1924 sub GetBranchBorrowerCircRule {
1925 my ( $branchcode, $categorycode ) = @_;
1927 # Initialize default values
1929 patron_maxissueqty => undef,
1930 patron_maxonsiteissueqty => undef,
1934 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1935 my $rule = Koha::CirculationRules->get_effective_rule(
1937 categorycode => $categorycode,
1939 branchcode => $branchcode,
1940 rule_name => $rule_name,
1944 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1950 =head2 GetBranchItemRule
1952 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1954 Retrieves circulation rule attributes that apply to the given
1955 branch and item type, regardless of patron category.
1957 The return value is a hashref containing the following keys:
1959 holdallowed => Hold policy for this branch and itemtype. Possible values:
1960 not_allowed: No holds allowed.
1961 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1962 from_any_library: Holds allowed from any patron.
1963 from_local_hold_group: Holds allowed from libraries in hold group
1965 This searches branchitemrules in the following order:
1967 * Same branchcode and itemtype
1968 * Same branchcode, itemtype '*'
1969 * branchcode '*', same itemtype
1970 * branchcode and itemtype '*'
1972 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1976 sub GetBranchItemRule {
1977 my ( $branchcode, $itemtype ) = @_;
1980 my $rules = Koha::CirculationRules->get_effective_rules({
1981 branchcode => $branchcode,
1982 itemtype => $itemtype,
1983 rules => ['holdallowed', 'hold_fulfillment_policy']
1986 # built-in default circulation rule
1987 $rules->{holdallowed} //= 'from_any_library';
1988 $rules->{hold_fulfillment_policy} //= 'any';
1995 ($doreturn, $messages, $iteminformation, $borrower) =
1996 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
2002 =item C<$barcode> is the bar code of the book being returned.
2004 =item C<$branch> is the code of the branch where the book is being returned.
2006 =item C<$exemptfine> indicates that overdue charges for the item will be
2009 =item C<$return_date> allows the default return date to be overridden
2010 by the given return date. Optional.
2014 C<&AddReturn> returns a list of four items:
2016 C<$doreturn> is true iff the return succeeded.
2018 C<$messages> is a reference-to-hash giving feedback on the operation.
2019 The keys of the hash are:
2025 No item with this barcode exists. The value is C<$barcode>.
2029 The book is not currently on loan. The value is C<$barcode>.
2033 This book has been withdrawn/cancelled. The value should be ignored.
2035 =item C<Wrongbranch>
2037 This book has was returned to the wrong branch. The value is a hashref
2038 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2039 contain the branchcode of the incorrect and correct return library, respectively.
2043 The item was reserved. The value is a reference-to-hash whose keys are
2044 fields from the reserves table of the Koha database, and
2045 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2046 either C<Waiting>, C<Reserved>, or 0.
2048 =item C<WasReturned>
2050 Value 1 if return is successful.
2052 =item C<NeedsTransfer>
2054 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2056 =item C<RecallFound>
2058 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2059 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2062 =item C<TransferredRecall>
2064 This item has been transferred to this branch to fill a recall. The recall object is returned.
2068 C<$iteminformation> is a reference-to-hash, giving information about the
2069 returned item from the issues table.
2071 C<$borrower> is a reference-to-hash, giving information about the
2072 patron who last borrowed the book.
2077 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2079 if ($branch and not Koha::Libraries->find($branch)) {
2080 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2083 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2084 my $return_date_specified = !!$return_date;
2085 $return_date //= dt_from_string();
2089 my $validTransfer = 1;
2090 my $stat_type = 'return';
2092 # get information on item
2093 my $item = Koha::Items->find({ barcode => $barcode });
2095 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2098 my $itemnumber = $item->itemnumber;
2099 my $itemtype = $item->effective_itemtype;
2101 my $issue = $item->checkout;
2103 $patron = $issue->patron
2104 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2105 . Dumper($issue->unblessed) . "\n";
2107 $messages->{'NotIssued'} = $barcode;
2108 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2110 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2112 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2113 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2114 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2115 $messages->{'LocalUse'} = 1;
2116 $stat_type = 'localuse';
2120 if ( $item->withdrawn ) { # book has been cancelled
2121 $messages->{'withdrawn'} = 1;
2123 # In the case where we block return of withdrawn, we should completely block the return
2124 # without updating item statuses, so we exit early
2125 return ( 0, $messages, $issue, ( $patron ? $patron->unblessed : {} ))
2126 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2130 # full item data, but no borrowernumber or checkout info (no issue)
2131 my $hbr = Koha::CirculationRules->get_return_branch_policy($item);
2132 # get the proper branch to which to return the item
2133 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2134 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2135 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2137 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2138 my $patron_unblessed = $patron ? $patron->unblessed : {};
2140 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2141 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2142 if ($update_loc_rules) {
2143 if (defined $update_loc_rules->{_ALL_}) {
2144 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2145 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2147 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2148 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2150 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2151 $item->location($update_loc_rules->{_ALL_})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2155 foreach my $key ( keys %$update_loc_rules ) {
2156 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2157 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2158 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2159 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2160 $item->location($update_loc_rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2167 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2169 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2171 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2173 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2176 foreach my $key ( keys %$rules ) {
2177 if ( $item->notforloan eq $key ) {
2178 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2179 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 }) unless $rules->{$key} eq 'ONLYMESSAGE';
2186 # check if the return is allowed at this branch
2187 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2188 unless ($returnallowed){
2189 $messages->{'Wrongbranch'} = {
2190 Wrongbranch => $branch,
2191 Rightbranch => $message
2194 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2195 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2196 return ( $doreturn, $messages, $issue, $patron_unblessed);
2199 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2203 # case of a return of document (deal with issues and holdingbranch)
2205 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2206 $patron or warn "AddReturn without current borrower";
2210 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2215 C4::Context->preference('CalculateFinesOnReturn')
2216 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2221 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2224 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 );
2226 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2227 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2229 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2232 # FIXME is the "= 1" right? This could be the borrower hash.
2233 $messages->{'WasReturned'} = 1;
2236 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2240 # the holdingbranch is updated if the document is returned to another location.
2241 # this is always done regardless of whether the item was on loan or not
2242 if ($item->holdingbranch ne $branch) {
2243 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2246 my $item_was_lost = $item->itemlost;
2247 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2248 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2250 # fix up the accounts.....
2251 if ($item_was_lost) {
2252 $messages->{'WasLost'} = 1;
2253 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2254 my @object_messages = @{ $updated_item->object_messages };
2255 for my $message (@object_messages) {
2256 $messages->{'LostItemFeeRefunded'} = 1
2257 if $message->message eq 'lost_refunded';
2258 $messages->{'ProcessingFeeRefunded'} = 1
2259 if $message->message eq 'processing_refunded';
2260 $messages->{'LostItemFeeRestored'} = 1
2261 if $message->message eq 'lost_restored';
2263 if ( $message->message eq 'lost_charge' ) {
2264 $issue //= Koha::Old::Checkouts->search(
2265 { itemnumber => $item->itemnumber },
2266 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2268 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2269 my $patron = $issue->patron;
2270 $patron_unblessed = $patron->unblessed;
2272 _CalculateAndUpdateFine(
2275 item => $item->unblessed,
2276 borrower => $patron_unblessed,
2277 return_date => $return_date
2280 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2281 $item->itemnumber, undef, 'RETURNED' );
2282 $messages->{'LostItemFeeCharged'} = 1;
2288 # check if we have a transfer for this document
2289 my $transfer = $item->get_transfer;
2291 # if we have a transfer to complete, we update the line of transfers with the datearrived
2294 if ( $transfer->in_transit ) {
2295 if ( $transfer->tobranch eq $branch ) {
2297 $messages->{'TransferArrived'} = $transfer->frombranch;
2298 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2300 if defined $transfer->reason && $transfer->reason eq 'Reserve';
2303 $messages->{'WrongTransfer'} = $transfer->tobranch;
2304 $messages->{'WrongTransferItem'} = $item->itemnumber;
2305 $messages->{'TransferTrigger'} = $transfer->reason;
2309 if ( $transfer->tobranch eq $branch ) {
2311 $messages->{'TransferArrived'} = $transfer->frombranch;
2312 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2313 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2316 $messages->{'TransferTrigger'} = $transfer->reason;
2317 if ( $transfer->frombranch eq $branch ) {
2319 $messages->{'WasTransfered'} = $transfer->tobranch;
2322 $messages->{'WrongTransfer'} = $transfer->tobranch;
2323 $messages->{'WrongTransferItem'} = $item->itemnumber;
2329 # fix up the overdues in accounts...
2330 if ($borrowernumber) {
2331 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2332 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2334 if ( $issue and $issue->is_overdue($return_date) ) {
2336 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2337 if ($debardate and $debardate ne "9999-12-31") {
2339 $messages->{'PrevDebarred'} = $debardate;
2341 $messages->{'Debarred'} = $debardate;
2343 } elsif ($patron->debarred) {
2344 if ( $patron->debarred eq "9999-12-31") {
2345 $messages->{'ForeverDebarred'} = $patron->debarred;
2347 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2348 $borrower_debar_dt->truncate(to => 'day');
2349 my $today_dt = $return_date->clone()->truncate(to => 'day');
2350 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2351 $messages->{'PrevDebarred'} = $patron->debarred;
2355 # there's no overdue on the item but borrower had been previously debarred
2356 } elsif ( $issue->date_due and $patron->debarred ) {
2357 if ( $patron->debarred eq "9999-12-31") {
2358 $messages->{'ForeverDebarred'} = $patron->debarred;
2360 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2361 $borrower_debar_dt->truncate(to => 'day');
2362 my $today_dt = $return_date->clone()->truncate(to => 'day');
2363 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2364 $messages->{'PrevDebarred'} = $patron->debarred;
2371 if ( C4::Context->preference('UseRecalls') ) {
2372 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2374 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2375 if ( defined $recall ) {
2376 $messages->{RecallFound} = $recall;
2377 if ( $recall->pickup_library_id ne $branch ) {
2378 $messages->{RecallNeedsTransfer} = $branch;
2383 # find reserves.....
2384 # launch the Checkreserves routine to find any holds
2385 my ($resfound, $resrec);
2386 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2387 ($resfound, $resrec, undef) = CheckReserves( $item, $lookahead ) unless ( $item->withdrawn );
2388 # 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)
2389 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2390 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2391 $resfound = 'Reserved';
2392 $resrec = $hold->unblessed;
2395 $resrec->{'ResFound'} = $resfound;
2396 $messages->{'ResFound'} = $resrec;
2399 # Record the fact that this book was returned.
2400 my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2401 C4::Stats::UpdateStats({
2404 itemnumber => $itemnumber,
2405 itemtype => $itemtype,
2406 location => $item->location,
2407 borrowernumber => $borrowernumber,
2408 ccode => $item->ccode,
2409 categorycode => $categorycode,
2410 interface => C4::Context->interface,
2413 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2415 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2417 branchcode => $branch,
2418 categorycode => $patron->categorycode,
2419 item_type => $itemtype,
2420 notification => 'CHECKIN',
2422 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2423 SendCirculationAlert({
2425 item => $item->unblessed,
2426 borrower => $patron->unblessed,
2432 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2433 if C4::Context->preference("ReturnLog");
2436 # Check if this item belongs to a biblio record that is attached to an
2437 # ILL request, if it is we need to update the ILL request's status
2438 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2439 my $request = Koha::Illrequests->find(
2440 { biblio_id => $item->biblio->biblionumber }
2442 $request->status('RET') if $request;
2445 if ( C4::Context->preference('UseRecalls') ) {
2446 # all recalls that have triggered a transfer will have an allocated itemnumber
2447 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2448 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2449 $messages->{TransferredRecall} = $transfer_recall;
2453 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2454 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2455 && ( $doreturn or $messages->{'NotIssued'} )
2457 and ( $branch ne $returnbranch )
2458 and not $messages->{'WrongTransfer'}
2459 and not $messages->{'WasTransfered'}
2460 and not $messages->{TransferredRecall}
2461 and not $messages->{RecallNeedsTransfer} )
2463 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2464 if (C4::Context->preference("AutomaticItemReturn" ) or
2465 (C4::Context->preference("UseBranchTransferLimits") and
2466 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2468 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2469 $messages->{'WasTransfered'} = $returnbranch;
2470 $messages->{'TransferTrigger'} = $transfer_trigger;
2472 $messages->{'NeedsTransfer'} = $returnbranch;
2473 $messages->{'TransferTrigger'} = $transfer_trigger;
2477 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2478 my $claims = Koha::Checkouts::ReturnClaims->search(
2480 itemnumber => $item->id,
2481 resolution => undef,
2485 if ( $claims->count ) {
2486 $messages->{ReturnClaims} = $claims;
2490 # Check for bundle status
2491 if ( $item->in_bundle ) {
2492 my $host = $item->bundle_host;
2493 $messages->{InBundle} = $host;
2496 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2497 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2499 if ( $doreturn and $issue ) {
2500 my $checkin = Koha::Old::Checkouts->find($issue->id);
2502 Koha::Plugins->call('after_circ_action', {
2503 action => 'checkin',
2509 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2511 biblio_ids => [ $item->biblionumber ]
2513 ) if C4::Context->preference('RealTimeHoldsQueue');
2516 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2519 =head2 MarkIssueReturned
2521 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2523 Unconditionally marks an issue as being returned by
2524 moving the C<issues> row to C<old_issues> and
2525 setting C<returndate> to the current date.
2527 if C<$returndate> is specified (in iso format), it is used as the date
2530 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2531 the old_issue is immediately anonymised
2533 Ideally, this function would be internal to C<C4::Circulation>,
2534 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2535 and offline_circ/process_koc.pl.
2537 The last optional parameter allos passing skip_record_index to the item store call.
2541 sub MarkIssueReturned {
2542 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2544 # Retrieve the issue
2545 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2547 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2549 my $issue_id = $issue->issue_id;
2551 my $schema = Koha::Database->schema;
2553 # FIXME Improve the return value and handle it from callers
2554 $schema->txn_do(sub {
2556 my $patron = Koha::Patrons->find( $borrowernumber );
2558 # Update the returndate value
2559 if ( $returndate ) {
2560 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2563 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2566 # Create the old_issues entry
2567 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2569 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2570 if ( $privacy && $privacy == 2) {
2571 $old_checkout->anonymize;
2574 # And finally delete the issue
2577 $issue->item->onloan(undef)->store(
2579 skip_record_index => $params->{skip_record_index},
2580 skip_holds_queue => $params->{skip_holds_queue}
2584 if ( C4::Context->preference('StoreLastBorrower') ) {
2585 my $item = Koha::Items->find( $itemnumber );
2586 $item->last_returned_by( $patron );
2589 # Remove any OVERDUES related debarment if the borrower has no overdues
2590 my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
2591 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2592 && $patron->debarred
2593 && !$patron->has_overdues
2594 && $overdue_restrictions->count
2596 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2604 =head2 _debar_user_on_return
2606 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2608 C<$borrower> borrower hashref
2610 C<$item> item hashref
2612 C<$datedue> date due DateTime object
2614 C<$returndate> DateTime object representing the return time
2616 Internal function, called only by AddReturn that calculates and updates
2617 the user fine days, and debars them if necessary.
2619 Should only be called for overdue returns
2621 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2626 sub _calculate_new_debar_dt {
2627 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2629 my $branchcode = _GetCircControlBranch( $item, $borrower );
2630 my $circcontrol = C4::Context->preference('CircControl');
2631 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2632 { categorycode => $borrower->{categorycode},
2633 itemtype => $item->{itype},
2634 branchcode => $branchcode,
2639 'maxsuspensiondays',
2640 'suspension_chargeperiod',
2644 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2645 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2646 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2648 return unless $finedays;
2650 # finedays is in days, so hourly loans must multiply by 24
2651 # thus 1 hour late equals 1 day suspension * finedays rate
2652 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2654 # grace period is measured in the same units as the loan
2656 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2658 my $deltadays = DateTime::Duration->new(
2659 days => $chargeable_units
2662 if ( $deltadays->subtract($grace)->is_positive() ) {
2663 my $suspension_days = $deltadays * $finedays;
2665 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2666 # No need to / 1 and do not consider / 0
2667 $suspension_days = DateTime::Duration->new(
2668 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2672 # If the max suspension days is < than the suspension days
2673 # the suspension days is limited to this maximum period.
2674 my $max_sd = $issuing_rule->{maxsuspensiondays};
2675 if ( defined $max_sd && $max_sd ne '' ) {
2676 $max_sd = DateTime::Duration->new( days => $max_sd );
2677 $suspension_days = $max_sd
2678 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2681 my ( $has_been_extended );
2682 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2683 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
2684 my $debarment = $patron->restrictions->search({type => 'SUSPENSION' },{rows => 1})->single;
2686 $return_date = dt_from_string( $debarment->expiration, 'sql' );
2687 $has_been_extended = 1;
2692 # Use the calendar or not to calculate the debarment date
2693 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2694 my $calendar = Koha::Calendar->new(
2695 branchcode => $branchcode,
2696 days_mode => 'Calendar'
2698 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2701 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2703 return $new_debar_dt;
2708 sub _debar_user_on_return {
2709 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2711 $return_date //= dt_from_string();
2713 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2715 return unless $new_debar_dt;
2717 Koha::Patron::Debarments::AddUniqueDebarment({
2718 borrowernumber => $borrower->{borrowernumber},
2719 expiration => $new_debar_dt->ymd(),
2720 type => 'SUSPENSION',
2722 # if borrower was already debarred but does not get an extra debarment
2723 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2724 my ($new_debarment_str, $is_a_reminder);
2725 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2727 $new_debarment_str = $borrower->{debarred};
2729 $new_debarment_str = $new_debar_dt->ymd();
2731 # FIXME Should return a DateTime object
2732 return $new_debarment_str, $is_a_reminder;
2735 =head2 _FixOverduesOnReturn
2737 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2739 C<$borrowernumber> borrowernumber
2741 C<$itemnumber> itemnumber
2743 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2745 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2751 sub _FixOverduesOnReturn {
2752 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2753 unless( $borrowernumber ) {
2754 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2758 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2762 warn "_FixOverduesOnReturn() not supplied valid status";
2766 my $schema = Koha::Database->schema;
2768 my $result = $schema->txn_do(
2770 # check for overdue fine
2771 my $accountlines = Koha::Account::Lines->search(
2773 borrowernumber => $borrowernumber,
2774 itemnumber => $item,
2775 debit_type_code => 'OVERDUE',
2776 status => 'UNRETURNED'
2779 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2781 my $accountline = $accountlines->next;
2782 my $payments = $accountline->credits;
2784 my $amountoutstanding = $accountline->amountoutstanding;
2785 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2786 $accountline->delete;
2787 return 0; # no warning, we've just removed a zero value fine (backdated return)
2788 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2789 my $account = Koha::Account->new({patron_id => $borrowernumber});
2790 my $credit = $account->add_credit(
2792 amount => $amountoutstanding,
2793 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2794 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2795 interface => C4::Context->interface,
2801 $credit->apply({ debits => [ $accountline ] });
2803 if (C4::Context->preference("FinesLog")) {
2804 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2808 $accountline->status($status);
2809 return $accountline->store();
2816 =head2 _GetCircControlBranch
2818 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2822 Return the library code to be used to determine which circulation
2823 policy applies to a transaction. Looks up the CircControl and
2824 HomeOrHoldingBranch system preferences.
2826 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2828 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2832 sub _GetCircControlBranch {
2833 my ($item, $borrower) = @_;
2834 my $circcontrol = C4::Context->preference('CircControl');
2837 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2838 $branch= C4::Context->userenv->{'branch'};
2839 } elsif ($circcontrol eq 'PatronLibrary') {
2840 $branch=$borrower->{branchcode};
2842 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2843 $branch = $item->{$branchfield};
2844 # default to item home branch if holdingbranch is used
2845 # and is not defined
2846 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2847 $branch = $item->{homebranch};
2853 =head2 GetUpcomingDueIssues
2855 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2859 sub GetUpcomingDueIssues {
2862 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2863 my $dbh = C4::Context->dbh;
2866 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2868 LEFT JOIN items USING (itemnumber)
2869 LEFT JOIN branches ON branches.branchcode =
2871 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2872 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2873 my @bind_parameters = ( $params->{'days_in_advance'} );
2875 my $sth = $dbh->prepare( $statement );
2876 $sth->execute( @bind_parameters );
2877 my $upcoming_dues = $sth->fetchall_arrayref({});
2879 return $upcoming_dues;
2882 =head2 CanBookBeRenewed
2884 ($ok,$error,$info) = &CanBookBeRenewed($patron, $issue, $override_limit);
2886 Find out whether a borrowed item may be renewed.
2888 C<$patron> is the patron who currently has the issue.
2890 C<$issue> is the checkout to renew.
2892 C<$override_limit>, if supplied with a true value, causes
2893 the limit on the number of times that the loan can be renewed
2894 (as controlled by the item type) to be ignored. Overriding also allows
2895 to renew sooner than "No renewal before" and to manually renew loans
2896 that are automatically renewed.
2898 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2899 item must currently be on loan to the specified borrower; renewals
2900 must be allowed for the item's type; and the borrower must not have
2901 already renewed the loan.
2902 $error will contain the reason the renewal can not proceed
2903 $info will contain a hash of additional info
2904 currently 'soonest_renew_date' if error is 'too soon'
2908 sub CanBookBeRenewed {
2909 my ( $patron, $issue, $override_limit, $cron ) = @_;
2911 my $auto_renew = "no";
2913 my $item = $issue->item;
2915 return ( 0, 'no_item' ) unless $item;
2916 return ( 0, 'no_checkout' ) unless $issue;
2917 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2918 return ( 0, 'item_issued_to_other_patron') if $issue->borrowernumber != $patron->borrowernumber;
2919 return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2921 # override_limit will override anything else except on_reserve
2922 unless ( $override_limit ){
2923 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2924 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2926 categorycode => $patron->categorycode,
2927 itemtype => $item->effective_itemtype,
2928 branchcode => $branchcode,
2932 'unseen_renewals_allowed'
2937 return ( 0, "too_many" )
2938 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2940 return ( 0, "too_unseen" )
2941 if C4::Context->preference('UnseenRenewals') &&
2942 looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
2943 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2945 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2946 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2947 my $restricted = $patron->is_debarred;
2948 my $hasoverdues = $patron->has_overdues;
2950 if ( $restricted and $restrictionblockrenewing ) {
2951 return ( 0, 'restriction');
2952 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2953 return ( 0, 'overdue');
2956 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
2959 branchcode => $branchcode,
2962 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
2963 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2964 # extra notices being sent. Cron also implies no override
2965 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2966 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2967 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
2970 if ( C4::Context->preference('UseRecalls') ) {
2972 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2973 if ( defined $recall ) {
2974 if ( $recall->item_level ) {
2975 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
2976 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
2978 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
2979 return ( 0, 'recalled' ) unless ( $recall->waiting );
2984 # There is an item level hold on this item, no other item can fill the hold
2985 return ( 0, "on_reserve" )
2986 if ( $item->current_holds->search( { non_priority => 0 } )->count );
2988 my $fillable_holds = Koha::Holds->search(
2990 biblionumber => $item->biblionumber,
2993 reservedate => { '<=' => \'NOW()' },
2997 if ( $fillable_holds->count ) {
2998 if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
2999 my @possible_holds = $fillable_holds->as_list;
3001 # Get all other items that could possibly fill reserves
3002 # FIXME We could join reserves (or more tables) here to eliminate some checks later
3003 my @other_items = Koha::Items->search({
3004 biblionumber => $item->biblionumber,
3007 -not => { itemnumber => $item->itemnumber } })->as_list;
3009 return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
3012 foreach my $possible_hold (@possible_holds) {
3014 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
3015 my $items_any_available = ItemsAnyAvailableAndNotRestricted({
3016 biblionumber => $item->biblionumber,
3017 patron => $patron_with_reserve
3020 # FIXME: We are not checking whether the item we are renewing can fill the hold
3022 foreach my $other_item (@other_items) {
3023 next if defined $matched_items{$other_item->itemnumber};
3024 next if IsItemOnHoldAndFound( $other_item->itemnumber );
3025 next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef, $items_any_available);
3026 next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3027 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3028 # CanItemBeReserved checks 'rules' and 'policies' which means
3029 # items will fill holds at checkin that are rejected here
3031 $matched_items{$other_item->itemnumber} = 1;
3034 return ( 0, "on_reserve" ) unless $fillable;
3038 my ($status, $matched_reserve, $possible_reserves) = CheckReserves($item);
3039 return ( 0, "on_reserve" ) if $status;
3043 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3044 $soonest = GetSoonestRenewDate($patron, $issue);
3045 if ( $soonest > dt_from_string() ){
3046 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3049 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3051 return ( 1, undef );
3056 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen], [$automatic]);
3060 C<$borrowernumber> is the borrower number of the patron who currently
3063 C<$itemnumber> is the number of the item to renew.
3065 C<$branch> is the library where the renewal took place (if any).
3066 The library that controls the circ policies for the renewal is retrieved from the issues record.
3068 C<$datedue> can be a DateTime object used to set the due date.
3070 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3071 this parameter is not supplied, lastreneweddate is set to the current date.
3073 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3074 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3075 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3078 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3079 from the book's item type.
3081 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3082 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3083 fallback to a true value
3085 C<$automatic> is a boolean flag indicating the renewal was triggered automatically and not by a person ( librarian or patron )
3087 C<$skip_record_index> is an optional boolean flag to indicate whether queuing the search indexing
3088 should be skipped for this renewal.
3093 my $borrowernumber = shift;
3094 my $itemnumber = shift or return;
3096 my $datedue = shift;
3097 my $lastreneweddate = shift || dt_from_string();
3098 my $skipfinecalc = shift;
3100 my $automatic = shift;
3101 my $skip_record_index = shift;
3103 # Fallback on a 'seen' renewal
3104 $seen = defined $seen && $seen == 0 ? 0 : 1;
3106 my $item_object = Koha::Items->find($itemnumber) or return;
3107 my $biblio = $item_object->biblio;
3108 my $issue = $item_object->checkout;
3109 my $item_unblessed = $item_object->unblessed;
3111 my $renewal_type = $automatic ? "Automatic" : "Manual";
3113 my $dbh = C4::Context->dbh;
3115 return unless $issue;
3117 $borrowernumber ||= $issue->borrowernumber;
3119 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3120 $datedue = dt_from_string($datedue, 'sql');
3123 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3124 my $patron_unblessed = $patron->unblessed;
3126 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3128 my $schema = Koha::Database->schema;
3129 $schema->txn_do(sub{
3131 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3132 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3134 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3136 # If the due date wasn't specified, calculate it by adding the
3137 # book's loan length to today's date or the current due date
3138 # based on the value of the RenewalPeriodBase syspref.
3139 my $itemtype = $item_object->effective_itemtype;
3142 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3143 dt_from_string( $issue->date_due, 'sql' ) :
3145 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3148 my $fees = Koha::Charges::Fees->new(
3151 library => $circ_library,
3152 item => $item_object,
3153 from_date => dt_from_string( $issue->date_due, 'sql' ),
3154 to_date => dt_from_string($datedue),
3158 # Increment the unseen renewals, if appropriate
3159 # We only do so if the syspref is enabled and
3160 # a maximum value has been set in the circ rules
3161 my $unseen_renewals = $issue->unseen_renewals;
3162 if (C4::Context->preference('UnseenRenewals')) {
3163 my $rule = Koha::CirculationRules->get_effective_rule(
3164 { categorycode => $patron->categorycode,
3165 itemtype => $item_object->effective_itemtype,
3166 branchcode => $circ_library->branchcode,
3167 rule_name => 'unseen_renewals_allowed'
3170 if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3173 # If the renewal is seen, unseen should revert to 0
3174 $unseen_renewals = 0;
3178 # Update the issues record to have the new due date, and a new count
3179 # of how many times it has been renewed.
3180 my $renews = ( $issue->renewals_count || 0 ) + 1;
3181 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3184 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3187 Koha::Exceptions::Checkout::FailedRenewal->throw(
3188 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3192 # Update the renewal count on the item, and tell zebra to reindex
3193 $renews = ( $item_object->renewals || 0 ) + 1;
3194 $item_object->renewals($renews);
3195 $item_object->onloan($datedue);
3196 # Don't index as we are in a transaction, skip hardcoded here
3197 $item_object->store({ log_action => 0, skip_record_index => 1 });
3199 # Charge a new rental fee, if applicable
3200 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3201 if ( $charge > 0 ) {
3202 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3205 # Charge a new accumulate rental fee, if applicable
3206 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3207 if ( $itemtype_object ) {
3208 my $accumulate_charge = $fees->accumulate_rentalcharge();
3209 if ( $accumulate_charge > 0 ) {
3210 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3212 $charge += $accumulate_charge;
3215 # Send a renewal slip according to checkout alert preferencei
3216 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3217 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3219 branchcode => $branch,
3220 categorycode => $patron->categorycode,
3221 item_type => $itemtype,
3222 notification => 'CHECKOUT',
3224 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3225 SendCirculationAlert(
3228 item => $item_unblessed,
3229 borrower => $patron->unblessed,
3236 # Remove any OVERDUES related debarment if the borrower has no overdues
3237 my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
3239 && $patron->is_debarred
3240 && ! $patron->has_overdues
3241 && $overdue_restrictions->count
3243 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3246 # Add renewal record
3247 my $renewal = Koha::Checkouts::Renewal->new(
3249 checkout_id => $issue->issue_id,
3250 interface => C4::Context->interface,
3251 renewal_type => $renewal_type,
3252 renewer_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3257 # Add the renewal to stats
3258 C4::Stats::UpdateStats(
3260 branch => $item_object->renewal_branchcode({branch => $branch}),
3263 itemnumber => $itemnumber,
3264 itemtype => $itemtype,
3265 location => $item_object->location,
3266 borrowernumber => $borrowernumber,
3267 ccode => $item_object->ccode,
3268 categorycode => $patron->categorycode,
3269 interface => C4::Context->interface,
3274 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3276 Koha::Plugins->call('after_circ_action', {
3277 action => 'renewal',
3279 checkout => $issue->get_from_storage
3284 unless( $skip_record_index ){
3285 # We index now, after the transaction is committed
3286 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
3287 $indexer->index_records( $item_object->biblionumber, "specialUpdate", "biblioserver" );
3294 # check renewal status
3295 my ( $borrowernumber_or_patron, $itemnumber_or_item ) = @_;
3297 my $dbh = C4::Context->dbh;
3299 my $unseencount = 0;
3300 my $renewsallowed = 0;
3301 my $unseenallowed = 0;
3304 my $patron = blessed $borrowernumber_or_patron ?
3305 $borrowernumber_or_patron : Koha::Patrons->find($borrowernumber_or_patron);
3306 my $item = blessed $itemnumber_or_item ?
3307 $itemnumber_or_item : Koha::Items->find($itemnumber_or_item);
3309 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3311 # Look in the issues table for this item, lent to this borrower,
3312 # and not yet returned.
3314 # FIXME - I think this function could be redone to use only one SQL call.
3315 my $sth = $dbh->prepare(q{
3316 SELECT * FROM issues
3317 WHERE (borrowernumber = ?) AND (itemnumber = ?)
3319 $sth->execute( $patron->borrowernumber, $item->itemnumber );
3320 my $data = $sth->fetchrow_hashref;
3321 $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3322 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3323 # $item and $borrower should be calculated
3324 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3326 my $rules = Koha::CirculationRules->get_effective_rules(
3328 categorycode => $patron->categorycode,
3329 itemtype => $item->effective_itemtype,
3330 branchcode => $branchcode,
3331 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3334 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3335 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3336 $rules->{unseen_renewals_allowed} :
3338 $renewsleft = $renewsallowed - $renewcount;
3339 $unseenleft = $unseenallowed - $unseencount;
3340 if($renewsleft < 0){ $renewsleft = 0; }
3341 if($unseenleft < 0){ $unseenleft = 0; }
3352 =head2 GetSoonestRenewDate
3354 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($patron, $issue);
3356 Find out the soonest possible renew date of a borrowed item.
3358 C<$patron> is the patron who currently has the item on loan.
3360 C<$issue> is the the item issue.
3362 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3363 renew date, based on the value "No renewal before" of the applicable
3364 issuing rule. Returns the current date if the item can already be
3365 renewed, and returns undefined if the patron, item, or checkout
3370 sub GetSoonestRenewDate {
3371 my ( $patron, $issue ) = @_;
3372 return unless $issue;
3373 return unless $patron;
3375 my $item = $issue->item;
3376 return unless $item;
3378 my $dbh = C4::Context->dbh;
3380 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3381 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3382 { categorycode => $patron->categorycode,
3383 itemtype => $item->effective_itemtype,
3384 branchcode => $branchcode,
3392 my $now = dt_from_string;
3394 if ( defined $issuing_rule->{norenewalbefore}
3395 and $issuing_rule->{norenewalbefore} ne "" )
3397 my $soonestrenewal =
3398 dt_from_string( $issue->date_due )->subtract(
3399 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3401 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3402 and $issuing_rule->{lengthunit} eq 'days' )
3404 $soonestrenewal->truncate( to => 'day' );
3406 return $soonestrenewal if $now < $soonestrenewal;
3407 } elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
3408 # Checkouts with auto-renewing fall back to due date
3409 my $soonestrenewal = dt_from_string( $issue->date_due );
3410 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3411 and $issuing_rule->{lengthunit} eq 'days' )
3413 $soonestrenewal->truncate( to => 'day' );
3415 return $soonestrenewal;
3420 =head2 GetLatestAutoRenewDate
3422 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($patron, $issue);
3424 Find out the latest possible auto renew date of a borrowed item.
3426 C<$patron> is the patron who currently has the item on loan.
3428 C<$issue> is the item issue.
3430 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3431 auto renew date, based on the value "No auto renewal after" and the "No auto
3432 renewal after (hard limit) of the applicable issuing rule.
3433 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3434 or item cannot be found.
3438 sub GetLatestAutoRenewDate {
3439 my ( $patron, $issue ) = @_;
3440 return unless $issue;
3441 return unless $patron;
3443 my $item = $issue->item;
3444 return unless $item;
3446 my $dbh = C4::Context->dbh;
3448 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3449 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3451 categorycode => $patron->categorycode,
3452 itemtype => $item->effective_itemtype,
3453 branchcode => $branchcode,
3455 'no_auto_renewal_after',
3456 'no_auto_renewal_after_hard_limit',
3462 return unless $circulation_rules;
3464 if ( not $circulation_rules->{no_auto_renewal_after}
3465 or $circulation_rules->{no_auto_renewal_after} eq '' )
3466 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3467 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3469 my $maximum_renewal_date;
3470 if ( $circulation_rules->{no_auto_renewal_after} ) {
3471 $maximum_renewal_date = dt_from_string($issue->issuedate);
3472 $maximum_renewal_date->add(
3473 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3477 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3478 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3479 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3481 return $maximum_renewal_date;
3485 =head2 GetIssuingCharges
3487 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3489 Calculate how much it would cost for a given patron to borrow a given
3490 item, including any applicable discounts.
3492 C<$itemnumber> is the item number of item the patron wishes to borrow.
3494 C<$borrowernumber> is the patron's borrower number.
3496 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3497 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3502 sub GetIssuingCharges {
3504 # calculate charges due
3505 my ( $itemnumber, $borrowernumber ) = @_;
3507 my $dbh = C4::Context->dbh;
3510 # Get the book's item type and rental charge (via its biblioitem).
3511 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3512 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3513 $charge_query .= (C4::Context->preference('item-level_itypes'))
3514 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3515 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3517 $charge_query .= ' WHERE items.itemnumber =?';
3519 my $sth = $dbh->prepare($charge_query);
3520 $sth->execute($itemnumber);
3522 if ( my $item_data = $sth->fetchrow_hashref ) {
3523 $item_type = $item_data->{itemtype};
3524 $charge = $item_data->{rentalcharge};
3526 # FIXME This should follow CircControl
3527 my $branch = C4::Context::mybranch();
3528 $patron //= Koha::Patrons->find( $borrowernumber );
3529 my $discount = Koha::CirculationRules->get_effective_rule({
3530 categorycode => $patron->categorycode,
3531 branchcode => $branch,
3532 itemtype => $item_type,
3533 rule_name => 'rentaldiscount'
3536 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3538 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3542 return ( $charge, $item_type );
3545 =head2 AddIssuingCharge
3547 &AddIssuingCharge( $checkout, $charge, $type )
3551 sub AddIssuingCharge {
3552 my ( $checkout, $charge, $type ) = @_;
3554 # FIXME What if checkout does not exist?
3556 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3557 my $accountline = $account->add_debit(
3561 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3562 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3563 interface => C4::Context->interface,
3565 item_id => $checkout->itemnumber,
3566 issue_id => $checkout->issue_id,
3571 =head2 GetTransfersFromTo
3573 @results = GetTransfersFromTo($frombranch,$tobranch);
3575 Returns the list of pending transfers between $from and $to branch
3579 sub GetTransfersFromTo {
3580 my ( $frombranch, $tobranch ) = @_;
3581 return unless ( $frombranch && $tobranch );
3582 my $dbh = C4::Context->dbh;
3584 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3585 FROM branchtransfers
3588 AND datecancelled IS NULL
3589 AND datesent IS NOT NULL
3590 AND datearrived IS NULL
3592 my $sth = $dbh->prepare($query);
3593 $sth->execute( $frombranch, $tobranch );
3596 while ( my $data = $sth->fetchrow_hashref ) {
3597 push @gettransfers, $data;
3599 return (@gettransfers);
3602 =head2 SendCirculationAlert
3604 Send out a C<check-in> or C<checkout> alert using the messaging system.
3612 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3616 Hashref of information about the item being checked in or out.
3620 Hashref of information about the borrower of the item.
3624 The branchcode from where the checkout or check-in took place.
3630 SendCirculationAlert({
3633 borrower => $borrower,
3639 sub SendCirculationAlert {
3641 my ($type, $item, $borrower, $branch, $issue) =
3642 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3643 my %message_name = (
3644 CHECKIN => 'Item_Check_in',
3645 CHECKOUT => 'Item_Checkout',
3646 RENEWAL => 'Item_Checkout',
3648 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3649 borrowernumber => $borrower->{borrowernumber},
3650 message_name => $message_name{$type},
3655 items => $item->{itemnumber},
3656 biblio => $item->{biblionumber},
3657 biblioitems => $item->{biblionumber},
3658 borrowers => $borrower,
3659 branches => $branch,
3662 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3663 # See C4::Letters:: _parseletter_sth
3664 if( $type eq 'CHECKIN' ){
3665 $tables->{old_issues} = $issue->issue_id;
3667 $tables->{issues} = $item->{itemnumber};
3670 my $schema = Koha::Database->new->schema;
3671 my @transports = keys %{ $borrower_preferences->{transports} };
3673 # From the MySQL doc:
3674 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3675 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3676 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3677 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3679 for my $mtt (@transports) {
3680 my $letter = C4::Letters::GetPreparedLetter (
3681 module => 'circulation',
3682 letter_code => $type,
3683 branchcode => $branch,
3684 message_transport_type => $mtt,
3685 lang => $borrower->{lang},
3689 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3690 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3691 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3692 unless ( $message ) {
3693 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3694 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
3695 C4::Message->enqueue($letter, $patron, $mtt);
3697 $message->append($letter);
3700 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3706 =head2 updateWrongTransfer
3708 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3710 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
3714 sub updateWrongTransfer {
3715 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3717 # first step: cancel the original transfer
3718 my $item = Koha::Items->find($itemNumber);
3719 my $transfer = $item->get_transfer;
3720 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3722 # second step: create a new transfer to the right location
3723 my $new_transfer = $item->request_transfer(
3725 to => $transfer->to_library,
3726 reason => $transfer->reason,
3727 comment => $transfer->comments,
3733 return $new_transfer;
3738 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3740 this function calculates the due date given the start date and configured circulation rules,
3741 checking against the holidays calendar as per the daysmode circulation rule.
3742 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3743 C<$itemtype> = itemtype code of item in question
3744 C<$branch> = location whose calendar to use
3745 C<$borrower> = Borrower object
3746 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3751 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3755 # loanlength now a href
3757 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3759 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3765 if (ref $startdate ne 'DateTime' ) {
3766 $datedue = dt_from_string($datedue);
3768 $datedue = $startdate->clone;
3771 $datedue = dt_from_string()->truncate( to => 'minute' );
3775 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3777 categorycode => $borrower->{categorycode},
3778 itemtype => $itemtype,
3779 branchcode => $branch,
3783 # calculate the datedue as normal
3784 if ( $daysmode eq 'Days' )
3785 { # ignoring calendar
3786 if ( $loanlength->{lengthunit} eq 'hours' ) {
3787 $datedue->add( hours => $loanlength->{$length_key} );
3789 $datedue->add( days => $loanlength->{$length_key} );
3790 $datedue->set_hour(23);
3791 $datedue->set_minute(59);
3795 if ($loanlength->{lengthunit} eq 'hours') {
3796 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3799 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3801 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3802 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3803 if ($loanlength->{lengthunit} eq 'days') {
3804 $datedue->set_hour(23);
3805 $datedue->set_minute(59);
3809 # if Hard Due Dates are used, retrieve them and apply as necessary
3810 my ( $hardduedate, $hardduedatecompare ) =
3811 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3812 if ($hardduedate) { # hardduedates are currently dates
3813 $hardduedate->truncate( to => 'minute' );
3814 $hardduedate->set_hour(23);
3815 $hardduedate->set_minute(59);
3816 my $cmp = DateTime->compare( $hardduedate, $datedue );
3818 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3819 # if the calculated date is before the 'after' Hard Due Date (floor), override
3820 # if the hard due date is set to 'exactly', overrride
3821 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3822 $datedue = $hardduedate->clone;
3825 # in all other cases, keep the date due as it is
3829 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3830 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3831 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3832 if( $expiry_dt ) { #skip empty expiry date..
3833 $expiry_dt->set( hour => 23, minute => 59);
3834 my $d1= $datedue->clone->set_time_zone('floating');
3835 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3836 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3839 if ( $daysmode ne 'Days' ) {
3840 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3841 if ( $calendar->is_holiday($datedue) ) {
3842 # Don't return on a closed day
3843 $datedue = $calendar->prev_open_days( $datedue, 1 );
3852 sub CheckValidBarcode{
3854 my $dbh = C4::Context->dbh;
3855 my $query=qq|SELECT count(*)
3859 my $sth = $dbh->prepare($query);
3860 $sth->execute($barcode);
3861 my $exist=$sth->fetchrow ;
3865 =head2 IsBranchTransferAllowed
3867 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3869 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3871 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3872 Koha::Item->can_be_transferred.
3876 sub IsBranchTransferAllowed {
3877 my ( $toBranch, $fromBranch, $code ) = @_;
3879 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3881 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3882 my $dbh = C4::Context->dbh;
3884 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3885 $sth->execute( $toBranch, $fromBranch, $code );
3886 my $limit = $sth->fetchrow_hashref();
3888 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3889 if ( $limit->{'limitId'} ) {
3896 =head2 CreateBranchTransferLimit
3898 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3900 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3902 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3906 sub CreateBranchTransferLimit {
3907 my ( $toBranch, $fromBranch, $code ) = @_;
3908 return unless defined($toBranch) && defined($fromBranch);
3909 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3911 my $dbh = C4::Context->dbh;
3913 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3914 return $sth->execute( $code, $toBranch, $fromBranch );
3917 =head2 DeleteBranchTransferLimits
3919 my $result = DeleteBranchTransferLimits($frombranch);
3921 Deletes all the library transfer limits for one library. Returns the
3922 number of limits deleted, 0e0 if no limits were deleted, or undef if
3923 no arguments are supplied.
3925 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3926 fromBranch => $fromBranch
3931 sub DeleteBranchTransferLimits {
3933 return unless defined $branch;
3934 my $dbh = C4::Context->dbh;
3935 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3936 return $sth->execute($branch);
3940 my ( $borrowernumber, $itemnum ) = @_;
3941 MarkIssueReturned( $borrowernumber, $itemnum );
3946 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3948 The final optional parameter, C<$params>, expected to contain
3949 'skip_record_index' key, which relayed down to Koha::Item/store,
3950 there it prevents calling of ModZebra index_records,
3951 which takes most of the time in batch adds/deletes: index_records better
3952 to be called later in C<additem.pl> after the whole loop.
3955 skip_record_index => 1|0
3960 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3962 unless ( $mark_lost_from ) {
3963 # Temporary check to avoid regressions
3964 die q|LostItem called without $mark_lost_from, check the API.|;
3968 if ( $force_mark_returned ) {
3971 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3972 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3975 my $dbh = C4::Context->dbh();
3976 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3978 JOIN items USING (itemnumber)
3979 JOIN biblio USING (biblionumber)
3980 WHERE issues.itemnumber=?");
3981 $sth->execute($itemnumber);
3982 my $issues=$sth->fetchrow_hashref();
3984 # If a borrower lost the item, add a replacement cost to the their record
3985 if ( my $borrowernumber = $issues->{borrowernumber} ){
3986 my $patron = Koha::Patrons->find( $borrowernumber );
3988 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3989 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3991 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3992 C4::Accounts::chargelostitem(
3995 $issues->{'replacementprice'},
3996 sprintf( "%s %s %s",
3997 $issues->{'title'} || q{},
3998 $issues->{'barcode'} || q{},
3999 $issues->{'itemcallnumber'} || q{},
4002 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4003 #warn " $issues->{'borrowernumber'} / $itemnumber ";
4006 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4009 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4010 my $item = Koha::Items->find($itemnumber);
4011 my $transfers = $item->get_transfers;
4012 while (my $transfer = $transfers->next) {
4013 $transfer->cancel({ reason => 'ItemLost', force => 1 });
4017 sub GetOfflineOperations {
4018 my $dbh = C4::Context->dbh;
4019 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4020 $sth->execute(C4::Context->userenv->{'branch'});
4021 my $results = $sth->fetchall_arrayref({});
4025 sub GetOfflineOperation {
4026 my $operationid = shift;
4027 return unless $operationid;
4028 my $dbh = C4::Context->dbh;
4029 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4030 $sth->execute( $operationid );
4031 return $sth->fetchrow_hashref;
4034 sub AddOfflineOperation {
4035 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4036 my $dbh = C4::Context->dbh;
4037 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4038 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4042 sub DeleteOfflineOperation {
4043 my $dbh = C4::Context->dbh;
4044 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4045 $sth->execute( shift );
4049 sub ProcessOfflineOperation {
4050 my $operation = shift;
4053 if ( $operation->{action} eq 'return' ) {
4054 $report = ProcessOfflineReturn( $operation );
4055 } elsif ( $operation->{action} eq 'issue' ) {
4056 $report = ProcessOfflineIssue( $operation );
4057 } elsif ( $operation->{action} eq 'payment' ) {
4058 $report = ProcessOfflinePayment( $operation );
4061 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4066 sub ProcessOfflineReturn {
4067 my $operation = shift;
4069 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4072 my $itemnumber = $item->itemnumber;
4073 my $issue = $item->checkout;
4075 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4076 ModDateLastSeen( $itemnumber, $leave_item_lost );
4078 $issue->borrowernumber,
4080 $operation->{timestamp},
4082 $item->renewals_count(0);
4083 $item->onloan(undef);
4084 $item->store({ log_action => 0 });
4087 return "Item not issued.";
4090 return "Item not found.";
4094 sub ProcessOfflineIssue {
4095 my $operation = shift;
4097 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4100 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4102 return "Barcode not found.";
4104 my $itemnumber = $item->itemnumber;
4105 my $issue = $item->checkout;
4107 if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4109 $issue->borrowernumber,
4111 $operation->{timestamp},
4116 $operation->{'barcode'},
4119 $operation->{timestamp},
4124 return "Borrower not found.";
4128 sub ProcessOfflinePayment {
4129 my $operation = shift;
4131 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4133 $patron->account->pay(
4135 amount => $operation->{amount},
4136 library_id => $operation->{branchcode},
4146 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4148 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4153 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4157 ? Koha::Items->find($itemnumber)
4158 : Koha::Items->find( { barcode => $barcode } );
4162 return C4::Letters::GetPreparedLetter (
4163 module => 'circulation',
4164 letter_code => 'TRANSFERSLIP',
4165 branchcode => $branch,
4167 'branches' => $to_branch,
4168 'biblio' => $item->biblionumber,
4169 'items' => $item->unblessed,
4174 =head2 CheckIfIssuedToPatron
4176 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4178 Return 1 if any record item is issued to patron, otherwise return 0
4182 sub CheckIfIssuedToPatron {
4183 my ($borrowernumber, $biblionumber) = @_;
4185 my $dbh = C4::Context->dbh;
4187 SELECT COUNT(*) FROM issues
4188 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4189 WHERE items.biblionumber = ?
4190 AND issues.borrowernumber = ?
4192 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4193 return 1 if $is_issued;
4199 IsItemIssued( $itemnumber )
4201 Return 1 if the item is on loan, otherwise return 0
4206 my $itemnumber = shift;
4207 my $dbh = C4::Context->dbh;
4208 my $sth = $dbh->prepare(q{
4211 WHERE itemnumber = ?
4213 $sth->execute($itemnumber);
4214 return $sth->fetchrow;
4217 =head2 GetAgeRestriction
4219 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4220 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4222 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4223 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4225 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4226 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4227 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4228 Negative days mean the borrower has gone past the age restriction age.
4232 sub GetAgeRestriction {
4233 my ($record_restrictions, $borrower) = @_;
4234 my $markers = C4::Context->preference('AgeRestrictionMarker');
4236 return unless $record_restrictions;
4237 # Split $record_restrictions to something like FSK 16 or PEGI 6
4238 my @values = split ' ', uc($record_restrictions);
4239 return unless @values;
4241 # Search first occurrence of one of the markers
4242 my @markers = split /\|/, uc($markers);
4243 return unless @markers;
4246 my $restriction_year = 0;
4247 for my $value (@values) {
4249 for my $marker (@markers) {
4250 $marker =~ s/^\s+//; #remove leading spaces
4251 $marker =~ s/\s+$//; #remove trailing spaces
4252 if ( $marker eq $value ) {
4253 if ( $index <= $#values ) {
4254 $restriction_year += $values[$index];
4258 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4260 # Perhaps it is something like "K16" (as in Finland)
4261 $restriction_year += $1;
4265 last if ( $restriction_year > 0 );
4268 #Check if the borrower is age restricted for this material and for how long.
4269 if ($restriction_year && $borrower) {
4270 if ( $borrower->{'dateofbirth'} ) {
4271 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4272 $alloweddate[0] += $restriction_year;
4274 #Prevent runime eror on leap year (invalid date)
4275 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4276 $alloweddate[2] = 28;
4279 #Get how many days the borrower has to reach the age restriction
4280 my @Today = split /-/, dt_from_string()->ymd();
4281 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4282 #Negative days means the borrower went past the age restriction age
4283 return ($restriction_year, $daysToAgeRestriction);
4287 return ($restriction_year);
4291 =head2 GetPendingOnSiteCheckouts
4295 sub GetPendingOnSiteCheckouts {
4296 my $dbh = C4::Context->dbh;
4297 return $dbh->selectall_arrayref(q|
4303 items.itemcallnumber,
4307 issues.date_due < NOW() AS is_overdue,
4310 borrowers.firstname,
4312 borrowers.cardnumber,
4313 borrowers.borrowernumber
4315 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4316 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4317 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4318 WHERE issues.onsite_checkout = 1
4319 |, { Slice => {} } );
4325 my ($count, $branch, $itemtype, $ccode, $newness)
4326 = @$params{qw(count branch itemtype ccode newness)};
4328 my $dbh = C4::Context->dbh;
4331 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4332 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4333 i.ccode, SUM(i.issues) AS count
4335 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4336 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4339 my (@where_strs, @where_args);
4342 push @where_strs, 'i.homebranch = ?';
4343 push @where_args, $branch;
4346 if (C4::Context->preference('item-level_itypes')){
4347 push @where_strs, 'i.itype = ?';
4348 push @where_args, $itemtype;
4350 push @where_strs, 'bi.itemtype = ?';
4351 push @where_args, $itemtype;
4355 push @where_strs, 'i.ccode = ?';
4356 push @where_args, $ccode;
4359 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4360 push @where_args, $newness;
4364 $query .= 'WHERE ' . join(' AND ', @where_strs);
4368 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4369 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4374 $query .= q{ ) xxx WHERE count > 0 };
4375 $count = int($count);
4377 $query .= "LIMIT $count";
4380 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4385 =head2 Internal methods
4389 sub _CalculateAndUpdateFine {
4392 my $borrower = $params->{borrower};
4393 my $item = $params->{item};
4394 my $issue = $params->{issue};
4395 my $return_date = $params->{return_date};
4397 unless ($borrower) { carp "No borrower passed in!" && return; }
4398 unless ($item) { carp "No item passed in!" && return; }
4399 unless ($issue) { carp "No issue passed in!" && return; }
4401 my $datedue = dt_from_string( $issue->date_due );
4403 # we only need to calculate and change the fines if we want to do that on return
4404 # Should be on for hourly loans
4405 my $control = C4::Context->preference('CircControl');
4406 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4407 my $control_branchcode =
4408 ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4409 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4410 : $issue->branchcode;
4412 my $date_returned = $return_date ? $return_date : dt_from_string();
4414 my ( $amount, $unitcounttotal, $unitcount ) =
4415 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4417 if ( C4::Context->preference('finesMode') eq 'production' ) {
4418 if ( $amount > 0 ) {
4419 C4::Overdues::UpdateFine({
4420 issue_id => $issue->issue_id,
4421 itemnumber => $issue->itemnumber,
4422 borrowernumber => $issue->borrowernumber,
4427 elsif ($return_date) {
4429 # Backdated returns may have fines that shouldn't exist,
4430 # so in this case, we need to drop those fines to 0
4432 C4::Overdues::UpdateFine({
4433 issue_id => $issue->issue_id,
4434 itemnumber => $issue->itemnumber,
4435 borrowernumber => $issue->borrowernumber,
4443 sub _CanBookBeAutoRenewed {
4444 my ( $params ) = @_;
4445 my $patron = $params->{patron};
4446 my $item = $params->{item};
4447 my $branchcode = $params->{branchcode};
4448 my $issue = $params->{issue};
4450 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4452 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4454 categorycode => $patron->categorycode,
4455 itemtype => $item->effective_itemtype,
4456 branchcode => $branchcode,
4458 'no_auto_renewal_after',
4459 'no_auto_renewal_after_hard_limit',
4466 if ( $patron->is_expired && $patron->category->effective_BlockExpiredPatronOpacActions ) {
4467 return 'auto_account_expired';
4470 if ( defined $issuing_rule->{no_auto_renewal_after}
4471 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4472 # Get issue_date and add no_auto_renewal_after
4473 # If this is greater than today, it's too late for renewal.
4474 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4475 $maximum_renewal_date->add(
4476 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4478 my $now = dt_from_string;
4479 if ( $now >= $maximum_renewal_date ) {
4480 return "auto_too_late";
4483 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4484 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4485 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4486 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4487 return "auto_too_late";
4491 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4492 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4493 my $amountoutstanding =
4494 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4495 ? $patron->account->balance
4496 : $patron->account->outstanding_debits->total_outstanding;
4497 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4498 return "auto_too_much_oweing";
4502 my $soonest = GetSoonestRenewDate($patron, $issue);
4503 if ( $soonest > dt_from_string() )
4505 return ( "auto_too_soon", $soonest );
4518 Koha Development Team <http://koha-community.org/>