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 );
32 use C4::ItemCirculationAlertPreference;
35 use C4::Log; # logaction
36 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits;
42 use Koha::AuthorisedValues;
43 use Koha::Biblioitems;
47 use Koha::Illrequests;
50 use Koha::Patron::Debarments;
53 use Koha::Account::Lines;
55 use Koha::Account::Lines;
56 use Koha::Account::Offsets;
57 use Koha::Config::SysPrefs;
58 use Koha::Charges::Fees;
59 use Koha::Util::SystemPreferences;
60 use Koha::Checkouts::ReturnClaims;
62 use List::MoreUtils qw( uniq any );
63 use Scalar::Util qw( looks_like_number );
74 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
80 # FIXME subs that should probably be elsewhere
85 &GetPendingOnSiteCheckouts
88 # subs to deal with issuing a book
96 &GetLatestAutoRenewDate
98 &GetBranchBorrowerCircRule
102 &CheckIfIssuedToPatron
107 # subs to deal with returns
113 # subs to deal with transfers
120 &IsBranchTransferAllowed
121 &CreateBranchTransferLimit
122 &DeleteBranchTransferLimits
126 # subs to deal with offline circulation
128 &GetOfflineOperations
131 &DeleteOfflineOperation
132 &ProcessOfflineOperation
138 C4::Circulation - Koha circulation module
146 The functions in this module deal with circulation, issues, and
147 returns, as well as general information about the library.
148 Also deals with inventory.
154 $str = &barcodedecode($barcode, [$filter]);
156 Generic filter function for barcode string.
157 Called on every circ if the System Pref itemBarcodeInputFilter is set.
158 Will do some manipulation of the barcode for systems that deliver a barcode
159 to circulation.pl that differs from the barcode stored for the item.
160 For proper functioning of this filter, calling the function on the
161 correct barcode string (items.barcode) should return an unaltered barcode.
163 The optional $filter argument is to allow for testing or explicit
164 behavior that ignores the System Pref. Valid values are the same as the
169 # FIXME -- the &decode fcn below should be wrapped into this one.
170 # FIXME -- these plugins should be moved out of Circulation.pm
173 my ($barcode, $filter) = @_;
174 my $branch = C4::Context::mybranch();
175 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
176 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
177 if ($filter eq 'whitespace') {
179 } elsif ($filter eq 'cuecat') {
181 my @fields = split( /\./, $barcode );
182 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
183 ($#results == 2) and return $results[2];
184 } elsif ($filter eq 'T-prefix') {
185 if ($barcode =~ /^[Tt](\d)/) {
186 (defined($1) and $1 eq '0') and return $barcode;
187 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
189 return sprintf("T%07d", $barcode);
190 # FIXME: $barcode could be "T1", causing warning: substr outside of string
191 # Why drop the nonzero digit after the T?
192 # Why pass non-digits (or empty string) to "T%07d"?
193 } elsif ($filter eq 'libsuite8') {
194 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
195 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
196 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
198 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
201 } elsif ($filter eq 'EAN13') {
202 my $ean = CheckDigits('ean');
203 if ( $ean->is_valid($barcode) ) {
204 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
205 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
207 warn "# [$barcode] not valid EAN-13/UPC-A\n";
210 return $barcode; # return barcode, modified or not
215 $str = &decode($chunk);
217 Decodes a segment of a string emitted by a CueCat barcode scanner and
220 FIXME: Should be replaced with Barcode::Cuecat from CPAN
221 or Javascript based decoding on the client side.
228 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
229 my @s = map { index( $seq, $_ ); } split( //, $encoded );
230 my $l = ( $#s + 1 ) % 4;
233 # warn "Error: Cuecat decode parsing failed!";
241 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
243 chr( ( $n >> 16 ) ^ 67 )
244 .chr( ( $n >> 8 & 255 ) ^ 67 )
245 .chr( ( $n & 255 ) ^ 67 );
248 $r = substr( $r, 0, length($r) - $l );
254 ($dotransfer, $messages, $iteminformation) = &transferbook({
255 from_branch => $frombranch
256 to_branch => $tobranch,
258 ignore_reserves => $ignore_reserves,
262 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
264 C<$fbr> is the code for the branch initiating the transfer.
265 C<$tbr> is the code for the branch to which the item should be transferred.
267 C<$barcode> is the barcode of the item to be transferred.
269 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
270 Otherwise, if an item is reserved, the transfer fails.
272 C<$trigger> is the enum value for what triggered the transfer.
274 Returns three values:
280 is true if the transfer was successful.
284 is a reference-to-hash which may have any of the following keys:
290 There is no item in the catalog with the given barcode. The value is C<$barcode>.
292 =item C<DestinationEqualsHolding>
294 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.
298 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.
302 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>.
304 =item C<WasTransferred>
306 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
316 my $tbr = $params->{to_branch};
317 my $fbr = $params->{from_branch};
318 my $ignoreRs = $params->{ignore_reserves};
319 my $barcode = $params->{barcode};
320 my $trigger = $params->{trigger};
323 my $item = Koha::Items->find( { barcode => $barcode } );
325 Koha::Exceptions::MissingParameter->throw(
326 "Missing mandatory parameter: from_branch")
329 Koha::Exceptions::MissingParameter->throw(
330 "Missing mandatory parameter: to_branch")
335 $messages->{'BadBarcode'} = $barcode;
337 return ( $dotransfer, $messages );
340 my $itemnumber = $item->itemnumber;
341 # get branches of book...
342 my $hbr = $item->homebranch;
344 # if using Branch Transfer Limits
345 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
346 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
347 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
348 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
349 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
352 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
353 $messages->{'NotAllowed'} = $tbr . "::" . $code;
358 # can't transfer book if is already there....
359 if ( $fbr eq $tbr ) {
360 $messages->{'DestinationEqualsHolding'} = 1;
364 # check if it is still issued to someone, return it...
365 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
367 AddReturn( $barcode, $fbr );
368 $messages->{'WasReturned'} = $issue->borrowernumber;
372 # That'll save a database query.
373 my ( $resfound, $resrec, undef ) =
374 CheckReserves( $itemnumber );
375 if ( $resfound and not $ignoreRs ) {
376 $resrec->{'ResFound'} = $resfound;
377 $messages->{'ResFound'} = $resrec;
381 #actually do the transfer....
383 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
385 # don't need to update MARC anymore, we do it in batch now
386 $messages->{'WasTransfered'} = 1;
389 ModDateLastSeen( $itemnumber );
390 return ( $dotransfer, $messages );
395 my $borrower = shift;
396 my $item_object = shift;
398 my $onsite_checkout = $params->{onsite_checkout} || 0;
399 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
400 my $cat_borrower = $borrower->{'categorycode'};
401 my $dbh = C4::Context->dbh;
402 # Get which branchcode we need
403 my $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
404 my $type = $item_object->effective_itemtype;
406 my ($type_object, $parent_type, $parent_maxissueqty_rule);
407 $type_object = Koha::ItemTypes->find( $type );
408 $parent_type = $type_object->parent_type if $type_object;
409 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
410 # Find any children if we are a parent_type;
412 # given branch, patron category, and item type, determine
413 # applicable issuing rule
415 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
417 categorycode => $cat_borrower,
418 itemtype => $parent_type,
419 branchcode => $branch,
420 rule_name => 'maxissueqty',
423 # If the parent rule is for default type we discount it
424 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
426 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
428 categorycode => $cat_borrower,
430 branchcode => $branch,
431 rule_name => 'maxissueqty',
435 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
437 categorycode => $cat_borrower,
439 branchcode => $branch,
440 rule_name => 'maxonsiteissueqty',
445 my $patron = Koha::Patrons->find($borrower->{borrowernumber});
446 # if a rule is found and has a loan limit set, count
447 # how many loans the patron already has that meet that
449 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
452 if ( $maxissueqty_rule->branchcode ) {
453 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
454 $checkouts = $patron->checkouts->search(
455 { 'me.branchcode' => $maxissueqty_rule->branchcode } );
456 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
457 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
459 $checkouts = $patron->checkouts->search(
460 { 'item.homebranch' => $maxissueqty_rule->branchcode },
461 { prefetch => 'item' } );
464 $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
467 my $rule_itemtype = $maxissueqty_rule->itemtype;
468 while ( my $c = $checkouts->next ) {
469 my $itemtype = $c->item->effective_itemtype;
471 unless ( $rule_itemtype ) {
472 # matching rule has the default item type, so count only
473 # those existing loans that don't fall under a more
475 @types = Koha::CirculationRules->search(
477 branchcode => $maxissueqty_rule->branchcode,
478 categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
479 itemtype => { '!=' => undef },
480 rule_name => 'maxissueqty'
482 )->get_column('itemtype');
484 next if grep {$_ eq $itemtype} @types;
487 if ( $parent_maxissueqty_rule ) {
488 # if we have a parent item type then we count loans of the
489 # specific item type or its siblings or parent
490 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
491 @types = $children->get_column('itemtype');
492 push @types, $parent_type;
493 } elsif ( $child_types ) {
494 # If we are a parent type, we need to count all child types and our own type
495 @types = $child_types->get_column('itemtype');
496 push @types, $type; # And don't forget to count our own types
497 } else { push @types, $type; } # Otherwise only count the specific itemtype
499 next unless grep {$_ eq $itemtype} @types;
501 $sum_checkouts->{total}++;
502 $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
503 $sum_checkouts->{itemtype}->{$itemtype}++;
506 my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
507 my $checkout_count = $sum_checkouts->{total} || 0;
508 my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
510 my $checkout_rules = {
511 checkout_count => $checkout_count,
512 onsite_checkout_count => $onsite_checkout_count,
513 onsite_checkout => $onsite_checkout,
514 max_checkouts_allowed => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
515 max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
516 switch_onsite_checkout => $switch_onsite_checkout,
518 # If parent rules exists
519 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
520 $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
521 my $qty_over = _check_max_qty($checkout_rules);
522 return $qty_over if defined $qty_over;
524 # If the parent rule is less than or equal to the child, we only need check the parent
525 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
526 $checkout_rules->{checkout_count} = $checkout_count_type;
527 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
528 my $qty_over = _check_max_qty($checkout_rules);
529 return $qty_over if defined $qty_over;
532 my $qty_over = _check_max_qty($checkout_rules);
533 return $qty_over if defined $qty_over;
537 # Now count total loans against the limit for the branch
538 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
539 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
541 if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
542 $checkouts = $patron->checkouts->search(
543 { 'me.branchcode' => $branch} );
544 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
545 ; # if branch is the patron's home branch, then count all loans by patron
547 $checkouts = $patron->checkouts->search(
548 { 'item.homebranch' => $branch} );
551 my $checkout_count = $checkouts->count;
552 my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
553 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
554 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
556 my $qty_over = _check_max_qty(
558 checkout_count => $checkout_count,
559 onsite_checkout_count => $onsite_checkout_count,
560 onsite_checkout => $onsite_checkout,
561 max_checkouts_allowed => $max_checkouts_allowed,
562 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
563 switch_onsite_checkout => $switch_onsite_checkout
566 return $qty_over if defined $qty_over;
569 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
570 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
573 # OK, the patron can issue !!!
579 my $checkout_count = $params->{checkout_count};
580 my $onsite_checkout_count = $params->{onsite_checkout_count};
581 my $onsite_checkout = $params->{onsite_checkout};
582 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
583 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
584 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
586 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
587 if ( $max_onsite_checkouts_allowed eq '' ) { return; }
588 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
590 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
591 count => $onsite_checkout_count,
592 max_allowed => $max_onsite_checkouts_allowed,
596 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
597 if ( $max_checkouts_allowed eq '' ) { return; }
598 my $delta = $switch_onsite_checkout ? 1 : 0;
599 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
601 reason => 'TOO_MANY_CHECKOUTS',
602 count => $checkout_count,
603 max_allowed => $max_checkouts_allowed,
607 elsif ( not $onsite_checkout ) {
608 if ( $max_checkouts_allowed eq '' ) { return; }
610 $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
613 reason => 'TOO_MANY_CHECKOUTS',
614 count => $checkout_count - $onsite_checkout_count,
615 max_allowed => $max_checkouts_allowed,
623 =head2 CanBookBeIssued
625 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
626 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
628 Check if a book can be issued.
630 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
632 IMPORTANT: The assumption by users of this routine is that causes blocking
633 the issue are keyed by uppercase labels and other returned
634 data is keyed in lower case!
638 =item C<$patron> is a Koha::Patron
640 =item C<$barcode> is the bar code of the book being issued.
642 =item C<$duedates> is a DateTime object.
644 =item C<$inprocess> boolean switch
646 =item C<$ignore_reserves> boolean switch
648 =item C<$params> Hashref of additional parameters
651 override_high_holds - Ignore high holds
652 onsite_checkout - Checkout is an onsite checkout that will not leave the library
660 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
661 Possible values are :
667 sticky due date is invalid
671 borrower gone with no address
675 borrower declared it's card lost
681 =head3 UNKNOWN_BARCODE
695 item is restricted (set by ??)
697 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
698 could be prevented, but ones that can be overriden by the operator.
700 Possible values are :
708 renewing, not issuing
710 =head3 ISSUED_TO_ANOTHER
712 issued to someone else.
716 reserved for someone else.
720 sticky due date is invalid or due date in the past
724 if the borrower borrows to much things
728 sub CanBookBeIssued {
729 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
730 my %needsconfirmation; # filled with problems that needs confirmations
731 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
732 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
733 my %messages; # filled with information messages that should be displayed.
735 my $onsite_checkout = $params->{onsite_checkout} || 0;
736 my $override_high_holds = $params->{override_high_holds} || 0;
738 my $item_object = Koha::Items->find({barcode => $barcode });
740 # MANDATORY CHECKS - unless item exists, nothing else matters
741 unless ( $item_object ) {
742 $issuingimpossible{UNKNOWN_BARCODE} = 1;
744 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
746 my $item_unblessed = $item_object->unblessed; # Transition...
747 my $issue = $item_object->checkout;
748 my $biblio = $item_object->biblio;
750 my $biblioitem = $biblio->biblioitem;
751 my $effective_itemtype = $item_object->effective_itemtype;
752 my $dbh = C4::Context->dbh;
753 my $patron_unblessed = $patron->unblessed;
755 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
757 # DUE DATE is OK ? -- should already have checked.
759 if ($duedate && ref $duedate ne 'DateTime') {
760 $duedate = dt_from_string($duedate);
762 my $now = dt_from_string();
763 unless ( $duedate ) {
764 my $issuedate = $now->clone();
766 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
768 # Offline circ calls AddIssue directly, doesn't run through here
769 # So issuingimpossible should be ok.
772 my $fees = Koha::Charges::Fees->new(
775 library => $circ_library,
776 item => $item_object,
782 my $today = $now->clone();
783 $today->truncate( to => 'minute');
784 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
785 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
788 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
794 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
795 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
797 branch => C4::Context->userenv->{'branch'},
799 itemnumber => $item_object->itemnumber,
800 itemtype => $effective_itemtype,
801 borrowernumber => $patron->borrowernumber,
802 ccode => $item_object->ccode}
804 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
805 return( { STATS => 1 }, {});
808 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
809 $issuingimpossible{GNA} = 1;
812 if ( $patron->lost && $patron->lost == 1 ) {
813 $issuingimpossible{CARD_LOST} = 1;
815 if ( $patron->is_debarred ) {
816 $issuingimpossible{DEBARRED} = 1;
819 if ( $patron->is_expired ) {
820 $issuingimpossible{EXPIRED} = 1;
828 my $account = $patron->account;
829 my $balance = $account->balance;
830 my $non_issues_charges = $account->non_issues_charges;
831 my $other_charges = $balance - $non_issues_charges;
833 my $amountlimit = C4::Context->preference("noissuescharge");
834 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
835 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
837 # Check the debt of this patrons guarantees
838 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
839 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
840 if ( defined $no_issues_charge_guarantees ) {
841 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
842 my $guarantees_non_issues_charges;
843 foreach my $g ( @guarantees ) {
844 $guarantees_non_issues_charges += $g->account->non_issues_charges;
847 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
848 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
849 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
850 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
851 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
852 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
856 if ( C4::Context->preference("IssuingInProcess") ) {
857 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
858 $issuingimpossible{DEBT} = $non_issues_charges;
859 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
860 $needsconfirmation{DEBT} = $non_issues_charges;
861 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
862 $needsconfirmation{DEBT} = $non_issues_charges;
866 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
867 $needsconfirmation{DEBT} = $non_issues_charges;
868 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
869 $issuingimpossible{DEBT} = $non_issues_charges;
870 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
871 $needsconfirmation{DEBT} = $non_issues_charges;
875 if ($balance > 0 && $other_charges > 0) {
876 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
879 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
880 $patron_unblessed = $patron->unblessed;
882 if ( my $debarred_date = $patron->is_debarred ) {
883 # patron has accrued fine days or has a restriction. $count is a date
884 if ($debarred_date eq '9999-12-31') {
885 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
888 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
890 } elsif ( my $num_overdues = $patron->has_overdues ) {
891 ## patron has outstanding overdue loans
892 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
893 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
895 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
896 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
901 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
903 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
905 # Already issued to current borrower.
906 # If it is an on-site checkout if it can be switched to a normal checkout
907 # or ask whether the loan should be renewed
909 if ( $issue->onsite_checkout
910 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
911 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
913 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
914 $patron->borrowernumber,
915 $item_object->itemnumber,
917 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
918 if ( $renewerror eq 'onsite_checkout' ) {
919 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
922 $issuingimpossible{NO_MORE_RENEWALS} = 1;
926 $needsconfirmation{RENEW_ISSUE} = 1;
932 # issued to someone else
934 my $patron = Koha::Patrons->find( $issue->borrowernumber );
936 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
938 unless ( $can_be_returned ) {
939 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
940 $issuingimpossible{branch_to_return} = $message;
942 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
943 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
945 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
946 $needsconfirmation{issued_firstname} = $patron->firstname;
947 $needsconfirmation{issued_surname} = $patron->surname;
948 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
949 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
954 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
956 my $switch_onsite_checkout = (
957 C4::Context->preference('SwitchOnSiteCheckouts')
959 and $issue->onsite_checkout
960 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
961 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
962 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
963 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
964 if ( $toomany->{max_allowed} == 0 ) {
965 $needsconfirmation{PATRON_CANT} = 1;
967 if ( C4::Context->preference("AllowTooManyOverride") ) {
968 $needsconfirmation{TOO_MANY} = $toomany->{reason};
969 $needsconfirmation{current_loan_count} = $toomany->{count};
970 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
972 $issuingimpossible{TOO_MANY} = $toomany->{reason};
973 $issuingimpossible{current_loan_count} = $toomany->{count};
974 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
979 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
981 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
982 my $wants_check = $patron->wants_check_for_previous_checkout;
983 $needsconfirmation{PREVISSUE} = 1
984 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
989 if ( $item_object->notforloan )
991 if(!C4::Context->preference("AllowNotForLoanOverride")){
992 $issuingimpossible{NOT_FOR_LOAN} = 1;
993 $issuingimpossible{item_notforloan} = $item_object->notforloan;
995 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
996 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1000 # we have to check itemtypes.notforloan also
1001 if (C4::Context->preference('item-level_itypes')){
1002 # this should probably be a subroutine
1003 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1004 $sth->execute($effective_itemtype);
1005 my $notforloan=$sth->fetchrow_hashref();
1006 if ($notforloan->{'notforloan'}) {
1007 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1008 $issuingimpossible{NOT_FOR_LOAN} = 1;
1009 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1011 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1012 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1017 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1018 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1019 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1020 $issuingimpossible{NOT_FOR_LOAN} = 1;
1021 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1023 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1024 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1029 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1031 $issuingimpossible{WTHDRAWN} = 1;
1033 if ( $item_object->restricted
1034 && $item_object->restricted == 1 )
1036 $issuingimpossible{RESTRICTED} = 1;
1038 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1039 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1040 my $code = $av->count ? $av->next->lib : '';
1041 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1042 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1044 if ( C4::Context->preference("IndependentBranches") ) {
1045 my $userenv = C4::Context->userenv;
1046 unless ( C4::Context->IsSuperLibrarian() ) {
1047 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1048 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1049 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1050 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1052 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1053 if ( $patron->branchcode ne $userenv->{branch} );
1058 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1060 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1061 if ($rentalConfirmation) {
1062 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1064 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1065 if ($itemtype_object) {
1066 my $accumulate_charge = $fees->accumulate_rentalcharge();
1067 if ( $accumulate_charge > 0 ) {
1068 $rentalCharge += $accumulate_charge;
1072 if ( $rentalCharge > 0 ) {
1073 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1077 unless ( $ignore_reserves ) {
1078 # See if the item is on reserve.
1079 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1081 my $resbor = $res->{'borrowernumber'};
1082 if ( $resbor ne $patron->borrowernumber ) {
1083 my $patron = Koha::Patrons->find( $resbor );
1084 if ( $restype eq "Waiting" )
1086 # The item is on reserve and waiting, but has been
1087 # reserved by some other patron.
1088 $needsconfirmation{RESERVE_WAITING} = 1;
1089 $needsconfirmation{'resfirstname'} = $patron->firstname;
1090 $needsconfirmation{'ressurname'} = $patron->surname;
1091 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1092 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1093 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1094 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1095 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1097 elsif ( $restype eq "Reserved" ) {
1098 # The item is on reserve for someone else.
1099 $needsconfirmation{RESERVED} = 1;
1100 $needsconfirmation{'resfirstname'} = $patron->firstname;
1101 $needsconfirmation{'ressurname'} = $patron->surname;
1102 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1103 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1104 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1105 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1106 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1112 ## CHECK AGE RESTRICTION
1113 my $agerestriction = $biblioitem->agerestriction;
1114 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1115 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1116 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1117 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1120 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1124 ## check for high holds decreasing loan period
1125 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1126 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1128 if ( $check->{exceeded} ) {
1129 if ($override_high_holds) {
1130 $alerts{HIGHHOLDS} = {
1131 num_holds => $check->{outstanding},
1132 duration => $check->{duration},
1133 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1137 $needsconfirmation{HIGHHOLDS} = {
1138 num_holds => $check->{outstanding},
1139 duration => $check->{duration},
1140 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1147 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1148 # don't do the multiple loans per bib check if we've
1149 # already determined that we've got a loan on the same item
1150 !$issuingimpossible{NO_MORE_RENEWALS} &&
1151 !$needsconfirmation{RENEW_ISSUE}
1153 # Check if borrower has already issued an item from the same biblio
1154 # Only if it's not a subscription
1155 my $biblionumber = $item_object->biblionumber;
1156 require C4::Serials;
1157 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1158 unless ($is_a_subscription) {
1159 # FIXME Should be $patron->checkouts($args);
1160 my $checkouts = Koha::Checkouts->search(
1162 borrowernumber => $patron->borrowernumber,
1163 biblionumber => $biblionumber,
1169 # if we get here, we don't already have a loan on this item,
1170 # so if there are any loans on this bib, ask for confirmation
1171 if ( $checkouts->count ) {
1172 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1177 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1180 =head2 CanBookBeReturned
1182 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1184 Check whether the item can be returned to the provided branch
1188 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1190 =item C<$branch> is the branchcode where the return is taking place
1198 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1200 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1206 sub CanBookBeReturned {
1207 my ($item, $branch) = @_;
1208 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1210 # assume return is allowed to start
1214 # identify all cases where return is forbidden
1215 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1217 $message = $item->{'homebranch'};
1218 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1220 $message = $item->{'holdingbranch'};
1221 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1223 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1226 return ($allowed, $message);
1229 =head2 CheckHighHolds
1231 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1232 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1233 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1237 sub checkHighHolds {
1238 my ( $item, $borrower ) = @_;
1239 my $branchcode = _GetCircControlBranch( $item, $borrower );
1240 my $item_object = Koha::Items->find( $item->{itemnumber} );
1249 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1251 if ( $holds->count() ) {
1252 $return_data->{outstanding} = $holds->count();
1254 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1255 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1256 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1258 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1260 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1262 # static means just more than a given number of holds on the record
1264 # If the number of holds is less than the threshold, we can stop here
1265 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1266 return $return_data;
1269 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1271 # dynamic means X more than the number of holdable items on the record
1273 # let's get the items
1274 my @items = $holds->next()->biblio()->items()->as_list;
1276 # Remove any items with status defined to be ignored even if the would not make item unholdable
1277 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1278 @items = grep { !$_->$status } @items;
1281 # Remove any items that are not holdable for this patron
1282 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1284 my $items_count = scalar @items;
1286 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1288 # If the number of holds is less than the count of items we have
1289 # plus the number of holds allowed above that count, we can stop here
1290 if ( $holds->count() <= $threshold ) {
1291 return $return_data;
1295 my $issuedate = dt_from_string();
1297 my $itype = $item_object->effective_itemtype;
1298 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1300 categorycode => $borrower->{categorycode},
1302 branchcode => $branchcode,
1305 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1307 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1309 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1311 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1312 $reduced_datedue->set_hour($orig_due->hour);
1313 $reduced_datedue->set_minute($orig_due->minute);
1314 $reduced_datedue->truncate( to => 'minute' );
1316 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1317 $return_data->{exceeded} = 1;
1318 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1319 $return_data->{due_date} = $reduced_datedue;
1323 return $return_data;
1328 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1330 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1334 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1336 =item C<$barcode> is the barcode of the item being issued.
1338 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1339 Calculated if empty.
1341 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1343 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1344 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1346 AddIssue does the following things :
1348 - step 01: check that there is a borrowernumber & a barcode provided
1349 - check for RENEWAL (book issued & being issued to the same patron)
1350 - renewal YES = Calculate Charge & renew
1352 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1354 - fill reserve if reserve to this patron
1355 - cancel reserve or not, otherwise
1356 * TRANSFERT PENDING ?
1357 - complete the transfert
1365 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1367 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1368 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1369 my $auto_renew = $params && $params->{auto_renew};
1370 my $dbh = C4::Context->dbh;
1371 my $barcodecheck = CheckValidBarcode($barcode);
1375 if ( $datedue && ref $datedue ne 'DateTime' ) {
1376 $datedue = dt_from_string($datedue);
1379 # $issuedate defaults to today.
1380 if ( !defined $issuedate ) {
1381 $issuedate = dt_from_string();
1384 if ( ref $issuedate ne 'DateTime' ) {
1385 $issuedate = dt_from_string($issuedate);
1390 # Stop here if the patron or barcode doesn't exist
1391 if ( $borrower && $barcode && $barcodecheck ) {
1392 # find which item we issue
1393 my $item_object = Koha::Items->find({ barcode => $barcode })
1394 or return; # if we don't get an Item, abort.
1395 my $item_unblessed = $item_object->unblessed;
1397 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1399 # get actual issuing if there is one
1400 my $actualissue = $item_object->checkout;
1402 # check if we just renew the issue.
1403 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1404 and not $switch_onsite_checkout ) {
1405 $datedue = AddRenewal(
1406 $borrower->{'borrowernumber'},
1407 $item_object->itemnumber,
1410 $issuedate, # here interpreted as the renewal date
1415 my $itype = $item_object->effective_itemtype;
1416 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1419 $datedue->truncate( to => 'minute' );
1421 my $patron = Koha::Patrons->find( $borrower );
1422 my $library = Koha::Libraries->find( $branchcode );
1423 my $fees = Koha::Charges::Fees->new(
1426 library => $library,
1427 item => $item_object,
1428 to_date => $datedue,
1432 # it's NOT a renewal
1433 if ( $actualissue and not $switch_onsite_checkout ) {
1434 # This book is currently on loan, but not to the person
1435 # who wants to borrow it now. mark it returned before issuing to the new borrower
1436 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1437 return unless $allowed;
1438 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1441 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1443 # Starting process for transfer job (checking transfert and validate it if we have one)
1444 my ($datesent) = GetTransfers( $item_object->itemnumber );
1446 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1447 my $sth = $dbh->prepare(
1448 "UPDATE branchtransfers
1449 SET datearrived = now(),
1451 comments = 'Forced branchtransfer'
1452 WHERE itemnumber= ? AND datearrived IS NULL"
1454 $sth->execute( C4::Context->userenv->{'branch'},
1455 $item_object->itemnumber );
1458 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1459 unless ($auto_renew) {
1460 my $rule = Koha::CirculationRules->get_effective_rule(
1462 categorycode => $borrower->{categorycode},
1463 itemtype => $item_object->effective_itemtype,
1464 branchcode => $branchcode,
1465 rule_name => 'auto_renew'
1469 $auto_renew = $rule->rule_value if $rule;
1472 # Record in the database the fact that the book was issued.
1474 my $itype = $item_object->effective_itemtype;
1475 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1478 $datedue->truncate( to => 'minute' );
1480 my $issue_attributes = {
1481 borrowernumber => $borrower->{'borrowernumber'},
1482 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1483 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1484 branchcode => C4::Context->userenv->{'branch'},
1485 onsite_checkout => $onsite_checkout,
1486 auto_renew => $auto_renew ? 1 : 0,
1489 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1491 $issue->set($issue_attributes)->store;
1494 $issue = Koha::Checkout->new(
1496 itemnumber => $item_object->itemnumber,
1501 if ( $item_object->location && $item_object->location eq 'CART'
1502 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1503 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1504 CartToShelf( $item_object->itemnumber );
1507 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1508 UpdateTotalIssues( $item_object->biblionumber, 1 );
1511 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1512 if ( $item_object->itemlost ) {
1514 my $no_refund_after_days = C4::Context->preference('NoRefundOnLostReturnedItemsAge');
1515 if ($no_refund_after_days) {
1516 my $today = dt_from_string();
1517 my $lost_age_in_days =
1518 dt_from_string( $item_object->itemlost_on )
1519 ->delta_days($today)
1522 $refund = 0 unless ( $lost_age_in_days < $no_refund_after_days );
1526 $refund && Koha::CirculationRules->get_lostreturn_policy(
1528 return_branch => C4::Context->userenv->{branch},
1529 item => $item_object
1534 _FixAccountForLostAndFound( $item_object->itemnumber, undef,
1535 $item_object->barcode );
1539 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1540 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1541 $item_object->itemlost(0);
1542 $item_object->onloan($datedue->ymd());
1543 $item_object->datelastborrowed( dt_from_string()->ymd() );
1544 $item_object->store({log_action => 0});
1545 ModDateLastSeen( $item_object->itemnumber );
1547 # If it costs to borrow this book, charge it to the patron's account.
1548 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1549 if ( $charge && $charge > 0 ) {
1550 AddIssuingCharge( $issue, $charge, 'RENT' );
1553 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1554 if ( $itemtype_object ) {
1555 my $accumulate_charge = $fees->accumulate_rentalcharge();
1556 if ( $accumulate_charge > 0 ) {
1557 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1558 $charge += $accumulate_charge;
1559 $item_unblessed->{charge} = $charge;
1563 # Record the fact that this book was issued.
1566 branch => C4::Context->userenv->{'branch'},
1567 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1569 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1570 itemnumber => $item_object->itemnumber,
1571 itemtype => $item_object->effective_itemtype,
1572 location => $item_object->location,
1573 borrowernumber => $borrower->{'borrowernumber'},
1574 ccode => $item_object->ccode,
1578 # Send a checkout slip.
1579 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1581 branchcode => $branchcode,
1582 categorycode => $borrower->{categorycode},
1583 item_type => $item_object->effective_itemtype,
1584 notification => 'CHECKOUT',
1586 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1587 SendCirculationAlert(
1590 item => $item_object->unblessed,
1591 borrower => $borrower,
1592 branch => $branchcode,
1597 "CIRCULATION", "ISSUE",
1598 $borrower->{'borrowernumber'},
1599 $item_object->itemnumber,
1600 ) if C4::Context->preference("IssueLog");
1602 Koha::Plugins->call('after_circ_action', {
1603 action => 'checkout',
1605 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1606 checkout => $issue->get_from_storage
1614 =head2 GetLoanLength
1616 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1618 Get loan length for an itemtype, a borrower type and a branch
1623 my ( $categorycode, $itemtype, $branchcode ) = @_;
1625 # Set search precedences
1628 categorycode => $categorycode,
1629 itemtype => $itemtype,
1630 branchcode => $branchcode,
1633 categorycode => $categorycode,
1635 branchcode => $branchcode,
1638 categorycode => undef,
1639 itemtype => $itemtype,
1640 branchcode => $branchcode,
1643 categorycode => undef,
1645 branchcode => $branchcode,
1648 categorycode => $categorycode,
1649 itemtype => $itemtype,
1650 branchcode => undef,
1653 categorycode => $categorycode,
1655 branchcode => undef,
1658 categorycode => undef,
1659 itemtype => $itemtype,
1660 branchcode => undef,
1663 categorycode => undef,
1665 branchcode => undef,
1669 # Initialize default values
1673 lengthunit => 'days',
1677 foreach my $rule_name (qw( issuelength renewalperiod lengthunit )) {
1678 foreach my $params (@params) {
1679 my $rule = Koha::CirculationRules->search(
1681 rule_name => $rule_name,
1687 $rules->{$rule_name} = $rule->rule_value;
1697 =head2 GetHardDueDate
1699 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1701 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1705 sub GetHardDueDate {
1706 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1708 my $rules = Koha::CirculationRules->get_effective_rules(
1710 categorycode => $borrowertype,
1711 itemtype => $itemtype,
1712 branchcode => $branchcode,
1713 rules => [ 'hardduedate', 'hardduedatecompare' ],
1717 if ( defined( $rules->{hardduedate} ) ) {
1718 if ( $rules->{hardduedate} ) {
1719 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1722 return ( undef, undef );
1727 =head2 GetBranchBorrowerCircRule
1729 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1731 Retrieves circulation rule attributes that apply to the given
1732 branch and patron category, regardless of item type.
1733 The return value is a hashref containing the following key:
1735 patron_maxissueqty - maximum number of loans that a
1736 patron of the given category can have at the given
1737 branch. If the value is undef, no limit.
1739 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1740 patron of the given category can have at the given
1741 branch. If the value is undef, no limit.
1743 This will check for different branch/category combinations in the following order:
1747 default branch and category
1749 If no rule has been found in the database, it will default to
1752 patron_maxissueqty - undef
1753 patron_maxonsiteissueqty - undef
1755 C<$branchcode> and C<$categorycode> should contain the
1756 literal branch code and patron category code, respectively - no
1761 sub GetBranchBorrowerCircRule {
1762 my ( $branchcode, $categorycode ) = @_;
1764 # Initialize default values
1766 patron_maxissueqty => undef,
1767 patron_maxonsiteissueqty => undef,
1771 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1772 my $rule = Koha::CirculationRules->get_effective_rule(
1774 categorycode => $categorycode,
1776 branchcode => $branchcode,
1777 rule_name => $rule_name,
1781 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1787 =head2 GetBranchItemRule
1789 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1791 Retrieves circulation rule attributes that apply to the given
1792 branch and item type, regardless of patron category.
1794 The return value is a hashref containing the following keys:
1796 holdallowed => Hold policy for this branch and itemtype. Possible values:
1797 0: No holds allowed.
1798 1: Holds allowed only by patrons that have the same homebranch as the item.
1799 2: Holds allowed from any patron.
1801 returnbranch => branch to which to return item. Possible values:
1802 noreturn: do not return, let item remain where checked in (floating collections)
1803 homebranch: return to item's home branch
1804 holdingbranch: return to issuer branch
1806 This searches branchitemrules in the following order:
1808 * Same branchcode and itemtype
1809 * Same branchcode, itemtype '*'
1810 * branchcode '*', same itemtype
1811 * branchcode and itemtype '*'
1813 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1817 sub GetBranchItemRule {
1818 my ( $branchcode, $itemtype ) = @_;
1821 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1823 branchcode => $branchcode,
1824 itemtype => $itemtype,
1825 rule_name => 'holdallowed',
1828 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1830 branchcode => $branchcode,
1831 itemtype => $itemtype,
1832 rule_name => 'hold_fulfillment_policy',
1835 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1837 branchcode => $branchcode,
1838 itemtype => $itemtype,
1839 rule_name => 'returnbranch',
1843 # built-in default circulation rule
1845 $rules->{holdallowed} = defined $holdallowed_rule
1846 ? $holdallowed_rule->rule_value
1848 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1849 ? $hold_fulfillment_policy_rule->rule_value
1851 $rules->{returnbranch} = defined $returnbranch_rule
1852 ? $returnbranch_rule->rule_value
1860 ($doreturn, $messages, $iteminformation, $borrower) =
1861 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1867 =item C<$barcode> is the bar code of the book being returned.
1869 =item C<$branch> is the code of the branch where the book is being returned.
1871 =item C<$exemptfine> indicates that overdue charges for the item will be
1874 =item C<$return_date> allows the default return date to be overridden
1875 by the given return date. Optional.
1879 C<&AddReturn> returns a list of four items:
1881 C<$doreturn> is true iff the return succeeded.
1883 C<$messages> is a reference-to-hash giving feedback on the operation.
1884 The keys of the hash are:
1890 No item with this barcode exists. The value is C<$barcode>.
1894 The book is not currently on loan. The value is C<$barcode>.
1898 This book has been withdrawn/cancelled. The value should be ignored.
1900 =item C<Wrongbranch>
1902 This book has was returned to the wrong branch. The value is a hashref
1903 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1904 contain the branchcode of the incorrect and correct return library, respectively.
1908 The item was reserved. The value is a reference-to-hash whose keys are
1909 fields from the reserves table of the Koha database, and
1910 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1911 either C<Waiting>, C<Reserved>, or 0.
1913 =item C<WasReturned>
1915 Value 1 if return is successful.
1917 =item C<NeedsTransfer>
1919 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1923 C<$iteminformation> is a reference-to-hash, giving information about the
1924 returned item from the issues table.
1926 C<$borrower> is a reference-to-hash, giving information about the
1927 patron who last borrowed the book.
1932 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1934 if ($branch and not Koha::Libraries->find($branch)) {
1935 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1938 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1939 my $return_date_specified = !!$return_date;
1940 $return_date //= dt_from_string();
1944 my $validTransfer = 1;
1945 my $stat_type = 'return';
1947 # get information on item
1948 my $item = Koha::Items->find({ barcode => $barcode });
1950 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1953 my $itemnumber = $item->itemnumber;
1954 my $itemtype = $item->effective_itemtype;
1956 my $issue = $item->checkout;
1958 $patron = $issue->patron
1959 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1960 . Dumper($issue->unblessed) . "\n";
1962 $messages->{'NotIssued'} = $barcode;
1963 $item->onloan(undef)->store if defined $item->onloan;
1965 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1967 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1968 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1969 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1970 $messages->{'LocalUse'} = 1;
1971 $stat_type = 'localuse';
1975 # full item data, but no borrowernumber or checkout info (no issue)
1976 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1977 # get the proper branch to which to return the item
1978 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1979 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1980 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1982 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1983 my $patron_unblessed = $patron ? $patron->unblessed : {};
1985 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1986 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1987 if ($update_loc_rules) {
1988 if (defined $update_loc_rules->{_ALL_}) {
1989 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1990 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1991 if ( $item->location ne $update_loc_rules->{_ALL_}) {
1992 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1993 $item->location($update_loc_rules->{_ALL_})->store;
1997 foreach my $key ( keys %$update_loc_rules ) {
1998 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1999 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2000 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2001 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2002 $item->location($update_loc_rules->{$key})->store;
2009 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2011 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2013 eval { $rules = YAML::Load($yaml); };
2015 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2018 foreach my $key ( keys %$rules ) {
2019 if ( $item->notforloan eq $key ) {
2020 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2021 $item->notforloan($rules->{$key})->store({ log_action => 0 });
2028 # check if the return is allowed at this branch
2029 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2030 unless ($returnallowed){
2031 $messages->{'Wrongbranch'} = {
2032 Wrongbranch => $branch,
2033 Rightbranch => $message
2036 return ( $doreturn, $messages, $issue, $patron_unblessed);
2039 if ( $item->withdrawn ) { # book has been cancelled
2040 $messages->{'withdrawn'} = 1;
2041 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2044 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2048 # case of a return of document (deal with issues and holdingbranch)
2050 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2051 $patron or warn "AddReturn without current borrower";
2055 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
2060 C4::Context->preference('CalculateFinesOnReturn')
2061 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2066 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2069 carp "The checkin for the following issue failed, Please go to the about page, section 'data corrupted' to know how to fix this problem ($@)" . Dumper( $issue->unblessed );
2071 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2074 # FIXME is the "= 1" right? This could be the borrower hash.
2075 $messages->{'WasReturned'} = 1;
2079 $item->onloan(undef)->store({ log_action => 0 });
2082 # the holdingbranch is updated if the document is returned to another location.
2083 # this is always done regardless of whether the item was on loan or not
2084 my $item_holding_branch = $item->holdingbranch;
2085 if ($item->holdingbranch ne $branch) {
2086 $item->holdingbranch($branch)->store;
2089 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2090 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
2092 # check if we have a transfer for this document
2093 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2095 # if we have a transfer to do, we update the line of transfers with the datearrived
2096 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2098 # At this point we will either fill the transfer or it is a wrong transfer
2099 # either way we should not now generate a new transfer
2101 if ( $tobranch eq $branch ) {
2102 my $sth = C4::Context->dbh->prepare(
2103 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2105 $sth->execute( $item->itemnumber );
2107 $messages->{'WrongTransfer'} = $tobranch;
2108 $messages->{'WrongTransferItem'} = $item->itemnumber;
2112 # fix up the accounts.....
2113 if ( $item->itemlost ) {
2114 $messages->{'WasLost'} = 1;
2115 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2117 my $no_refund_after_days = C4::Context->preference('NoRefundOnLostReturnedItemsAge');
2118 if ($no_refund_after_days) {
2119 my $today = dt_from_string();
2120 my $lost_age_in_days =
2121 dt_from_string( $item->itemlost_on )
2122 ->delta_days($today)
2125 $refund = 0 unless ( $lost_age_in_days < $no_refund_after_days );
2130 Koha::CirculationRules->get_lostreturn_policy(
2132 return_branch => C4::Context->userenv->{branch},
2138 _FixAccountForLostAndFound( $item->itemnumber,
2139 $borrowernumber, $barcode );
2140 $messages->{'LostItemFeeRefunded'} = 1;
2145 # fix up the overdues in accounts...
2146 if ($borrowernumber) {
2147 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2148 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2150 if ( $issue and $issue->is_overdue($return_date) ) {
2152 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2154 $messages->{'PrevDebarred'} = $debardate;
2156 $messages->{'Debarred'} = $debardate if $debardate;
2158 # there's no overdue on the item but borrower had been previously debarred
2159 } elsif ( $issue->date_due and $patron->debarred ) {
2160 if ( $patron->debarred eq "9999-12-31") {
2161 $messages->{'ForeverDebarred'} = $patron->debarred;
2163 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2164 $borrower_debar_dt->truncate(to => 'day');
2165 my $today_dt = $return_date->clone()->truncate(to => 'day');
2166 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2167 $messages->{'PrevDebarred'} = $patron->debarred;
2173 # find reserves.....
2174 # launch the Checkreserves routine to find any holds
2175 my ($resfound, $resrec);
2176 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2177 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2178 # 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)
2179 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2180 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2181 $resfound = 'Reserved';
2182 $resrec = $hold->unblessed;
2185 $resrec->{'ResFound'} = $resfound;
2186 $messages->{'ResFound'} = $resrec;
2189 # Record the fact that this book was returned.
2193 itemnumber => $itemnumber,
2194 itemtype => $itemtype,
2195 location => $item->location,
2196 borrowernumber => $borrowernumber,
2197 ccode => $item->ccode,
2200 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2202 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2204 branchcode => $branch,
2205 categorycode => $patron->categorycode,
2206 item_type => $itemtype,
2207 notification => 'CHECKIN',
2209 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2210 SendCirculationAlert({
2212 item => $item->unblessed,
2213 borrower => $patron->unblessed,
2218 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2219 if C4::Context->preference("ReturnLog");
2222 # Check if this item belongs to a biblio record that is attached to an
2223 # ILL request, if it is we need to update the ILL request's status
2224 if ( $doreturn and C4::Context->preference('CirculateILL')) {
2225 my $request = Koha::Illrequests->find(
2226 { biblio_id => $item->biblio->biblionumber }
2228 $request->status('RET') if $request;
2231 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2232 if ($validTransfer && !$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) ){
2233 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2234 if (C4::Context->preference("AutomaticItemReturn" ) or
2235 (C4::Context->preference("UseBranchTransferLimits") and
2236 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2238 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2239 $debug and warn "item: " . Dumper($item->unblessed);
2240 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger);
2241 $messages->{'WasTransfered'} = 1;
2243 $messages->{'NeedsTransfer'} = $returnbranch;
2244 $messages->{'TransferTrigger'} = $transfer_trigger;
2248 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2249 my $claims = Koha::Checkouts::ReturnClaims->search(
2251 itemnumber => $item->id,
2252 resolution => undef,
2256 if ( $claims->count ) {
2257 $messages->{ReturnClaims} = $claims;
2261 if ( $doreturn and $issue ) {
2262 my $checkin = Koha::Old::Checkouts->find($issue->id);
2264 Koha::Plugins->call('after_circ_action', {
2265 action => 'checkin',
2272 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2275 =head2 MarkIssueReturned
2277 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2279 Unconditionally marks an issue as being returned by
2280 moving the C<issues> row to C<old_issues> and
2281 setting C<returndate> to the current date.
2283 if C<$returndate> is specified (in iso format), it is used as the date
2286 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2287 the old_issue is immediately anonymised
2289 Ideally, this function would be internal to C<C4::Circulation>,
2290 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2291 and offline_circ/process_koc.pl.
2295 sub MarkIssueReturned {
2296 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2298 # Retrieve the issue
2299 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2301 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2303 my $issue_id = $issue->issue_id;
2305 my $anonymouspatron;
2306 if ( $privacy && $privacy == 2 ) {
2307 # The default of 0 will not work due to foreign key constraints
2308 # The anonymisation will fail if AnonymousPatron is not a valid entry
2309 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2310 # Note that a warning should appear on the about page (System information tab).
2311 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2312 die "Fatal error: the patron ($borrowernumber) has requested their circulation history be anonymized on check-in, but the AnonymousPatron system preference is empty or not set correctly."
2313 unless Koha::Patrons->find( $anonymouspatron );
2316 my $schema = Koha::Database->schema;
2318 # FIXME Improve the return value and handle it from callers
2319 $schema->txn_do(sub {
2321 my $patron = Koha::Patrons->find( $borrowernumber );
2323 # Update the returndate value
2324 if ( $returndate ) {
2325 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2328 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2331 # Create the old_issues entry
2332 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2334 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2335 if ( $privacy && $privacy == 2) {
2336 $old_checkout->borrowernumber($anonymouspatron)->store;
2339 # And finally delete the issue
2342 $issue->item->onloan(undef)->store({ log_action => 0 });
2344 if ( C4::Context->preference('StoreLastBorrower') ) {
2345 my $item = Koha::Items->find( $itemnumber );
2346 $item->last_returned_by( $patron );
2349 # Remove any OVERDUES related debarment if the borrower has no overdues
2350 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2351 && $patron->debarred
2352 && !$patron->has_overdues
2353 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2355 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2363 =head2 _debar_user_on_return
2365 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2367 C<$borrower> borrower hashref
2369 C<$item> item hashref
2371 C<$datedue> date due DateTime object
2373 C<$returndate> DateTime object representing the return time
2375 Internal function, called only by AddReturn that calculates and updates
2376 the user fine days, and debars them if necessary.
2378 Should only be called for overdue returns
2380 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2385 sub _calculate_new_debar_dt {
2386 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2388 my $branchcode = _GetCircControlBranch( $item, $borrower );
2389 my $circcontrol = C4::Context->preference('CircControl');
2390 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2391 { categorycode => $borrower->{categorycode},
2392 itemtype => $item->{itype},
2393 branchcode => $branchcode,
2398 'maxsuspensiondays',
2399 'suspension_chargeperiod',
2403 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2404 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2405 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2407 return unless $finedays;
2409 # finedays is in days, so hourly loans must multiply by 24
2410 # thus 1 hour late equals 1 day suspension * finedays rate
2411 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2413 # grace period is measured in the same units as the loan
2415 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2417 my $deltadays = DateTime::Duration->new(
2418 days => $chargeable_units
2421 if ( $deltadays->subtract($grace)->is_positive() ) {
2422 my $suspension_days = $deltadays * $finedays;
2424 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2425 # No need to / 1 and do not consider / 0
2426 $suspension_days = DateTime::Duration->new(
2427 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2431 # If the max suspension days is < than the suspension days
2432 # the suspension days is limited to this maximum period.
2433 my $max_sd = $issuing_rule->{maxsuspensiondays};
2434 if ( defined $max_sd && $max_sd ne '' ) {
2435 $max_sd = DateTime::Duration->new( days => $max_sd );
2436 $suspension_days = $max_sd
2437 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2440 my ( $has_been_extended );
2441 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2442 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2444 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2445 $has_been_extended = 1;
2450 # Use the calendar or not to calculate the debarment date
2451 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2452 my $calendar = Koha::Calendar->new(
2453 branchcode => $branchcode,
2454 days_mode => 'Calendar'
2456 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2459 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2461 return $new_debar_dt;
2466 sub _debar_user_on_return {
2467 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2469 $return_date //= dt_from_string();
2471 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2473 return unless $new_debar_dt;
2475 Koha::Patron::Debarments::AddUniqueDebarment({
2476 borrowernumber => $borrower->{borrowernumber},
2477 expiration => $new_debar_dt->ymd(),
2478 type => 'SUSPENSION',
2480 # if borrower was already debarred but does not get an extra debarment
2481 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2482 my ($new_debarment_str, $is_a_reminder);
2483 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2485 $new_debarment_str = $borrower->{debarred};
2487 $new_debarment_str = $new_debar_dt->ymd();
2489 # FIXME Should return a DateTime object
2490 return $new_debarment_str, $is_a_reminder;
2493 =head2 _FixOverduesOnReturn
2495 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2497 C<$borrowernumber> borrowernumber
2499 C<$itemnumber> itemnumber
2501 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2503 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2509 sub _FixOverduesOnReturn {
2510 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2511 unless( $borrowernumber ) {
2512 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2516 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2520 warn "_FixOverduesOnReturn() not supplied valid status";
2524 my $schema = Koha::Database->schema;
2526 my $result = $schema->txn_do(
2528 # check for overdue fine
2529 my $accountlines = Koha::Account::Lines->search(
2531 borrowernumber => $borrowernumber,
2532 itemnumber => $item,
2533 debit_type_code => 'OVERDUE',
2534 status => 'UNRETURNED'
2537 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2539 my $accountline = $accountlines->next;
2540 my $payments = $accountline->credits;
2542 my $amountoutstanding = $accountline->amountoutstanding;
2543 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2544 $accountline->delete;
2545 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2546 my $account = Koha::Account->new({patron_id => $borrowernumber});
2547 my $credit = $account->add_credit(
2549 amount => $amountoutstanding,
2550 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2551 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2552 interface => C4::Context->interface,
2558 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2560 if (C4::Context->preference("FinesLog")) {
2561 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2564 $accountline->status('FORGIVEN');
2565 $accountline->store();
2567 $accountline->status($status);
2568 $accountline->store();
2577 =head2 _FixAccountForLostAndFound
2579 &_FixAccountForLostAndFound($itemnumber, [$borrowernumber, $barcode]);
2581 Finds the most recent lost item charge for this item and refunds the borrower
2582 appropriatly, taking into account any payments or writeoffs already applied
2585 Internal function, not exported, called only by AddReturn.
2589 sub _FixAccountForLostAndFound {
2590 my $itemnumber = shift or return;
2591 my $borrowernumber = @_ ? shift : undef;
2592 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2596 # check for charge made for lost book
2597 my $accountlines = Koha::Account::Lines->search(
2599 itemnumber => $itemnumber,
2600 debit_type_code => 'LOST',
2601 status => [ undef, { '<>' => 'FOUND' } ]
2604 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2608 return unless $accountlines->count > 0;
2609 my $accountline = $accountlines->next;
2610 my $total_to_refund = 0;
2612 return unless $accountline->borrowernumber;
2613 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2614 return unless $patron; # Patron has been deleted, nobody to credit the return to
2616 my $account = $patron->account;
2619 if ( $accountline->amount > $accountline->amountoutstanding ) {
2620 # some amount has been cancelled. collect the offsets that are not writeoffs
2621 # this works because the only way to subtract from this kind of a debt is
2622 # using the UI buttons 'Pay' and 'Write off'
2623 my $credits_offsets = Koha::Account::Offsets->search({
2624 debit_id => $accountline->id,
2625 credit_id => { '!=' => undef }, # it is not the debit itself
2626 type => { '!=' => 'Writeoff' },
2627 amount => { '<' => 0 } # credits are negative on the DB
2630 $total_to_refund = ( $credits_offsets->count > 0 )
2631 ? $credits_offsets->total * -1 # credits are negative on the DB
2635 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2637 if ( $credit_total > 0 ) {
2638 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2639 $credit = $account->add_credit(
2641 amount => $credit_total,
2642 description => 'Item found ' . $item_id,
2643 type => 'LOST_FOUND',
2644 interface => C4::Context->interface,
2645 library_id => $branchcode,
2646 item_id => $itemnumber
2650 $credit->apply( { debits => [ $accountline ] } );
2653 # Update the account status
2654 $accountline->discard_changes->status('FOUND');
2655 $accountline->store;
2657 $accountline->item->paidfor('')->store({ log_action => 0 });
2659 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2660 $account->reconcile_balance;
2663 return ($credit) ? $credit->id : undef;
2666 =head2 _GetCircControlBranch
2668 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2672 Return the library code to be used to determine which circulation
2673 policy applies to a transaction. Looks up the CircControl and
2674 HomeOrHoldingBranch system preferences.
2676 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2678 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2682 sub _GetCircControlBranch {
2683 my ($item, $borrower) = @_;
2684 my $circcontrol = C4::Context->preference('CircControl');
2687 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2688 $branch= C4::Context->userenv->{'branch'};
2689 } elsif ($circcontrol eq 'PatronLibrary') {
2690 $branch=$borrower->{branchcode};
2692 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2693 $branch = $item->{$branchfield};
2694 # default to item home branch if holdingbranch is used
2695 # and is not defined
2696 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2697 $branch = $item->{homebranch};
2705 $issue = GetOpenIssue( $itemnumber );
2707 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2709 C<$itemnumber> is the item's itemnumber
2716 my ( $itemnumber ) = @_;
2717 return unless $itemnumber;
2718 my $dbh = C4::Context->dbh;
2719 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2720 $sth->execute( $itemnumber );
2721 return $sth->fetchrow_hashref();
2725 =head2 GetBiblioIssues
2727 $issues = GetBiblioIssues($biblionumber);
2729 this function get all issues from a biblionumber.
2732 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2733 tables issues and the firstname,surname & cardnumber from borrowers.
2737 sub GetBiblioIssues {
2738 my $biblionumber = shift;
2739 return unless $biblionumber;
2740 my $dbh = C4::Context->dbh;
2742 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2744 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2745 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2746 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2747 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2748 WHERE biblio.biblionumber = ?
2750 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2752 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2753 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2754 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2755 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2756 WHERE biblio.biblionumber = ?
2759 my $sth = $dbh->prepare($query);
2760 $sth->execute($biblionumber, $biblionumber);
2763 while ( my $data = $sth->fetchrow_hashref ) {
2764 push @issues, $data;
2769 =head2 GetUpcomingDueIssues
2771 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2775 sub GetUpcomingDueIssues {
2778 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2779 my $dbh = C4::Context->dbh;
2781 my $statement = <<END_SQL;
2784 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2786 LEFT JOIN items USING (itemnumber)
2787 LEFT OUTER JOIN branches USING (branchcode)
2788 WHERE returndate is NULL
2790 WHERE days_until_due >= 0 AND days_until_due <= ?
2793 my @bind_parameters = ( $params->{'days_in_advance'} );
2795 my $sth = $dbh->prepare( $statement );
2796 $sth->execute( @bind_parameters );
2797 my $upcoming_dues = $sth->fetchall_arrayref({});
2799 return $upcoming_dues;
2802 =head2 CanBookBeRenewed
2804 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2806 Find out whether a borrowed item may be renewed.
2808 C<$borrowernumber> is the borrower number of the patron who currently
2809 has the item on loan.
2811 C<$itemnumber> is the number of the item to renew.
2813 C<$override_limit>, if supplied with a true value, causes
2814 the limit on the number of times that the loan can be renewed
2815 (as controlled by the item type) to be ignored. Overriding also allows
2816 to renew sooner than "No renewal before" and to manually renew loans
2817 that are automatically renewed.
2819 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2820 item must currently be on loan to the specified borrower; renewals
2821 must be allowed for the item's type; and the borrower must not have
2822 already renewed the loan. $error will contain the reason the renewal can not proceed
2826 sub CanBookBeRenewed {
2827 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2829 my $dbh = C4::Context->dbh;
2833 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2834 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2835 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2836 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2838 my $patron = $issue->patron or return;
2840 # override_limit will override anything else except on_reserve
2841 unless ( $override_limit ){
2842 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2843 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2845 categorycode => $patron->categorycode,
2846 itemtype => $item->effective_itemtype,
2847 branchcode => $branchcode,
2850 'no_auto_renewal_after',
2851 'no_auto_renewal_after_hard_limit',
2858 return ( 0, "too_many" )
2859 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2861 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2862 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2863 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2864 my $restricted = $patron->is_debarred;
2865 my $hasoverdues = $patron->has_overdues;
2867 if ( $restricted and $restrictionblockrenewing ) {
2868 return ( 0, 'restriction');
2869 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2870 return ( 0, 'overdue');
2873 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2875 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2876 return ( 0, 'auto_account_expired' );
2879 if ( defined $issuing_rule->{no_auto_renewal_after}
2880 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2881 # Get issue_date and add no_auto_renewal_after
2882 # If this is greater than today, it's too late for renewal.
2883 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2884 $maximum_renewal_date->add(
2885 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2887 my $now = dt_from_string;
2888 if ( $now >= $maximum_renewal_date ) {
2889 return ( 0, "auto_too_late" );
2892 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2893 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2894 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2895 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2896 return ( 0, "auto_too_late" );
2900 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2901 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2902 my $amountoutstanding =
2903 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2904 ? $patron->account->balance
2905 : $patron->account->outstanding_debits->total_outstanding;
2906 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2907 return ( 0, "auto_too_much_oweing" );
2912 if ( defined $issuing_rule->{norenewalbefore}
2913 and $issuing_rule->{norenewalbefore} ne "" )
2916 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2917 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2918 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2920 # Depending on syspref reset the exact time, only check the date
2921 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2922 and $issuing_rule->{lengthunit} eq 'days' )
2924 $soonestrenewal->truncate( to => 'day' );
2927 if ( $soonestrenewal > dt_from_string() )
2929 return ( 0, "auto_too_soon" ) if $issue->auto_renew && $patron->autorenew_checkouts;
2930 return ( 0, "too_soon" );
2932 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2937 # Fallback for automatic renewals:
2938 # If norenewalbefore is undef, don't renew before due date.
2939 if ( $issue->auto_renew && !$auto_renew && $patron->autorenew_checkouts ) {
2940 my $now = dt_from_string;
2941 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2944 return ( 0, "auto_too_soon" );
2949 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2951 # This item can fill one or more unfilled reserve, can those unfilled reserves
2952 # all be filled by other available items?
2954 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2956 my $schema = Koha::Database->new()->schema();
2958 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2960 # There is an item level hold on this item, no other item can fill the hold
2965 # Get all other items that could possibly fill reserves
2966 my @itemnumbers = $schema->resultset('Item')->search(
2968 biblionumber => $resrec->{biblionumber},
2971 -not => { itemnumber => $itemnumber }
2973 { columns => 'itemnumber' }
2974 )->get_column('itemnumber')->all();
2976 # Get all other reserves that could have been filled by this item
2977 my @borrowernumbers;
2979 my ( $reserve_found, $reserve, undef ) =
2980 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2982 if ($reserve_found) {
2983 push( @borrowernumbers, $reserve->{borrowernumber} );
2990 # If the count of the union of the lists of reservable items for each borrower
2991 # is equal or greater than the number of borrowers, we know that all reserves
2992 # can be filled with available items. We can get the union of the sets simply
2993 # by pushing all the elements onto an array and removing the duplicates.
2996 ITEM: foreach my $itemnumber (@itemnumbers) {
2997 my $item = Koha::Items->find( $itemnumber );
2998 next if IsItemOnHoldAndFound( $itemnumber );
2999 for my $borrowernumber (@borrowernumbers) {
3000 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
3001 next unless IsAvailableForItemLevelRequest($item, $patron);
3002 next unless CanItemBeReserved($borrowernumber,$itemnumber);
3004 push @reservable, $itemnumber;
3005 if (@reservable >= @borrowernumbers) {
3014 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
3015 return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
3017 return ( 1, undef );
3022 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
3026 C<$borrowernumber> is the borrower number of the patron who currently
3029 C<$itemnumber> is the number of the item to renew.
3031 C<$branch> is the library where the renewal took place (if any).
3032 The library that controls the circ policies for the renewal is retrieved from the issues record.
3034 C<$datedue> can be a DateTime object used to set the due date.
3036 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3037 this parameter is not supplied, lastreneweddate is set to the current date.
3039 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3040 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3041 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3044 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3045 from the book's item type.
3050 my $borrowernumber = shift;
3051 my $itemnumber = shift or return;
3053 my $datedue = shift;
3054 my $lastreneweddate = shift || dt_from_string();
3055 my $skipfinecalc = shift;
3057 my $item_object = Koha::Items->find($itemnumber) or return;
3058 my $biblio = $item_object->biblio;
3059 my $issue = $item_object->checkout;
3060 my $item_unblessed = $item_object->unblessed;
3062 my $dbh = C4::Context->dbh;
3064 return unless $issue;
3066 $borrowernumber ||= $issue->borrowernumber;
3068 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3069 carp 'Invalid date passed to AddRenewal.';
3073 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3074 my $patron_unblessed = $patron->unblessed;
3076 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3078 my $schema = Koha::Database->schema;
3079 $schema->txn_do(sub{
3081 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3082 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3084 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3086 # If the due date wasn't specified, calculate it by adding the
3087 # book's loan length to today's date or the current due date
3088 # based on the value of the RenewalPeriodBase syspref.
3089 my $itemtype = $item_object->effective_itemtype;
3092 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3093 dt_from_string( $issue->date_due, 'sql' ) :
3095 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3098 my $fees = Koha::Charges::Fees->new(
3101 library => $circ_library,
3102 item => $item_object,
3103 from_date => dt_from_string( $issue->date_due, 'sql' ),
3104 to_date => dt_from_string($datedue),
3108 # Update the issues record to have the new due date, and a new count
3109 # of how many times it has been renewed.
3110 my $renews = ( $issue->renewals || 0 ) + 1;
3111 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3112 WHERE borrowernumber=?
3116 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3118 # Update the renewal count on the item, and tell zebra to reindex
3119 $renews = ( $item_object->renewals || 0 ) + 1;
3120 $item_object->renewals($renews);
3121 $item_object->onloan($datedue);
3122 $item_object->store({ log_action => 0 });
3124 # Charge a new rental fee, if applicable
3125 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3126 if ( $charge > 0 ) {
3127 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3130 # Charge a new accumulate rental fee, if applicable
3131 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3132 if ( $itemtype_object ) {
3133 my $accumulate_charge = $fees->accumulate_rentalcharge();
3134 if ( $accumulate_charge > 0 ) {
3135 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3137 $charge += $accumulate_charge;
3140 # Send a renewal slip according to checkout alert preferencei
3141 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3142 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3144 branchcode => $branch,
3145 categorycode => $patron->categorycode,
3146 item_type => $itemtype,
3147 notification => 'CHECKOUT',
3149 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3150 SendCirculationAlert(
3153 item => $item_unblessed,
3154 borrower => $patron->unblessed,
3161 # Remove any OVERDUES related debarment if the borrower has no overdues
3163 && $patron->is_debarred
3164 && ! $patron->has_overdues
3165 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3167 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3170 # Add the renewal to stats
3173 branch => $item_object->renewal_branchcode({branch => $branch}),
3176 itemnumber => $itemnumber,
3177 itemtype => $itemtype,
3178 location => $item_object->location,
3179 borrowernumber => $borrowernumber,
3180 ccode => $item_object->ccode,
3185 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3187 Koha::Plugins->call('after_circ_action', {
3188 action => 'renewal',
3190 checkout => $issue->get_from_storage
3199 # check renewal status
3200 my ( $bornum, $itemno ) = @_;
3201 my $dbh = C4::Context->dbh;
3203 my $renewsallowed = 0;
3206 my $patron = Koha::Patrons->find( $bornum );
3207 my $item = Koha::Items->find($itemno);
3209 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3211 # Look in the issues table for this item, lent to this borrower,
3212 # and not yet returned.
3214 # FIXME - I think this function could be redone to use only one SQL call.
3215 my $sth = $dbh->prepare(
3216 "select * from issues
3217 where (borrowernumber = ?)
3218 and (itemnumber = ?)"
3220 $sth->execute( $bornum, $itemno );
3221 my $data = $sth->fetchrow_hashref;
3222 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3223 # $item and $borrower should be calculated
3224 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3226 my $rule = Koha::CirculationRules->get_effective_rule(
3228 categorycode => $patron->categorycode,
3229 itemtype => $item->effective_itemtype,
3230 branchcode => $branchcode,
3231 rule_name => 'renewalsallowed',
3235 $renewsallowed = $rule ? $rule->rule_value : 0;
3236 $renewsleft = $renewsallowed - $renewcount;
3237 if($renewsleft < 0){ $renewsleft = 0; }
3238 return ( $renewcount, $renewsallowed, $renewsleft );
3241 =head2 GetSoonestRenewDate
3243 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3245 Find out the soonest possible renew date of a borrowed item.
3247 C<$borrowernumber> is the borrower number of the patron who currently
3248 has the item on loan.
3250 C<$itemnumber> is the number of the item to renew.
3252 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3253 renew date, based on the value "No renewal before" of the applicable
3254 issuing rule. Returns the current date if the item can already be
3255 renewed, and returns undefined if the borrower, loan, or item
3260 sub GetSoonestRenewDate {
3261 my ( $borrowernumber, $itemnumber ) = @_;
3263 my $dbh = C4::Context->dbh;
3265 my $item = Koha::Items->find($itemnumber) or return;
3266 my $itemissue = $item->checkout or return;
3268 $borrowernumber ||= $itemissue->borrowernumber;
3269 my $patron = Koha::Patrons->find( $borrowernumber )
3272 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3273 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3274 { categorycode => $patron->categorycode,
3275 itemtype => $item->effective_itemtype,
3276 branchcode => $branchcode,
3284 my $now = dt_from_string;
3285 return $now unless $issuing_rule;
3287 if ( defined $issuing_rule->{norenewalbefore}
3288 and $issuing_rule->{norenewalbefore} ne "" )
3290 my $soonestrenewal =
3291 dt_from_string( $itemissue->date_due )->subtract(
3292 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3294 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3295 and $issuing_rule->{lengthunit} eq 'days' )
3297 $soonestrenewal->truncate( to => 'day' );
3299 return $soonestrenewal if $now < $soonestrenewal;
3304 =head2 GetLatestAutoRenewDate
3306 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3308 Find out the latest possible auto renew date of a borrowed item.
3310 C<$borrowernumber> is the borrower number of the patron who currently
3311 has the item on loan.
3313 C<$itemnumber> is the number of the item to renew.
3315 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3316 auto renew date, based on the value "No auto renewal after" and the "No auto
3317 renewal after (hard limit) of the applicable issuing rule.
3318 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3319 or item cannot be found.
3323 sub GetLatestAutoRenewDate {
3324 my ( $borrowernumber, $itemnumber ) = @_;
3326 my $dbh = C4::Context->dbh;
3328 my $item = Koha::Items->find($itemnumber) or return;
3329 my $itemissue = $item->checkout or return;
3331 $borrowernumber ||= $itemissue->borrowernumber;
3332 my $patron = Koha::Patrons->find( $borrowernumber )
3335 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3336 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3338 categorycode => $patron->categorycode,
3339 itemtype => $item->effective_itemtype,
3340 branchcode => $branchcode,
3342 'no_auto_renewal_after',
3343 'no_auto_renewal_after_hard_limit',
3349 return unless $circulation_rules;
3351 if ( not $circulation_rules->{no_auto_renewal_after}
3352 or $circulation_rules->{no_auto_renewal_after} eq '' )
3353 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3354 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3356 my $maximum_renewal_date;
3357 if ( $circulation_rules->{no_auto_renewal_after} ) {
3358 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3359 $maximum_renewal_date->add(
3360 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3364 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3365 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3366 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3368 return $maximum_renewal_date;
3372 =head2 GetIssuingCharges
3374 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3376 Calculate how much it would cost for a given patron to borrow a given
3377 item, including any applicable discounts.
3379 C<$itemnumber> is the item number of item the patron wishes to borrow.
3381 C<$borrowernumber> is the patron's borrower number.
3383 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3384 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3389 sub GetIssuingCharges {
3391 # calculate charges due
3392 my ( $itemnumber, $borrowernumber ) = @_;
3394 my $dbh = C4::Context->dbh;
3397 # Get the book's item type and rental charge (via its biblioitem).
3398 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3399 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3400 $charge_query .= (C4::Context->preference('item-level_itypes'))
3401 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3402 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3404 $charge_query .= ' WHERE items.itemnumber =?';
3406 my $sth = $dbh->prepare($charge_query);
3407 $sth->execute($itemnumber);
3408 if ( my $item_data = $sth->fetchrow_hashref ) {
3409 $item_type = $item_data->{itemtype};
3410 $charge = $item_data->{rentalcharge};
3411 my $branch = C4::Context::mybranch();
3412 my $patron = Koha::Patrons->find( $borrowernumber );
3413 my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3415 # We may have multiple rules so get the most specific
3416 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3419 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3423 return ( $charge, $item_type );
3426 # Select most appropriate discount rule from those returned
3427 sub _get_discount_from_rule {
3428 my ($categorycode, $branchcode, $itemtype) = @_;
3430 # Set search precedences
3433 branchcode => $branchcode,
3434 itemtype => $itemtype,
3435 categorycode => $categorycode,
3438 branchcode => undef,
3439 categorycode => $categorycode,
3440 itemtype => $itemtype,
3443 branchcode => $branchcode,
3444 categorycode => $categorycode,
3448 branchcode => undef,
3449 categorycode => $categorycode,
3454 foreach my $params (@params) {
3455 my $rule = Koha::CirculationRules->search(
3457 rule_name => 'rentaldiscount',
3462 return $rule->rule_value if $rule;
3469 =head2 AddIssuingCharge
3471 &AddIssuingCharge( $checkout, $charge, $type )
3475 sub AddIssuingCharge {
3476 my ( $checkout, $charge, $type ) = @_;
3478 # FIXME What if checkout does not exist?
3480 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3481 my $accountline = $account->add_debit(
3485 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3486 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3487 interface => C4::Context->interface,
3489 item_id => $checkout->itemnumber,
3490 issue_id => $checkout->issue_id,
3497 GetTransfers($itemnumber);
3502 my ($itemnumber) = @_;
3504 my $dbh = C4::Context->dbh;
3511 FROM branchtransfers
3512 WHERE itemnumber = ?
3513 AND datearrived IS NULL
3515 my $sth = $dbh->prepare($query);
3516 $sth->execute($itemnumber);
3517 my @row = $sth->fetchrow_array();
3521 =head2 GetTransfersFromTo
3523 @results = GetTransfersFromTo($frombranch,$tobranch);
3525 Returns the list of pending transfers between $from and $to branch
3529 sub GetTransfersFromTo {
3530 my ( $frombranch, $tobranch ) = @_;
3531 return unless ( $frombranch && $tobranch );
3532 my $dbh = C4::Context->dbh;
3534 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3535 FROM branchtransfers
3538 AND datearrived IS NULL
3540 my $sth = $dbh->prepare($query);
3541 $sth->execute( $frombranch, $tobranch );
3544 while ( my $data = $sth->fetchrow_hashref ) {
3545 push @gettransfers, $data;
3547 return (@gettransfers);
3550 =head2 DeleteTransfer
3552 &DeleteTransfer($itemnumber);
3556 sub DeleteTransfer {
3557 my ($itemnumber) = @_;
3558 return unless $itemnumber;
3559 my $dbh = C4::Context->dbh;
3560 my $sth = $dbh->prepare(
3561 "DELETE FROM branchtransfers
3563 AND datearrived IS NULL "
3565 return $sth->execute($itemnumber);
3568 =head2 SendCirculationAlert
3570 Send out a C<check-in> or C<checkout> alert using the messaging system.
3578 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3582 Hashref of information about the item being checked in or out.
3586 Hashref of information about the borrower of the item.
3590 The branchcode from where the checkout or check-in took place.
3596 SendCirculationAlert({
3599 borrower => $borrower,
3605 sub SendCirculationAlert {
3607 my ($type, $item, $borrower, $branch) =
3608 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3609 my %message_name = (
3610 CHECKIN => 'Item_Check_in',
3611 CHECKOUT => 'Item_Checkout',
3612 RENEWAL => 'Item_Checkout',
3614 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3615 borrowernumber => $borrower->{borrowernumber},
3616 message_name => $message_name{$type},
3618 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3620 my $schema = Koha::Database->new->schema;
3621 my @transports = keys %{ $borrower_preferences->{transports} };
3623 # From the MySQL doc:
3624 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3625 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3626 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3627 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3629 for my $mtt (@transports) {
3630 my $letter = C4::Letters::GetPreparedLetter (
3631 module => 'circulation',
3632 letter_code => $type,
3633 branchcode => $branch,
3634 message_transport_type => $mtt,
3635 lang => $borrower->{lang},
3637 $issues_table => $item->{itemnumber},
3638 'items' => $item->{itemnumber},
3639 'biblio' => $item->{biblionumber},
3640 'biblioitems' => $item->{biblionumber},
3641 'borrowers' => $borrower,
3642 'branches' => $branch,
3646 $schema->storage->txn_begin;
3647 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3648 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3649 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3650 unless ( $message ) {
3651 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3652 C4::Message->enqueue($letter, $borrower, $mtt);
3654 $message->append($letter);
3657 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3658 $schema->storage->txn_commit;
3664 =head2 updateWrongTransfer
3666 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3668 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
3672 sub updateWrongTransfer {
3673 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3674 my $dbh = C4::Context->dbh;
3675 # first step validate the actual line of transfert .
3678 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3680 $sth->execute($FromLibrary,$itemNumber);
3682 # second step create a new line of branchtransfer to the right location .
3683 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3685 #third step changing holdingbranch of item
3686 my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3691 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3693 this function calculates the due date given the start date and configured circulation rules,
3694 checking against the holidays calendar as per the daysmode circulation rule.
3695 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3696 C<$itemtype> = itemtype code of item in question
3697 C<$branch> = location whose calendar to use
3698 C<$borrower> = Borrower object
3699 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3704 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3708 # loanlength now a href
3710 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3712 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3718 if (ref $startdate ne 'DateTime' ) {
3719 $datedue = dt_from_string($datedue);
3721 $datedue = $startdate->clone;
3724 $datedue = dt_from_string()->truncate( to => 'minute' );
3728 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3730 categorycode => $borrower->{categorycode},
3731 itemtype => $itemtype,
3732 branchcode => $branch,
3736 # calculate the datedue as normal
3737 if ( $daysmode eq 'Days' )
3738 { # ignoring calendar
3739 if ( $loanlength->{lengthunit} eq 'hours' ) {
3740 $datedue->add( hours => $loanlength->{$length_key} );
3742 $datedue->add( days => $loanlength->{$length_key} );
3743 $datedue->set_hour(23);
3744 $datedue->set_minute(59);
3748 if ($loanlength->{lengthunit} eq 'hours') {
3749 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3752 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3754 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3755 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3756 if ($loanlength->{lengthunit} eq 'days') {
3757 $datedue->set_hour(23);
3758 $datedue->set_minute(59);
3762 # if Hard Due Dates are used, retrieve them and apply as necessary
3763 my ( $hardduedate, $hardduedatecompare ) =
3764 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3765 if ($hardduedate) { # hardduedates are currently dates
3766 $hardduedate->truncate( to => 'minute' );
3767 $hardduedate->set_hour(23);
3768 $hardduedate->set_minute(59);
3769 my $cmp = DateTime->compare( $hardduedate, $datedue );
3771 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3772 # if the calculated date is before the 'after' Hard Due Date (floor), override
3773 # if the hard due date is set to 'exactly', overrride
3774 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3775 $datedue = $hardduedate->clone;
3778 # in all other cases, keep the date due as it is
3782 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3783 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3784 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3785 if( $expiry_dt ) { #skip empty expiry date..
3786 $expiry_dt->set( hour => 23, minute => 59);
3787 my $d1= $datedue->clone->set_time_zone('floating');
3788 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3789 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3792 if ( $daysmode ne 'Days' ) {
3793 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3794 if ( $calendar->is_holiday($datedue) ) {
3795 # Don't return on a closed day
3796 $datedue = $calendar->prev_open_days( $datedue, 1 );
3805 sub CheckValidBarcode{
3807 my $dbh = C4::Context->dbh;
3808 my $query=qq|SELECT count(*)
3812 my $sth = $dbh->prepare($query);
3813 $sth->execute($barcode);
3814 my $exist=$sth->fetchrow ;
3818 =head2 IsBranchTransferAllowed
3820 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3822 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3824 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3825 Koha::Item->can_be_transferred.
3829 sub IsBranchTransferAllowed {
3830 my ( $toBranch, $fromBranch, $code ) = @_;
3832 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3834 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3835 my $dbh = C4::Context->dbh;
3837 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3838 $sth->execute( $toBranch, $fromBranch, $code );
3839 my $limit = $sth->fetchrow_hashref();
3841 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3842 if ( $limit->{'limitId'} ) {
3849 =head2 CreateBranchTransferLimit
3851 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3853 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3855 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3859 sub CreateBranchTransferLimit {
3860 my ( $toBranch, $fromBranch, $code ) = @_;
3861 return unless defined($toBranch) && defined($fromBranch);
3862 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3864 my $dbh = C4::Context->dbh;
3866 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3867 return $sth->execute( $code, $toBranch, $fromBranch );
3870 =head2 DeleteBranchTransferLimits
3872 my $result = DeleteBranchTransferLimits($frombranch);
3874 Deletes all the library transfer limits for one library. Returns the
3875 number of limits deleted, 0e0 if no limits were deleted, or undef if
3876 no arguments are supplied.
3878 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3879 fromBranch => $fromBranch
3884 sub DeleteBranchTransferLimits {
3886 return unless defined $branch;
3887 my $dbh = C4::Context->dbh;
3888 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3889 return $sth->execute($branch);
3893 my ( $borrowernumber, $itemnum ) = @_;
3894 MarkIssueReturned( $borrowernumber, $itemnum );
3899 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3901 unless ( $mark_lost_from ) {
3902 # Temporary check to avoid regressions
3903 die q|LostItem called without $mark_lost_from, check the API.|;
3907 if ( $force_mark_returned ) {
3910 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3911 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3914 my $dbh = C4::Context->dbh();
3915 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3917 JOIN items USING (itemnumber)
3918 JOIN biblio USING (biblionumber)
3919 WHERE issues.itemnumber=?");
3920 $sth->execute($itemnumber);
3921 my $issues=$sth->fetchrow_hashref();
3923 # If a borrower lost the item, add a replacement cost to the their record
3924 if ( my $borrowernumber = $issues->{borrowernumber} ){
3925 my $patron = Koha::Patrons->find( $borrowernumber );
3927 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3928 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3930 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3931 C4::Accounts::chargelostitem(
3934 $issues->{'replacementprice'},
3935 sprintf( "%s %s %s",
3936 $issues->{'title'} || q{},
3937 $issues->{'barcode'} || q{},
3938 $issues->{'itemcallnumber'} || q{},
3941 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3942 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3945 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3948 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3949 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3950 Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store;
3952 my $transferdeleted = DeleteTransfer($itemnumber);
3955 sub GetOfflineOperations {
3956 my $dbh = C4::Context->dbh;
3957 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3958 $sth->execute(C4::Context->userenv->{'branch'});
3959 my $results = $sth->fetchall_arrayref({});
3963 sub GetOfflineOperation {
3964 my $operationid = shift;
3965 return unless $operationid;
3966 my $dbh = C4::Context->dbh;
3967 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3968 $sth->execute( $operationid );
3969 return $sth->fetchrow_hashref;
3972 sub AddOfflineOperation {
3973 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3974 my $dbh = C4::Context->dbh;
3975 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3976 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3980 sub DeleteOfflineOperation {
3981 my $dbh = C4::Context->dbh;
3982 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3983 $sth->execute( shift );
3987 sub ProcessOfflineOperation {
3988 my $operation = shift;
3991 if ( $operation->{action} eq 'return' ) {
3992 $report = ProcessOfflineReturn( $operation );
3993 } elsif ( $operation->{action} eq 'issue' ) {
3994 $report = ProcessOfflineIssue( $operation );
3995 } elsif ( $operation->{action} eq 'payment' ) {
3996 $report = ProcessOfflinePayment( $operation );
3999 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4004 sub ProcessOfflineReturn {
4005 my $operation = shift;
4007 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4010 my $itemnumber = $item->itemnumber;
4011 my $issue = GetOpenIssue( $itemnumber );
4013 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4014 ModDateLastSeen( $itemnumber, $leave_item_lost );
4016 $issue->{borrowernumber},
4018 $operation->{timestamp},
4021 $item->onloan(undef);
4022 $item->store({ log_action => 0 });
4025 return "Item not issued.";
4028 return "Item not found.";
4032 sub ProcessOfflineIssue {
4033 my $operation = shift;
4035 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4038 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4040 return "Barcode not found.";
4042 my $itemnumber = $item->itemnumber;
4043 my $issue = GetOpenIssue( $itemnumber );
4045 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4047 $issue->{borrowernumber},
4049 $operation->{timestamp},
4054 $operation->{'barcode'},
4057 $operation->{timestamp},
4062 return "Borrower not found.";
4066 sub ProcessOfflinePayment {
4067 my $operation = shift;
4069 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4071 $patron->account->pay(
4073 amount => $operation->{amount},
4074 library_id => $operation->{branchcode},
4084 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4086 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4091 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4095 ? Koha::Items->find($itemnumber)
4096 : Koha::Items->find( { barcode => $barcode } );
4100 return C4::Letters::GetPreparedLetter (
4101 module => 'circulation',
4102 letter_code => 'TRANSFERSLIP',
4103 branchcode => $branch,
4105 'branches' => $to_branch,
4106 'biblio' => $item->biblionumber,
4107 'items' => $item->unblessed,
4112 =head2 CheckIfIssuedToPatron
4114 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4116 Return 1 if any record item is issued to patron, otherwise return 0
4120 sub CheckIfIssuedToPatron {
4121 my ($borrowernumber, $biblionumber) = @_;
4123 my $dbh = C4::Context->dbh;
4125 SELECT COUNT(*) FROM issues
4126 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4127 WHERE items.biblionumber = ?
4128 AND issues.borrowernumber = ?
4130 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4131 return 1 if $is_issued;
4137 IsItemIssued( $itemnumber )
4139 Return 1 if the item is on loan, otherwise return 0
4144 my $itemnumber = shift;
4145 my $dbh = C4::Context->dbh;
4146 my $sth = $dbh->prepare(q{
4149 WHERE itemnumber = ?
4151 $sth->execute($itemnumber);
4152 return $sth->fetchrow;
4155 =head2 GetAgeRestriction
4157 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4158 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4160 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4161 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4163 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4164 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4165 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4166 Negative days mean the borrower has gone past the age restriction age.
4170 sub GetAgeRestriction {
4171 my ($record_restrictions, $borrower) = @_;
4172 my $markers = C4::Context->preference('AgeRestrictionMarker');
4174 return unless $record_restrictions;
4175 # Split $record_restrictions to something like FSK 16 or PEGI 6
4176 my @values = split ' ', uc($record_restrictions);
4177 return unless @values;
4179 # Search first occurrence of one of the markers
4180 my @markers = split /\|/, uc($markers);
4181 return unless @markers;
4184 my $restriction_year = 0;
4185 for my $value (@values) {
4187 for my $marker (@markers) {
4188 $marker =~ s/^\s+//; #remove leading spaces
4189 $marker =~ s/\s+$//; #remove trailing spaces
4190 if ( $marker eq $value ) {
4191 if ( $index <= $#values ) {
4192 $restriction_year += $values[$index];
4196 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4198 # Perhaps it is something like "K16" (as in Finland)
4199 $restriction_year += $1;
4203 last if ( $restriction_year > 0 );
4206 #Check if the borrower is age restricted for this material and for how long.
4207 if ($restriction_year && $borrower) {
4208 if ( $borrower->{'dateofbirth'} ) {
4209 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4210 $alloweddate[0] += $restriction_year;
4212 #Prevent runime eror on leap year (invalid date)
4213 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4214 $alloweddate[2] = 28;
4217 #Get how many days the borrower has to reach the age restriction
4218 my @Today = split /-/, dt_from_string()->ymd();
4219 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4220 #Negative days means the borrower went past the age restriction age
4221 return ($restriction_year, $daysToAgeRestriction);
4225 return ($restriction_year);
4229 =head2 GetPendingOnSiteCheckouts
4233 sub GetPendingOnSiteCheckouts {
4234 my $dbh = C4::Context->dbh;
4235 return $dbh->selectall_arrayref(q|
4241 items.itemcallnumber,
4245 issues.date_due < NOW() AS is_overdue,
4248 borrowers.firstname,
4250 borrowers.cardnumber,
4251 borrowers.borrowernumber
4253 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4254 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4255 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4256 WHERE issues.onsite_checkout = 1
4257 |, { Slice => {} } );
4263 my ($count, $branch, $itemtype, $ccode, $newness)
4264 = @$params{qw(count branch itemtype ccode newness)};
4266 my $dbh = C4::Context->dbh;
4269 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4270 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4271 i.ccode, SUM(i.issues) AS count
4273 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4274 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4277 my (@where_strs, @where_args);
4280 push @where_strs, 'i.homebranch = ?';
4281 push @where_args, $branch;
4284 if (C4::Context->preference('item-level_itypes')){
4285 push @where_strs, 'i.itype = ?';
4286 push @where_args, $itemtype;
4288 push @where_strs, 'bi.itemtype = ?';
4289 push @where_args, $itemtype;
4293 push @where_strs, 'i.ccode = ?';
4294 push @where_args, $ccode;
4297 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4298 push @where_args, $newness;
4302 $query .= 'WHERE ' . join(' AND ', @where_strs);
4306 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4307 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4312 $query .= q{ ) xxx WHERE count > 0 };
4313 $count = int($count);
4315 $query .= "LIMIT $count";
4318 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4323 =head2 Internal methods
4327 sub _CalculateAndUpdateFine {
4330 my $borrower = $params->{borrower};
4331 my $item = $params->{item};
4332 my $issue = $params->{issue};
4333 my $return_date = $params->{return_date};
4335 unless ($borrower) { carp "No borrower passed in!" && return; }
4336 unless ($item) { carp "No item passed in!" && return; }
4337 unless ($issue) { carp "No issue passed in!" && return; }
4339 my $datedue = dt_from_string( $issue->date_due );
4341 # we only need to calculate and change the fines if we want to do that on return
4342 # Should be on for hourly loans
4343 my $control = C4::Context->preference('CircControl');
4344 my $control_branchcode =
4345 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4346 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4347 : $issue->branchcode;
4349 my $date_returned = $return_date ? $return_date : dt_from_string();
4351 my ( $amount, $unitcounttotal, $unitcount ) =
4352 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4354 if ( C4::Context->preference('finesMode') eq 'production' ) {
4355 if ( $amount > 0 ) {
4356 C4::Overdues::UpdateFine({
4357 issue_id => $issue->issue_id,
4358 itemnumber => $issue->itemnumber,
4359 borrowernumber => $issue->borrowernumber,
4361 due => output_pref($datedue),
4364 elsif ($return_date) {
4366 # Backdated returns may have fines that shouldn't exist,
4367 # so in this case, we need to drop those fines to 0
4369 C4::Overdues::UpdateFine({
4370 issue_id => $issue->issue_id,
4371 itemnumber => $issue->itemnumber,
4372 borrowernumber => $issue->borrowernumber,
4374 due => output_pref($datedue),
4380 sub _item_denied_renewal {
4383 my $item = $params->{item};
4384 return unless $item;
4386 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4387 return unless $denyingrules;
4388 foreach my $field (keys %$denyingrules) {
4389 my $val = $item->$field;
4390 if( !defined $val) {
4391 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4394 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4395 # If the results matches the values in the syspref
4396 # We return true if match found
4409 Koha Development Team <http://koha-community.org/>