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 warnings; FIXME - Bug 2505
25 use POSIX qw( floor );
34 use C4::ItemCirculationAlertPreference;
37 use C4::Log; # logaction
38 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
39 use C4::RotatingCollections qw(GetCollectionItemBranches);
40 use Algorithm::CheckDigits;
44 use Koha::AuthorisedValues;
45 use Koha::Biblioitems;
49 use Koha::IssuingRules;
52 use Koha::Patron::Debarments;
55 use Koha::Account::Lines;
57 use Koha::RefundLostItemFeeRule;
58 use Koha::RefundLostItemFeeRules;
59 use Koha::Account::Lines;
60 use Koha::Account::Offsets;
61 use Koha::Config::SysPrefs;
63 use List::MoreUtils qw( uniq any );
64 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($newbranch,
255 $barcode, $ignore_reserves);
257 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
259 C<$newbranch> is the code for the branch to which the item should be transferred.
261 C<$barcode> is the barcode of the item to be transferred.
263 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
264 Otherwise, if an item is reserved, the transfer fails.
266 Returns three values:
272 is true if the transfer was successful.
276 is a reference-to-hash which may have any of the following keys:
282 There is no item in the catalog with the given barcode. The value is C<$barcode>.
284 =item C<DestinationEqualsHolding>
286 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.
290 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.
294 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>.
296 =item C<WasTransferred>
298 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
307 my ( $tbr, $barcode, $ignoreRs ) = @_;
310 my $item = Koha::Items->find( { barcode => $barcode } );
314 $messages->{'BadBarcode'} = $barcode;
318 my $itemnumber = $item->itemnumber;
319 my $issue = GetOpenIssue($itemnumber);
320 # get branches of book...
321 my $hbr = $item->homebranch;
322 my $fbr = $item->holdingbranch;
324 # if using Branch Transfer Limits
325 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
326 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
327 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
328 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
329 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
332 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
333 $messages->{'NotAllowed'} = $tbr . "::" . $code;
338 # can't transfer book if is already there....
339 if ( $fbr eq $tbr ) {
340 $messages->{'DestinationEqualsHolding'} = 1;
344 # check if it is still issued to someone, return it...
346 AddReturn( $barcode, $fbr );
347 $messages->{'WasReturned'} = $issue->borrowernumber;
351 # That'll save a database query.
352 my ( $resfound, $resrec, undef ) =
353 CheckReserves( $itemnumber );
354 if ( $resfound and not $ignoreRs ) {
355 $resrec->{'ResFound'} = $resfound;
357 # $messages->{'ResFound'} = $resrec;
361 #actually do the transfer....
363 ModItemTransfer( $itemnumber, $fbr, $tbr );
365 # don't need to update MARC anymore, we do it in batch now
366 $messages->{'WasTransfered'} = 1;
369 ModDateLastSeen( $itemnumber );
370 return ( $dotransfer, $messages );
375 my $borrower = shift;
376 my $biblionumber = shift;
379 my $onsite_checkout = $params->{onsite_checkout} || 0;
380 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
381 my $cat_borrower = $borrower->{'categorycode'};
382 my $dbh = C4::Context->dbh;
384 # Get which branchcode we need
385 $branch = _GetCircControlBranch($item,$borrower);
386 my $type = (C4::Context->preference('item-level_itypes'))
387 ? $item->{'itype'} # item-level
388 : $item->{'itemtype'}; # biblio-level
390 # given branch, patron category, and item type, determine
391 # applicable issuing rule
392 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
393 { categorycode => $cat_borrower,
395 branchcode => $branch
400 # if a rule is found and has a loan limit set, count
401 # how many loans the patron already has that meet that
403 if (defined($issuing_rule) and defined($issuing_rule->maxissueqty)) {
406 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
408 JOIN items USING (itemnumber)
411 my $rule_itemtype = $issuing_rule->itemtype;
412 if ($rule_itemtype eq "*") {
413 # matching rule has the default item type, so count only
414 # those existing loans that don't fall under a more
416 if (C4::Context->preference('item-level_itypes')) {
417 $count_query .= " WHERE items.itype NOT IN (
418 SELECT itemtype FROM issuingrules
420 AND (categorycode = ? OR categorycode = ?)
424 $count_query .= " JOIN biblioitems USING (biblionumber)
425 WHERE biblioitems.itemtype NOT IN (
426 SELECT itemtype FROM issuingrules
428 AND (categorycode = ? OR categorycode = ?)
432 push @bind_params, $issuing_rule->branchcode;
433 push @bind_params, $issuing_rule->categorycode;
434 push @bind_params, $cat_borrower;
436 # rule has specific item type, so count loans of that
438 if (C4::Context->preference('item-level_itypes')) {
439 $count_query .= " WHERE items.itype = ? ";
441 $count_query .= " JOIN biblioitems USING (biblionumber)
442 WHERE biblioitems.itemtype= ? ";
444 push @bind_params, $type;
447 $count_query .= " AND borrowernumber = ? ";
448 push @bind_params, $borrower->{'borrowernumber'};
449 my $rule_branch = $issuing_rule->branchcode;
450 if ($rule_branch ne "*") {
451 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
452 $count_query .= " AND issues.branchcode = ? ";
453 push @bind_params, $branch;
454 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
455 ; # if branch is the patron's home branch, then count all loans by patron
457 $count_query .= " AND items.homebranch = ? ";
458 push @bind_params, $branch;
462 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
464 my $max_checkouts_allowed = $issuing_rule->maxissueqty;
465 my $max_onsite_checkouts_allowed = $issuing_rule->maxonsiteissueqty;
467 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
468 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
470 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
471 count => $onsite_checkout_count,
472 max_allowed => $max_onsite_checkouts_allowed,
476 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
477 my $delta = $switch_onsite_checkout ? 1 : 0;
478 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
480 reason => 'TOO_MANY_CHECKOUTS',
481 count => $checkout_count,
482 max_allowed => $max_checkouts_allowed,
485 } elsif ( not $onsite_checkout ) {
486 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
488 reason => 'TOO_MANY_CHECKOUTS',
489 count => $checkout_count - $onsite_checkout_count,
490 max_allowed => $max_checkouts_allowed,
496 # Now count total loans against the limit for the branch
497 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
498 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
499 my @bind_params = ();
500 my $branch_count_query = q|
501 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
503 JOIN items USING (itemnumber)
504 WHERE borrowernumber = ?
506 push @bind_params, $borrower->{borrowernumber};
508 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
509 $branch_count_query .= " AND issues.branchcode = ? ";
510 push @bind_params, $branch;
511 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
512 ; # if branch is the patron's home branch, then count all loans by patron
514 $branch_count_query .= " AND items.homebranch = ? ";
515 push @bind_params, $branch;
517 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
518 my $max_checkouts_allowed = $branch_borrower_circ_rule->{maxissueqty};
519 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{maxonsiteissueqty};
521 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
522 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
524 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
525 count => $onsite_checkout_count,
526 max_allowed => $max_onsite_checkouts_allowed,
530 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
531 my $delta = $switch_onsite_checkout ? 1 : 0;
532 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
534 reason => 'TOO_MANY_CHECKOUTS',
535 count => $checkout_count,
536 max_allowed => $max_checkouts_allowed,
539 } elsif ( not $onsite_checkout ) {
540 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
542 reason => 'TOO_MANY_CHECKOUTS',
543 count => $checkout_count - $onsite_checkout_count,
544 max_allowed => $max_checkouts_allowed,
550 if ( not defined( $issuing_rule ) and not defined($branch_borrower_circ_rule->{maxissueqty}) ) {
551 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
554 # OK, the patron can issue !!!
558 =head2 CanBookBeIssued
560 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
561 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
563 Check if a book can be issued.
565 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
567 IMPORTANT: The assumption by users of this routine is that causes blocking
568 the issue are keyed by uppercase labels and other returned
569 data is keyed in lower case!
573 =item C<$patron> is a Koha::Patron
575 =item C<$barcode> is the bar code of the book being issued.
577 =item C<$duedates> is a DateTime object.
579 =item C<$inprocess> boolean switch
581 =item C<$ignore_reserves> boolean switch
583 =item C<$params> Hashref of additional parameters
586 override_high_holds - Ignore high holds
587 onsite_checkout - Checkout is an onsite checkout that will not leave the library
595 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
596 Possible values are :
602 sticky due date is invalid
606 borrower gone with no address
610 borrower declared it's card lost
616 =head3 UNKNOWN_BARCODE
630 item is restricted (set by ??)
632 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
633 could be prevented, but ones that can be overriden by the operator.
635 Possible values are :
643 renewing, not issuing
645 =head3 ISSUED_TO_ANOTHER
647 issued to someone else.
651 reserved for someone else.
655 sticky due date is invalid or due date in the past
659 if the borrower borrows to much things
663 sub CanBookBeIssued {
664 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
665 my %needsconfirmation; # filled with problems that needs confirmations
666 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
667 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
668 my %messages; # filled with information messages that should be displayed.
670 my $onsite_checkout = $params->{onsite_checkout} || 0;
671 my $override_high_holds = $params->{override_high_holds} || 0;
673 my $item = GetItem(undef, $barcode );
674 # MANDATORY CHECKS - unless item exists, nothing else matters
676 $issuingimpossible{UNKNOWN_BARCODE} = 1;
678 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
680 my $issue = Koha::Checkouts->find( { itemnumber => $item->{itemnumber} } );
681 my $biblio = Koha::Biblios->find( $item->{biblionumber} );
682 my $biblioitem = $biblio->biblioitem;
683 my $effective_itemtype = $item->{itype}; # GetItem deals with that
684 my $dbh = C4::Context->dbh;
685 my $patron_unblessed = $patron->unblessed;
688 # DUE DATE is OK ? -- should already have checked.
690 if ($duedate && ref $duedate ne 'DateTime') {
691 $duedate = dt_from_string($duedate);
693 my $now = DateTime->now( time_zone => C4::Context->tz() );
694 unless ( $duedate ) {
695 my $issuedate = $now->clone();
697 my $branch = _GetCircControlBranch($item, $patron_unblessed);
698 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $branch, $patron_unblessed );
700 # Offline circ calls AddIssue directly, doesn't run through here
701 # So issuingimpossible should be ok.
704 my $today = $now->clone();
705 $today->truncate( to => 'minute');
706 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
707 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
710 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
716 if ( $patron->category->category_type eq 'X' && ( $item->{barcode} )) {
717 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
719 branch => C4::Context->userenv->{'branch'},
721 itemnumber => $item->{'itemnumber'},
722 itemtype => $effective_itemtype,
723 borrowernumber => $patron->borrowernumber,
724 ccode => $item->{'ccode'}}
726 ModDateLastSeen( $item->{'itemnumber'} );
727 return( { STATS => 1 }, {});
730 if ( $patron->gonenoaddress == 1 ) {
731 $issuingimpossible{GNA} = 1;
734 if ( $patron->lost == 1 ) {
735 $issuingimpossible{CARD_LOST} = 1;
737 if ( $patron->is_debarred ) {
738 $issuingimpossible{DEBARRED} = 1;
741 if ( $patron->is_expired ) {
742 $issuingimpossible{EXPIRED} = 1;
750 my $account = $patron->account;
751 my $balance = $account->balance;
752 my $non_issues_charges = $account->non_issues_charges;
753 my $other_charges = $balance - $non_issues_charges;
755 my $amountlimit = C4::Context->preference("noissuescharge");
756 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
757 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
759 # Check the debt of this patrons guarantees
760 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
761 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
762 if ( defined $no_issues_charge_guarantees ) {
763 my @guarantees = $patron->guarantees();
764 my $guarantees_non_issues_charges;
765 foreach my $g ( @guarantees ) {
766 $guarantees_non_issues_charges += $g->account->non_issues_charges;
769 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
770 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
771 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
772 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
773 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
774 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
778 if ( C4::Context->preference("IssuingInProcess") ) {
779 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
780 $issuingimpossible{DEBT} = $non_issues_charges;
781 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
782 $needsconfirmation{DEBT} = $non_issues_charges;
783 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
784 $needsconfirmation{DEBT} = $non_issues_charges;
788 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
789 $needsconfirmation{DEBT} = $non_issues_charges;
790 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
791 $issuingimpossible{DEBT} = $non_issues_charges;
792 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
793 $needsconfirmation{DEBT} = $non_issues_charges;
797 if ($balance > 0 && $other_charges > 0) {
798 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
801 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
802 $patron_unblessed = $patron->unblessed;
804 if ( my $debarred_date = $patron->is_debarred ) {
805 # patron has accrued fine days or has a restriction. $count is a date
806 if ($debarred_date eq '9999-12-31') {
807 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
810 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
812 } elsif ( my $num_overdues = $patron->has_overdues ) {
813 ## patron has outstanding overdue loans
814 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
815 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
817 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
818 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
823 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
825 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
827 # Already issued to current borrower.
828 # If it is an on-site checkout if it can be switched to a normal checkout
829 # or ask whether the loan should be renewed
831 if ( $issue->onsite_checkout
832 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
833 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
835 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
836 $patron->borrowernumber,
837 $item->{'itemnumber'},
839 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
840 if ( $renewerror eq 'onsite_checkout' ) {
841 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
844 $issuingimpossible{NO_MORE_RENEWALS} = 1;
848 $needsconfirmation{RENEW_ISSUE} = 1;
854 # issued to someone else
856 my $patron = Koha::Patrons->find( $issue->borrowernumber );
858 my ( $can_be_returned, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
860 unless ( $can_be_returned ) {
861 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
862 $issuingimpossible{branch_to_return} = $message;
864 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
865 $needsconfirmation{issued_firstname} = $patron->firstname;
866 $needsconfirmation{issued_surname} = $patron->surname;
867 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
868 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
872 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
874 my $switch_onsite_checkout = (
875 C4::Context->preference('SwitchOnSiteCheckouts')
877 and $issue->onsite_checkout
878 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
879 my $toomany = TooMany( $patron_unblessed, $item->{biblionumber}, $item, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
880 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
881 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
882 if ( $toomany->{max_allowed} == 0 ) {
883 $needsconfirmation{PATRON_CANT} = 1;
885 if ( C4::Context->preference("AllowTooManyOverride") ) {
886 $needsconfirmation{TOO_MANY} = $toomany->{reason};
887 $needsconfirmation{current_loan_count} = $toomany->{count};
888 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
890 $issuingimpossible{TOO_MANY} = $toomany->{reason};
891 $issuingimpossible{current_loan_count} = $toomany->{count};
892 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
897 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
899 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
900 my $wants_check = $patron->wants_check_for_previous_checkout;
901 $needsconfirmation{PREVISSUE} = 1
902 if ($wants_check and $patron->do_check_for_previous_checkout($item));
907 if ( $item->{'notforloan'} )
909 if(!C4::Context->preference("AllowNotForLoanOverride")){
910 $issuingimpossible{NOT_FOR_LOAN} = 1;
911 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
913 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
914 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
918 # we have to check itemtypes.notforloan also
919 if (C4::Context->preference('item-level_itypes')){
920 # this should probably be a subroutine
921 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
922 $sth->execute($effective_itemtype);
923 my $notforloan=$sth->fetchrow_hashref();
924 if ($notforloan->{'notforloan'}) {
925 if (!C4::Context->preference("AllowNotForLoanOverride")) {
926 $issuingimpossible{NOT_FOR_LOAN} = 1;
927 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
929 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
930 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
935 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
936 if ( $itemtype and $itemtype->notforloan == 1){
937 if (!C4::Context->preference("AllowNotForLoanOverride")) {
938 $issuingimpossible{NOT_FOR_LOAN} = 1;
939 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
941 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
942 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
947 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
949 $issuingimpossible{WTHDRAWN} = 1;
951 if ( $item->{'restricted'}
952 && $item->{'restricted'} == 1 )
954 $issuingimpossible{RESTRICTED} = 1;
956 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
957 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->{itemlost} });
958 my $code = $av->count ? $av->next->lib : '';
959 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
960 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
962 if ( C4::Context->preference("IndependentBranches") ) {
963 my $userenv = C4::Context->userenv;
964 unless ( C4::Context->IsSuperLibrarian() ) {
965 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
966 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
967 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
969 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
970 if ( $patron->branchcode ne $userenv->{branch} );
974 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
976 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
978 if ( $rentalConfirmation ){
979 my ($rentalCharge) = GetIssuingCharges( $item->{'itemnumber'}, $patron->borrowernumber );
980 if ( $rentalCharge > 0 ){
981 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
985 unless ( $ignore_reserves ) {
986 # See if the item is on reserve.
987 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
989 my $resbor = $res->{'borrowernumber'};
990 if ( $resbor ne $patron->borrowernumber ) {
991 my $patron = Koha::Patrons->find( $resbor );
992 if ( $restype eq "Waiting" )
994 # The item is on reserve and waiting, but has been
995 # reserved by some other patron.
996 $needsconfirmation{RESERVE_WAITING} = 1;
997 $needsconfirmation{'resfirstname'} = $patron->firstname;
998 $needsconfirmation{'ressurname'} = $patron->surname;
999 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1000 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1001 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1002 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1004 elsif ( $restype eq "Reserved" ) {
1005 # The item is on reserve for someone else.
1006 $needsconfirmation{RESERVED} = 1;
1007 $needsconfirmation{'resfirstname'} = $patron->firstname;
1008 $needsconfirmation{'ressurname'} = $patron->surname;
1009 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1010 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1011 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1012 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1018 ## CHECK AGE RESTRICTION
1019 my $agerestriction = $biblioitem->agerestriction;
1020 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1021 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1022 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1023 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1026 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1030 ## check for high holds decreasing loan period
1031 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1032 my $check = checkHighHolds( $item, $patron_unblessed );
1034 if ( $check->{exceeded} ) {
1035 if ($override_high_holds) {
1036 $alerts{HIGHHOLDS} = {
1037 num_holds => $check->{outstanding},
1038 duration => $check->{duration},
1039 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1043 $needsconfirmation{HIGHHOLDS} = {
1044 num_holds => $check->{outstanding},
1045 duration => $check->{duration},
1046 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1053 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1054 # don't do the multiple loans per bib check if we've
1055 # already determined that we've got a loan on the same item
1056 !$issuingimpossible{NO_MORE_RENEWALS} &&
1057 !$needsconfirmation{RENEW_ISSUE}
1059 # Check if borrower has already issued an item from the same biblio
1060 # Only if it's not a subscription
1061 my $biblionumber = $item->{biblionumber};
1062 require C4::Serials;
1063 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1064 unless ($is_a_subscription) {
1065 # FIXME Should be $patron->checkouts($args);
1066 my $checkouts = Koha::Checkouts->search(
1068 borrowernumber => $patron->borrowernumber,
1069 biblionumber => $biblionumber,
1075 # if we get here, we don't already have a loan on this item,
1076 # so if there are any loans on this bib, ask for confirmation
1077 if ( $checkouts->count ) {
1078 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1083 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1086 =head2 CanBookBeReturned
1088 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1090 Check whether the item can be returned to the provided branch
1094 =item C<$item> is a hash of item information as returned from GetItem
1096 =item C<$branch> is the branchcode where the return is taking place
1104 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1106 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1112 sub CanBookBeReturned {
1113 my ($item, $branch) = @_;
1114 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1116 # assume return is allowed to start
1120 # identify all cases where return is forbidden
1121 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1123 $message = $item->{'homebranch'};
1124 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1126 $message = $item->{'holdingbranch'};
1127 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1129 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1132 return ($allowed, $message);
1135 =head2 CheckHighHolds
1137 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1138 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1139 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1143 sub checkHighHolds {
1144 my ( $item, $borrower ) = @_;
1145 my $branch = _GetCircControlBranch( $item, $borrower );
1146 my $item_object = Koha::Items->find( $item->{itemnumber} );
1155 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1157 if ( $holds->count() ) {
1158 $return_data->{outstanding} = $holds->count();
1160 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1161 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1162 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1164 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1166 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1168 # static means just more than a given number of holds on the record
1170 # If the number of holds is less than the threshold, we can stop here
1171 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1172 return $return_data;
1175 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1177 # dynamic means X more than the number of holdable items on the record
1179 # let's get the items
1180 my @items = $holds->next()->biblio()->items();
1182 # Remove any items with status defined to be ignored even if the would not make item unholdable
1183 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1184 @items = grep { !$_->$status } @items;
1187 # Remove any items that are not holdable for this patron
1188 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber )->{status} eq 'OK' } @items;
1190 my $items_count = scalar @items;
1192 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1194 # If the number of holds is less than the count of items we have
1195 # plus the number of holds allowed above that count, we can stop here
1196 if ( $holds->count() <= $threshold ) {
1197 return $return_data;
1201 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1203 my $calendar = Koha::Calendar->new( branchcode => $branch );
1205 my $itype = $item_object->effective_itemtype;
1206 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1208 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1210 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1211 $reduced_datedue->set_hour($orig_due->hour);
1212 $reduced_datedue->set_minute($orig_due->minute);
1213 $reduced_datedue->truncate( to => 'minute' );
1215 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1216 $return_data->{exceeded} = 1;
1217 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1218 $return_data->{due_date} = $reduced_datedue;
1222 return $return_data;
1227 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1229 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1233 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1235 =item C<$barcode> is the barcode of the item being issued.
1237 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1238 Calculated if empty.
1240 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1242 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1243 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1245 AddIssue does the following things :
1247 - step 01: check that there is a borrowernumber & a barcode provided
1248 - check for RENEWAL (book issued & being issued to the same patron)
1249 - renewal YES = Calculate Charge & renew
1251 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1253 - fill reserve if reserve to this patron
1254 - cancel reserve or not, otherwise
1255 * TRANSFERT PENDING ?
1256 - complete the transfert
1264 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1266 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1267 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1268 my $auto_renew = $params && $params->{auto_renew};
1269 my $dbh = C4::Context->dbh;
1270 my $barcodecheck = CheckValidBarcode($barcode);
1274 if ( $datedue && ref $datedue ne 'DateTime' ) {
1275 $datedue = dt_from_string($datedue);
1278 # $issuedate defaults to today.
1279 if ( !defined $issuedate ) {
1280 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1283 if ( ref $issuedate ne 'DateTime' ) {
1284 $issuedate = dt_from_string($issuedate);
1289 # Stop here if the patron or barcode doesn't exist
1290 if ( $borrower && $barcode && $barcodecheck ) {
1291 # find which item we issue
1292 my $item = GetItem( '', $barcode )
1293 or return; # if we don't get an Item, abort.
1294 my $item_object = Koha::Items->find( { barcode => $barcode } );
1296 my $branch = _GetCircControlBranch( $item, $borrower );
1298 # get actual issuing if there is one
1299 my $actualissue = Koha::Checkouts->find( { itemnumber => $item->{itemnumber} } );
1301 # check if we just renew the issue.
1302 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1303 and not $switch_onsite_checkout ) {
1304 $datedue = AddRenewal(
1305 $borrower->{'borrowernumber'},
1306 $item->{'itemnumber'},
1309 $issuedate, # here interpreted as the renewal date
1313 # it's NOT a renewal
1314 if ( $actualissue and not $switch_onsite_checkout ) {
1315 # This book is currently on loan, but not to the person
1316 # who wants to borrow it now. mark it returned before issuing to the new borrower
1317 my ( $allowed, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
1318 return unless $allowed;
1319 AddReturn( $item->{'barcode'}, C4::Context->userenv->{'branch'} );
1322 C4::Reserves::MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1324 # Starting process for transfer job (checking transfert and validate it if we have one)
1325 my ($datesent) = GetTransfers( $item->{'itemnumber'} );
1327 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1328 my $sth = $dbh->prepare(
1329 "UPDATE branchtransfers
1330 SET datearrived = now(),
1332 comments = 'Forced branchtransfer'
1333 WHERE itemnumber= ? AND datearrived IS NULL"
1335 $sth->execute( C4::Context->userenv->{'branch'},
1336 $item->{'itemnumber'} );
1339 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1340 unless ($auto_renew) {
1341 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1342 { categorycode => $borrower->{categorycode},
1343 itemtype => $item->{itype},
1344 branchcode => $branch
1348 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1351 # Record in the database the fact that the book was issued.
1353 my $itype = $item_object->effective_itemtype;
1354 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1357 $datedue->truncate( to => 'minute' );
1359 $issue = Koha::Database->new()->schema()->resultset('Issue')->update_or_create(
1361 borrowernumber => $borrower->{'borrowernumber'},
1362 itemnumber => $item->{'itemnumber'},
1363 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1364 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1365 branchcode => C4::Context->userenv->{'branch'},
1366 onsite_checkout => $onsite_checkout,
1367 auto_renew => $auto_renew ? 1 : 0
1371 if ( C4::Context->preference('ReturnToShelvingCart') ) {
1372 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1373 CartToShelf( $item->{'itemnumber'} );
1375 $item->{'issues'}++;
1376 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1377 UpdateTotalIssues( $item->{'biblionumber'}, 1 );
1380 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1381 if ( $item->{'itemlost'} ) {
1383 Koha::RefundLostItemFeeRules->should_refund(
1385 current_branch => C4::Context->userenv->{branch},
1386 item_home_branch => $item->{homebranch},
1387 item_holding_branch => $item->{holdingbranch}
1392 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef,
1393 $item->{'barcode'} );
1399 issues => $item->{'issues'},
1400 holdingbranch => C4::Context->userenv->{'branch'},
1402 onloan => $datedue->ymd(),
1403 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1405 $item->{'biblionumber'},
1406 $item->{'itemnumber'},
1409 ModDateLastSeen( $item->{'itemnumber'} );
1411 # If it costs to borrow this book, charge it to the patron's account.
1412 my ( $charge, $itemtype ) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1413 if ( $charge > 0 ) {
1414 AddIssuingCharge( $issue, $charge );
1415 $item->{'charge'} = $charge;
1418 # Record the fact that this book was issued.
1421 branch => C4::Context->userenv->{'branch'},
1422 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1424 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1425 itemnumber => $item->{'itemnumber'},
1426 itemtype => $item->{'itype'},
1427 location => $item->{location},
1428 borrowernumber => $borrower->{'borrowernumber'},
1429 ccode => $item->{'ccode'}
1433 # Send a checkout slip.
1434 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1436 branchcode => $branch,
1437 categorycode => $borrower->{categorycode},
1438 item_type => $item->{itype},
1439 notification => 'CHECKOUT',
1441 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1442 SendCirculationAlert(
1446 borrower => $borrower,
1452 "CIRCULATION", "ISSUE",
1453 $borrower->{'borrowernumber'},
1454 $item->{'itemnumber'}
1455 ) if C4::Context->preference("IssueLog");
1461 =head2 GetLoanLength
1463 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1465 Get loan length for an itemtype, a borrower type and a branch
1470 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1471 my $dbh = C4::Context->dbh;
1472 my $sth = $dbh->prepare(qq{
1473 SELECT issuelength, lengthunit, renewalperiod
1475 WHERE categorycode=?
1478 AND issuelength IS NOT NULL
1481 # try to find issuelength & return the 1st available.
1482 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1483 $sth->execute( $borrowertype, $itemtype, $branchcode );
1484 my $loanlength = $sth->fetchrow_hashref;
1487 if defined($loanlength) && defined $loanlength->{issuelength};
1489 $sth->execute( $borrowertype, '*', $branchcode );
1490 $loanlength = $sth->fetchrow_hashref;
1492 if defined($loanlength) && defined $loanlength->{issuelength};
1494 $sth->execute( '*', $itemtype, $branchcode );
1495 $loanlength = $sth->fetchrow_hashref;
1497 if defined($loanlength) && defined $loanlength->{issuelength};
1499 $sth->execute( '*', '*', $branchcode );
1500 $loanlength = $sth->fetchrow_hashref;
1502 if defined($loanlength) && defined $loanlength->{issuelength};
1504 $sth->execute( $borrowertype, $itemtype, '*' );
1505 $loanlength = $sth->fetchrow_hashref;
1507 if defined($loanlength) && defined $loanlength->{issuelength};
1509 $sth->execute( $borrowertype, '*', '*' );
1510 $loanlength = $sth->fetchrow_hashref;
1512 if defined($loanlength) && defined $loanlength->{issuelength};
1514 $sth->execute( '*', $itemtype, '*' );
1515 $loanlength = $sth->fetchrow_hashref;
1517 if defined($loanlength) && defined $loanlength->{issuelength};
1519 $sth->execute( '*', '*', '*' );
1520 $loanlength = $sth->fetchrow_hashref;
1522 if defined($loanlength) && defined $loanlength->{issuelength};
1524 # if no rule is set => 0 day (hardcoded)
1528 lengthunit => 'days',
1534 =head2 GetHardDueDate
1536 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1538 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1542 sub GetHardDueDate {
1543 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1545 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1546 { categorycode => $borrowertype,
1547 itemtype => $itemtype,
1548 branchcode => $branchcode
1553 if ( defined( $issuing_rule ) ) {
1554 if ( $issuing_rule->hardduedate ) {
1555 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1557 return (undef, undef);
1562 =head2 GetBranchBorrowerCircRule
1564 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1566 Retrieves circulation rule attributes that apply to the given
1567 branch and patron category, regardless of item type.
1568 The return value is a hashref containing the following key:
1570 maxissueqty - maximum number of loans that a
1571 patron of the given category can have at the given
1572 branch. If the value is undef, no limit.
1574 maxonsiteissueqty - maximum of on-site checkouts that a
1575 patron of the given category can have at the given
1576 branch. If the value is undef, no limit.
1578 This will first check for a specific branch and
1579 category match from branch_borrower_circ_rules.
1581 If no rule is found, it will then check default_branch_circ_rules
1582 (same branch, default category). If no rule is found,
1583 it will then check default_borrower_circ_rules (default
1584 branch, same category), then failing that, default_circ_rules
1585 (default branch, default category).
1587 If no rule has been found in the database, it will default to
1591 maxonsiteissueqty - undef
1593 C<$branchcode> and C<$categorycode> should contain the
1594 literal branch code and patron category code, respectively - no
1599 sub GetBranchBorrowerCircRule {
1600 my ( $branchcode, $categorycode ) = @_;
1603 my $dbh = C4::Context->dbh();
1604 $rules = $dbh->selectrow_hashref( q|
1605 SELECT maxissueqty, maxonsiteissueqty
1606 FROM branch_borrower_circ_rules
1607 WHERE branchcode = ?
1608 AND categorycode = ?
1609 |, {}, $branchcode, $categorycode ) ;
1610 return $rules if $rules;
1612 # try same branch, default borrower category
1613 $rules = $dbh->selectrow_hashref( q|
1614 SELECT maxissueqty, maxonsiteissueqty
1615 FROM default_branch_circ_rules
1616 WHERE branchcode = ?
1617 |, {}, $branchcode ) ;
1618 return $rules if $rules;
1620 # try default branch, same borrower category
1621 $rules = $dbh->selectrow_hashref( q|
1622 SELECT maxissueqty, maxonsiteissueqty
1623 FROM default_borrower_circ_rules
1624 WHERE categorycode = ?
1625 |, {}, $categorycode ) ;
1626 return $rules if $rules;
1628 # try default branch, default borrower category
1629 $rules = $dbh->selectrow_hashref( q|
1630 SELECT maxissueqty, maxonsiteissueqty
1631 FROM default_circ_rules
1633 return $rules if $rules;
1635 # built-in default circulation rule
1637 maxissueqty => undef,
1638 maxonsiteissueqty => undef,
1642 =head2 GetBranchItemRule
1644 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1646 Retrieves circulation rule attributes that apply to the given
1647 branch and item type, regardless of patron category.
1649 The return value is a hashref containing the following keys:
1651 holdallowed => Hold policy for this branch and itemtype. Possible values:
1652 0: No holds allowed.
1653 1: Holds allowed only by patrons that have the same homebranch as the item.
1654 2: Holds allowed from any patron.
1656 returnbranch => branch to which to return item. Possible values:
1657 noreturn: do not return, let item remain where checked in (floating collections)
1658 homebranch: return to item's home branch
1659 holdingbranch: return to issuer branch
1661 This searches branchitemrules in the following order:
1663 * Same branchcode and itemtype
1664 * Same branchcode, itemtype '*'
1665 * branchcode '*', same itemtype
1666 * branchcode and itemtype '*'
1668 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1672 sub GetBranchItemRule {
1673 my ( $branchcode, $itemtype ) = @_;
1674 my $dbh = C4::Context->dbh();
1678 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1679 FROM branch_item_rules
1680 WHERE branchcode = ?
1681 AND itemtype = ?', $branchcode, $itemtype],
1682 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1683 FROM default_branch_circ_rules
1684 WHERE branchcode = ?', $branchcode],
1685 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1686 FROM default_branch_item_rules
1687 WHERE itemtype = ?', $itemtype],
1688 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1689 FROM default_circ_rules'],
1692 foreach my $attempt (@attempts) {
1693 my ($query, @bind_params) = @{$attempt};
1694 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1697 # Since branch/category and branch/itemtype use the same per-branch
1698 # defaults tables, we have to check that the key we want is set, not
1699 # just that a row was returned
1700 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1701 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1702 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1705 # built-in default circulation rule
1706 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1707 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1708 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1715 ($doreturn, $messages, $iteminformation, $borrower) =
1716 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1722 =item C<$barcode> is the bar code of the book being returned.
1724 =item C<$branch> is the code of the branch where the book is being returned.
1726 =item C<$exemptfine> indicates that overdue charges for the item will be
1729 =item C<$dropbox> indicates that the check-in date is assumed to be
1730 yesterday, or the last non-holiday as defined in C4::Calendar . If
1731 overdue charges are applied and C<$dropbox> is true, the last charge
1732 will be removed. This assumes that the fines accrual script has run
1733 for _today_. Optional.
1735 =item C<$return_date> allows the default return date to be overridden
1736 by the given return date. Optional.
1740 C<&AddReturn> returns a list of four items:
1742 C<$doreturn> is true iff the return succeeded.
1744 C<$messages> is a reference-to-hash giving feedback on the operation.
1745 The keys of the hash are:
1751 No item with this barcode exists. The value is C<$barcode>.
1755 The book is not currently on loan. The value is C<$barcode>.
1759 This book has been withdrawn/cancelled. The value should be ignored.
1761 =item C<Wrongbranch>
1763 This book has was returned to the wrong branch. The value is a hashref
1764 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1765 contain the branchcode of the incorrect and correct return library, respectively.
1769 The item was reserved. The value is a reference-to-hash whose keys are
1770 fields from the reserves table of the Koha database, and
1771 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1772 either C<Waiting>, C<Reserved>, or 0.
1774 =item C<WasReturned>
1776 Value 1 if return is successful.
1778 =item C<NeedsTransfer>
1780 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1784 C<$iteminformation> is a reference-to-hash, giving information about the
1785 returned item from the issues table.
1787 C<$borrower> is a reference-to-hash, giving information about the
1788 patron who last borrowed the book.
1793 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1795 if ($branch and not Koha::Libraries->find($branch)) {
1796 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1799 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1803 my $validTransfert = 0;
1804 my $stat_type = 'return';
1806 # get information on item
1807 my $item = GetItem( undef, $barcode );
1809 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1812 my $itemnumber = $item->{ itemnumber };
1813 my $itemtype = $item->{itype}; # GetItem called effective_itemtype
1815 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
1817 $patron = Koha::Patrons->find( $issue->borrowernumber )
1818 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1819 . Dumper($issue->unblessed) . "\n";
1821 $messages->{'NotIssued'} = $barcode;
1822 ModItem({ onloan => undef }, $item->{biblionumber}, $item->{itemnumber}) if defined $item->{onloan};
1823 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1825 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1826 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1827 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1828 $messages->{'LocalUse'} = 1;
1829 $stat_type = 'localuse';
1833 if ( $item->{'location'} eq 'PROC' ) {
1834 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1835 $item->{'location'} = 'CART';
1838 $item->{location} = $item->{permanent_location};
1841 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'}, { log_action => 0 } );
1844 # full item data, but no borrowernumber or checkout info (no issue)
1845 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1846 # get the proper branch to which to return the item
1847 my $returnbranch = $item->{$hbr} || $branch ;
1848 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1850 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1851 my $patron_unblessed = $patron ? $patron->unblessed : {};
1853 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1855 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1857 eval { $rules = YAML::Load($yaml); };
1859 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1862 foreach my $key ( keys %$rules ) {
1863 if ( $item->{notforloan} eq $key ) {
1864 $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1865 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1872 # check if the return is allowed at this branch
1873 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1874 unless ($returnallowed){
1875 $messages->{'Wrongbranch'} = {
1876 Wrongbranch => $branch,
1877 Rightbranch => $message
1880 return ( $doreturn, $messages, $issue, $patron_unblessed);
1883 if ( $item->{'withdrawn'} ) { # book has been cancelled
1884 $messages->{'withdrawn'} = 1;
1885 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1888 if ( $item->{itemlost} and C4::Context->preference("BlockReturnOfLostItems") ) {
1892 # case of a return of document (deal with issues and holdingbranch)
1893 my $today = DateTime->now( time_zone => C4::Context->tz() );
1897 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1898 $patron or warn "AddReturn without current borrower";
1899 my $circControlBranch;
1901 # define circControlBranch only if dropbox mode is set
1902 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1903 # FIXME: check issuedate > returndate, factoring in holidays
1905 $circControlBranch = _GetCircControlBranch($item,$patron_unblessed);
1906 $is_overdue = $issue->is_overdue( $dropboxdate );
1908 $is_overdue = $issue->is_overdue;
1913 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1914 $circControlBranch, $return_date, $patron->privacy );
1917 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1918 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed, return_date => $return_date } );
1921 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 );
1923 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1926 # FIXME is the "= 1" right? This could be the borrower hash.
1927 $messages->{'WasReturned'} = 1;
1931 ModItem( { onloan => undef }, $item->{biblionumber}, $item->{itemnumber}, { log_action => 0 } );
1934 # the holdingbranch is updated if the document is returned to another location.
1935 # this is always done regardless of whether the item was on loan or not
1936 my $item_holding_branch = $item->{ holdingbranch };
1937 if ($item->{'holdingbranch'} ne $branch) {
1938 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1939 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1942 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1943 ModDateLastSeen( $item->{itemnumber}, $leave_item_lost );
1945 # check if we have a transfer for this document
1946 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1948 # if we have a transfer to do, we update the line of transfers with the datearrived
1949 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1951 if ( $tobranch eq $branch ) {
1952 my $sth = C4::Context->dbh->prepare(
1953 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1955 $sth->execute( $item->{'itemnumber'} );
1956 # if we have a reservation with valid transfer, we can set it's status to 'W'
1957 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1958 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1960 $messages->{'WrongTransfer'} = $tobranch;
1961 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1963 $validTransfert = 1;
1965 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1968 # fix up the accounts.....
1969 if ( $item->{'itemlost'} ) {
1970 $messages->{'WasLost'} = 1;
1971 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
1973 Koha::RefundLostItemFeeRules->should_refund(
1975 current_branch => C4::Context->userenv->{branch},
1976 item_home_branch => $item->{homebranch},
1977 item_holding_branch => $item_holding_branch
1982 _FixAccountForLostAndReturned( $item->{'itemnumber'},
1983 $borrowernumber, $barcode );
1984 $messages->{'LostItemFeeRefunded'} = 1;
1989 # fix up the overdues in accounts...
1990 if ($borrowernumber) {
1991 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1992 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1994 if ( $issue and $issue->is_overdue ) {
1996 $today = dt_from_string($return_date) if $return_date;
1997 $today = $dropboxdate if $dropbox;
1998 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item, dt_from_string($issue->date_due), $today );
2000 $messages->{'PrevDebarred'} = $debardate;
2002 $messages->{'Debarred'} = $debardate if $debardate;
2004 # there's no overdue on the item but borrower had been previously debarred
2005 } elsif ( $issue->date_due and $patron->debarred ) {
2006 if ( $patron->debarred eq "9999-12-31") {
2007 $messages->{'ForeverDebarred'} = $patron->debarred;
2009 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2010 $borrower_debar_dt->truncate(to => 'day');
2011 my $today_dt = $today->clone()->truncate(to => 'day');
2012 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2013 $messages->{'PrevDebarred'} = $patron->debarred;
2019 # find reserves.....
2020 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2021 my ($resfound, $resrec);
2022 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2023 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2025 $resrec->{'ResFound'} = $resfound;
2026 $messages->{'ResFound'} = $resrec;
2029 # Record the fact that this book was returned.
2033 itemnumber => $itemnumber,
2034 itemtype => $itemtype,
2035 borrowernumber => $borrowernumber,
2036 ccode => $item->{ ccode }
2039 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2041 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2043 branchcode => $branch,
2044 categorycode => $patron->categorycode,
2045 item_type => $item->{itype},
2046 notification => 'CHECKIN',
2048 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2049 SendCirculationAlert({
2052 borrower => $patron->unblessed,
2057 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2058 if C4::Context->preference("ReturnLog");
2061 # Remove any OVERDUES related debarment if the borrower has no overdues
2062 if ( $borrowernumber
2063 && $patron->debarred
2064 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2065 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2066 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2068 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2071 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2072 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2073 if (C4::Context->preference("AutomaticItemReturn" ) or
2074 (C4::Context->preference("UseBranchTransferLimits") and
2075 ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2077 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2078 $debug and warn "item: " . Dumper($item);
2079 ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2080 $messages->{'WasTransfered'} = 1;
2082 $messages->{'NeedsTransfer'} = $returnbranch;
2086 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2089 =head2 MarkIssueReturned
2091 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2093 Unconditionally marks an issue as being returned by
2094 moving the C<issues> row to C<old_issues> and
2095 setting C<returndate> to the current date, or
2096 the last non-holiday date of the branccode specified in
2097 C<dropbox_branch> . Assumes you've already checked that
2098 it's safe to do this, i.e. last non-holiday > issuedate.
2100 if C<$returndate> is specified (in iso format), it is used as the date
2101 of the return. It is ignored when a dropbox_branch is passed in.
2103 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2104 the old_issue is immediately anonymised
2106 Ideally, this function would be internal to C<C4::Circulation>,
2107 not exported, but it is currently needed by one
2108 routine in C<C4::Accounts>.
2112 sub MarkIssueReturned {
2113 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2116 # Retrieve the issue
2117 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2118 my $issue_id = $issue->issue_id;
2120 my $anonymouspatron;
2121 if ( $privacy == 2 ) {
2122 # The default of 0 will not work due to foreign key constraints
2123 # The anonymisation will fail if AnonymousPatron is not a valid entry
2124 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2125 # Note that a warning should appear on the about page (System information tab).
2126 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2127 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."
2128 unless Koha::Patrons->find( $anonymouspatron );
2130 my $database = Koha::Database->new();
2131 my $schema = $database->schema;
2132 my $dbh = C4::Context->dbh;
2134 my $query = 'UPDATE issues SET returndate=';
2136 if ($dropbox_branch) {
2137 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2138 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2140 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2141 } elsif ($returndate) {
2143 push @bind, $returndate;
2145 $query .= ' now() ';
2147 $query .= ' WHERE issue_id = ?';
2148 push @bind, $issue_id;
2150 # FIXME Improve the return value and handle it from callers
2151 $schema->txn_do(sub {
2153 # Update the returndate
2154 $dbh->do( $query, undef, @bind );
2156 # We just updated the returndate, so we need to refetch $issue
2157 $issue->discard_changes;
2159 # Create the old_issues entry
2160 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2162 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2163 if ( $privacy == 2) {
2164 $dbh->do(q|UPDATE old_issues SET borrowernumber=? WHERE issue_id = ?|, undef, $anonymouspatron, $old_checkout->issue_id);
2167 # And finally delete the issue
2170 ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2172 if ( C4::Context->preference('StoreLastBorrower') ) {
2173 my $item = Koha::Items->find( $itemnumber );
2174 my $patron = Koha::Patrons->find( $borrowernumber );
2175 $item->last_returned_by( $patron );
2182 =head2 _debar_user_on_return
2184 _debar_user_on_return($borrower, $item, $datedue, today);
2186 C<$borrower> borrower hashref
2188 C<$item> item hashref
2190 C<$datedue> date due DateTime object
2192 C<$return_date> DateTime object representing the return time
2194 Internal function, called only by AddReturn that calculates and updates
2195 the user fine days, and debars them if necessary.
2197 Should only be called for overdue returns
2201 sub _debar_user_on_return {
2202 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2204 my $branchcode = _GetCircControlBranch( $item, $borrower );
2206 my $circcontrol = C4::Context->preference('CircControl');
2207 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2208 { categorycode => $borrower->{categorycode},
2209 itemtype => $item->{itype},
2210 branchcode => $branchcode
2213 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2214 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2215 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2219 # finedays is in days, so hourly loans must multiply by 24
2220 # thus 1 hour late equals 1 day suspension * finedays rate
2221 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2223 # grace period is measured in the same units as the loan
2225 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2227 my $deltadays = DateTime::Duration->new(
2228 days => $chargeable_units
2230 if ( $deltadays->subtract($grace)->is_positive() ) {
2231 my $suspension_days = $deltadays * $finedays;
2233 # If the max suspension days is < than the suspension days
2234 # the suspension days is limited to this maximum period.
2235 my $max_sd = $issuing_rule->maxsuspensiondays;
2236 if ( defined $max_sd ) {
2237 $max_sd = DateTime::Duration->new( days => $max_sd );
2238 $suspension_days = $max_sd
2239 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2242 my ( $has_been_extended, $is_a_reminder );
2243 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2244 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2246 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2247 $has_been_extended = 1;
2251 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2252 # No need to / 1 and do not consider / 0
2253 $suspension_days = DateTime::Duration->new(
2254 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2259 # Use the calendar or not to calculate the debarment date
2260 if ( C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed' ) {
2261 my $calendar = Koha::Calendar->new(
2262 branchcode => $branchcode,
2263 days_mode => 'Calendar'
2265 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2268 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2271 Koha::Patron::Debarments::AddUniqueDebarment({
2272 borrowernumber => $borrower->{borrowernumber},
2273 expiration => $new_debar_dt->ymd(),
2274 type => 'SUSPENSION',
2276 # if borrower was already debarred but does not get an extra debarment
2277 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2278 my $new_debarment_str;
2279 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2281 $new_debarment_str = $borrower->{debarred};
2283 $new_debarment_str = $new_debar_dt->ymd();
2285 # FIXME Should return a DateTime object
2286 return $new_debarment_str, $is_a_reminder;
2292 =head2 _FixOverduesOnReturn
2294 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2296 C<$brn> borrowernumber
2300 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2301 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2307 sub _FixOverduesOnReturn {
2308 my ($borrowernumber, $item, $exemptfine, $dropbox ) = @_;
2309 unless( $borrowernumber ) {
2310 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2314 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2318 # check for overdue fine
2319 my $accountline = Koha::Account::Lines->search(
2321 borrowernumber => $borrowernumber,
2322 itemnumber => $item,
2324 accounttype => 'FU',
2329 return 0 unless $accountline; # no warning, there's just nothing to fix
2332 my $amountoutstanding = $accountline->amountoutstanding;
2334 $accountline->accounttype('FFOR');
2335 $accountline->amountoutstanding(0);
2337 Koha::Account::Offset->new(
2339 debit_id => $accountline->id,
2341 amount => $amountoutstanding * -1,
2345 if (C4::Context->preference("FinesLog")) {
2346 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2348 } elsif ($dropbox && $accountline->lastincrement) {
2349 my $outstanding = $accountline->amountoutstanding - $accountline->lastincrement;
2350 my $amt = $accountline->amount - $accountline->lastincrement;
2352 Koha::Account::Offset->new(
2354 debit_id => $accountline->id,
2356 amount => $accountline->lastincrement * -1,
2360 if ( C4::Context->preference("FinesLog") ) {
2361 &logaction( "FINES", 'MODIFY', $borrowernumber,
2362 "Dropbox adjustment $amt, item $item" );
2365 $accountline->accounttype('F');
2367 if ( $outstanding >= 0 && $amt >= 0 ) {
2368 $accountline->amount($amt);
2369 $accountline->amountoutstanding($outstanding);
2373 $accountline->accounttype('F');
2376 return $accountline->store();
2379 =head2 _FixAccountForLostAndReturned
2381 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2383 Calculates the charge for a book lost and returned.
2385 Internal function, not exported, called only by AddReturn.
2389 sub _FixAccountForLostAndReturned {
2390 my $itemnumber = shift or return;
2391 my $borrowernumber = @_ ? shift : undef;
2392 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2396 # check for charge made for lost book
2397 my $accountlines = Koha::Account::Lines->search(
2399 itemnumber => $itemnumber,
2400 accounttype => { -in => [ 'L', 'Rep', 'W' ] },
2403 order_by => { -desc => [ 'date', 'accountno' ] }
2407 return unless $accountlines->count > 0;
2408 my $accountline = $accountlines->next;
2409 my $total_to_refund = 0;
2410 my $account = Koha::Patrons->find( $accountline->borrowernumber )->account;
2413 if ( $accountline->amount > $accountline->amountoutstanding ) {
2414 # some amount has been cancelled. collect the offsets that are not writeoffs
2415 # this works because the only way to subtract from this kind of a debt is
2416 # using the UI buttons 'Pay' and 'Write off'
2417 my $credits_offsets = Koha::Account::Offsets->search({
2418 debit_id => $accountline->id,
2419 credit_id => { '!=' => undef }, # it is not the debit itself
2420 type => { '!=' => 'Writeoff' },
2421 amount => { '<' => 0 } # credits are negative on the DB
2424 $total_to_refund = ( $credits_offsets->count > 0 )
2425 ? $credits_offsets->total * -1 # credits are negative on the DB
2429 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2431 if ( $credit_total > 0 ) {
2432 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2433 $credit = $account->add_credit(
2434 { amount => $credit_total,
2435 description => 'Item Returned ' . $item_id,
2436 type => 'lost_item_return',
2437 library_id => $branchcode
2441 # TODO: ->apply should just accept the accountline
2442 $credit->apply( { debits => $accountlines->reset } );
2445 # Manually set the accounttype
2446 $accountline->discard_changes->accounttype('LR');
2447 $accountline->store;
2449 ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2451 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2452 $account->reconcile_balance;
2455 return ($credit) ? $credit->id : undef;
2458 =head2 _GetCircControlBranch
2460 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2464 Return the library code to be used to determine which circulation
2465 policy applies to a transaction. Looks up the CircControl and
2466 HomeOrHoldingBranch system preferences.
2468 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2470 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2474 sub _GetCircControlBranch {
2475 my ($item, $borrower) = @_;
2476 my $circcontrol = C4::Context->preference('CircControl');
2479 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2480 $branch= C4::Context->userenv->{'branch'};
2481 } elsif ($circcontrol eq 'PatronLibrary') {
2482 $branch=$borrower->{branchcode};
2484 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2485 $branch = $item->{$branchfield};
2486 # default to item home branch if holdingbranch is used
2487 # and is not defined
2488 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2489 $branch = $item->{homebranch};
2497 $issue = GetOpenIssue( $itemnumber );
2499 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2501 C<$itemnumber> is the item's itemnumber
2508 my ( $itemnumber ) = @_;
2509 return unless $itemnumber;
2510 my $dbh = C4::Context->dbh;
2511 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2512 $sth->execute( $itemnumber );
2513 return $sth->fetchrow_hashref();
2517 =head2 GetBiblioIssues
2519 $issues = GetBiblioIssues($biblionumber);
2521 this function get all issues from a biblionumber.
2524 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2525 tables issues and the firstname,surname & cardnumber from borrowers.
2529 sub GetBiblioIssues {
2530 my $biblionumber = shift;
2531 return unless $biblionumber;
2532 my $dbh = C4::Context->dbh;
2534 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2536 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2537 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2538 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2539 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2540 WHERE biblio.biblionumber = ?
2542 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2544 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2545 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2546 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2547 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2548 WHERE biblio.biblionumber = ?
2551 my $sth = $dbh->prepare($query);
2552 $sth->execute($biblionumber, $biblionumber);
2555 while ( my $data = $sth->fetchrow_hashref ) {
2556 push @issues, $data;
2561 =head2 GetUpcomingDueIssues
2563 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2567 sub GetUpcomingDueIssues {
2570 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2571 my $dbh = C4::Context->dbh;
2573 my $statement = <<END_SQL;
2576 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2578 LEFT JOIN items USING (itemnumber)
2579 LEFT OUTER JOIN branches USING (branchcode)
2580 WHERE returndate is NULL
2582 WHERE days_until_due >= 0 AND days_until_due <= ?
2585 my @bind_parameters = ( $params->{'days_in_advance'} );
2587 my $sth = $dbh->prepare( $statement );
2588 $sth->execute( @bind_parameters );
2589 my $upcoming_dues = $sth->fetchall_arrayref({});
2591 return $upcoming_dues;
2594 =head2 CanBookBeRenewed
2596 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2598 Find out whether a borrowed item may be renewed.
2600 C<$borrowernumber> is the borrower number of the patron who currently
2601 has the item on loan.
2603 C<$itemnumber> is the number of the item to renew.
2605 C<$override_limit>, if supplied with a true value, causes
2606 the limit on the number of times that the loan can be renewed
2607 (as controlled by the item type) to be ignored. Overriding also allows
2608 to renew sooner than "No renewal before" and to manually renew loans
2609 that are automatically renewed.
2611 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2612 item must currently be on loan to the specified borrower; renewals
2613 must be allowed for the item's type; and the borrower must not have
2614 already renewed the loan. $error will contain the reason the renewal can not proceed
2618 sub CanBookBeRenewed {
2619 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2621 my $dbh = C4::Context->dbh;
2624 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2625 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return ( 0, 'no_checkout' );
2626 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2627 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2630 $borrowernumber ||= $issue->borrowernumber;
2631 my $patron = Koha::Patrons->find( $borrowernumber )
2634 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2636 # This item can fill one or more unfilled reserve, can those unfilled reserves
2637 # all be filled by other available items?
2639 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2641 my $schema = Koha::Database->new()->schema();
2643 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2645 # There is an item level hold on this item, no other item can fill the hold
2650 # Get all other items that could possibly fill reserves
2651 my @itemnumbers = $schema->resultset('Item')->search(
2653 biblionumber => $resrec->{biblionumber},
2656 -not => { itemnumber => $itemnumber }
2658 { columns => 'itemnumber' }
2659 )->get_column('itemnumber')->all();
2661 # Get all other reserves that could have been filled by this item
2662 my @borrowernumbers;
2664 my ( $reserve_found, $reserve, undef ) =
2665 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2667 if ($reserve_found) {
2668 push( @borrowernumbers, $reserve->{borrowernumber} );
2675 # If the count of the union of the lists of reservable items for each borrower
2676 # is equal or greater than the number of borrowers, we know that all reserves
2677 # can be filled with available items. We can get the union of the sets simply
2678 # by pushing all the elements onto an array and removing the duplicates.
2681 ITEM: foreach my $i (@itemnumbers) {
2682 my $item = GetItem($i);
2683 next if IsItemOnHoldAndFound($i);
2684 for my $b (@borrowernumbers) {
2685 my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2686 next unless IsAvailableForItemLevelRequest($item, $borr);
2687 next unless CanItemBeReserved($b,$i);
2689 push @reservable, $i;
2690 if (@reservable >= @borrowernumbers) {
2699 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2701 return ( 1, undef ) if $override_limit;
2703 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2704 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2705 { categorycode => $patron->categorycode,
2706 itemtype => $item->{itype},
2707 branchcode => $branchcode
2711 return ( 0, "too_many" )
2712 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2714 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2715 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2716 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2717 my $restricted = $patron->is_debarred;
2718 my $hasoverdues = $patron->has_overdues;
2720 if ( $restricted and $restrictionblockrenewing ) {
2721 return ( 0, 'restriction');
2722 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2723 return ( 0, 'overdue');
2726 if ( $issue->auto_renew ) {
2728 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2729 return ( 0, 'auto_account_expired' );
2732 if ( defined $issuing_rule->no_auto_renewal_after
2733 and $issuing_rule->no_auto_renewal_after ne "" ) {
2734 # Get issue_date and add no_auto_renewal_after
2735 # If this is greater than today, it's too late for renewal.
2736 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2737 $maximum_renewal_date->add(
2738 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2740 my $now = dt_from_string;
2741 if ( $now >= $maximum_renewal_date ) {
2742 return ( 0, "auto_too_late" );
2745 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2746 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2747 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2748 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2749 return ( 0, "auto_too_late" );
2753 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2754 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2755 my $amountoutstanding = $patron->account->balance;
2756 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2757 return ( 0, "auto_too_much_oweing" );
2762 if ( defined $issuing_rule->norenewalbefore
2763 and $issuing_rule->norenewalbefore ne "" )
2766 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2767 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2768 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2770 # Depending on syspref reset the exact time, only check the date
2771 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2772 and $issuing_rule->lengthunit eq 'days' )
2774 $soonestrenewal->truncate( to => 'day' );
2777 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2779 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2780 return ( 0, "too_soon" );
2782 elsif ( $issue->auto_renew ) {
2783 return ( 0, "auto_renew" );
2787 # Fallback for automatic renewals:
2788 # If norenewalbefore is undef, don't renew before due date.
2789 if ( $issue->auto_renew ) {
2790 my $now = dt_from_string;
2791 return ( 0, "auto_renew" )
2792 if $now >= dt_from_string( $issue->date_due, 'sql' );
2793 return ( 0, "auto_too_soon" );
2796 return ( 1, undef );
2801 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2805 C<$borrowernumber> is the borrower number of the patron who currently
2808 C<$itemnumber> is the number of the item to renew.
2810 C<$branch> is the library where the renewal took place (if any).
2811 The library that controls the circ policies for the renewal is retrieved from the issues record.
2813 C<$datedue> can be a DateTime object used to set the due date.
2815 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2816 this parameter is not supplied, lastreneweddate is set to the current date.
2818 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2819 from the book's item type.
2824 my $borrowernumber = shift;
2825 my $itemnumber = shift or return;
2827 my $datedue = shift;
2828 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2830 my $item = GetItem($itemnumber) or return;
2831 my $item_object = Koha::Items->find( $itemnumber ); # Should replace $item
2832 my $biblio = $item_object->biblio;
2834 my $dbh = C4::Context->dbh;
2836 # Find the issues record for this book
2837 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
2839 return unless $issue;
2841 $borrowernumber ||= $issue->borrowernumber;
2843 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2844 carp 'Invalid date passed to AddRenewal.';
2848 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2849 my $patron_unblessed = $patron->unblessed;
2851 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2852 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed } );
2854 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2856 # If the due date wasn't specified, calculate it by adding the
2857 # book's loan length to today's date or the current due date
2858 # based on the value of the RenewalPeriodBase syspref.
2861 my $itemtype = $item_object->effective_itemtype;
2862 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2863 dt_from_string( $issue->date_due, 'sql' ) :
2864 DateTime->now( time_zone => C4::Context->tz());
2865 $datedue = CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $patron_unblessed), $patron_unblessed, 'is a renewal');
2868 # Update the issues record to have the new due date, and a new count
2869 # of how many times it has been renewed.
2870 my $renews = $issue->renewals + 1;
2871 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2872 WHERE borrowernumber=?
2876 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2878 # Update the renewal count on the item, and tell zebra to reindex
2879 $renews = $item->{renewals} + 1;
2880 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item->{biblionumber}, $itemnumber, { log_action => 0 } );
2882 # Charge a new rental fee, if applicable?
2883 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2884 if ( $charge > 0 ) {
2885 my $accountno = C4::Accounts::getnextacctno( $borrowernumber );
2887 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2888 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2889 Koha::Account::Line->new(
2891 date => dt_from_string(),
2892 borrowernumber => $borrowernumber,
2893 accountno => $accountno,
2895 manager_id => $manager_id,
2896 accounttype => 'Rent',
2897 amountoutstanding => $charge,
2898 itemnumber => $itemnumber,
2899 branchcode => $branchcode,
2900 description => 'Renewal of Rental Item '
2902 . " $item->{'barcode'}",
2907 # Send a renewal slip according to checkout alert preferencei
2908 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2909 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2911 branchcode => $branch,
2912 categorycode => $patron->categorycode,
2913 item_type => $item->{itype},
2914 notification => 'CHECKOUT',
2916 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2917 SendCirculationAlert(
2921 borrower => $patron->unblessed,
2928 # Remove any OVERDUES related debarment if the borrower has no overdues
2930 && $patron->is_debarred
2931 && ! $patron->has_overdues
2932 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2934 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2937 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2938 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2941 # Add the renewal to stats
2947 itemnumber => $itemnumber,
2948 itemtype => $item->{itype},
2949 location => $item->{location},
2950 borrowernumber => $borrowernumber,
2951 ccode => $item->{'ccode'}
2956 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2961 # check renewal status
2962 my ( $bornum, $itemno ) = @_;
2963 my $dbh = C4::Context->dbh;
2965 my $renewsallowed = 0;
2968 my $patron = Koha::Patrons->find( $bornum );
2969 my $item = GetItem($itemno);
2971 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2973 # Look in the issues table for this item, lent to this borrower,
2974 # and not yet returned.
2976 # FIXME - I think this function could be redone to use only one SQL call.
2977 my $sth = $dbh->prepare(
2978 "select * from issues
2979 where (borrowernumber = ?)
2980 and (itemnumber = ?)"
2982 $sth->execute( $bornum, $itemno );
2983 my $data = $sth->fetchrow_hashref;
2984 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2985 # $item and $borrower should be calculated
2986 my $branchcode = _GetCircControlBranch($item, $patron->unblessed);
2988 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2989 { categorycode => $patron->categorycode,
2990 itemtype => $item->{itype},
2991 branchcode => $branchcode
2995 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
2996 $renewsleft = $renewsallowed - $renewcount;
2997 if($renewsleft < 0){ $renewsleft = 0; }
2998 return ( $renewcount, $renewsallowed, $renewsleft );
3001 =head2 GetSoonestRenewDate
3003 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3005 Find out the soonest possible renew date of a borrowed item.
3007 C<$borrowernumber> is the borrower number of the patron who currently
3008 has the item on loan.
3010 C<$itemnumber> is the number of the item to renew.
3012 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3013 renew date, based on the value "No renewal before" of the applicable
3014 issuing rule. Returns the current date if the item can already be
3015 renewed, and returns undefined if the borrower, loan, or item
3020 sub GetSoonestRenewDate {
3021 my ( $borrowernumber, $itemnumber ) = @_;
3023 my $dbh = C4::Context->dbh;
3025 my $item = GetItem($itemnumber) or return;
3026 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3028 $borrowernumber ||= $itemissue->borrowernumber;
3029 my $patron = Koha::Patrons->find( $borrowernumber )
3032 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3033 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3034 { categorycode => $patron->categorycode,
3035 itemtype => $item->{itype},
3036 branchcode => $branchcode
3040 my $now = dt_from_string;
3041 return $now unless $issuing_rule;
3043 if ( defined $issuing_rule->norenewalbefore
3044 and $issuing_rule->norenewalbefore ne "" )
3046 my $soonestrenewal =
3047 dt_from_string( $itemissue->date_due )->subtract(
3048 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3050 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3051 and $issuing_rule->lengthunit eq 'days' )
3053 $soonestrenewal->truncate( to => 'day' );
3055 return $soonestrenewal if $now < $soonestrenewal;
3060 =head2 GetLatestAutoRenewDate
3062 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3064 Find out the latest possible auto renew date of a borrowed item.
3066 C<$borrowernumber> is the borrower number of the patron who currently
3067 has the item on loan.
3069 C<$itemnumber> is the number of the item to renew.
3071 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3072 auto renew date, based on the value "No auto renewal after" and the "No auto
3073 renewal after (hard limit) of the applicable issuing rule.
3074 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3075 or item cannot be found.
3079 sub GetLatestAutoRenewDate {
3080 my ( $borrowernumber, $itemnumber ) = @_;
3082 my $dbh = C4::Context->dbh;
3084 my $item = GetItem($itemnumber) or return;
3085 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3087 $borrowernumber ||= $itemissue->borrowernumber;
3088 my $patron = Koha::Patrons->find( $borrowernumber )
3091 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3092 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3093 { categorycode => $patron->categorycode,
3094 itemtype => $item->{itype},
3095 branchcode => $branchcode
3099 return unless $issuing_rule;
3101 if ( not $issuing_rule->no_auto_renewal_after
3102 or $issuing_rule->no_auto_renewal_after eq '' )
3103 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3104 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3106 my $maximum_renewal_date;
3107 if ( $issuing_rule->no_auto_renewal_after ) {
3108 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3109 $maximum_renewal_date->add(
3110 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3114 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3115 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3116 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3118 return $maximum_renewal_date;
3122 =head2 GetIssuingCharges
3124 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3126 Calculate how much it would cost for a given patron to borrow a given
3127 item, including any applicable discounts.
3129 C<$itemnumber> is the item number of item the patron wishes to borrow.
3131 C<$borrowernumber> is the patron's borrower number.
3133 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3134 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3139 sub GetIssuingCharges {
3141 # calculate charges due
3142 my ( $itemnumber, $borrowernumber ) = @_;
3144 my $dbh = C4::Context->dbh;
3147 # Get the book's item type and rental charge (via its biblioitem).
3148 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3149 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3150 $charge_query .= (C4::Context->preference('item-level_itypes'))
3151 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3152 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3154 $charge_query .= ' WHERE items.itemnumber =?';
3156 my $sth = $dbh->prepare($charge_query);
3157 $sth->execute($itemnumber);
3158 if ( my $item_data = $sth->fetchrow_hashref ) {
3159 $item_type = $item_data->{itemtype};
3160 $charge = $item_data->{rentalcharge};
3161 my $branch = C4::Context::mybranch();
3162 my $discount_query = q|SELECT rentaldiscount,
3163 issuingrules.itemtype, issuingrules.branchcode
3165 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3166 WHERE borrowers.borrowernumber = ?
3167 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3168 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3169 my $discount_sth = $dbh->prepare($discount_query);
3170 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3171 my $discount_rules = $discount_sth->fetchall_arrayref({});
3172 if (@{$discount_rules}) {
3173 # We may have multiple rules so get the most specific
3174 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3175 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3178 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3182 return ( $charge, $item_type );
3185 # Select most appropriate discount rule from those returned
3186 sub _get_discount_from_rule {
3187 my ($rules_ref, $branch, $itemtype) = @_;
3190 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3191 $discount = $rules_ref->[0]->{rentaldiscount};
3192 return (defined $discount) ? $discount : 0;
3194 # could have up to 4 does one match $branch and $itemtype
3195 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3197 $discount = $d[0]->{rentaldiscount};
3198 return (defined $discount) ? $discount : 0;
3200 # do we have item type + all branches
3201 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3203 $discount = $d[0]->{rentaldiscount};
3204 return (defined $discount) ? $discount : 0;
3206 # do we all item types + this branch
3207 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3209 $discount = $d[0]->{rentaldiscount};
3210 return (defined $discount) ? $discount : 0;
3212 # so all and all (surely we wont get here)
3213 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3215 $discount = $d[0]->{rentaldiscount};
3216 return (defined $discount) ? $discount : 0;
3222 =head2 AddIssuingCharge
3224 &AddIssuingCharge( $checkout, $charge )
3228 sub AddIssuingCharge {
3229 my ( $checkout, $charge ) = @_;
3231 # FIXME What if checkout does not exist?
3233 my $nextaccntno = C4::Accounts::getnextacctno( $checkout->borrowernumber );
3236 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3238 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
3240 my $accountline = Koha::Account::Line->new(
3242 borrowernumber => $checkout->borrowernumber,
3243 itemnumber => $checkout->itemnumber,
3244 issue_id => $checkout->issue_id,
3245 accountno => $nextaccntno,
3247 amountoutstanding => $charge,
3248 manager_id => $manager_id,
3249 branchcode => $branchcode,
3250 description => 'Rental',
3251 accounttype => 'Rent',
3256 Koha::Account::Offset->new(
3258 debit_id => $accountline->id,
3259 type => 'Rental Fee',
3267 GetTransfers($itemnumber);
3272 my ($itemnumber) = @_;
3274 my $dbh = C4::Context->dbh;
3281 FROM branchtransfers
3282 WHERE itemnumber = ?
3283 AND datearrived IS NULL
3285 my $sth = $dbh->prepare($query);
3286 $sth->execute($itemnumber);
3287 my @row = $sth->fetchrow_array();
3291 =head2 GetTransfersFromTo
3293 @results = GetTransfersFromTo($frombranch,$tobranch);
3295 Returns the list of pending transfers between $from and $to branch
3299 sub GetTransfersFromTo {
3300 my ( $frombranch, $tobranch ) = @_;
3301 return unless ( $frombranch && $tobranch );
3302 my $dbh = C4::Context->dbh;
3304 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3305 FROM branchtransfers
3308 AND datearrived IS NULL
3310 my $sth = $dbh->prepare($query);
3311 $sth->execute( $frombranch, $tobranch );
3314 while ( my $data = $sth->fetchrow_hashref ) {
3315 push @gettransfers, $data;
3317 return (@gettransfers);
3320 =head2 DeleteTransfer
3322 &DeleteTransfer($itemnumber);
3326 sub DeleteTransfer {
3327 my ($itemnumber) = @_;
3328 return unless $itemnumber;
3329 my $dbh = C4::Context->dbh;
3330 my $sth = $dbh->prepare(
3331 "DELETE FROM branchtransfers
3333 AND datearrived IS NULL "
3335 return $sth->execute($itemnumber);
3338 =head2 SendCirculationAlert
3340 Send out a C<check-in> or C<checkout> alert using the messaging system.
3348 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3352 Hashref of information about the item being checked in or out.
3356 Hashref of information about the borrower of the item.
3360 The branchcode from where the checkout or check-in took place.
3366 SendCirculationAlert({
3369 borrower => $borrower,
3375 sub SendCirculationAlert {
3377 my ($type, $item, $borrower, $branch) =
3378 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3379 my %message_name = (
3380 CHECKIN => 'Item_Check_in',
3381 CHECKOUT => 'Item_Checkout',
3382 RENEWAL => 'Item_Checkout',
3384 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3385 borrowernumber => $borrower->{borrowernumber},
3386 message_name => $message_name{$type},
3388 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3390 my $schema = Koha::Database->new->schema;
3391 my @transports = keys %{ $borrower_preferences->{transports} };
3393 # From the MySQL doc:
3394 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3395 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3396 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3397 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3399 for my $mtt (@transports) {
3400 my $letter = C4::Letters::GetPreparedLetter (
3401 module => 'circulation',
3402 letter_code => $type,
3403 branchcode => $branch,
3404 message_transport_type => $mtt,
3405 lang => $borrower->{lang},
3407 $issues_table => $item->{itemnumber},
3408 'items' => $item->{itemnumber},
3409 'biblio' => $item->{biblionumber},
3410 'biblioitems' => $item->{biblionumber},
3411 'borrowers' => $borrower,
3412 'branches' => $branch,
3416 $schema->storage->txn_begin;
3417 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3418 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3419 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3420 unless ( $message ) {
3421 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3422 C4::Message->enqueue($letter, $borrower, $mtt);
3424 $message->append($letter);
3427 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3428 $schema->storage->txn_commit;
3434 =head2 updateWrongTransfer
3436 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3438 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
3442 sub updateWrongTransfer {
3443 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3444 my $dbh = C4::Context->dbh;
3445 # first step validate the actual line of transfert .
3448 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3450 $sth->execute($FromLibrary,$itemNumber);
3452 # second step create a new line of branchtransfer to the right location .
3453 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3455 #third step changing holdingbranch of item
3456 UpdateHoldingbranch($FromLibrary,$itemNumber);
3459 =head2 UpdateHoldingbranch
3461 $items = UpdateHoldingbranch($branch,$itmenumber);
3463 Simple methode for updating hodlingbranch in items BDD line
3467 sub UpdateHoldingbranch {
3468 my ( $branch,$itemnumber ) = @_;
3469 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3474 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3476 this function calculates the due date given the start date and configured circulation rules,
3477 checking against the holidays calendar as per the 'useDaysMode' syspref.
3478 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3479 C<$itemtype> = itemtype code of item in question
3480 C<$branch> = location whose calendar to use
3481 C<$borrower> = Borrower object
3482 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3487 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3491 # loanlength now a href
3493 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3495 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3501 if (ref $startdate ne 'DateTime' ) {
3502 $datedue = dt_from_string($datedue);
3504 $datedue = $startdate->clone;
3508 DateTime->now( time_zone => C4::Context->tz() )
3509 ->truncate( to => 'minute' );
3513 # calculate the datedue as normal
3514 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3515 { # ignoring calendar
3516 if ( $loanlength->{lengthunit} eq 'hours' ) {
3517 $datedue->add( hours => $loanlength->{$length_key} );
3519 $datedue->add( days => $loanlength->{$length_key} );
3520 $datedue->set_hour(23);
3521 $datedue->set_minute(59);
3525 if ($loanlength->{lengthunit} eq 'hours') {
3526 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3529 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3531 my $calendar = Koha::Calendar->new( branchcode => $branch );
3532 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3533 if ($loanlength->{lengthunit} eq 'days') {
3534 $datedue->set_hour(23);
3535 $datedue->set_minute(59);
3539 # if Hard Due Dates are used, retrieve them and apply as necessary
3540 my ( $hardduedate, $hardduedatecompare ) =
3541 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3542 if ($hardduedate) { # hardduedates are currently dates
3543 $hardduedate->truncate( to => 'minute' );
3544 $hardduedate->set_hour(23);
3545 $hardduedate->set_minute(59);
3546 my $cmp = DateTime->compare( $hardduedate, $datedue );
3548 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3549 # if the calculated date is before the 'after' Hard Due Date (floor), override
3550 # if the hard due date is set to 'exactly', overrride
3551 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3552 $datedue = $hardduedate->clone;
3555 # in all other cases, keep the date due as it is
3559 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3560 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3561 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3562 if( $expiry_dt ) { #skip empty expiry date..
3563 $expiry_dt->set( hour => 23, minute => 59);
3564 my $d1= $datedue->clone->set_time_zone('floating');
3565 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3566 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3569 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3570 my $calendar = Koha::Calendar->new( branchcode => $branch );
3571 if ( $calendar->is_holiday($datedue) ) {
3572 # Don't return on a closed day
3573 $datedue = $calendar->prev_open_day( $datedue );
3582 sub CheckValidBarcode{
3584 my $dbh = C4::Context->dbh;
3585 my $query=qq|SELECT count(*)
3589 my $sth = $dbh->prepare($query);
3590 $sth->execute($barcode);
3591 my $exist=$sth->fetchrow ;
3595 =head2 IsBranchTransferAllowed
3597 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3599 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3601 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3602 Koha::Item->can_be_transferred.
3606 sub IsBranchTransferAllowed {
3607 my ( $toBranch, $fromBranch, $code ) = @_;
3609 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3611 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3612 my $dbh = C4::Context->dbh;
3614 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3615 $sth->execute( $toBranch, $fromBranch, $code );
3616 my $limit = $sth->fetchrow_hashref();
3618 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3619 if ( $limit->{'limitId'} ) {
3626 =head2 CreateBranchTransferLimit
3628 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3630 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3632 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3636 sub CreateBranchTransferLimit {
3637 my ( $toBranch, $fromBranch, $code ) = @_;
3638 return unless defined($toBranch) && defined($fromBranch);
3639 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3641 my $dbh = C4::Context->dbh;
3643 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3644 return $sth->execute( $code, $toBranch, $fromBranch );
3647 =head2 DeleteBranchTransferLimits
3649 my $result = DeleteBranchTransferLimits($frombranch);
3651 Deletes all the library transfer limits for one library. Returns the
3652 number of limits deleted, 0e0 if no limits were deleted, or undef if
3653 no arguments are supplied.
3655 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3656 fromBranch => $fromBranch
3661 sub DeleteBranchTransferLimits {
3663 return unless defined $branch;
3664 my $dbh = C4::Context->dbh;
3665 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3666 return $sth->execute($branch);
3670 my ( $borrowernumber, $itemnum ) = @_;
3672 MarkIssueReturned( $borrowernumber, $itemnum );
3673 my $patron = Koha::Patrons->find( $borrowernumber );
3674 my $item = C4::Items::GetItem( $itemnum );
3675 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3676 my @datearr = localtime(time);
3677 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3678 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3679 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3684 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3686 unless ( $mark_lost_from ) {
3687 # Temporary check to avoid regressions
3688 die q|LostItem called without $mark_lost_from, check the API.|;
3692 if ( $force_mark_returned ) {
3695 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3696 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3699 my $dbh = C4::Context->dbh();
3700 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3702 JOIN items USING (itemnumber)
3703 JOIN biblio USING (biblionumber)
3704 WHERE issues.itemnumber=?");
3705 $sth->execute($itemnumber);
3706 my $issues=$sth->fetchrow_hashref();
3708 # If a borrower lost the item, add a replacement cost to the their record
3709 if ( my $borrowernumber = $issues->{borrowernumber} ){
3710 my $patron = Koha::Patrons->find( $borrowernumber );
3712 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 0); # 1, 0 = exemptfine, no-dropbox
3713 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3715 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3716 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3717 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3718 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3721 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$patron->privacy) if $mark_returned;
3724 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3725 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3726 ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3728 my $transferdeleted = DeleteTransfer($itemnumber);
3731 sub GetOfflineOperations {
3732 my $dbh = C4::Context->dbh;
3733 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3734 $sth->execute(C4::Context->userenv->{'branch'});
3735 my $results = $sth->fetchall_arrayref({});
3739 sub GetOfflineOperation {
3740 my $operationid = shift;
3741 return unless $operationid;
3742 my $dbh = C4::Context->dbh;
3743 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3744 $sth->execute( $operationid );
3745 return $sth->fetchrow_hashref;
3748 sub AddOfflineOperation {
3749 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3750 my $dbh = C4::Context->dbh;
3751 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3752 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3756 sub DeleteOfflineOperation {
3757 my $dbh = C4::Context->dbh;
3758 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3759 $sth->execute( shift );
3763 sub ProcessOfflineOperation {
3764 my $operation = shift;
3767 if ( $operation->{action} eq 'return' ) {
3768 $report = ProcessOfflineReturn( $operation );
3769 } elsif ( $operation->{action} eq 'issue' ) {
3770 $report = ProcessOfflineIssue( $operation );
3771 } elsif ( $operation->{action} eq 'payment' ) {
3772 $report = ProcessOfflinePayment( $operation );
3775 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3780 sub ProcessOfflineReturn {
3781 my $operation = shift;
3783 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3786 my $itemnumber = $item->itemnumber;
3787 my $issue = GetOpenIssue( $itemnumber );
3790 $issue->{borrowernumber},
3793 $operation->{timestamp},
3796 { renewals => 0, onloan => undef },
3797 $issue->{'biblionumber'},
3803 return "Item not issued.";
3806 return "Item not found.";
3810 sub ProcessOfflineIssue {
3811 my $operation = shift;
3813 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3816 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3818 return "Barcode not found.";
3820 my $itemnumber = $item->itemnumber;
3821 my $issue = GetOpenIssue( $itemnumber );
3823 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3825 $issue->{borrowernumber},
3828 $operation->{timestamp},
3833 $operation->{'barcode'},
3836 $operation->{timestamp},
3841 return "Borrower not found.";
3845 sub ProcessOfflinePayment {
3846 my $operation = shift;
3848 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3850 $patron->account->pay({ amount => $operation->{amount}, library_id => $operation->{branchcode} });
3857 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3859 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3864 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3866 my $item = GetItem( $itemnumber, $barcode )
3869 return C4::Letters::GetPreparedLetter (
3870 module => 'circulation',
3871 letter_code => 'TRANSFERSLIP',
3872 branchcode => $branch,
3874 'branches' => $to_branch,
3875 'biblio' => $item->{biblionumber},
3881 =head2 CheckIfIssuedToPatron
3883 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3885 Return 1 if any record item is issued to patron, otherwise return 0
3889 sub CheckIfIssuedToPatron {
3890 my ($borrowernumber, $biblionumber) = @_;
3892 my $dbh = C4::Context->dbh;
3894 SELECT COUNT(*) FROM issues
3895 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3896 WHERE items.biblionumber = ?
3897 AND issues.borrowernumber = ?
3899 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3900 return 1 if $is_issued;
3906 IsItemIssued( $itemnumber )
3908 Return 1 if the item is on loan, otherwise return 0
3913 my $itemnumber = shift;
3914 my $dbh = C4::Context->dbh;
3915 my $sth = $dbh->prepare(q{
3918 WHERE itemnumber = ?
3920 $sth->execute($itemnumber);
3921 return $sth->fetchrow;
3924 =head2 GetAgeRestriction
3926 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3927 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3929 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3930 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3932 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3933 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3934 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3935 Negative days mean the borrower has gone past the age restriction age.
3939 sub GetAgeRestriction {
3940 my ($record_restrictions, $borrower) = @_;
3941 my $markers = C4::Context->preference('AgeRestrictionMarker');
3943 # Split $record_restrictions to something like FSK 16 or PEGI 6
3944 my @values = split ' ', uc($record_restrictions);
3945 return unless @values;
3947 # Search first occurrence of one of the markers
3948 my @markers = split /\|/, uc($markers);
3949 return unless @markers;
3952 my $restriction_year = 0;
3953 for my $value (@values) {
3955 for my $marker (@markers) {
3956 $marker =~ s/^\s+//; #remove leading spaces
3957 $marker =~ s/\s+$//; #remove trailing spaces
3958 if ( $marker eq $value ) {
3959 if ( $index <= $#values ) {
3960 $restriction_year += $values[$index];
3964 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3966 # Perhaps it is something like "K16" (as in Finland)
3967 $restriction_year += $1;
3971 last if ( $restriction_year > 0 );
3974 #Check if the borrower is age restricted for this material and for how long.
3975 if ($restriction_year && $borrower) {
3976 if ( $borrower->{'dateofbirth'} ) {
3977 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3978 $alloweddate[0] += $restriction_year;
3980 #Prevent runime eror on leap year (invalid date)
3981 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3982 $alloweddate[2] = 28;
3985 #Get how many days the borrower has to reach the age restriction
3986 my @Today = split /-/, DateTime->today->ymd();
3987 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3988 #Negative days means the borrower went past the age restriction age
3989 return ($restriction_year, $daysToAgeRestriction);
3993 return ($restriction_year);
3997 =head2 GetPendingOnSiteCheckouts
4001 sub GetPendingOnSiteCheckouts {
4002 my $dbh = C4::Context->dbh;
4003 return $dbh->selectall_arrayref(q|
4009 items.itemcallnumber,
4013 issues.date_due < NOW() AS is_overdue,
4016 borrowers.firstname,
4018 borrowers.cardnumber,
4019 borrowers.borrowernumber
4021 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4022 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4023 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4024 WHERE issues.onsite_checkout = 1
4025 |, { Slice => {} } );
4031 my ($count, $branch, $itemtype, $ccode, $newness)
4032 = @$params{qw(count branch itemtype ccode newness)};
4034 my $dbh = C4::Context->dbh;
4037 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4038 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4039 i.ccode, SUM(i.issues) AS count
4041 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4042 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4045 my (@where_strs, @where_args);
4048 push @where_strs, 'i.homebranch = ?';
4049 push @where_args, $branch;
4052 if (C4::Context->preference('item-level_itypes')){
4053 push @where_strs, 'i.itype = ?';
4054 push @where_args, $itemtype;
4056 push @where_strs, 'bi.itemtype = ?';
4057 push @where_args, $itemtype;
4061 push @where_strs, 'i.ccode = ?';
4062 push @where_args, $ccode;
4065 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4066 push @where_args, $newness;
4070 $query .= 'WHERE ' . join(' AND ', @where_strs);
4074 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4075 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4080 $query .= q{ ) xxx WHERE count > 0 };
4081 $count = int($count);
4083 $query .= "LIMIT $count";
4086 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4091 sub _CalculateAndUpdateFine {
4094 my $borrower = $params->{borrower};
4095 my $item = $params->{item};
4096 my $issue = $params->{issue};
4097 my $return_date = $params->{return_date};
4099 unless ($borrower) { carp "No borrower passed in!" && return; }
4100 unless ($item) { carp "No item passed in!" && return; }
4101 unless ($issue) { carp "No issue passed in!" && return; }
4103 my $datedue = dt_from_string( $issue->date_due );
4105 # we only need to calculate and change the fines if we want to do that on return
4106 # Should be on for hourly loans
4107 my $control = C4::Context->preference('CircControl');
4108 my $control_branchcode =
4109 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4110 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4111 : $issue->branchcode;
4113 my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4115 my ( $amount, $type, $unitcounttotal ) =
4116 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4120 if ( C4::Context->preference('finesMode') eq 'production' ) {
4121 if ( $amount > 0 ) {
4122 C4::Overdues::UpdateFine({
4123 issue_id => $issue->issue_id,
4124 itemnumber => $issue->itemnumber,
4125 borrowernumber => $issue->borrowernumber,
4128 due => output_pref($datedue),
4131 elsif ($return_date) {
4133 # Backdated returns may have fines that shouldn't exist,
4134 # so in this case, we need to drop those fines to 0
4136 C4::Overdues::UpdateFine({
4137 issue_id => $issue->issue_id,
4138 itemnumber => $issue->itemnumber,
4139 borrowernumber => $issue->borrowernumber,
4142 due => output_pref($datedue),
4148 sub _item_denied_renewal {
4151 my $item = $params->{item};
4152 return unless $item;
4154 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4155 return unless $denyingrules;
4156 foreach my $field (keys %$denyingrules) {
4157 my $val = $item->{$field};
4158 if( !defined $val) {
4159 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4162 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4163 # If the results matches the values in the syspref
4164 # We return true if match found
4178 Koha Development Team <http://koha-community.org/>