1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use POSIX qw( floor );
27 use Koha::DateUtils qw( dt_from_string output_pref );
29 use C4::Stats qw( UpdateStats );
30 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest ItemsAnyAvailableAndNotRestricted );
31 use C4::Biblio qw( UpdateTotalIssues );
32 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
34 use C4::ItemCirculationAlertPreference;
36 use C4::Log qw( logaction ); # logaction
38 use C4::RotatingCollections qw(GetCollectionItemBranches);
39 use Algorithm::CheckDigits qw( CheckDigits );
41 use Data::Dumper qw( Dumper );
43 use Koha::AuthorisedValues;
44 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
45 use Koha::Biblioitems;
46 use Koha::DateUtils qw( dt_from_string output_pref );
49 use Koha::Illrequests;
52 use Koha::Patron::Debarments qw( DelUniqueDebarment GetDebarments AddUniqueDebarment );
55 use Koha::Account::Lines;
57 use Koha::Account::Lines;
58 use Koha::Account::Offsets;
59 use Koha::Config::SysPrefs;
60 use Koha::Charges::Fees;
61 use Koha::Config::SysPref;
62 use Koha::Checkouts::ReturnClaims;
63 use Koha::SearchEngine::Indexer;
64 use Koha::Exceptions::Checkout;
68 use List::MoreUtils qw( any );
69 use Scalar::Util qw( looks_like_number );
70 use Date::Calc qw( Date_to_Days );
71 our (@ISA, @EXPORT_OK);
77 # FIXME subs that should probably be elsewhere
82 GetPendingOnSiteCheckouts
93 GetLatestAutoRenewDate
96 GetBranchBorrowerCircRule
101 CheckIfIssuedToPatron
116 IsBranchTransferAllowed
117 CreateBranchTransferLimit
118 DeleteBranchTransferLimits
124 DeleteOfflineOperation
125 ProcessOfflineOperation
126 ProcessOfflinePayment
128 push @EXPORT_OK, '_GetCircControlBranch'; # This is wrong!
133 C4::Circulation - Koha circulation module
141 The functions in this module deal with circulation, issues, and
142 returns, as well as general information about the library.
143 Also deals with inventory.
149 $str = &barcodedecode($barcode, [$filter]);
151 Generic filter function for barcode string.
152 Called on every circ if the System Pref itemBarcodeInputFilter is set.
153 Will do some manipulation of the barcode for systems that deliver a barcode
154 to circulation.pl that differs from the barcode stored for the item.
155 For proper functioning of this filter, calling the function on the
156 correct barcode string (items.barcode) should return an unaltered barcode.
157 Barcode is going to be automatically trimmed of leading/trailing whitespaces.
159 The optional $filter argument is to allow for testing or explicit
160 behavior that ignores the System Pref. Valid values are the same as the
165 # FIXME -- the &decode fcn below should be wrapped into this one.
166 # FIXME -- these plugins should be moved out of Circulation.pm
169 my ($barcode, $filter) = @_;
171 return unless defined $barcode;
173 my $branch = C4::Context::mybranch();
174 $barcode =~ s/^\s+|\s+$//g;
175 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
176 Koha::Plugins->call('item_barcode_transform', \$barcode );
177 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
178 if ($filter eq 'whitespace') {
180 } elsif ($filter eq 'cuecat') {
182 my @fields = split( /\./, $barcode );
183 my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
184 ($#results == 2) and return $results[2];
185 } elsif ($filter eq 'T-prefix') {
186 if ($barcode =~ /^[Tt](\d)/) {
187 (defined($1) and $1 eq '0') and return $barcode;
188 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
190 return sprintf("T%07d", $barcode);
191 # FIXME: $barcode could be "T1", causing warning: substr outside of string
192 # Why drop the nonzero digit after the T?
193 # Why pass non-digits (or empty string) to "T%07d"?
194 } elsif ($filter eq 'libsuite8') {
195 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
196 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
197 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
199 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
202 } elsif ($filter eq 'EAN13') {
203 my $ean = CheckDigits('ean');
204 if ( $ean->is_valid($barcode) ) {
205 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
206 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
208 warn "# [$barcode] not valid EAN-13/UPC-A\n";
211 return $barcode; # return barcode, modified or not
216 $str = &_decode($chunk);
218 Decodes a segment of a string emitted by a CueCat barcode scanner and
221 FIXME: Should be replaced with Barcode::Cuecat from CPAN
222 or Javascript based decoding on the client side.
229 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
230 my @s = map { index( $seq, $_ ); } split( //, $encoded );
231 my $l = ( $#s + 1 ) % 4;
234 # warn "Error: Cuecat decode parsing failed!";
242 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
244 chr( ( $n >> 16 ) ^ 67 )
245 .chr( ( $n >> 8 & 255 ) ^ 67 )
246 .chr( ( $n & 255 ) ^ 67 );
249 $r = substr( $r, 0, length($r) - $l );
255 ($dotransfer, $messages, $iteminformation) = &transferbook({
256 from_branch => $frombranch
257 to_branch => $tobranch,
259 ignore_reserves => $ignore_reserves,
263 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
265 C<$fbr> is the code for the branch initiating the transfer.
266 C<$tbr> is the code for the branch to which the item should be transferred.
268 C<$barcode> is the barcode of the item to be transferred.
270 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
271 Otherwise, if an item is reserved, the transfer fails.
273 C<$trigger> is the enum value for what triggered the transfer.
275 Returns three values:
281 is true if the transfer was successful.
285 is a reference-to-hash which may have any of the following keys:
291 There is no item in the catalog with the given barcode. The value is C<$barcode>.
293 =item C<DestinationEqualsHolding>
295 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
299 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
303 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
305 =item C<WasTransferred>
307 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
309 =item C<RecallPlacedAtHoldingBranch>
311 A recall for this item was found, and the transfer has already been completed as the item's branch matches the recall's pickup branch.
315 A recall for this item was found, and the item needs to be transferred to the recall's pickup branch.
325 my $tbr = $params->{to_branch};
326 my $fbr = $params->{from_branch};
327 my $ignoreRs = $params->{ignore_reserves};
328 my $barcode = $params->{barcode};
329 my $trigger = $params->{trigger};
332 my $item = Koha::Items->find( { barcode => $barcode } );
334 Koha::Exceptions::MissingParameter->throw(
335 "Missing mandatory parameter: from_branch")
338 Koha::Exceptions::MissingParameter->throw(
339 "Missing mandatory parameter: to_branch")
344 $messages->{'BadBarcode'} = $barcode;
346 return ( $dotransfer, $messages );
349 my $itemnumber = $item->itemnumber;
350 # get branches of book...
351 my $hbr = $item->homebranch;
353 # if using Branch Transfer Limits
354 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
355 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
356 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
357 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
358 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
361 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
362 $messages->{'NotAllowed'} = $tbr . "::" . $code;
367 # can't transfer book if is already there....
368 if ( $fbr eq $tbr ) {
369 $messages->{'DestinationEqualsHolding'} = 1;
373 # check if it is still issued to someone, return it...
374 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
376 AddReturn( $barcode, $fbr );
377 $messages->{'WasReturned'} = $issue->borrowernumber;
381 # That'll save a database query.
382 my ( $resfound, $resrec, undef ) =
383 CheckReserves( $itemnumber );
385 $resrec->{'ResFound'} = $resfound;
386 $messages->{'ResFound'} = $resrec;
387 $dotransfer = 0 unless $ignoreRs;
391 if ( C4::Context->preference('UseRecalls') ) {
392 my $recall = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
393 if ( defined $recall ) {
394 # do a transfer if the recall branch is different to the item holding branch
395 if ( $recall->pickup_library_id eq $fbr ) {
397 $messages->{'RecallPlacedAtHoldingBranch'} = 1;
400 $messages->{'RecallFound'} = $recall;
405 #actually do the transfer....
407 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
409 # don't need to update MARC anymore, we do it in batch now
410 $messages->{'WasTransfered'} = $tbr;
413 ModDateLastSeen( $itemnumber );
414 return ( $dotransfer, $messages );
419 my $borrower = shift;
420 my $item_object = shift;
422 my $onsite_checkout = $params->{onsite_checkout} || 0;
423 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
424 my $cat_borrower = $borrower->{'categorycode'};
425 my $dbh = C4::Context->dbh;
426 # Get which branchcode we need
427 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
428 my $type = $item_object->effective_itemtype;
430 my ($type_object, $parent_type, $parent_maxissueqty_rule);
431 $type_object = Koha::ItemTypes->find( $type );
432 $parent_type = $type_object->parent_type if $type_object;
433 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
434 # Find any children if we are a parent_type;
436 # given branch, patron category, and item type, determine
437 # applicable issuing rule
439 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
441 categorycode => $cat_borrower,
442 itemtype => $parent_type,
443 branchcode => $branch,
444 rule_name => 'maxissueqty',
447 # If the parent rule is for default type we discount it
448 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
450 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
452 categorycode => $cat_borrower,
454 branchcode => $branch,
455 rule_name => 'maxissueqty',
459 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
461 categorycode => $cat_borrower,
463 branchcode => $branch,
464 rule_name => 'maxonsiteissueqty',
469 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
470 # if a rule is found and has a loan limit set, count
471 # how many loans the patron already has that meet that
473 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
476 if ( $maxissueqty_rule->branchcode ) {
477 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
478 $checkouts = $patron->checkouts->search(
479 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
480 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
481 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
483 $checkouts = $patron->checkouts->search(
484 { 'item.homebranch' => $maxissueqty_rule->branchcode } );
487 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
489 $checkouts = $checkouts->search(undef, { prefetch => 'item' });
492 my $rule_itemtype = $maxissueqty_rule->itemtype;
495 unless ( $rule_itemtype ) {
496 # matching rule has the default item type, so count only
497 # those existing loans that don't fall under a more
499 @types = Koha::CirculationRules->search(
501 branchcode => $maxissueqty_rule->branchcode,
502 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
503 itemtype => { '!=' => undef },
504 rule_name => 'maxissueqty'
506 )->get_column('itemtype');
508 if ( $parent_maxissueqty_rule ) {
509 # if we have a parent item type then we count loans of the
510 # specific item type or its siblings or parent
511 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
512 @types = $children->get_column('itemtype');
513 push @types, $parent_type;
514 } elsif ( $child_types ) {
515 # If we are a parent type, we need to count all child types and our own type
516 @types = $child_types->get_column('itemtype');
517 push @types, $type; # And don't forget to count our own types
519 # Otherwise only count the specific itemtype
524 while ( my $c = $checkouts->next ) {
525 my $itemtype = $c->item->effective_itemtype;
527 unless ( $rule_itemtype ) {
528 next if grep {$_ eq $itemtype} @types;
530 next unless grep {$_ eq $itemtype} @types;
533 $sum_checkouts->{total}++;
534 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
535 $sum_checkouts->{itemtype}->{$itemtype}++;
538 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
539 my $checkout_count = $sum_checkouts->{total} || 0;
540 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
542 my $checkout_rules = {
543 checkout_count => $checkout_count,
544 onsite_checkout_count => $onsite_checkout_count,
545 onsite_checkout => $onsite_checkout,
546 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
547 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
548 switch_onsite_checkout => $switch_onsite_checkout,
550 # If parent rules exists
551 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
552 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
553 my $qty_over = _check_max_qty($checkout_rules);
554 return $qty_over if defined $qty_over;
556 # If the parent rule is less than or equal to the child, we only need check the parent
557 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
558 $checkout_rules->{checkout_count} = $checkout_count_type;
559 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
560 my $qty_over = _check_max_qty($checkout_rules);
561 return $qty_over if defined $qty_over;
564 my $qty_over = _check_max_qty($checkout_rules);
565 return $qty_over if defined $qty_over;
569 # Now count total loans against the limit for the branch
570 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
571 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
573 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
574 $checkouts = $patron->checkouts->search(
575 { 'me.branchcode' => $branch} );
576 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
577 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
579 $checkouts = $patron->checkouts->search(
580 { 'item.homebranch' => $branch},
581 { prefetch => 'item' } );
584 my $checkout_count = $checkouts->count;
585 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
586 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
587 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
589 my $qty_over = _check_max_qty(
591 checkout_count => $checkout_count,
592 onsite_checkout_count => $onsite_checkout_count,
593 onsite_checkout => $onsite_checkout,
594 max_checkouts_allowed => $max_checkouts_allowed,
595 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
596 switch_onsite_checkout => $switch_onsite_checkout
599 return $qty_over if defined $qty_over;
602 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
603 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
606 # OK, the patron can issue !!!
612 my $checkout_count = $params->{checkout_count};
613 my $onsite_checkout_count = $params->{onsite_checkout_count};
614 my $onsite_checkout = $params->{onsite_checkout};
615 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
616 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
617 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
619 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
620 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
621 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
623 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
624 count => $onsite_checkout_count,
625 max_allowed => $max_onsite_checkouts_allowed,
629 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
630 if ( $max_checkouts_allowed eq '' ) { return; }
631 my $delta = $switch_onsite_checkout ? 1 : 0;
632 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
634 reason => 'TOO_MANY_CHECKOUTS',
635 count => $checkout_count,
636 max_allowed => $max_checkouts_allowed,
640 elsif ( not $onsite_checkout ) {
641 if ( $max_checkouts_allowed eq '' ) { return; }
643 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
646 reason => 'TOO_MANY_CHECKOUTS',
647 count => $checkout_count - $onsite_checkout_count,
648 max_allowed => $max_checkouts_allowed,
656 =head2 CanBookBeIssued
658 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
659 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
661 Check if a book can be issued.
663 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
665 IMPORTANT: The assumption by users of this routine is that causes blocking
666 the issue are keyed by uppercase labels and other returned
667 data is keyed in lower case!
671 =item C<$patron> is a Koha::Patron
673 =item C<$barcode> is the bar code of the book being issued.
675 =item C<$duedates> is a DateTime object.
677 =item C<$inprocess> boolean switch
679 =item C<$ignore_reserves> boolean switch
681 =item C<$params> Hashref of additional parameters
684 override_high_holds - Ignore high holds
685 onsite_checkout - Checkout is an onsite checkout that will not leave the library
693 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
694 Possible values are :
700 sticky due date is invalid
704 borrower gone with no address
708 borrower declared it's card lost
714 =head3 UNKNOWN_BARCODE
728 item is restricted (set by ??)
730 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
731 could be prevented, but ones that can be overriden by the operator.
733 Possible values are :
741 renewing, not issuing
743 =head3 ISSUED_TO_ANOTHER
745 issued to someone else.
749 reserved for someone else.
753 reserved and being transferred for someone else.
757 sticky due date is invalid or due date in the past
761 if the borrower borrows to much things
765 recalled by someone else
769 sub CanBookBeIssued {
770 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
771 my %needsconfirmation; # filled with problems that needs confirmations
772 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
773 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
774 my %messages; # filled with information messages that should be displayed.
776 my $onsite_checkout = $params->{onsite_checkout} || 0;
777 my $override_high_holds = $params->{override_high_holds} || 0;
779 my $item_object = Koha::Items->find({barcode => $barcode });
781 # MANDATORY CHECKS - unless item exists, nothing else matters
782 unless ( $item_object ) {
783 $issuingimpossible{UNKNOWN_BARCODE} = 1;
785 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
787 my $item_unblessed = $item_object->unblessed; # Transition...
788 my $issue = $item_object->checkout;
789 my $biblio = $item_object->biblio;
791 my $biblioitem = $biblio->biblioitem;
792 my $effective_itemtype = $item_object->effective_itemtype;
793 my $dbh = C4::Context->dbh;
794 my $patron_unblessed = $patron->unblessed;
796 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
798 # DUE DATE is OK ? -- should already have checked.
800 if ($duedate && ref $duedate ne 'DateTime') {
801 $duedate = dt_from_string($duedate);
803 my $now = dt_from_string();
804 unless ( $duedate ) {
805 my $issuedate = $now->clone();
807 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
809 # Offline circ calls AddIssue directly, doesn't run through here
810 # So issuingimpossible should be ok.
813 my $fees = Koha::Charges::Fees->new(
816 library => $circ_library,
817 item => $item_object,
823 my $today = $now->clone();
824 $today->truncate( to => 'minute');
825 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
826 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
829 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
835 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
836 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
837 C4::Stats::UpdateStats({
838 branch => C4::Context->userenv->{'branch'},
840 itemnumber => $item_object->itemnumber,
841 itemtype => $effective_itemtype,
842 borrowernumber => $patron->borrowernumber,
843 ccode => $item_object->ccode}
845 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
846 return( { STATS => 1 }, {});
849 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
850 $issuingimpossible{GNA} = 1;
853 if ( $patron->lost && $patron->lost == 1 ) {
854 $issuingimpossible{CARD_LOST} = 1;
856 if ( $patron->is_debarred ) {
857 $issuingimpossible{DEBARRED} = 1;
860 if ( $patron->is_expired ) {
861 $issuingimpossible{EXPIRED} = 1;
869 my $account = $patron->account;
870 my $balance = $account->balance;
871 my $non_issues_charges = $account->non_issues_charges;
872 my $other_charges = $balance - $non_issues_charges;
874 my $amountlimit = C4::Context->preference("noissuescharge");
875 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
876 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
878 # Check the debt of this patrons guarantees
879 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
880 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
881 if ( defined $no_issues_charge_guarantees ) {
882 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
883 my $guarantees_non_issues_charges = 0;
884 foreach my $g ( @guarantees ) {
885 $guarantees_non_issues_charges += $g->account->non_issues_charges;
888 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
889 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
890 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
891 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
892 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
893 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
897 # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
898 my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
899 $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
900 if ( defined $no_issues_charge_guarantors ) {
901 my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
903 if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
904 $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
905 } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
906 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
907 } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
908 $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
912 if ( C4::Context->preference("IssuingInProcess") ) {
913 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
914 $issuingimpossible{DEBT} = $non_issues_charges;
915 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
916 $needsconfirmation{DEBT} = $non_issues_charges;
917 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
918 $needsconfirmation{DEBT} = $non_issues_charges;
922 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
923 $needsconfirmation{DEBT} = $non_issues_charges;
924 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
925 $issuingimpossible{DEBT} = $non_issues_charges;
926 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
927 $needsconfirmation{DEBT} = $non_issues_charges;
931 if ($balance > 0 && $other_charges > 0) {
932 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
935 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
936 $patron_unblessed = $patron->unblessed;
938 if ( my $debarred_date = $patron->is_debarred ) {
939 # patron has accrued fine days or has a restriction. $count is a date
940 if ($debarred_date eq '9999-12-31') {
941 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
944 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
946 } elsif ( my $num_overdues = $patron->has_overdues ) {
947 ## patron has outstanding overdue loans
948 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
949 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
951 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
952 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
956 # Additional Materials Check
957 if ( C4::Context->preference("CircConfirmItemParts")
958 && $item_object->materials )
960 $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
964 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
966 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
968 # Already issued to current borrower.
969 # If it is an on-site checkout if it can be switched to a normal checkout
970 # or ask whether the loan should be renewed
972 if ( $issue->onsite_checkout
973 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
974 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
976 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
977 $patron->borrowernumber,
978 $item_object->itemnumber,
980 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
981 if ( $renewerror eq 'onsite_checkout' ) {
982 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
985 $issuingimpossible{NO_MORE_RENEWALS} = 1;
989 $needsconfirmation{RENEW_ISSUE} = 1;
995 # issued to someone else
997 my $patron = Koha::Patrons->find( $issue->borrowernumber );
999 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1001 unless ( $can_be_returned ) {
1002 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
1003 $issuingimpossible{branch_to_return} = $message;
1005 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
1006 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
1008 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
1009 $needsconfirmation{issued_firstname} = $patron->firstname;
1010 $needsconfirmation{issued_surname} = $patron->surname;
1011 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
1012 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
1017 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1019 my $switch_onsite_checkout = (
1020 C4::Context->preference('SwitchOnSiteCheckouts')
1022 and $issue->onsite_checkout
1023 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1024 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1025 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1026 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1027 if ( $toomany->{max_allowed} == 0 ) {
1028 $needsconfirmation{PATRON_CANT} = 1;
1030 if ( C4::Context->preference("AllowTooManyOverride") ) {
1031 $needsconfirmation{TOO_MANY} = $toomany->{reason};
1032 $needsconfirmation{current_loan_count} = $toomany->{count};
1033 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1035 $issuingimpossible{TOO_MANY} = $toomany->{reason};
1036 $issuingimpossible{current_loan_count} = $toomany->{count};
1037 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1042 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1044 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1045 my $wants_check = $patron->wants_check_for_previous_checkout;
1046 $needsconfirmation{PREVISSUE} = 1
1047 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1052 if ( $item_object->notforloan )
1054 if(!C4::Context->preference("AllowNotForLoanOverride")){
1055 $issuingimpossible{NOT_FOR_LOAN} = 1;
1056 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1058 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1059 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1063 # we have to check itemtypes.notforloan also
1064 if (C4::Context->preference('item-level_itypes')){
1065 # this should probably be a subroutine
1066 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1067 $sth->execute($effective_itemtype);
1068 my $notforloan=$sth->fetchrow_hashref();
1069 if ($notforloan->{'notforloan'}) {
1070 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1071 $issuingimpossible{NOT_FOR_LOAN} = 1;
1072 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1074 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1075 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1080 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1081 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1082 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1083 $issuingimpossible{NOT_FOR_LOAN} = 1;
1084 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1086 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1087 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1092 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1094 $issuingimpossible{WTHDRAWN} = 1;
1096 if ( $item_object->restricted
1097 && $item_object->restricted == 1 )
1099 $issuingimpossible{RESTRICTED} = 1;
1101 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1102 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1103 my $code = $av->count ? $av->next->lib : '';
1104 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1105 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1107 if ( C4::Context->preference("IndependentBranches") ) {
1108 my $userenv = C4::Context->userenv;
1109 unless ( C4::Context->IsSuperLibrarian() ) {
1110 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1111 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1112 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1113 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1115 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1116 if ( $patron->branchcode ne $userenv->{branch} );
1121 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1123 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1124 if ($rentalConfirmation) {
1125 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1127 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1128 if ($itemtype_object) {
1129 my $accumulate_charge = $fees->accumulate_rentalcharge();
1130 if ( $accumulate_charge > 0 ) {
1131 $rentalCharge += $accumulate_charge;
1135 if ( $rentalCharge > 0 ) {
1136 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1141 # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1142 # Only bother doing this if UseRecalls is enabled and the item is recallable
1143 # Don't look at recalls that are in transit
1144 if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1145 my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1147 foreach my $r ( @recalls ) {
1148 if ( $r->item_id and
1149 $r->item_id == $item_object->itemnumber and
1150 $r->patron_id == $patron->borrowernumber and
1151 ( $r->waiting or $r->requested ) ) {
1152 $messages{RECALLED} = $r->id;
1154 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1157 elsif ( $r->item_id and
1158 $r->item_id == $item_object->itemnumber and
1160 # recalled item is in transit
1161 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1163 elsif ( $r->item_level and
1164 $r->item_id == $item_object->itemnumber and
1165 $r->patron_id != $patron->borrowernumber and
1167 # this specific item has been recalled by a different patron
1168 $needsconfirmation{RECALLED} = $r;
1172 elsif ( !$r->item_level and
1173 $r->patron_id != $patron->borrowernumber and
1175 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1176 $needsconfirmation{RECALLED} = $r;
1183 unless ( $ignore_reserves and defined $recall ) {
1184 # See if the item is on reserve.
1185 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1187 my $resbor = $res->{'borrowernumber'};
1188 if ( $resbor ne $patron->borrowernumber ) {
1189 my $patron = Koha::Patrons->find( $resbor );
1190 if ( $restype eq "Waiting" )
1192 # The item is on reserve and waiting, but has been
1193 # reserved by some other patron.
1194 $needsconfirmation{RESERVE_WAITING} = 1;
1195 $needsconfirmation{'resfirstname'} = $patron->firstname;
1196 $needsconfirmation{'ressurname'} = $patron->surname;
1197 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1198 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1199 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1200 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1201 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1203 elsif ( $restype eq "Reserved" ) {
1204 # The item is on reserve for someone else.
1205 $needsconfirmation{RESERVED} = 1;
1206 $needsconfirmation{'resfirstname'} = $patron->firstname;
1207 $needsconfirmation{'ressurname'} = $patron->surname;
1208 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1209 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1210 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1211 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1212 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1214 elsif ( $restype eq "Transferred" ) {
1215 # The item is determined hold being transferred for someone else.
1216 $needsconfirmation{TRANSFERRED} = 1;
1217 $needsconfirmation{'resfirstname'} = $patron->firstname;
1218 $needsconfirmation{'ressurname'} = $patron->surname;
1219 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1220 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1221 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1222 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1223 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1225 elsif ( $restype eq "Processing" ) {
1226 # The item is determined hold being processed for someone else.
1227 $needsconfirmation{PROCESSING} = 1;
1228 $needsconfirmation{'resfirstname'} = $patron->firstname;
1229 $needsconfirmation{'ressurname'} = $patron->surname;
1230 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1231 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1232 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1233 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1234 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1240 ## CHECK AGE RESTRICTION
1241 my $agerestriction = $biblioitem->agerestriction;
1242 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1243 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1244 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1245 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1248 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1252 ## check for high holds decreasing loan period
1253 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1254 my $check = checkHighHolds( $item_object, $patron );
1256 if ( $check->{exceeded} ) {
1257 if ($override_high_holds) {
1258 $alerts{HIGHHOLDS} = {
1259 num_holds => $check->{outstanding},
1260 duration => $check->{duration},
1261 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1265 $needsconfirmation{HIGHHOLDS} = {
1266 num_holds => $check->{outstanding},
1267 duration => $check->{duration},
1268 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1275 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1276 # don't do the multiple loans per bib check if we've
1277 # already determined that we've got a loan on the same item
1278 !$issuingimpossible{NO_MORE_RENEWALS} &&
1279 !$needsconfirmation{RENEW_ISSUE}
1281 # Check if borrower has already issued an item from the same biblio
1282 # Only if it's not a subscription
1283 my $biblionumber = $item_object->biblionumber;
1284 require C4::Serials;
1285 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1286 unless ($is_a_subscription) {
1287 # FIXME Should be $patron->checkouts($args);
1288 my $checkouts = Koha::Checkouts->search(
1290 borrowernumber => $patron->borrowernumber,
1291 biblionumber => $biblionumber,
1297 # if we get here, we don't already have a loan on this item,
1298 # so if there are any loans on this bib, ask for confirmation
1299 if ( $checkouts->count ) {
1300 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1305 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1308 =head2 CanBookBeReturned
1310 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1312 Check whether the item can be returned to the provided branch
1316 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1318 =item C<$branch> is the branchcode where the return is taking place
1326 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1328 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1334 sub CanBookBeReturned {
1335 my ($item, $branch) = @_;
1336 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1338 # assume return is allowed to start
1342 # identify all cases where return is forbidden
1343 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1345 $message = $item->{'homebranch'};
1346 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1348 $message = $item->{'holdingbranch'};
1349 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1351 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1354 return ($allowed, $message);
1357 =head2 CheckHighHolds
1359 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1360 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1361 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1365 sub checkHighHolds {
1366 my ( $item, $patron ) = @_;
1367 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
1376 my $holds = Koha::Holds->search( { biblionumber => $item->biblionumber } );
1378 if ( $holds->count() ) {
1379 $return_data->{outstanding} = $holds->count();
1381 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1382 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1383 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1385 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1387 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1389 # static means just more than a given number of holds on the record
1391 # If the number of holds is less than the threshold, we can stop here
1392 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1393 return $return_data;
1396 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1398 # dynamic means X more than the number of holdable items on the record
1400 # let's get the items
1401 my @items = $holds->next()->biblio()->items()->as_list;
1403 # Remove any items with status defined to be ignored even if the would not make item unholdable
1404 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1405 @items = grep { !$_->$status } @items;
1408 # Remove any items that are not holdable for this patron
1409 @items = grep { CanItemBeReserved( $patron , $_, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1411 my $items_count = scalar @items;
1413 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1415 # If the number of holds is less than the count of items we have
1416 # plus the number of holds allowed above that count, we can stop here
1417 if ( $holds->count() <= $threshold ) {
1418 return $return_data;
1422 my $issuedate = dt_from_string();
1424 my $itype = $item->effective_itemtype;
1425 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1427 categorycode => $patron->categorycode,
1429 branchcode => $branchcode,
1432 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1434 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1436 my $rule = Koha::CirculationRules->get_effective_rule(
1438 categorycode => $patron->categorycode,
1439 itemtype => $item->effective_itemtype,
1440 branchcode => $branchcode,
1441 rule_name => 'decreaseloanholds',
1446 if ( defined($rule) && $rule->rule_value ne '' ){
1447 # overrides decreaseLoanHighHoldsDuration syspref
1448 $duration = $rule->rule_value;
1450 $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1452 my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1453 $reduced_datedue->set_hour($orig_due->hour);
1454 $reduced_datedue->set_minute($orig_due->minute);
1455 $reduced_datedue->truncate( to => 'minute' );
1457 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1458 $return_data->{exceeded} = 1;
1459 $return_data->{duration} = $duration;
1460 $return_data->{due_date} = $reduced_datedue;
1464 return $return_data;
1469 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1471 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1475 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1477 =item C<$barcode> is the barcode of the item being issued.
1479 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1480 Calculated if empty.
1482 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1484 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1485 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1487 AddIssue does the following things :
1489 - step 01: check that there is a borrowernumber & a barcode provided
1490 - check for RENEWAL (book issued & being issued to the same patron)
1491 - renewal YES = Calculate Charge & renew
1493 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1495 - fill reserve if reserve to this patron
1496 - cancel reserve or not, otherwise
1498 - fill recall if recall to this patron
1499 - cancel recall or not
1500 - revert recall's waiting status or not
1501 * TRANSFERT PENDING ?
1502 - complete the transfert
1510 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1512 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1513 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1514 my $auto_renew = $params && $params->{auto_renew};
1515 my $cancel_recall = $params && $params->{cancel_recall};
1516 my $recall_id = $params && $params->{recall_id};
1517 my $dbh = C4::Context->dbh;
1518 my $barcodecheck = CheckValidBarcode($barcode);
1522 if ( $datedue && ref $datedue ne 'DateTime' ) {
1523 $datedue = dt_from_string($datedue);
1526 # $issuedate defaults to today.
1527 if ( !defined $issuedate ) {
1528 $issuedate = dt_from_string();
1531 if ( ref $issuedate ne 'DateTime' ) {
1532 $issuedate = dt_from_string($issuedate);
1537 # Stop here if the patron or barcode doesn't exist
1538 if ( $borrower && $barcode && $barcodecheck ) {
1539 # find which item we issue
1540 my $item_object = Koha::Items->find({ barcode => $barcode })
1541 or return; # if we don't get an Item, abort.
1542 my $item_unblessed = $item_object->unblessed;
1544 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1546 # get actual issuing if there is one
1547 my $actualissue = $item_object->checkout;
1549 # check if we just renew the issue.
1550 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1551 and not $switch_onsite_checkout ) {
1552 $datedue = AddRenewal(
1553 $borrower->{'borrowernumber'},
1554 $item_object->itemnumber,
1557 $issuedate, # here interpreted as the renewal date
1562 my $itype = $item_object->effective_itemtype;
1563 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1566 $datedue->truncate( to => 'minute' );
1568 my $patron = Koha::Patrons->find( $borrower );
1569 my $library = Koha::Libraries->find( $branchcode );
1570 my $fees = Koha::Charges::Fees->new(
1573 library => $library,
1574 item => $item_object,
1575 to_date => $datedue,
1579 # it's NOT a renewal
1580 if ( $actualissue and not $switch_onsite_checkout ) {
1581 # This book is currently on loan, but not to the person
1582 # who wants to borrow it now. mark it returned before issuing to the new borrower
1583 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1584 return unless $allowed;
1585 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1586 # AddReturn certainly has side-effects, like onloan => undef
1587 $item_object->discard_changes;
1590 if ( C4::Context->preference('UseRecalls') ) {
1591 Koha::Recalls->move_recall(
1593 action => $cancel_recall,
1594 recall_id => $recall_id,
1595 item => $item_object,
1596 borrowernumber => $borrower->{borrowernumber},
1601 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1603 # Starting process for transfer job (checking transfert and validate it if we have one)
1604 if ( my $transfer = $item_object->get_transfer ) {
1605 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1608 datearrived => dt_from_string,
1609 tobranch => C4::Context->userenv->{branch},
1610 comments => 'Forced branchtransfer'
1613 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1614 my $hold = $item_object->holds->search( { found => 'T' } )->next;
1615 if ( $hold ) { # Is this really needed?
1616 $hold->set( { found => undef } )->store;
1617 C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1622 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1623 unless ($auto_renew) {
1624 my $rule = Koha::CirculationRules->get_effective_rule(
1626 categorycode => $borrower->{categorycode},
1627 itemtype => $item_object->effective_itemtype,
1628 branchcode => $branchcode,
1629 rule_name => 'auto_renew'
1633 $auto_renew = $rule->rule_value if $rule;
1636 my $issue_attributes = {
1637 borrowernumber => $borrower->{'borrowernumber'},
1638 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1639 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1640 branchcode => C4::Context->userenv->{'branch'},
1641 onsite_checkout => $onsite_checkout,
1642 auto_renew => $auto_renew ? 1 : 0,
1645 # Get ID of logged in user. if called from a batch job,
1646 # no user session exists and C4::Context->userenv() returns
1647 # the scalar '0'. Only do this if the syspref says so
1648 if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1649 my $userenv = C4::Context->userenv();
1650 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1652 $issue_attributes->{issuer_id} = $usernumber;
1656 # In the case that the borrower has an on-site checkout
1657 # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1658 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1660 $issue->set($issue_attributes)->store;
1663 $issue = Koha::Checkout->new(
1665 itemnumber => $item_object->itemnumber,
1670 $issue->discard_changes;
1671 C4::Auth::track_login_daily( $borrower->{userid} );
1672 if ( $item_object->location && $item_object->location eq 'CART'
1673 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1674 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1675 CartToShelf( $item_object->itemnumber );
1678 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1679 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1682 # Record if item was lost
1683 my $was_lost = $item_object->itemlost;
1685 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1686 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1687 $item_object->itemlost(0);
1688 $item_object->onloan($datedue->ymd());
1689 $item_object->datelastborrowed( dt_from_string()->ymd() );
1690 $item_object->datelastseen( dt_from_string()->ymd() );
1691 $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1693 # If the item was lost, it has now been found, charge the overdue if necessary
1695 if ( $item_object->{_charge} ) {
1696 $actualissue //= Koha::Old::Checkouts->search(
1697 { itemnumber => $item_unblessed->{itemnumber} },
1699 order_by => { '-desc' => 'returndate' },
1703 unless ( exists( $borrower->{branchcode} ) ) {
1704 my $patron = $actualissue->patron;
1705 $borrower = $patron->unblessed;
1707 _CalculateAndUpdateFine(
1709 issue => $actualissue,
1710 item => $item_unblessed,
1711 borrower => $borrower,
1712 return_date => $issuedate
1715 _FixOverduesOnReturn( $borrower->{borrowernumber},
1716 $item_object->itemnumber, undef, 'RENEWED' );
1720 # If it costs to borrow this book, charge it to the patron's account.
1721 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1722 if ( $charge && $charge > 0 ) {
1723 AddIssuingCharge( $issue, $charge, 'RENT' );
1726 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1727 if ( $itemtype_object ) {
1728 my $accumulate_charge = $fees->accumulate_rentalcharge();
1729 if ( $accumulate_charge > 0 ) {
1730 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1731 $charge += $accumulate_charge;
1732 $item_unblessed->{charge} = $charge;
1736 # Record the fact that this book was issued.
1737 C4::Stats::UpdateStats(
1739 branch => C4::Context->userenv->{'branch'},
1740 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1742 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1743 itemnumber => $item_object->itemnumber,
1744 itemtype => $item_object->effective_itemtype,
1745 location => $item_object->location,
1746 borrowernumber => $borrower->{'borrowernumber'},
1747 ccode => $item_object->ccode,
1751 # Send a checkout slip.
1752 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1754 branchcode => $branchcode,
1755 categorycode => $borrower->{categorycode},
1756 item_type => $item_object->effective_itemtype,
1757 notification => 'CHECKOUT',
1759 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1760 SendCirculationAlert(
1763 item => $item_object->unblessed,
1764 borrower => $borrower,
1765 branch => $branchcode,
1770 "CIRCULATION", "ISSUE",
1771 $borrower->{'borrowernumber'},
1772 $item_object->itemnumber,
1773 ) if C4::Context->preference("IssueLog");
1775 Koha::Plugins->call('after_circ_action', {
1776 action => 'checkout',
1778 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1779 checkout => $issue->get_from_storage
1783 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1785 biblio_ids => [ $item_object->biblionumber ]
1787 ) if C4::Context->preference('RealTimeHoldsQueue');
1793 =head2 GetLoanLength
1795 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1797 Get loan length for an itemtype, a borrower type and a branch
1802 my ( $categorycode, $itemtype, $branchcode ) = @_;
1804 # Initialize default values
1808 lengthunit => 'days',
1811 my $found = Koha::CirculationRules->get_effective_rules( {
1812 branchcode => $branchcode,
1813 categorycode => $categorycode,
1814 itemtype => $itemtype,
1823 foreach my $rule_name (keys %$found) {
1824 $rules->{$rule_name} = $found->{$rule_name};
1831 =head2 GetHardDueDate
1833 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1835 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1839 sub GetHardDueDate {
1840 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1842 my $rules = Koha::CirculationRules->get_effective_rules(
1844 categorycode => $borrowertype,
1845 itemtype => $itemtype,
1846 branchcode => $branchcode,
1847 rules => [ 'hardduedate', 'hardduedatecompare' ],
1851 if ( defined( $rules->{hardduedate} ) ) {
1852 if ( $rules->{hardduedate} ) {
1853 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1856 return ( undef, undef );
1861 =head2 GetBranchBorrowerCircRule
1863 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1865 Retrieves circulation rule attributes that apply to the given
1866 branch and patron category, regardless of item type.
1867 The return value is a hashref containing the following key:
1869 patron_maxissueqty - maximum number of loans that a
1870 patron of the given category can have at the given
1871 branch. If the value is undef, no limit.
1873 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1874 patron of the given category can have at the given
1875 branch. If the value is undef, no limit.
1877 This will check for different branch/category combinations in the following order:
1881 default branch and category
1883 If no rule has been found in the database, it will default to
1886 patron_maxissueqty - undef
1887 patron_maxonsiteissueqty - undef
1889 C<$branchcode> and C<$categorycode> should contain the
1890 literal branch code and patron category code, respectively - no
1895 sub GetBranchBorrowerCircRule {
1896 my ( $branchcode, $categorycode ) = @_;
1898 # Initialize default values
1900 patron_maxissueqty => undef,
1901 patron_maxonsiteissueqty => undef,
1905 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1906 my $rule = Koha::CirculationRules->get_effective_rule(
1908 categorycode => $categorycode,
1910 branchcode => $branchcode,
1911 rule_name => $rule_name,
1915 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1921 =head2 GetBranchItemRule
1923 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1925 Retrieves circulation rule attributes that apply to the given
1926 branch and item type, regardless of patron category.
1928 The return value is a hashref containing the following keys:
1930 holdallowed => Hold policy for this branch and itemtype. Possible values:
1931 not_allowed: No holds allowed.
1932 from_home_library: Holds allowed only by patrons that have the same homebranch as the item.
1933 from_any_library: Holds allowed from any patron.
1934 from_local_hold_group: Holds allowed from libraries in hold group
1936 returnbranch => branch to which to return item. Possible values:
1937 noreturn: do not return, let item remain where checked in (floating collections)
1938 homebranch: return to item's home branch
1939 holdingbranch: return to issuer branch
1941 This searches branchitemrules in the following order:
1943 * Same branchcode and itemtype
1944 * Same branchcode, itemtype '*'
1945 * branchcode '*', same itemtype
1946 * branchcode and itemtype '*'
1948 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1952 sub GetBranchItemRule {
1953 my ( $branchcode, $itemtype ) = @_;
1956 my $rules = Koha::CirculationRules->get_effective_rules({
1957 branchcode => $branchcode,
1958 itemtype => $itemtype,
1959 rules => ['holdallowed', 'hold_fulfillment_policy', 'returnbranch']
1962 # built-in default circulation rule
1963 $rules->{holdallowed} //= 'from_any_library';
1964 $rules->{hold_fulfillment_policy} //= 'any';
1965 $rules->{returnbranch} //= 'homebranch';
1972 ($doreturn, $messages, $iteminformation, $borrower) =
1973 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1979 =item C<$barcode> is the bar code of the book being returned.
1981 =item C<$branch> is the code of the branch where the book is being returned.
1983 =item C<$exemptfine> indicates that overdue charges for the item will be
1986 =item C<$return_date> allows the default return date to be overridden
1987 by the given return date. Optional.
1991 C<&AddReturn> returns a list of four items:
1993 C<$doreturn> is true iff the return succeeded.
1995 C<$messages> is a reference-to-hash giving feedback on the operation.
1996 The keys of the hash are:
2002 No item with this barcode exists. The value is C<$barcode>.
2006 The book is not currently on loan. The value is C<$barcode>.
2010 This book has been withdrawn/cancelled. The value should be ignored.
2012 =item C<Wrongbranch>
2014 This book has was returned to the wrong branch. The value is a hashref
2015 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2016 contain the branchcode of the incorrect and correct return library, respectively.
2020 The item was reserved. The value is a reference-to-hash whose keys are
2021 fields from the reserves table of the Koha database, and
2022 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2023 either C<Waiting>, C<Reserved>, or 0.
2025 =item C<WasReturned>
2027 Value 1 if return is successful.
2029 =item C<NeedsTransfer>
2031 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2033 =item C<RecallFound>
2035 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2036 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2039 =item C<TransferredRecall>
2041 This item has been transferred to this branch to fill a recall. The recall object is returned.
2045 C<$iteminformation> is a reference-to-hash, giving information about the
2046 returned item from the issues table.
2048 C<$borrower> is a reference-to-hash, giving information about the
2049 patron who last borrowed the book.
2054 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2056 if ($branch and not Koha::Libraries->find($branch)) {
2057 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
2060 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
2061 my $return_date_specified = !!$return_date;
2062 $return_date //= dt_from_string();
2066 my $validTransfer = 1;
2067 my $stat_type = 'return';
2069 # get information on item
2070 my $item = Koha::Items->find({ barcode => $barcode });
2072 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
2075 my $itemnumber = $item->itemnumber;
2076 my $itemtype = $item->effective_itemtype;
2078 my $issue = $item->checkout;
2080 $patron = $issue->patron
2081 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2082 . Dumper($issue->unblessed) . "\n";
2084 $messages->{'NotIssued'} = $barcode;
2085 $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2087 # even though item is not on loan, it may still be transferred; therefore, get current branch info
2089 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
2090 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2091 if (C4::Context->preference("RecordLocalUseOnReturn")) {
2092 $messages->{'LocalUse'} = 1;
2093 $stat_type = 'localuse';
2097 # full item data, but no borrowernumber or checkout info (no issue)
2098 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2099 # get the proper branch to which to return the item
2100 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2101 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2102 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2104 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2105 my $patron_unblessed = $patron ? $patron->unblessed : {};
2107 my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2108 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2109 if ($update_loc_rules) {
2110 if (defined $update_loc_rules->{_ALL_}) {
2111 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2112 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2114 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2115 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2117 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2118 $item->location($update_loc_rules->{_ALL_})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2122 foreach my $key ( keys %$update_loc_rules ) {
2123 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2124 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2125 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2126 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2127 $item->location($update_loc_rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2134 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2136 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2138 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2140 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2143 foreach my $key ( keys %$rules ) {
2144 if ( $item->notforloan eq $key ) {
2145 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2146 $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2153 # check if the return is allowed at this branch
2154 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2155 unless ($returnallowed){
2156 $messages->{'Wrongbranch'} = {
2157 Wrongbranch => $branch,
2158 Rightbranch => $message
2161 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2162 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2163 return ( $doreturn, $messages, $issue, $patron_unblessed);
2166 if ( $item->withdrawn ) { # book has been cancelled
2167 $messages->{'withdrawn'} = 1;
2168 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2171 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2175 # case of a return of document (deal with issues and holdingbranch)
2177 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2178 $patron or warn "AddReturn without current borrower";
2182 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2187 C4::Context->preference('CalculateFinesOnReturn')
2188 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2193 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2196 carp "The checkin for the following issue failed, Please go to the about page and check all messages on the 'System information' to see if there are configuration / data issues ($@)" . Dumper( $issue->unblessed );
2198 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2199 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2201 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2204 # FIXME is the "= 1" right? This could be the borrower hash.
2205 $messages->{'WasReturned'} = 1;
2208 $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2212 # the holdingbranch is updated if the document is returned to another location.
2213 # this is always done regardless of whether the item was on loan or not
2214 if ($item->holdingbranch ne $branch) {
2215 $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2218 my $item_was_lost = $item->itemlost;
2219 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2220 my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2222 # fix up the accounts.....
2223 if ($item_was_lost) {
2224 $messages->{'WasLost'} = 1;
2225 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2226 my @object_messages = @{ $updated_item->object_messages };
2227 for my $message (@object_messages) {
2228 $messages->{'LostItemFeeRefunded'} = 1
2229 if $message->message eq 'lost_refunded';
2230 $messages->{'LostItemFeeRestored'} = 1
2231 if $message->message eq 'lost_restored';
2233 if ( $message->message eq 'lost_charge' ) {
2234 $issue //= Koha::Old::Checkouts->search(
2235 { itemnumber => $item->itemnumber },
2236 { order_by => { '-desc' => 'returndate' }, rows => 1 }
2238 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2239 my $patron = $issue->patron;
2240 $patron_unblessed = $patron->unblessed;
2242 _CalculateAndUpdateFine(
2245 item => $item->unblessed,
2246 borrower => $patron_unblessed,
2247 return_date => $return_date
2250 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2251 $item->itemnumber, undef, 'RETURNED' );
2252 $messages->{'LostItemFeeCharged'} = 1;
2258 # check if we have a transfer for this document
2259 my $transfer = $item->get_transfer;
2261 # if we have a transfer to complete, we update the line of transfers with the datearrived
2264 if ( $transfer->in_transit ) {
2265 if ( $transfer->tobranch eq $branch ) {
2267 $messages->{'TransferArrived'} = $transfer->frombranch;
2268 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2269 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2272 $messages->{'WrongTransfer'} = $transfer->tobranch;
2273 $messages->{'WrongTransferItem'} = $item->itemnumber;
2274 $messages->{'TransferTrigger'} = $transfer->reason;
2278 if ( $transfer->tobranch eq $branch ) {
2280 $messages->{'TransferArrived'} = $transfer->frombranch;
2281 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2282 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2285 $messages->{'WasTransfered'} = $transfer->tobranch;
2286 $messages->{'TransferTrigger'} = $transfer->reason;
2291 # fix up the overdues in accounts...
2292 if ($borrowernumber) {
2293 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2294 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2296 if ( $issue and $issue->is_overdue($return_date) ) {
2298 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2300 $messages->{'PrevDebarred'} = $debardate;
2302 $messages->{'Debarred'} = $debardate if $debardate;
2304 # there's no overdue on the item but borrower had been previously debarred
2305 } elsif ( $issue->date_due and $patron->debarred ) {
2306 if ( $patron->debarred eq "9999-12-31") {
2307 $messages->{'ForeverDebarred'} = $patron->debarred;
2309 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2310 $borrower_debar_dt->truncate(to => 'day');
2311 my $today_dt = $return_date->clone()->truncate(to => 'day');
2312 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2313 $messages->{'PrevDebarred'} = $patron->debarred;
2320 if ( C4::Context->preference('UseRecalls') ) {
2321 # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2323 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2324 if ( defined $recall ) {
2325 $messages->{RecallFound} = $recall;
2326 if ( $recall->pickup_library_id ne $branch ) {
2327 $messages->{RecallNeedsTransfer} = $branch;
2332 # find reserves.....
2333 # launch the Checkreserves routine to find any holds
2334 my ($resfound, $resrec);
2335 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2336 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2337 # if a hold is found and is waiting at another branch, change the priority back to 1 and trigger the hold (this will trigger a transfer and update the hold status properly)
2338 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2339 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2340 $resfound = 'Reserved';
2341 $resrec = $hold->unblessed;
2344 $resrec->{'ResFound'} = $resfound;
2345 $messages->{'ResFound'} = $resrec;
2348 # Record the fact that this book was returned.
2349 C4::Stats::UpdateStats({
2352 itemnumber => $itemnumber,
2353 itemtype => $itemtype,
2354 location => $item->location,
2355 borrowernumber => $borrowernumber,
2356 ccode => $item->ccode,
2359 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2361 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2363 branchcode => $branch,
2364 categorycode => $patron->categorycode,
2365 item_type => $itemtype,
2366 notification => 'CHECKIN',
2368 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2369 SendCirculationAlert({
2371 item => $item->unblessed,
2372 borrower => $patron->unblessed,
2378 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2379 if C4::Context->preference("ReturnLog");
2382 # Check if this item belongs to a biblio record that is attached to an
2383 # ILL request, if it is we need to update the ILL request's status
2384 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2385 my $request = Koha::Illrequests->find(
2386 { biblio_id => $item->biblio->biblionumber }
2388 $request->status('RET') if $request;
2391 if ( C4::Context->preference('UseRecalls') ) {
2392 # all recalls that have triggered a transfer will have an allocated itemnumber
2393 my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2394 if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2395 $messages->{TransferredRecall} = $transfer_recall;
2399 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2400 if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2401 && ( $doreturn or $messages->{'NotIssued'} )
2403 and ( $branch ne $returnbranch )
2404 and not $messages->{'WrongTransfer'}
2405 and not $messages->{'WasTransfered'}
2406 and not $messages->{TransferredRecall}
2407 and not $messages->{RecallNeedsTransfer} )
2409 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2410 if (C4::Context->preference("AutomaticItemReturn" ) or
2411 (C4::Context->preference("UseBranchTransferLimits") and
2412 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2414 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2415 $messages->{'WasTransfered'} = $returnbranch;
2416 $messages->{'TransferTrigger'} = $transfer_trigger;
2418 $messages->{'NeedsTransfer'} = $returnbranch;
2419 $messages->{'TransferTrigger'} = $transfer_trigger;
2423 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2424 my $claims = Koha::Checkouts::ReturnClaims->search(
2426 itemnumber => $item->id,
2427 resolution => undef,
2431 if ( $claims->count ) {
2432 $messages->{ReturnClaims} = $claims;
2436 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2437 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2439 if ( $doreturn and $issue ) {
2440 my $checkin = Koha::Old::Checkouts->find($issue->id);
2442 Koha::Plugins->call('after_circ_action', {
2443 action => 'checkin',
2449 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2451 biblio_ids => [ $item->biblionumber ]
2453 ) if C4::Context->preference('RealTimeHoldsQueue');
2456 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2459 =head2 MarkIssueReturned
2461 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2463 Unconditionally marks an issue as being returned by
2464 moving the C<issues> row to C<old_issues> and
2465 setting C<returndate> to the current date.
2467 if C<$returndate> is specified (in iso format), it is used as the date
2470 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2471 the old_issue is immediately anonymised
2473 Ideally, this function would be internal to C<C4::Circulation>,
2474 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2475 and offline_circ/process_koc.pl.
2477 The last optional parameter allos passing skip_record_index to the item store call.
2481 sub MarkIssueReturned {
2482 my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2484 # Retrieve the issue
2485 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2487 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2489 my $issue_id = $issue->issue_id;
2491 my $schema = Koha::Database->schema;
2493 # FIXME Improve the return value and handle it from callers
2494 $schema->txn_do(sub {
2496 my $patron = Koha::Patrons->find( $borrowernumber );
2498 # Update the returndate value
2499 if ( $returndate ) {
2500 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2503 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2506 # Create the old_issues entry
2507 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2509 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2510 if ( $privacy && $privacy == 2) {
2511 $old_checkout->anonymize;
2514 # And finally delete the issue
2517 $issue->item->onloan(undef)->store(
2519 skip_record_index => $params->{skip_record_index},
2520 skip_holds_queue => $params->{skip_holds_queue}
2524 if ( C4::Context->preference('StoreLastBorrower') ) {
2525 my $item = Koha::Items->find( $itemnumber );
2526 $item->last_returned_by( $patron );
2529 # Remove any OVERDUES related debarment if the borrower has no overdues
2530 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2531 && $patron->debarred
2532 && !$patron->has_overdues
2533 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2535 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2543 =head2 _debar_user_on_return
2545 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2547 C<$borrower> borrower hashref
2549 C<$item> item hashref
2551 C<$datedue> date due DateTime object
2553 C<$returndate> DateTime object representing the return time
2555 Internal function, called only by AddReturn that calculates and updates
2556 the user fine days, and debars them if necessary.
2558 Should only be called for overdue returns
2560 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2565 sub _calculate_new_debar_dt {
2566 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2568 my $branchcode = _GetCircControlBranch( $item, $borrower );
2569 my $circcontrol = C4::Context->preference('CircControl');
2570 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2571 { categorycode => $borrower->{categorycode},
2572 itemtype => $item->{itype},
2573 branchcode => $branchcode,
2578 'maxsuspensiondays',
2579 'suspension_chargeperiod',
2583 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2584 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2585 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2587 return unless $finedays;
2589 # finedays is in days, so hourly loans must multiply by 24
2590 # thus 1 hour late equals 1 day suspension * finedays rate
2591 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2593 # grace period is measured in the same units as the loan
2595 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2597 my $deltadays = DateTime::Duration->new(
2598 days => $chargeable_units
2601 if ( $deltadays->subtract($grace)->is_positive() ) {
2602 my $suspension_days = $deltadays * $finedays;
2604 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2605 # No need to / 1 and do not consider / 0
2606 $suspension_days = DateTime::Duration->new(
2607 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2611 # If the max suspension days is < than the suspension days
2612 # the suspension days is limited to this maximum period.
2613 my $max_sd = $issuing_rule->{maxsuspensiondays};
2614 if ( defined $max_sd && $max_sd ne '' ) {
2615 $max_sd = DateTime::Duration->new( days => $max_sd );
2616 $suspension_days = $max_sd
2617 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2620 my ( $has_been_extended );
2621 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2622 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2624 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2625 $has_been_extended = 1;
2630 # Use the calendar or not to calculate the debarment date
2631 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2632 my $calendar = Koha::Calendar->new(
2633 branchcode => $branchcode,
2634 days_mode => 'Calendar'
2636 $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2639 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2641 return $new_debar_dt;
2646 sub _debar_user_on_return {
2647 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2649 $return_date //= dt_from_string();
2651 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2653 return unless $new_debar_dt;
2655 Koha::Patron::Debarments::AddUniqueDebarment({
2656 borrowernumber => $borrower->{borrowernumber},
2657 expiration => $new_debar_dt->ymd(),
2658 type => 'SUSPENSION',
2660 # if borrower was already debarred but does not get an extra debarment
2661 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2662 my ($new_debarment_str, $is_a_reminder);
2663 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2665 $new_debarment_str = $borrower->{debarred};
2667 $new_debarment_str = $new_debar_dt->ymd();
2669 # FIXME Should return a DateTime object
2670 return $new_debarment_str, $is_a_reminder;
2673 =head2 _FixOverduesOnReturn
2675 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2677 C<$borrowernumber> borrowernumber
2679 C<$itemnumber> itemnumber
2681 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2683 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2689 sub _FixOverduesOnReturn {
2690 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2691 unless( $borrowernumber ) {
2692 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2696 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2700 warn "_FixOverduesOnReturn() not supplied valid status";
2704 my $schema = Koha::Database->schema;
2706 my $result = $schema->txn_do(
2708 # check for overdue fine
2709 my $accountlines = Koha::Account::Lines->search(
2711 borrowernumber => $borrowernumber,
2712 itemnumber => $item,
2713 debit_type_code => 'OVERDUE',
2714 status => 'UNRETURNED'
2717 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2719 my $accountline = $accountlines->next;
2720 my $payments = $accountline->credits;
2722 my $amountoutstanding = $accountline->amountoutstanding;
2723 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2724 $accountline->delete;
2725 return 0; # no warning, we've just removed a zero value fine (backdated return)
2726 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2727 my $account = Koha::Account->new({patron_id => $borrowernumber});
2728 my $credit = $account->add_credit(
2730 amount => $amountoutstanding,
2731 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2732 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2733 interface => C4::Context->interface,
2739 $credit->apply({ debits => [ $accountline ] });
2741 if (C4::Context->preference("FinesLog")) {
2742 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2746 $accountline->status($status);
2747 return $accountline->store();
2754 =head2 _GetCircControlBranch
2756 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2760 Return the library code to be used to determine which circulation
2761 policy applies to a transaction. Looks up the CircControl and
2762 HomeOrHoldingBranch system preferences.
2764 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2766 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2770 sub _GetCircControlBranch {
2771 my ($item, $borrower) = @_;
2772 my $circcontrol = C4::Context->preference('CircControl');
2775 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2776 $branch= C4::Context->userenv->{'branch'};
2777 } elsif ($circcontrol eq 'PatronLibrary') {
2778 $branch=$borrower->{branchcode};
2780 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2781 $branch = $item->{$branchfield};
2782 # default to item home branch if holdingbranch is used
2783 # and is not defined
2784 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2785 $branch = $item->{homebranch};
2793 $issue = GetOpenIssue( $itemnumber );
2795 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2797 C<$itemnumber> is the item's itemnumber
2804 my ( $itemnumber ) = @_;
2805 return unless $itemnumber;
2806 my $dbh = C4::Context->dbh;
2807 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2808 $sth->execute( $itemnumber );
2809 return $sth->fetchrow_hashref();
2813 =head2 GetUpcomingDueIssues
2815 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2819 sub GetUpcomingDueIssues {
2822 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2823 my $dbh = C4::Context->dbh;
2826 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2828 LEFT JOIN items USING (itemnumber)
2829 LEFT JOIN branches ON branches.branchcode =
2831 $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2832 $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2833 my @bind_parameters = ( $params->{'days_in_advance'} );
2835 my $sth = $dbh->prepare( $statement );
2836 $sth->execute( @bind_parameters );
2837 my $upcoming_dues = $sth->fetchall_arrayref({});
2839 return $upcoming_dues;
2842 =head2 CanBookBeRenewed
2844 ($ok,$error,$info) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2846 Find out whether a borrowed item may be renewed.
2848 C<$borrowernumber> is the borrower number of the patron who currently
2849 has the item on loan.
2851 C<$itemnumber> is the number of the item to renew.
2853 C<$override_limit>, if supplied with a true value, causes
2854 the limit on the number of times that the loan can be renewed
2855 (as controlled by the item type) to be ignored. Overriding also allows
2856 to renew sooner than "No renewal before" and to manually renew loans
2857 that are automatically renewed.
2859 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2860 item must currently be on loan to the specified borrower; renewals
2861 must be allowed for the item's type; and the borrower must not have
2862 already renewed the loan.
2863 $error will contain the reason the renewal can not proceed
2864 $info will contain a hash of additional info
2865 currently 'soonest_renew_date' if error is 'too soon'
2869 sub CanBookBeRenewed {
2870 my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2872 my $auto_renew = "no";
2875 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2876 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2877 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2878 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2880 my $patron = $issue->patron or return;
2882 # override_limit will override anything else except on_reserve
2883 unless ( $override_limit ){
2884 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2885 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2887 categorycode => $patron->categorycode,
2888 itemtype => $item->effective_itemtype,
2889 branchcode => $branchcode,
2893 'unseen_renewals_allowed'
2898 return ( 0, "too_many" )
2899 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2901 return ( 0, "too_unseen" )
2902 if C4::Context->preference('UnseenRenewals') &&
2903 $issuing_rule->{unseen_renewals_allowed} &&
2904 $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2906 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2907 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2908 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2909 my $restricted = $patron->is_debarred;
2910 my $hasoverdues = $patron->has_overdues;
2912 if ( $restricted and $restrictionblockrenewing ) {
2913 return ( 0, 'restriction');
2914 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2915 return ( 0, 'overdue');
2918 ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
2921 branchcode => $branchcode,
2924 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
2925 # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2926 # extra notices being sent. Cron also implies no override
2927 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_account_expired';
2928 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_late';
2929 return ( 0, $auto_renew ) if $auto_renew =~ 'auto_too_much_oweing';
2932 if ( C4::Context->preference('UseRecalls') ) {
2934 $recall = $item->check_recalls if $item->can_be_waiting_recall;
2935 if ( defined $recall ) {
2936 if ( $recall->item_level ) {
2937 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
2938 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
2940 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
2941 return ( 0, 'recalled' ) unless ( $recall->waiting );
2946 # Note: possible_reserves will contain all title level holds on this bib and item level
2947 # holds on the checked out item
2948 my ( $resfound, $resrec, $possible_reserves ) = C4::Reserves::CheckReserves($itemnumber);
2950 # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2951 if ( $resfound && $resrec->{non_priority} ) {
2952 $resfound = Koha::Holds->search(
2953 { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2959 # This item can fill one or more unfilled reserve, can those unfilled reserves
2960 # all be filled by other available items?
2962 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2964 my $item_holds = Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count();
2966 # There is an item level hold on this item, no other item can fill the hold
2971 # Get all other items that could possibly fill reserves
2972 # FIXME We could join reserves (or more tables) here to eliminate some checks later
2973 my $items = Koha::Items->search({
2974 biblionumber => $resrec->{biblionumber},
2977 -not => { itemnumber => $itemnumber }
2979 my $item_count = $items->count();
2981 # Get all other reserves that could have been filled by this item
2982 my @borrowernumbers = map { $_->{borrowernumber} } @$possible_reserves;
2983 # Note: fetching the patrons in this manner means that a patron with 2 holds will
2984 # not block renewal if one reserve can be satisfied i.e. each patron is checked once
2985 my $patrons = Koha::Patrons->search({
2986 borrowernumber => { -in => \@borrowernumbers }
2988 my $patron_count = $patrons->count();
2990 return ( 0, "on_reserve" ) if ($patron_count > $item_count);
2991 # We cannot possibly fill all reserves if we don't have enough items
2993 # If we can fill each hold that has been found with the available items on the record
2994 # then the patron can renew. If we cannot, they cannot renew.
2995 # FIXME This code does not check whether the item we are renewing can fill
2996 # any of the existing reserves.
3000 PATRON: while ( my $patron = $patrons->next ) {
3001 # If there is a reserve that cannot be filled we are done
3002 return ( 0, "on_reserve" ) if ( $seen > $reservable );
3003 my $items_any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron });
3004 while ( my $other_item = $items->next ) {
3005 next if defined $matched_items{$other_item->itemnumber};
3006 next if IsItemOnHoldAndFound( $other_item->itemnumber );
3007 next unless IsAvailableForItemLevelRequest($other_item, $patron, undef, $items_any_available);
3008 next unless CanItemBeReserved($patron,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3009 # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3010 # CanItemBeReserved checks 'rules' and 'policies' which means
3011 # items will fill holds at checkin that are rejected here
3013 if ($reservable >= $patron_count) {
3017 $matched_items{$other_item->itemnumber} = 1;
3026 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
3027 return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3028 $soonest = GetSoonestRenewDate($borrowernumber, $itemnumber);
3029 if ( $soonest > dt_from_string() ){
3030 return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3033 return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3035 return ( 1, undef );
3040 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
3044 C<$borrowernumber> is the borrower number of the patron who currently
3047 C<$itemnumber> is the number of the item to renew.
3049 C<$branch> is the library where the renewal took place (if any).
3050 The library that controls the circ policies for the renewal is retrieved from the issues record.
3052 C<$datedue> can be a DateTime object used to set the due date.
3054 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3055 this parameter is not supplied, lastreneweddate is set to the current date.
3057 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3058 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3059 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3062 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3063 from the book's item type.
3065 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3066 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3067 fallback to a true value
3072 my $borrowernumber = shift;
3073 my $itemnumber = shift or return;
3075 my $datedue = shift;
3076 my $lastreneweddate = shift || dt_from_string();
3077 my $skipfinecalc = shift;
3080 # Fallback on a 'seen' renewal
3081 $seen = defined $seen && $seen == 0 ? 0 : 1;
3083 my $item_object = Koha::Items->find($itemnumber) or return;
3084 my $biblio = $item_object->biblio;
3085 my $issue = $item_object->checkout;
3086 my $item_unblessed = $item_object->unblessed;
3088 my $dbh = C4::Context->dbh;
3090 return unless $issue;
3092 $borrowernumber ||= $issue->borrowernumber;
3094 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3095 carp 'Invalid date passed to AddRenewal.';
3099 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3100 my $patron_unblessed = $patron->unblessed;
3102 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3104 my $schema = Koha::Database->schema;
3105 $schema->txn_do(sub{
3107 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3108 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3110 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3112 # If the due date wasn't specified, calculate it by adding the
3113 # book's loan length to today's date or the current due date
3114 # based on the value of the RenewalPeriodBase syspref.
3115 my $itemtype = $item_object->effective_itemtype;
3118 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3119 dt_from_string( $issue->date_due, 'sql' ) :
3121 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3124 my $fees = Koha::Charges::Fees->new(
3127 library => $circ_library,
3128 item => $item_object,
3129 from_date => dt_from_string( $issue->date_due, 'sql' ),
3130 to_date => dt_from_string($datedue),
3134 # Increment the unseen renewals, if appropriate
3135 # We only do so if the syspref is enabled and
3136 # a maximum value has been set in the circ rules
3137 my $unseen_renewals = $issue->unseen_renewals;
3138 if (C4::Context->preference('UnseenRenewals')) {
3139 my $rule = Koha::CirculationRules->get_effective_rule(
3140 { categorycode => $patron->categorycode,
3141 itemtype => $item_object->effective_itemtype,
3142 branchcode => $circ_library->branchcode,
3143 rule_name => 'unseen_renewals_allowed'
3146 if (!$seen && $rule && $rule->rule_value) {
3149 # If the renewal is seen, unseen should revert to 0
3150 $unseen_renewals = 0;
3154 # Update the issues record to have the new due date, and a new count
3155 # of how many times it has been renewed.
3156 my $renews = ( $issue->renewals || 0 ) + 1;
3157 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3160 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3163 Koha::Exceptions::Checkout::FailedRenewal->throw(
3164 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3168 # Update the renewal count on the item, and tell zebra to reindex
3169 $renews = ( $item_object->renewals || 0 ) + 1;
3170 $item_object->renewals($renews);
3171 $item_object->onloan($datedue);
3172 $item_object->store({ log_action => 0 });
3174 # Charge a new rental fee, if applicable
3175 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3176 if ( $charge > 0 ) {
3177 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3180 # Charge a new accumulate rental fee, if applicable
3181 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3182 if ( $itemtype_object ) {
3183 my $accumulate_charge = $fees->accumulate_rentalcharge();
3184 if ( $accumulate_charge > 0 ) {
3185 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3187 $charge += $accumulate_charge;
3190 # Send a renewal slip according to checkout alert preferencei
3191 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3192 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3194 branchcode => $branch,
3195 categorycode => $patron->categorycode,
3196 item_type => $itemtype,
3197 notification => 'CHECKOUT',
3199 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3200 SendCirculationAlert(
3203 item => $item_unblessed,
3204 borrower => $patron->unblessed,
3211 # Remove any OVERDUES related debarment if the borrower has no overdues
3213 && $patron->is_debarred
3214 && ! $patron->has_overdues
3215 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3217 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3220 # Add the renewal to stats
3221 C4::Stats::UpdateStats(
3223 branch => $item_object->renewal_branchcode({branch => $branch}),
3226 itemnumber => $itemnumber,
3227 itemtype => $itemtype,
3228 location => $item_object->location,
3229 borrowernumber => $borrowernumber,
3230 ccode => $item_object->ccode,
3235 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3237 Koha::Plugins->call('after_circ_action', {
3238 action => 'renewal',
3240 checkout => $issue->get_from_storage
3249 # check renewal status
3250 my ( $bornum, $itemno ) = @_;
3251 my $dbh = C4::Context->dbh;
3253 my $unseencount = 0;
3254 my $renewsallowed = 0;
3255 my $unseenallowed = 0;
3259 my $patron = Koha::Patrons->find( $bornum );
3260 my $item = Koha::Items->find($itemno);
3262 return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3264 # Look in the issues table for this item, lent to this borrower,
3265 # and not yet returned.
3267 # FIXME - I think this function could be redone to use only one SQL call.
3268 my $sth = $dbh->prepare(
3269 "select * from issues
3270 where (borrowernumber = ?)
3271 and (itemnumber = ?)"
3273 $sth->execute( $bornum, $itemno );
3274 my $data = $sth->fetchrow_hashref;
3275 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3276 $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3277 # $item and $borrower should be calculated
3278 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3280 my $rules = Koha::CirculationRules->get_effective_rules(
3282 categorycode => $patron->categorycode,
3283 itemtype => $item->effective_itemtype,
3284 branchcode => $branchcode,
3285 rules => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3288 $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3289 $unseenallowed = $rules->{unseen_renewals_allowed} ?
3290 $rules->{unseen_renewals_allowed} :
3292 $renewsleft = $renewsallowed - $renewcount;
3293 $unseenleft = $unseenallowed - $unseencount;
3294 if($renewsleft < 0){ $renewsleft = 0; }
3295 if($unseenleft < 0){ $unseenleft = 0; }
3306 =head2 GetSoonestRenewDate
3308 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3310 Find out the soonest possible renew date of a borrowed item.
3312 C<$borrowernumber> is the borrower number of the patron who currently
3313 has the item on loan.
3315 C<$itemnumber> is the number of the item to renew.
3317 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3318 renew date, based on the value "No renewal before" of the applicable
3319 issuing rule. Returns the current date if the item can already be
3320 renewed, and returns undefined if the borrower, loan, or item
3325 sub GetSoonestRenewDate {
3326 my ( $borrowernumber, $itemnumber ) = @_;
3328 my $dbh = C4::Context->dbh;
3330 my $item = Koha::Items->find($itemnumber) or return;
3331 my $itemissue = $item->checkout or return;
3333 $borrowernumber ||= $itemissue->borrowernumber;
3334 my $patron = Koha::Patrons->find( $borrowernumber )
3337 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3338 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3339 { categorycode => $patron->categorycode,
3340 itemtype => $item->effective_itemtype,
3341 branchcode => $branchcode,
3349 my $now = dt_from_string;
3351 if ( defined $issuing_rule->{norenewalbefore}
3352 and $issuing_rule->{norenewalbefore} ne "" )
3354 my $soonestrenewal =
3355 dt_from_string( $itemissue->date_due )->subtract(
3356 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3358 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3359 and $issuing_rule->{lengthunit} eq 'days' )
3361 $soonestrenewal->truncate( to => 'day' );
3363 return $soonestrenewal if $now < $soonestrenewal;
3364 } elsif ( $itemissue->auto_renew && $patron->autorenew_checkouts ) {
3365 # Checkouts with auto-renewing fall back to due date
3366 my $soonestrenewal = dt_from_string( $itemissue->date_due );
3367 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3368 and $issuing_rule->{lengthunit} eq 'days' )
3370 $soonestrenewal->truncate( to => 'day' );
3372 return $soonestrenewal;
3377 =head2 GetLatestAutoRenewDate
3379 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3381 Find out the latest possible auto renew date of a borrowed item.
3383 C<$borrowernumber> is the borrower number of the patron who currently
3384 has the item on loan.
3386 C<$itemnumber> is the number of the item to renew.
3388 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3389 auto renew date, based on the value "No auto renewal after" and the "No auto
3390 renewal after (hard limit) of the applicable issuing rule.
3391 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3392 or item cannot be found.
3396 sub GetLatestAutoRenewDate {
3397 my ( $borrowernumber, $itemnumber ) = @_;
3399 my $dbh = C4::Context->dbh;
3401 my $item = Koha::Items->find($itemnumber) or return;
3402 my $itemissue = $item->checkout or return;
3404 $borrowernumber ||= $itemissue->borrowernumber;
3405 my $patron = Koha::Patrons->find( $borrowernumber )
3408 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3409 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3411 categorycode => $patron->categorycode,
3412 itemtype => $item->effective_itemtype,
3413 branchcode => $branchcode,
3415 'no_auto_renewal_after',
3416 'no_auto_renewal_after_hard_limit',
3422 return unless $circulation_rules;
3424 if ( not $circulation_rules->{no_auto_renewal_after}
3425 or $circulation_rules->{no_auto_renewal_after} eq '' )
3426 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3427 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3429 my $maximum_renewal_date;
3430 if ( $circulation_rules->{no_auto_renewal_after} ) {
3431 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3432 $maximum_renewal_date->add(
3433 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3437 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3438 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3439 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3441 return $maximum_renewal_date;
3445 =head2 GetIssuingCharges
3447 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3449 Calculate how much it would cost for a given patron to borrow a given
3450 item, including any applicable discounts.
3452 C<$itemnumber> is the item number of item the patron wishes to borrow.
3454 C<$borrowernumber> is the patron's borrower number.
3456 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3457 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3462 sub GetIssuingCharges {
3464 # calculate charges due
3465 my ( $itemnumber, $borrowernumber ) = @_;
3467 my $dbh = C4::Context->dbh;
3470 # Get the book's item type and rental charge (via its biblioitem).
3471 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3472 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3473 $charge_query .= (C4::Context->preference('item-level_itypes'))
3474 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3475 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3477 $charge_query .= ' WHERE items.itemnumber =?';
3479 my $sth = $dbh->prepare($charge_query);
3480 $sth->execute($itemnumber);
3481 if ( my $item_data = $sth->fetchrow_hashref ) {
3482 $item_type = $item_data->{itemtype};
3483 $charge = $item_data->{rentalcharge};
3485 # FIXME This should follow CircControl
3486 my $branch = C4::Context::mybranch();
3487 my $patron = Koha::Patrons->find( $borrowernumber );
3488 my $discount = Koha::CirculationRules->get_effective_rule({
3489 categorycode => $patron->categorycode,
3490 branchcode => $branch,
3491 itemtype => $item_type,
3492 rule_name => 'rentaldiscount'
3495 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3497 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3501 return ( $charge, $item_type );
3504 =head2 AddIssuingCharge
3506 &AddIssuingCharge( $checkout, $charge, $type )
3510 sub AddIssuingCharge {
3511 my ( $checkout, $charge, $type ) = @_;
3513 # FIXME What if checkout does not exist?
3515 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3516 my $accountline = $account->add_debit(
3520 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3521 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3522 interface => C4::Context->interface,
3524 item_id => $checkout->itemnumber,
3525 issue_id => $checkout->issue_id,
3532 GetTransfers($itemnumber);
3537 my ($itemnumber) = @_;
3539 my $dbh = C4::Context->dbh;
3548 FROM branchtransfers
3549 WHERE itemnumber = ?
3550 AND datearrived IS NULL
3551 AND datecancelled IS NULL
3553 my $sth = $dbh->prepare($query);
3554 $sth->execute($itemnumber);
3555 my @row = $sth->fetchrow_array();
3559 =head2 GetTransfersFromTo
3561 @results = GetTransfersFromTo($frombranch,$tobranch);
3563 Returns the list of pending transfers between $from and $to branch
3567 sub GetTransfersFromTo {
3568 my ( $frombranch, $tobranch ) = @_;
3569 return unless ( $frombranch && $tobranch );
3570 my $dbh = C4::Context->dbh;
3572 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3573 FROM branchtransfers
3576 AND datecancelled IS NULL
3577 AND datesent IS NOT NULL
3578 AND datearrived IS NULL
3580 my $sth = $dbh->prepare($query);
3581 $sth->execute( $frombranch, $tobranch );
3584 while ( my $data = $sth->fetchrow_hashref ) {
3585 push @gettransfers, $data;
3587 return (@gettransfers);
3590 =head2 SendCirculationAlert
3592 Send out a C<check-in> or C<checkout> alert using the messaging system.
3600 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3604 Hashref of information about the item being checked in or out.
3608 Hashref of information about the borrower of the item.
3612 The branchcode from where the checkout or check-in took place.
3618 SendCirculationAlert({
3621 borrower => $borrower,
3627 sub SendCirculationAlert {
3629 my ($type, $item, $borrower, $branch, $issue) =
3630 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3631 my %message_name = (
3632 CHECKIN => 'Item_Check_in',
3633 CHECKOUT => 'Item_Checkout',
3634 RENEWAL => 'Item_Checkout',
3636 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3637 borrowernumber => $borrower->{borrowernumber},
3638 message_name => $message_name{$type},
3643 items => $item->{itemnumber},
3644 biblio => $item->{biblionumber},
3645 biblioitems => $item->{biblionumber},
3646 borrowers => $borrower,
3647 branches => $branch,
3650 # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3651 # See C4::Letters:: _parseletter_sth
3652 if( $type eq 'CHECKIN' ){
3653 $tables->{old_issues} = $issue->issue_id;
3655 $tables->{issues} = $item->{itemnumber};
3658 my $schema = Koha::Database->new->schema;
3659 my @transports = keys %{ $borrower_preferences->{transports} };
3661 # From the MySQL doc:
3662 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3663 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3664 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3665 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3667 for my $mtt (@transports) {
3668 my $letter = C4::Letters::GetPreparedLetter (
3669 module => 'circulation',
3670 letter_code => $type,
3671 branchcode => $branch,
3672 message_transport_type => $mtt,
3673 lang => $borrower->{lang},
3677 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3678 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3679 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3680 unless ( $message ) {
3681 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3682 C4::Message->enqueue($letter, $borrower, $mtt);
3684 $message->append($letter);
3687 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3693 =head2 updateWrongTransfer
3695 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3697 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
3701 sub updateWrongTransfer {
3702 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3704 # first step: cancel the original transfer
3705 my $item = Koha::Items->find($itemNumber);
3706 my $transfer = $item->get_transfer;
3707 $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3709 # second step: create a new transfer to the right location
3710 my $new_transfer = $item->request_transfer(
3712 to => $transfer->to_library,
3713 reason => $transfer->reason,
3714 comment => $transfer->comments,
3720 return $new_transfer;
3725 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3727 this function calculates the due date given the start date and configured circulation rules,
3728 checking against the holidays calendar as per the daysmode circulation rule.
3729 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3730 C<$itemtype> = itemtype code of item in question
3731 C<$branch> = location whose calendar to use
3732 C<$borrower> = Borrower object
3733 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3738 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3742 # loanlength now a href
3744 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3746 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3752 if (ref $startdate ne 'DateTime' ) {
3753 $datedue = dt_from_string($datedue);
3755 $datedue = $startdate->clone;
3758 $datedue = dt_from_string()->truncate( to => 'minute' );
3762 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3764 categorycode => $borrower->{categorycode},
3765 itemtype => $itemtype,
3766 branchcode => $branch,
3770 # calculate the datedue as normal
3771 if ( $daysmode eq 'Days' )
3772 { # ignoring calendar
3773 if ( $loanlength->{lengthunit} eq 'hours' ) {
3774 $datedue->add( hours => $loanlength->{$length_key} );
3776 $datedue->add( days => $loanlength->{$length_key} );
3777 $datedue->set_hour(23);
3778 $datedue->set_minute(59);
3782 if ($loanlength->{lengthunit} eq 'hours') {
3783 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3786 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3788 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3789 $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3790 if ($loanlength->{lengthunit} eq 'days') {
3791 $datedue->set_hour(23);
3792 $datedue->set_minute(59);
3796 # if Hard Due Dates are used, retrieve them and apply as necessary
3797 my ( $hardduedate, $hardduedatecompare ) =
3798 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3799 if ($hardduedate) { # hardduedates are currently dates
3800 $hardduedate->truncate( to => 'minute' );
3801 $hardduedate->set_hour(23);
3802 $hardduedate->set_minute(59);
3803 my $cmp = DateTime->compare( $hardduedate, $datedue );
3805 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3806 # if the calculated date is before the 'after' Hard Due Date (floor), override
3807 # if the hard due date is set to 'exactly', overrride
3808 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3809 $datedue = $hardduedate->clone;
3812 # in all other cases, keep the date due as it is
3816 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3817 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3818 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3819 if( $expiry_dt ) { #skip empty expiry date..
3820 $expiry_dt->set( hour => 23, minute => 59);
3821 my $d1= $datedue->clone->set_time_zone('floating');
3822 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3823 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3826 if ( $daysmode ne 'Days' ) {
3827 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3828 if ( $calendar->is_holiday($datedue) ) {
3829 # Don't return on a closed day
3830 $datedue = $calendar->prev_open_days( $datedue, 1 );
3839 sub CheckValidBarcode{
3841 my $dbh = C4::Context->dbh;
3842 my $query=qq|SELECT count(*)
3846 my $sth = $dbh->prepare($query);
3847 $sth->execute($barcode);
3848 my $exist=$sth->fetchrow ;
3852 =head2 IsBranchTransferAllowed
3854 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3856 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3858 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3859 Koha::Item->can_be_transferred.
3863 sub IsBranchTransferAllowed {
3864 my ( $toBranch, $fromBranch, $code ) = @_;
3866 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3868 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3869 my $dbh = C4::Context->dbh;
3871 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3872 $sth->execute( $toBranch, $fromBranch, $code );
3873 my $limit = $sth->fetchrow_hashref();
3875 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3876 if ( $limit->{'limitId'} ) {
3883 =head2 CreateBranchTransferLimit
3885 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3887 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3889 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3893 sub CreateBranchTransferLimit {
3894 my ( $toBranch, $fromBranch, $code ) = @_;
3895 return unless defined($toBranch) && defined($fromBranch);
3896 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3898 my $dbh = C4::Context->dbh;
3900 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3901 return $sth->execute( $code, $toBranch, $fromBranch );
3904 =head2 DeleteBranchTransferLimits
3906 my $result = DeleteBranchTransferLimits($frombranch);
3908 Deletes all the library transfer limits for one library. Returns the
3909 number of limits deleted, 0e0 if no limits were deleted, or undef if
3910 no arguments are supplied.
3912 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3913 fromBranch => $fromBranch
3918 sub DeleteBranchTransferLimits {
3920 return unless defined $branch;
3921 my $dbh = C4::Context->dbh;
3922 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3923 return $sth->execute($branch);
3927 my ( $borrowernumber, $itemnum ) = @_;
3928 MarkIssueReturned( $borrowernumber, $itemnum );
3933 LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3935 The final optional parameter, C<$params>, expected to contain
3936 'skip_record_index' key, which relayed down to Koha::Item/store,
3937 there it prevents calling of ModZebra index_records,
3938 which takes most of the time in batch adds/deletes: index_records better
3939 to be called later in C<additem.pl> after the whole loop.
3942 skip_record_index => 1|0
3947 my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3949 unless ( $mark_lost_from ) {
3950 # Temporary check to avoid regressions
3951 die q|LostItem called without $mark_lost_from, check the API.|;
3955 if ( $force_mark_returned ) {
3958 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3959 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3962 my $dbh = C4::Context->dbh();
3963 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3965 JOIN items USING (itemnumber)
3966 JOIN biblio USING (biblionumber)
3967 WHERE issues.itemnumber=?");
3968 $sth->execute($itemnumber);
3969 my $issues=$sth->fetchrow_hashref();
3971 # If a borrower lost the item, add a replacement cost to the their record
3972 if ( my $borrowernumber = $issues->{borrowernumber} ){
3973 my $patron = Koha::Patrons->find( $borrowernumber );
3975 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3976 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3978 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3979 C4::Accounts::chargelostitem(
3982 $issues->{'replacementprice'},
3983 sprintf( "%s %s %s",
3984 $issues->{'title'} || q{},
3985 $issues->{'barcode'} || q{},
3986 $issues->{'itemcallnumber'} || q{},
3989 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3990 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3993 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3996 # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3997 my $item = Koha::Items->find($itemnumber);
3998 my $transfers = $item->get_transfers;
3999 while (my $transfer = $transfers->next) {
4000 $transfer->cancel({ reason => 'ItemLost', force => 1 });
4004 sub GetOfflineOperations {
4005 my $dbh = C4::Context->dbh;
4006 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4007 $sth->execute(C4::Context->userenv->{'branch'});
4008 my $results = $sth->fetchall_arrayref({});
4012 sub GetOfflineOperation {
4013 my $operationid = shift;
4014 return unless $operationid;
4015 my $dbh = C4::Context->dbh;
4016 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4017 $sth->execute( $operationid );
4018 return $sth->fetchrow_hashref;
4021 sub AddOfflineOperation {
4022 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4023 my $dbh = C4::Context->dbh;
4024 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4025 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4029 sub DeleteOfflineOperation {
4030 my $dbh = C4::Context->dbh;
4031 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4032 $sth->execute( shift );
4036 sub ProcessOfflineOperation {
4037 my $operation = shift;
4040 if ( $operation->{action} eq 'return' ) {
4041 $report = ProcessOfflineReturn( $operation );
4042 } elsif ( $operation->{action} eq 'issue' ) {
4043 $report = ProcessOfflineIssue( $operation );
4044 } elsif ( $operation->{action} eq 'payment' ) {
4045 $report = ProcessOfflinePayment( $operation );
4048 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4053 sub ProcessOfflineReturn {
4054 my $operation = shift;
4056 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4059 my $itemnumber = $item->itemnumber;
4060 my $issue = GetOpenIssue( $itemnumber );
4062 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4063 ModDateLastSeen( $itemnumber, $leave_item_lost );
4065 $issue->{borrowernumber},
4067 $operation->{timestamp},
4070 $item->onloan(undef);
4071 $item->store({ log_action => 0 });
4074 return "Item not issued.";
4077 return "Item not found.";
4081 sub ProcessOfflineIssue {
4082 my $operation = shift;
4084 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4087 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4089 return "Barcode not found.";
4091 my $itemnumber = $item->itemnumber;
4092 my $issue = GetOpenIssue( $itemnumber );
4094 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4096 $issue->{borrowernumber},
4098 $operation->{timestamp},
4103 $operation->{'barcode'},
4106 $operation->{timestamp},
4111 return "Borrower not found.";
4115 sub ProcessOfflinePayment {
4116 my $operation = shift;
4118 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4120 $patron->account->pay(
4122 amount => $operation->{amount},
4123 library_id => $operation->{branchcode},
4133 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4135 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4140 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4144 ? Koha::Items->find($itemnumber)
4145 : Koha::Items->find( { barcode => $barcode } );
4149 return C4::Letters::GetPreparedLetter (
4150 module => 'circulation',
4151 letter_code => 'TRANSFERSLIP',
4152 branchcode => $branch,
4154 'branches' => $to_branch,
4155 'biblio' => $item->biblionumber,
4156 'items' => $item->unblessed,
4161 =head2 CheckIfIssuedToPatron
4163 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4165 Return 1 if any record item is issued to patron, otherwise return 0
4169 sub CheckIfIssuedToPatron {
4170 my ($borrowernumber, $biblionumber) = @_;
4172 my $dbh = C4::Context->dbh;
4174 SELECT COUNT(*) FROM issues
4175 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4176 WHERE items.biblionumber = ?
4177 AND issues.borrowernumber = ?
4179 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4180 return 1 if $is_issued;
4186 IsItemIssued( $itemnumber )
4188 Return 1 if the item is on loan, otherwise return 0
4193 my $itemnumber = shift;
4194 my $dbh = C4::Context->dbh;
4195 my $sth = $dbh->prepare(q{
4198 WHERE itemnumber = ?
4200 $sth->execute($itemnumber);
4201 return $sth->fetchrow;
4204 =head2 GetAgeRestriction
4206 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4207 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4209 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4210 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4212 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4213 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4214 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4215 Negative days mean the borrower has gone past the age restriction age.
4219 sub GetAgeRestriction {
4220 my ($record_restrictions, $borrower) = @_;
4221 my $markers = C4::Context->preference('AgeRestrictionMarker');
4223 return unless $record_restrictions;
4224 # Split $record_restrictions to something like FSK 16 or PEGI 6
4225 my @values = split ' ', uc($record_restrictions);
4226 return unless @values;
4228 # Search first occurrence of one of the markers
4229 my @markers = split /\|/, uc($markers);
4230 return unless @markers;
4233 my $restriction_year = 0;
4234 for my $value (@values) {
4236 for my $marker (@markers) {
4237 $marker =~ s/^\s+//; #remove leading spaces
4238 $marker =~ s/\s+$//; #remove trailing spaces
4239 if ( $marker eq $value ) {
4240 if ( $index <= $#values ) {
4241 $restriction_year += $values[$index];
4245 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4247 # Perhaps it is something like "K16" (as in Finland)
4248 $restriction_year += $1;
4252 last if ( $restriction_year > 0 );
4255 #Check if the borrower is age restricted for this material and for how long.
4256 if ($restriction_year && $borrower) {
4257 if ( $borrower->{'dateofbirth'} ) {
4258 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4259 $alloweddate[0] += $restriction_year;
4261 #Prevent runime eror on leap year (invalid date)
4262 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4263 $alloweddate[2] = 28;
4266 #Get how many days the borrower has to reach the age restriction
4267 my @Today = split /-/, dt_from_string()->ymd();
4268 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4269 #Negative days means the borrower went past the age restriction age
4270 return ($restriction_year, $daysToAgeRestriction);
4274 return ($restriction_year);
4278 =head2 GetPendingOnSiteCheckouts
4282 sub GetPendingOnSiteCheckouts {
4283 my $dbh = C4::Context->dbh;
4284 return $dbh->selectall_arrayref(q|
4290 items.itemcallnumber,
4294 issues.date_due < NOW() AS is_overdue,
4297 borrowers.firstname,
4299 borrowers.cardnumber,
4300 borrowers.borrowernumber
4302 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4303 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4304 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4305 WHERE issues.onsite_checkout = 1
4306 |, { Slice => {} } );
4312 my ($count, $branch, $itemtype, $ccode, $newness)
4313 = @$params{qw(count branch itemtype ccode newness)};
4315 my $dbh = C4::Context->dbh;
4318 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4319 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4320 i.ccode, SUM(i.issues) AS count
4322 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4323 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4326 my (@where_strs, @where_args);
4329 push @where_strs, 'i.homebranch = ?';
4330 push @where_args, $branch;
4333 if (C4::Context->preference('item-level_itypes')){
4334 push @where_strs, 'i.itype = ?';
4335 push @where_args, $itemtype;
4337 push @where_strs, 'bi.itemtype = ?';
4338 push @where_args, $itemtype;
4342 push @where_strs, 'i.ccode = ?';
4343 push @where_args, $ccode;
4346 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4347 push @where_args, $newness;
4351 $query .= 'WHERE ' . join(' AND ', @where_strs);
4355 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4356 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4361 $query .= q{ ) xxx WHERE count > 0 };
4362 $count = int($count);
4364 $query .= "LIMIT $count";
4367 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4372 =head2 Internal methods
4376 sub _CalculateAndUpdateFine {
4379 my $borrower = $params->{borrower};
4380 my $item = $params->{item};
4381 my $issue = $params->{issue};
4382 my $return_date = $params->{return_date};
4384 unless ($borrower) { carp "No borrower passed in!" && return; }
4385 unless ($item) { carp "No item passed in!" && return; }
4386 unless ($issue) { carp "No issue passed in!" && return; }
4388 my $datedue = dt_from_string( $issue->date_due );
4390 # we only need to calculate and change the fines if we want to do that on return
4391 # Should be on for hourly loans
4392 my $control = C4::Context->preference('CircControl');
4393 my $control_branchcode =
4394 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4395 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4396 : $issue->branchcode;
4398 my $date_returned = $return_date ? $return_date : dt_from_string();
4400 my ( $amount, $unitcounttotal, $unitcount ) =
4401 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4403 if ( C4::Context->preference('finesMode') eq 'production' ) {
4404 if ( $amount > 0 ) {
4405 C4::Overdues::UpdateFine({
4406 issue_id => $issue->issue_id,
4407 itemnumber => $issue->itemnumber,
4408 borrowernumber => $issue->borrowernumber,
4410 due => output_pref($datedue),
4413 elsif ($return_date) {
4415 # Backdated returns may have fines that shouldn't exist,
4416 # so in this case, we need to drop those fines to 0
4418 C4::Overdues::UpdateFine({
4419 issue_id => $issue->issue_id,
4420 itemnumber => $issue->itemnumber,
4421 borrowernumber => $issue->borrowernumber,
4423 due => output_pref($datedue),
4429 sub _CanBookBeAutoRenewed {
4430 my ( $params ) = @_;
4431 my $patron = $params->{patron};
4432 my $item = $params->{item};
4433 my $branchcode = $params->{branchcode};
4434 my $issue = $params->{issue};
4436 return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4438 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4440 categorycode => $patron->categorycode,
4441 itemtype => $item->effective_itemtype,
4442 branchcode => $branchcode,
4444 'no_auto_renewal_after',
4445 'no_auto_renewal_after_hard_limit',
4452 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
4453 return 'auto_account_expired';
4456 if ( defined $issuing_rule->{no_auto_renewal_after}
4457 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4458 # Get issue_date and add no_auto_renewal_after
4459 # If this is greater than today, it's too late for renewal.
4460 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4461 $maximum_renewal_date->add(
4462 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4464 my $now = dt_from_string;
4465 if ( $now >= $maximum_renewal_date ) {
4466 return "auto_too_late";
4469 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4470 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4471 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4472 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4473 return "auto_too_late";
4477 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4478 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4479 my $amountoutstanding =
4480 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4481 ? $patron->account->balance
4482 : $patron->account->outstanding_debits->total_outstanding;
4483 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4484 return "auto_too_much_oweing";
4488 my $soonest = GetSoonestRenewDate($patron->id, $item->id);
4489 if ( $soonest > dt_from_string() )
4491 return ( "auto_too_soon", $soonest );
4497 sub _item_denied_renewal {
4500 my $item = $params->{item};
4501 return unless $item;
4503 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4504 return unless $denyingrules;
4505 foreach my $field (keys %$denyingrules) {
4506 my $val = $item->$field;
4507 if( !defined $val) {
4508 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4511 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4512 # If the results matches the values in the syspref
4513 # We return true if match found
4526 Koha Development Team <http://koha-community.org/>