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;
62 use Koha::Charges::Fees;
63 use Koha::Util::SystemPreferences;
65 use List::MoreUtils qw( uniq any );
66 use Scalar::Util qw( looks_like_number );
76 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
82 # FIXME subs that should probably be elsewhere
87 &GetPendingOnSiteCheckouts
90 # subs to deal with issuing a book
98 &GetLatestAutoRenewDate
100 &GetBranchBorrowerCircRule
104 &CheckIfIssuedToPatron
109 # subs to deal with returns
115 # subs to deal with transfers
122 &IsBranchTransferAllowed
123 &CreateBranchTransferLimit
124 &DeleteBranchTransferLimits
128 # subs to deal with offline circulation
130 &GetOfflineOperations
133 &DeleteOfflineOperation
134 &ProcessOfflineOperation
140 C4::Circulation - Koha circulation module
148 The functions in this module deal with circulation, issues, and
149 returns, as well as general information about the library.
150 Also deals with inventory.
156 $str = &barcodedecode($barcode, [$filter]);
158 Generic filter function for barcode string.
159 Called on every circ if the System Pref itemBarcodeInputFilter is set.
160 Will do some manipulation of the barcode for systems that deliver a barcode
161 to circulation.pl that differs from the barcode stored for the item.
162 For proper functioning of this filter, calling the function on the
163 correct barcode string (items.barcode) should return an unaltered barcode.
165 The optional $filter argument is to allow for testing or explicit
166 behavior that ignores the System Pref. Valid values are the same as the
171 # FIXME -- the &decode fcn below should be wrapped into this one.
172 # FIXME -- these plugins should be moved out of Circulation.pm
175 my ($barcode, $filter) = @_;
176 my $branch = C4::Context::mybranch();
177 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
178 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
179 if ($filter eq 'whitespace') {
181 } elsif ($filter eq 'cuecat') {
183 my @fields = split( /\./, $barcode );
184 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
185 ($#results == 2) and return $results[2];
186 } elsif ($filter eq 'T-prefix') {
187 if ($barcode =~ /^[Tt](\d)/) {
188 (defined($1) and $1 eq '0') and return $barcode;
189 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
191 return sprintf("T%07d", $barcode);
192 # FIXME: $barcode could be "T1", causing warning: substr outside of string
193 # Why drop the nonzero digit after the T?
194 # Why pass non-digits (or empty string) to "T%07d"?
195 } elsif ($filter eq 'libsuite8') {
196 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
197 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
198 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
200 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
203 } elsif ($filter eq 'EAN13') {
204 my $ean = CheckDigits('ean');
205 if ( $ean->is_valid($barcode) ) {
206 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
207 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
209 warn "# [$barcode] not valid EAN-13/UPC-A\n";
212 return $barcode; # return barcode, modified or not
217 $str = &decode($chunk);
219 Decodes a segment of a string emitted by a CueCat barcode scanner and
222 FIXME: Should be replaced with Barcode::Cuecat from CPAN
223 or Javascript based decoding on the client side.
230 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
231 my @s = map { index( $seq, $_ ); } split( //, $encoded );
232 my $l = ( $#s + 1 ) % 4;
235 # warn "Error: Cuecat decode parsing failed!";
243 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
245 chr( ( $n >> 16 ) ^ 67 )
246 .chr( ( $n >> 8 & 255 ) ^ 67 )
247 .chr( ( $n & 255 ) ^ 67 );
250 $r = substr( $r, 0, length($r) - $l );
256 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
257 $barcode, $ignore_reserves);
259 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
261 C<$newbranch> is the code for the branch to which the item should be transferred.
263 C<$barcode> is the barcode of the item to be transferred.
265 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
266 Otherwise, if an item is reserved, the transfer fails.
268 Returns three values:
274 is true if the transfer was successful.
278 is a reference-to-hash which may have any of the following keys:
284 There is no item in the catalog with the given barcode. The value is C<$barcode>.
286 =item C<DestinationEqualsHolding>
288 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.
292 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.
296 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>.
298 =item C<WasTransferred>
300 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
309 my ( $tbr, $barcode, $ignoreRs ) = @_;
312 my $item = Koha::Items->find( { barcode => $barcode } );
316 $messages->{'BadBarcode'} = $barcode;
318 return ( $dotransfer, $messages );
321 my $itemnumber = $item->itemnumber;
322 my $issue = GetOpenIssue($itemnumber);
323 # get branches of book...
324 my $hbr = $item->homebranch;
325 my $fbr = $item->holdingbranch;
327 # if using Branch Transfer Limits
328 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
329 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
330 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
331 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
332 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
335 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
336 $messages->{'NotAllowed'} = $tbr . "::" . $code;
341 # can't transfer book if is already there....
342 if ( $fbr eq $tbr ) {
343 $messages->{'DestinationEqualsHolding'} = 1;
347 # check if it is still issued to someone, return it...
349 AddReturn( $barcode, $fbr );
350 $messages->{'WasReturned'} = $issue->borrowernumber;
354 # That'll save a database query.
355 my ( $resfound, $resrec, undef ) =
356 CheckReserves( $itemnumber );
357 if ( $resfound and not $ignoreRs ) {
358 $resrec->{'ResFound'} = $resfound;
360 # $messages->{'ResFound'} = $resrec;
364 #actually do the transfer....
366 ModItemTransfer( $itemnumber, $fbr, $tbr );
368 # don't need to update MARC anymore, we do it in batch now
369 $messages->{'WasTransfered'} = 1;
372 ModDateLastSeen( $itemnumber );
373 return ( $dotransfer, $messages );
378 my $borrower = shift;
379 my $item_object = shift;
381 my $onsite_checkout = $params->{onsite_checkout} || 0;
382 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
383 my $cat_borrower = $borrower->{'categorycode'};
384 my $dbh = C4::Context->dbh;
386 # Get which branchcode we need
387 $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
388 my $type = $item_object->effective_itemtype;
390 # given branch, patron category, and item type, determine
391 # applicable issuing rule
392 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
394 categorycode => $cat_borrower,
396 branchcode => $branch,
397 rule_name => 'maxissueqty',
400 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
402 categorycode => $cat_borrower,
404 branchcode => $branch,
405 rule_name => 'maxonsiteissueqty',
410 # if a rule is found and has a loan limit set, count
411 # how many loans the patron already has that meet that
413 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne '') {
416 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
418 JOIN items USING (itemnumber)
421 my $rule_itemtype = $maxissueqty_rule->itemtype;
422 unless ($rule_itemtype) {
423 # matching rule has the default item type, so count only
424 # those existing loans that don't fall under a more
426 if (C4::Context->preference('item-level_itypes')) {
427 $count_query .= " WHERE items.itype NOT IN (
428 SELECT itemtype FROM issuingrules
430 AND (categorycode = ? OR categorycode = ?)
434 $count_query .= " JOIN biblioitems USING (biblionumber)
435 WHERE biblioitems.itemtype NOT IN (
436 SELECT itemtype FROM issuingrules
438 AND (categorycode = ? OR categorycode = ?)
442 push @bind_params, $maxissueqty_rule->branchcode;
443 push @bind_params, $maxissueqty_rule->categorycode;
444 push @bind_params, $cat_borrower;
446 # rule has specific item type, so count loans of that
448 if (C4::Context->preference('item-level_itypes')) {
449 $count_query .= " WHERE items.itype = ? ";
451 $count_query .= " JOIN biblioitems USING (biblionumber)
452 WHERE biblioitems.itemtype= ? ";
454 push @bind_params, $type;
457 $count_query .= " AND borrowernumber = ? ";
458 push @bind_params, $borrower->{'borrowernumber'};
459 my $rule_branch = $maxissueqty_rule->branchcode;
461 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
462 $count_query .= " AND issues.branchcode = ? ";
463 push @bind_params, $rule_branch;
464 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
465 ; # if branch is the patron's home branch, then count all loans by patron
467 $count_query .= " AND items.homebranch = ? ";
468 push @bind_params, $rule_branch;
472 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
474 my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
475 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
477 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
478 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
480 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
481 count => $onsite_checkout_count,
482 max_allowed => $max_onsite_checkouts_allowed,
486 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
487 my $delta = $switch_onsite_checkout ? 1 : 0;
488 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
490 reason => 'TOO_MANY_CHECKOUTS',
491 count => $checkout_count,
492 max_allowed => $max_checkouts_allowed,
495 } elsif ( not $onsite_checkout ) {
496 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
498 reason => 'TOO_MANY_CHECKOUTS',
499 count => $checkout_count - $onsite_checkout_count,
500 max_allowed => $max_checkouts_allowed,
506 # Now count total loans against the limit for the branch
507 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
508 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
509 my @bind_params = ();
510 my $branch_count_query = q|
511 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
513 JOIN items USING (itemnumber)
514 WHERE borrowernumber = ?
516 push @bind_params, $borrower->{borrowernumber};
518 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
519 $branch_count_query .= " AND issues.branchcode = ? ";
520 push @bind_params, $branch;
521 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
522 ; # if branch is the patron's home branch, then count all loans by patron
524 $branch_count_query .= " AND items.homebranch = ? ";
525 push @bind_params, $branch;
527 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
528 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
529 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
531 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
532 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
534 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
535 count => $onsite_checkout_count,
536 max_allowed => $max_onsite_checkouts_allowed,
540 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
541 my $delta = $switch_onsite_checkout ? 1 : 0;
542 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
544 reason => 'TOO_MANY_CHECKOUTS',
545 count => $checkout_count,
546 max_allowed => $max_checkouts_allowed,
549 } elsif ( not $onsite_checkout ) {
550 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
552 reason => 'TOO_MANY_CHECKOUTS',
553 count => $checkout_count - $onsite_checkout_count,
554 max_allowed => $max_checkouts_allowed,
560 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
561 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
564 # OK, the patron can issue !!!
568 =head2 CanBookBeIssued
570 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
571 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
573 Check if a book can be issued.
575 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
577 IMPORTANT: The assumption by users of this routine is that causes blocking
578 the issue are keyed by uppercase labels and other returned
579 data is keyed in lower case!
583 =item C<$patron> is a Koha::Patron
585 =item C<$barcode> is the bar code of the book being issued.
587 =item C<$duedates> is a DateTime object.
589 =item C<$inprocess> boolean switch
591 =item C<$ignore_reserves> boolean switch
593 =item C<$params> Hashref of additional parameters
596 override_high_holds - Ignore high holds
597 onsite_checkout - Checkout is an onsite checkout that will not leave the library
605 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
606 Possible values are :
612 sticky due date is invalid
616 borrower gone with no address
620 borrower declared it's card lost
626 =head3 UNKNOWN_BARCODE
640 item is restricted (set by ??)
642 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
643 could be prevented, but ones that can be overriden by the operator.
645 Possible values are :
653 renewing, not issuing
655 =head3 ISSUED_TO_ANOTHER
657 issued to someone else.
661 reserved for someone else.
665 sticky due date is invalid or due date in the past
669 if the borrower borrows to much things
673 sub CanBookBeIssued {
674 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
675 my %needsconfirmation; # filled with problems that needs confirmations
676 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
677 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
678 my %messages; # filled with information messages that should be displayed.
680 my $onsite_checkout = $params->{onsite_checkout} || 0;
681 my $override_high_holds = $params->{override_high_holds} || 0;
683 my $item_object = Koha::Items->find({barcode => $barcode });
685 # MANDATORY CHECKS - unless item exists, nothing else matters
686 unless ( $item_object ) {
687 $issuingimpossible{UNKNOWN_BARCODE} = 1;
689 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
691 my $item_unblessed = $item_object->unblessed; # Transition...
692 my $issue = $item_object->checkout;
693 my $biblio = $item_object->biblio;
695 my $biblioitem = $biblio->biblioitem;
696 my $effective_itemtype = $item_object->effective_itemtype;
697 my $dbh = C4::Context->dbh;
698 my $patron_unblessed = $patron->unblessed;
700 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
702 # DUE DATE is OK ? -- should already have checked.
704 if ($duedate && ref $duedate ne 'DateTime') {
705 $duedate = dt_from_string($duedate);
707 my $now = DateTime->now( time_zone => C4::Context->tz() );
708 unless ( $duedate ) {
709 my $issuedate = $now->clone();
711 my $branch = $circ_library;
712 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $branch, $patron_unblessed );
714 # Offline circ calls AddIssue directly, doesn't run through here
715 # So issuingimpossible should be ok.
718 my $fees = Koha::Charges::Fees->new(
721 library => $circ_library,
722 item => $item_object,
728 my $today = $now->clone();
729 $today->truncate( to => 'minute');
730 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
731 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
734 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
740 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
741 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
743 branch => C4::Context->userenv->{'branch'},
745 itemnumber => $item_object->itemnumber,
746 itemtype => $effective_itemtype,
747 borrowernumber => $patron->borrowernumber,
748 ccode => $item_object->ccode}
750 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
751 return( { STATS => 1 }, {});
754 if ( $patron->gonenoaddress == 1 ) {
755 $issuingimpossible{GNA} = 1;
758 if ( $patron->lost == 1 ) {
759 $issuingimpossible{CARD_LOST} = 1;
761 if ( $patron->is_debarred ) {
762 $issuingimpossible{DEBARRED} = 1;
765 if ( $patron->is_expired ) {
766 $issuingimpossible{EXPIRED} = 1;
774 my $account = $patron->account;
775 my $balance = $account->balance;
776 my $non_issues_charges = $account->non_issues_charges;
777 my $other_charges = $balance - $non_issues_charges;
779 my $amountlimit = C4::Context->preference("noissuescharge");
780 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
781 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
783 # Check the debt of this patrons guarantees
784 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
785 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
786 if ( defined $no_issues_charge_guarantees ) {
787 my @guarantees = $patron->guarantees();
788 my $guarantees_non_issues_charges;
789 foreach my $g ( @guarantees ) {
790 $guarantees_non_issues_charges += $g->account->non_issues_charges;
793 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
794 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
795 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
796 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
797 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
798 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
802 if ( C4::Context->preference("IssuingInProcess") ) {
803 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
804 $issuingimpossible{DEBT} = $non_issues_charges;
805 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
806 $needsconfirmation{DEBT} = $non_issues_charges;
807 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
808 $needsconfirmation{DEBT} = $non_issues_charges;
812 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
813 $needsconfirmation{DEBT} = $non_issues_charges;
814 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
815 $issuingimpossible{DEBT} = $non_issues_charges;
816 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
817 $needsconfirmation{DEBT} = $non_issues_charges;
821 if ($balance > 0 && $other_charges > 0) {
822 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
825 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
826 $patron_unblessed = $patron->unblessed;
828 if ( my $debarred_date = $patron->is_debarred ) {
829 # patron has accrued fine days or has a restriction. $count is a date
830 if ($debarred_date eq '9999-12-31') {
831 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
834 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
836 } elsif ( my $num_overdues = $patron->has_overdues ) {
837 ## patron has outstanding overdue loans
838 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
839 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
841 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
842 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
847 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
849 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
851 # Already issued to current borrower.
852 # If it is an on-site checkout if it can be switched to a normal checkout
853 # or ask whether the loan should be renewed
855 if ( $issue->onsite_checkout
856 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
857 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
859 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
860 $patron->borrowernumber,
861 $item_object->itemnumber,
863 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
864 if ( $renewerror eq 'onsite_checkout' ) {
865 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
868 $issuingimpossible{NO_MORE_RENEWALS} = 1;
872 $needsconfirmation{RENEW_ISSUE} = 1;
878 # issued to someone else
880 my $patron = Koha::Patrons->find( $issue->borrowernumber );
882 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
884 unless ( $can_be_returned ) {
885 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
886 $issuingimpossible{branch_to_return} = $message;
888 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
889 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
891 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
892 $needsconfirmation{issued_firstname} = $patron->firstname;
893 $needsconfirmation{issued_surname} = $patron->surname;
894 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
895 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
900 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
902 my $switch_onsite_checkout = (
903 C4::Context->preference('SwitchOnSiteCheckouts')
905 and $issue->onsite_checkout
906 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
907 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
908 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
909 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
910 if ( $toomany->{max_allowed} == 0 ) {
911 $needsconfirmation{PATRON_CANT} = 1;
913 if ( C4::Context->preference("AllowTooManyOverride") ) {
914 $needsconfirmation{TOO_MANY} = $toomany->{reason};
915 $needsconfirmation{current_loan_count} = $toomany->{count};
916 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
918 $issuingimpossible{TOO_MANY} = $toomany->{reason};
919 $issuingimpossible{current_loan_count} = $toomany->{count};
920 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
925 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
927 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
928 my $wants_check = $patron->wants_check_for_previous_checkout;
929 $needsconfirmation{PREVISSUE} = 1
930 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
935 if ( $item_object->notforloan )
937 if(!C4::Context->preference("AllowNotForLoanOverride")){
938 $issuingimpossible{NOT_FOR_LOAN} = 1;
939 $issuingimpossible{item_notforloan} = $item_object->notforloan;
941 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
942 $needsconfirmation{item_notforloan} = $item_object->notforloan;
946 # we have to check itemtypes.notforloan also
947 if (C4::Context->preference('item-level_itypes')){
948 # this should probably be a subroutine
949 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
950 $sth->execute($effective_itemtype);
951 my $notforloan=$sth->fetchrow_hashref();
952 if ($notforloan->{'notforloan'}) {
953 if (!C4::Context->preference("AllowNotForLoanOverride")) {
954 $issuingimpossible{NOT_FOR_LOAN} = 1;
955 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
957 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
958 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
963 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
964 if ( $itemtype and $itemtype->notforloan == 1){
965 if (!C4::Context->preference("AllowNotForLoanOverride")) {
966 $issuingimpossible{NOT_FOR_LOAN} = 1;
967 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
969 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
970 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
975 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
977 $issuingimpossible{WTHDRAWN} = 1;
979 if ( $item_object->restricted
980 && $item_object->restricted == 1 )
982 $issuingimpossible{RESTRICTED} = 1;
984 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
985 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
986 my $code = $av->count ? $av->next->lib : '';
987 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
988 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
990 if ( C4::Context->preference("IndependentBranches") ) {
991 my $userenv = C4::Context->userenv;
992 unless ( C4::Context->IsSuperLibrarian() ) {
993 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
994 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
995 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
996 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
998 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
999 if ( $patron->branchcode ne $userenv->{branch} );
1003 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1005 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1007 if ( $rentalConfirmation ){
1008 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1009 my $itemtype = Koha::ItemTypes->find( $item_object->itype ); # GetItem sets effective itemtype
1010 $rentalCharge += $fees->accumulate_rentalcharge({ from => dt_from_string(), to => $duedate });
1011 if ( $rentalCharge > 0 ){
1012 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1016 unless ( $ignore_reserves ) {
1017 # See if the item is on reserve.
1018 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1020 my $resbor = $res->{'borrowernumber'};
1021 if ( $resbor ne $patron->borrowernumber ) {
1022 my $patron = Koha::Patrons->find( $resbor );
1023 if ( $restype eq "Waiting" )
1025 # The item is on reserve and waiting, but has been
1026 # reserved by some other patron.
1027 $needsconfirmation{RESERVE_WAITING} = 1;
1028 $needsconfirmation{'resfirstname'} = $patron->firstname;
1029 $needsconfirmation{'ressurname'} = $patron->surname;
1030 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1031 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1032 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1033 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1035 elsif ( $restype eq "Reserved" ) {
1036 # The item is on reserve for someone else.
1037 $needsconfirmation{RESERVED} = 1;
1038 $needsconfirmation{'resfirstname'} = $patron->firstname;
1039 $needsconfirmation{'ressurname'} = $patron->surname;
1040 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1041 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1042 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1043 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1049 ## CHECK AGE RESTRICTION
1050 my $agerestriction = $biblioitem->agerestriction;
1051 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1052 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1053 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1054 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1057 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1061 ## check for high holds decreasing loan period
1062 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1063 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1065 if ( $check->{exceeded} ) {
1066 if ($override_high_holds) {
1067 $alerts{HIGHHOLDS} = {
1068 num_holds => $check->{outstanding},
1069 duration => $check->{duration},
1070 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1074 $needsconfirmation{HIGHHOLDS} = {
1075 num_holds => $check->{outstanding},
1076 duration => $check->{duration},
1077 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1084 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1085 # don't do the multiple loans per bib check if we've
1086 # already determined that we've got a loan on the same item
1087 !$issuingimpossible{NO_MORE_RENEWALS} &&
1088 !$needsconfirmation{RENEW_ISSUE}
1090 # Check if borrower has already issued an item from the same biblio
1091 # Only if it's not a subscription
1092 my $biblionumber = $item_object->biblionumber;
1093 require C4::Serials;
1094 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1095 unless ($is_a_subscription) {
1096 # FIXME Should be $patron->checkouts($args);
1097 my $checkouts = Koha::Checkouts->search(
1099 borrowernumber => $patron->borrowernumber,
1100 biblionumber => $biblionumber,
1106 # if we get here, we don't already have a loan on this item,
1107 # so if there are any loans on this bib, ask for confirmation
1108 if ( $checkouts->count ) {
1109 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1114 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1117 =head2 CanBookBeReturned
1119 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1121 Check whether the item can be returned to the provided branch
1125 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1127 =item C<$branch> is the branchcode where the return is taking place
1135 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1137 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1143 sub CanBookBeReturned {
1144 my ($item, $branch) = @_;
1145 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1147 # assume return is allowed to start
1151 # identify all cases where return is forbidden
1152 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1154 $message = $item->{'homebranch'};
1155 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1157 $message = $item->{'holdingbranch'};
1158 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1160 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1163 return ($allowed, $message);
1166 =head2 CheckHighHolds
1168 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1169 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1170 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1174 sub checkHighHolds {
1175 my ( $item, $borrower ) = @_;
1176 my $branch = _GetCircControlBranch( $item, $borrower );
1177 my $item_object = Koha::Items->find( $item->{itemnumber} );
1186 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1188 if ( $holds->count() ) {
1189 $return_data->{outstanding} = $holds->count();
1191 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1192 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1193 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1195 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1197 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1199 # static means just more than a given number of holds on the record
1201 # If the number of holds is less than the threshold, we can stop here
1202 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1203 return $return_data;
1206 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1208 # dynamic means X more than the number of holdable items on the record
1210 # let's get the items
1211 my @items = $holds->next()->biblio()->items()->as_list;
1213 # Remove any items with status defined to be ignored even if the would not make item unholdable
1214 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1215 @items = grep { !$_->$status } @items;
1218 # Remove any items that are not holdable for this patron
1219 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber )->{status} eq 'OK' } @items;
1221 my $items_count = scalar @items;
1223 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1225 # If the number of holds is less than the count of items we have
1226 # plus the number of holds allowed above that count, we can stop here
1227 if ( $holds->count() <= $threshold ) {
1228 return $return_data;
1232 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1234 my $calendar = Koha::Calendar->new( branchcode => $branch );
1236 my $itype = $item_object->effective_itemtype;
1237 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1239 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1241 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1242 $reduced_datedue->set_hour($orig_due->hour);
1243 $reduced_datedue->set_minute($orig_due->minute);
1244 $reduced_datedue->truncate( to => 'minute' );
1246 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1247 $return_data->{exceeded} = 1;
1248 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1249 $return_data->{due_date} = $reduced_datedue;
1253 return $return_data;
1258 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1260 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1264 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1266 =item C<$barcode> is the barcode of the item being issued.
1268 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1269 Calculated if empty.
1271 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1273 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1274 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1276 AddIssue does the following things :
1278 - step 01: check that there is a borrowernumber & a barcode provided
1279 - check for RENEWAL (book issued & being issued to the same patron)
1280 - renewal YES = Calculate Charge & renew
1282 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1284 - fill reserve if reserve to this patron
1285 - cancel reserve or not, otherwise
1286 * TRANSFERT PENDING ?
1287 - complete the transfert
1295 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1297 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1298 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1299 my $auto_renew = $params && $params->{auto_renew};
1300 my $dbh = C4::Context->dbh;
1301 my $barcodecheck = CheckValidBarcode($barcode);
1305 if ( $datedue && ref $datedue ne 'DateTime' ) {
1306 $datedue = dt_from_string($datedue);
1309 # $issuedate defaults to today.
1310 if ( !defined $issuedate ) {
1311 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1314 if ( ref $issuedate ne 'DateTime' ) {
1315 $issuedate = dt_from_string($issuedate);
1320 # Stop here if the patron or barcode doesn't exist
1321 if ( $borrower && $barcode && $barcodecheck ) {
1322 # find which item we issue
1323 my $item_object = Koha::Items->find({ barcode => $barcode })
1324 or return; # if we don't get an Item, abort.
1325 my $item_unblessed = $item_object->unblessed;
1327 my $branch = _GetCircControlBranch( $item_unblessed, $borrower );
1329 # get actual issuing if there is one
1330 my $actualissue = $item_object->checkout;
1332 # check if we just renew the issue.
1333 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1334 and not $switch_onsite_checkout ) {
1335 $datedue = AddRenewal(
1336 $borrower->{'borrowernumber'},
1337 $item_object->itemnumber,
1340 $issuedate, # here interpreted as the renewal date
1345 my $itype = $item_object->effective_itemtype;
1346 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1349 $datedue->truncate( to => 'minute' );
1351 my $patron = Koha::Patrons->find( $borrower );
1352 my $library = Koha::Libraries->find( $branch );
1353 my $fees = Koha::Charges::Fees->new(
1356 library => $library,
1357 item => $item_object,
1358 to_date => $datedue,
1362 # it's NOT a renewal
1363 if ( $actualissue and not $switch_onsite_checkout ) {
1364 # This book is currently on loan, but not to the person
1365 # who wants to borrow it now. mark it returned before issuing to the new borrower
1366 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1367 return unless $allowed;
1368 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1371 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1373 # Starting process for transfer job (checking transfert and validate it if we have one)
1374 my ($datesent) = GetTransfers( $item_object->itemnumber );
1376 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1377 my $sth = $dbh->prepare(
1378 "UPDATE branchtransfers
1379 SET datearrived = now(),
1381 comments = 'Forced branchtransfer'
1382 WHERE itemnumber= ? AND datearrived IS NULL"
1384 $sth->execute( C4::Context->userenv->{'branch'},
1385 $item_object->itemnumber );
1388 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1389 unless ($auto_renew) {
1390 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1391 { categorycode => $borrower->{categorycode},
1392 itemtype => $item_object->effective_itemtype,
1393 branchcode => $branch
1397 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1400 # Record in the database the fact that the book was issued.
1402 my $itype = $item_object->effective_itemtype;
1403 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1406 $datedue->truncate( to => 'minute' );
1408 my $issue_attributes = {
1409 borrowernumber => $borrower->{'borrowernumber'},
1410 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1411 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1412 branchcode => C4::Context->userenv->{'branch'},
1413 onsite_checkout => $onsite_checkout,
1414 auto_renew => $auto_renew ? 1 : 0,
1417 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1419 $issue->set($issue_attributes)->store;
1422 $issue = Koha::Checkout->new(
1424 itemnumber => $item_object->itemnumber,
1429 if ( $item_object->location eq 'CART' && $item_object->permanent_location ne 'CART' ) {
1430 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1431 CartToShelf( $item_object->itemnumber );
1434 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1435 UpdateTotalIssues( $item_object->biblionumber, 1 );
1438 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1439 if ( $item_object->itemlost ) {
1441 Koha::RefundLostItemFeeRules->should_refund(
1443 current_branch => C4::Context->userenv->{branch},
1444 item_home_branch => $item_object->homebranch,
1445 item_holding_branch => $item_object->holdingbranch,
1450 _FixAccountForLostAndReturned( $item_object->itemnumber, undef,
1451 $item_object->barcode );
1457 issues => $item_object->issues + 1,
1458 holdingbranch => C4::Context->userenv->{'branch'},
1460 onloan => $datedue->ymd(),
1461 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1463 $item_object->biblionumber,
1464 $item_object->itemnumber,
1467 ModDateLastSeen( $item_object->itemnumber );
1469 # If it costs to borrow this book, charge it to the patron's account.
1470 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1471 if ( $charge > 0 ) {
1472 my $description = "Rental";
1473 AddIssuingCharge( $issue, $charge, $description );
1476 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1477 if ( $itemtype_object ) {
1478 my $accumulate_charge = $fees->accumulate_rentalcharge();
1479 if ( $accumulate_charge > 0 ) {
1480 AddIssuingCharge( $issue, $accumulate_charge, 'Daily rental' ) if $accumulate_charge > 0;
1481 $charge += $accumulate_charge;
1482 $item_unblessed->{charge} = $charge;
1486 # Record the fact that this book was issued.
1489 branch => C4::Context->userenv->{'branch'},
1490 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1492 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1493 itemnumber => $item_object->itemnumber,
1494 itemtype => $item_object->effective_itemtype,
1495 location => $item_object->location,
1496 borrowernumber => $borrower->{'borrowernumber'},
1497 ccode => $item_object->ccode,
1501 # Send a checkout slip.
1502 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1504 branchcode => $branch,
1505 categorycode => $borrower->{categorycode},
1506 item_type => $item_object->effective_itemtype,
1507 notification => 'CHECKOUT',
1509 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1510 SendCirculationAlert(
1513 item => $item_object->unblessed,
1514 borrower => $borrower,
1520 "CIRCULATION", "ISSUE",
1521 $borrower->{'borrowernumber'},
1522 $item_object->itemnumber,
1523 ) if C4::Context->preference("IssueLog");
1529 =head2 GetLoanLength
1531 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1533 Get loan length for an itemtype, a borrower type and a branch
1538 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1539 my $dbh = C4::Context->dbh;
1540 my $sth = $dbh->prepare(qq{
1541 SELECT issuelength, lengthunit, renewalperiod
1543 WHERE categorycode=?
1546 AND issuelength IS NOT NULL
1549 # try to find issuelength & return the 1st available.
1550 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1551 $sth->execute( $borrowertype, $itemtype, $branchcode );
1552 my $loanlength = $sth->fetchrow_hashref;
1555 if defined($loanlength) && defined $loanlength->{issuelength};
1557 $sth->execute( $borrowertype, '*', $branchcode );
1558 $loanlength = $sth->fetchrow_hashref;
1560 if defined($loanlength) && defined $loanlength->{issuelength};
1562 $sth->execute( '*', $itemtype, $branchcode );
1563 $loanlength = $sth->fetchrow_hashref;
1565 if defined($loanlength) && defined $loanlength->{issuelength};
1567 $sth->execute( '*', '*', $branchcode );
1568 $loanlength = $sth->fetchrow_hashref;
1570 if defined($loanlength) && defined $loanlength->{issuelength};
1572 $sth->execute( $borrowertype, $itemtype, '*' );
1573 $loanlength = $sth->fetchrow_hashref;
1575 if defined($loanlength) && defined $loanlength->{issuelength};
1577 $sth->execute( $borrowertype, '*', '*' );
1578 $loanlength = $sth->fetchrow_hashref;
1580 if defined($loanlength) && defined $loanlength->{issuelength};
1582 $sth->execute( '*', $itemtype, '*' );
1583 $loanlength = $sth->fetchrow_hashref;
1585 if defined($loanlength) && defined $loanlength->{issuelength};
1587 $sth->execute( '*', '*', '*' );
1588 $loanlength = $sth->fetchrow_hashref;
1590 if defined($loanlength) && defined $loanlength->{issuelength};
1592 # if no rule is set => 0 day (hardcoded)
1596 lengthunit => 'days',
1602 =head2 GetHardDueDate
1604 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1606 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1610 sub GetHardDueDate {
1611 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1613 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1614 { categorycode => $borrowertype,
1615 itemtype => $itemtype,
1616 branchcode => $branchcode
1621 if ( defined( $issuing_rule ) ) {
1622 if ( $issuing_rule->hardduedate ) {
1623 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1625 return (undef, undef);
1630 =head2 GetBranchBorrowerCircRule
1632 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1634 Retrieves circulation rule attributes that apply to the given
1635 branch and patron category, regardless of item type.
1636 The return value is a hashref containing the following key:
1638 patron_maxissueqty - maximum number of loans that a
1639 patron of the given category can have at the given
1640 branch. If the value is undef, no limit.
1642 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1643 patron of the given category can have at the given
1644 branch. If the value is undef, no limit.
1646 This will check for different branch/category combinations in the following order:
1650 default branch and category
1652 If no rule has been found in the database, it will default to
1655 patron_maxissueqty - undef
1656 patron_maxonsiteissueqty - undef
1658 C<$branchcode> and C<$categorycode> should contain the
1659 literal branch code and patron category code, respectively - no
1664 sub GetBranchBorrowerCircRule {
1665 my ( $branchcode, $categorycode ) = @_;
1667 # Initialize default values
1669 patron_maxissueqty => undef,
1670 patron_maxonsiteissueqty => undef,
1674 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1675 my $rule = Koha::CirculationRules->get_effective_rule(
1677 categorycode => $categorycode,
1679 branchcode => $branchcode,
1680 rule_name => $rule_name,
1684 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1690 =head2 GetBranchItemRule
1692 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1694 Retrieves circulation rule attributes that apply to the given
1695 branch and item type, regardless of patron category.
1697 The return value is a hashref containing the following keys:
1699 holdallowed => Hold policy for this branch and itemtype. Possible values:
1700 0: No holds allowed.
1701 1: Holds allowed only by patrons that have the same homebranch as the item.
1702 2: Holds allowed from any patron.
1704 returnbranch => branch to which to return item. Possible values:
1705 noreturn: do not return, let item remain where checked in (floating collections)
1706 homebranch: return to item's home branch
1707 holdingbranch: return to issuer branch
1709 This searches branchitemrules in the following order:
1711 * Same branchcode and itemtype
1712 * Same branchcode, itemtype '*'
1713 * branchcode '*', same itemtype
1714 * branchcode and itemtype '*'
1716 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1720 sub GetBranchItemRule {
1721 my ( $branchcode, $itemtype ) = @_;
1722 my $dbh = C4::Context->dbh();
1726 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1727 FROM branch_item_rules
1728 WHERE branchcode = ?
1729 AND itemtype = ?', $branchcode, $itemtype],
1730 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1731 FROM default_branch_circ_rules
1732 WHERE branchcode = ?', $branchcode],
1733 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1734 FROM default_branch_item_rules
1735 WHERE itemtype = ?', $itemtype],
1736 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1737 FROM default_circ_rules'],
1740 foreach my $attempt (@attempts) {
1741 my ($query, @bind_params) = @{$attempt};
1742 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1745 # Since branch/category and branch/itemtype use the same per-branch
1746 # defaults tables, we have to check that the key we want is set, not
1747 # just that a row was returned
1748 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1749 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1750 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1753 # built-in default circulation rule
1754 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1755 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1756 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1763 ($doreturn, $messages, $iteminformation, $borrower) =
1764 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1770 =item C<$barcode> is the bar code of the book being returned.
1772 =item C<$branch> is the code of the branch where the book is being returned.
1774 =item C<$exemptfine> indicates that overdue charges for the item will be
1777 =item C<$return_date> allows the default return date to be overridden
1778 by the given return date. Optional.
1782 C<&AddReturn> returns a list of four items:
1784 C<$doreturn> is true iff the return succeeded.
1786 C<$messages> is a reference-to-hash giving feedback on the operation.
1787 The keys of the hash are:
1793 No item with this barcode exists. The value is C<$barcode>.
1797 The book is not currently on loan. The value is C<$barcode>.
1801 This book has been withdrawn/cancelled. The value should be ignored.
1803 =item C<Wrongbranch>
1805 This book has was returned to the wrong branch. The value is a hashref
1806 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1807 contain the branchcode of the incorrect and correct return library, respectively.
1811 The item was reserved. The value is a reference-to-hash whose keys are
1812 fields from the reserves table of the Koha database, and
1813 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1814 either C<Waiting>, C<Reserved>, or 0.
1816 =item C<WasReturned>
1818 Value 1 if return is successful.
1820 =item C<NeedsTransfer>
1822 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1826 C<$iteminformation> is a reference-to-hash, giving information about the
1827 returned item from the issues table.
1829 C<$borrower> is a reference-to-hash, giving information about the
1830 patron who last borrowed the book.
1835 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1837 if ($branch and not Koha::Libraries->find($branch)) {
1838 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1841 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1842 $return_date //= dt_from_string();
1846 my $validTransfert = 0;
1847 my $stat_type = 'return';
1849 # get information on item
1850 my $item = Koha::Items->find({ barcode => $barcode });
1852 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1855 my $itemnumber = $item->itemnumber;
1856 my $itemtype = $item->effective_itemtype;
1858 my $issue = $item->checkout;
1860 $patron = $issue->patron
1861 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1862 . Dumper($issue->unblessed) . "\n";
1864 $messages->{'NotIssued'} = $barcode;
1865 ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1866 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1868 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1869 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1870 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1871 $messages->{'LocalUse'} = 1;
1872 $stat_type = 'localuse';
1876 my $item_unblessed = $item->unblessed;
1877 # full item data, but no borrowernumber or checkout info (no issue)
1878 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1879 # get the proper branch to which to return the item
1880 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1881 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1883 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1884 my $patron_unblessed = $patron ? $patron->unblessed : {};
1886 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1887 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1888 if ($update_loc_rules) {
1889 if (defined $update_loc_rules->{_ALL_}) {
1890 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1891 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1892 if ( $item->location ne $update_loc_rules->{_ALL_}) {
1893 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1894 ModItem( { location => $update_loc_rules->{_ALL_} }, undef, $itemnumber );
1898 foreach my $key ( keys %$update_loc_rules ) {
1899 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1900 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1901 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1902 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1903 ModItem( { location => $update_loc_rules->{$key} }, undef, $itemnumber );
1910 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1912 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1914 eval { $rules = YAML::Load($yaml); };
1916 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1919 foreach my $key ( keys %$rules ) {
1920 if ( $item->notforloan eq $key ) {
1921 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1922 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1929 # check if the return is allowed at this branch
1930 my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1931 unless ($returnallowed){
1932 $messages->{'Wrongbranch'} = {
1933 Wrongbranch => $branch,
1934 Rightbranch => $message
1937 return ( $doreturn, $messages, $issue, $patron_unblessed);
1940 if ( $item->withdrawn ) { # book has been cancelled
1941 $messages->{'withdrawn'} = 1;
1942 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1945 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1949 # case of a return of document (deal with issues and holdingbranch)
1952 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1953 $patron or warn "AddReturn without current borrower";
1954 $is_overdue = $issue->is_overdue( $return_date );
1958 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1961 if ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue && !$item->itemlost ) {
1962 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1965 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 );
1967 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1970 # FIXME is the "= 1" right? This could be the borrower hash.
1971 $messages->{'WasReturned'} = 1;
1975 ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1978 # the holdingbranch is updated if the document is returned to another location.
1979 # this is always done regardless of whether the item was on loan or not
1980 my $item_holding_branch = $item->holdingbranch;
1981 if ($item->holdingbranch ne $branch) {
1982 UpdateHoldingbranch($branch, $item->itemnumber);
1983 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1986 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1987 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
1989 # check if we have a transfer for this document
1990 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
1992 # if we have a transfer to do, we update the line of transfers with the datearrived
1993 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
1995 if ( $tobranch eq $branch ) {
1996 my $sth = C4::Context->dbh->prepare(
1997 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1999 $sth->execute( $item->itemnumber );
2000 # if we have a reservation with valid transfer, we can set it's status to 'W'
2001 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2003 $messages->{'WrongTransfer'} = $tobranch;
2004 $messages->{'WrongTransferItem'} = $item->itemnumber;
2006 $validTransfert = 1;
2009 # fix up the accounts.....
2010 if ( $item->itemlost ) {
2011 $messages->{'WasLost'} = 1;
2012 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2014 Koha::RefundLostItemFeeRules->should_refund(
2016 current_branch => C4::Context->userenv->{branch},
2017 item_home_branch => $item->homebranch,
2018 item_holding_branch => $item_holding_branch
2023 _FixAccountForLostAndReturned( $item->itemnumber,
2024 $borrowernumber, $barcode );
2025 $messages->{'LostItemFeeRefunded'} = 1;
2030 # fix up the overdues in accounts...
2031 if ($borrowernumber) {
2032 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine );
2033 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2035 if ( $issue and $issue->is_overdue ) {
2037 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $return_date );
2039 $messages->{'PrevDebarred'} = $debardate;
2041 $messages->{'Debarred'} = $debardate if $debardate;
2043 # there's no overdue on the item but borrower had been previously debarred
2044 } elsif ( $issue->date_due and $patron->debarred ) {
2045 if ( $patron->debarred eq "9999-12-31") {
2046 $messages->{'ForeverDebarred'} = $patron->debarred;
2048 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2049 $borrower_debar_dt->truncate(to => 'day');
2050 my $today_dt = $return_date->clone()->truncate(to => 'day');
2051 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2052 $messages->{'PrevDebarred'} = $patron->debarred;
2058 # find reserves.....
2059 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2060 my ($resfound, $resrec);
2061 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2062 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2064 $resrec->{'ResFound'} = $resfound;
2065 $messages->{'ResFound'} = $resrec;
2068 # Record the fact that this book was returned.
2072 itemnumber => $itemnumber,
2073 itemtype => $itemtype,
2074 borrowernumber => $borrowernumber,
2075 ccode => $item->ccode,
2078 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2080 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2082 branchcode => $branch,
2083 categorycode => $patron->categorycode,
2084 item_type => $itemtype,
2085 notification => 'CHECKIN',
2087 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2088 SendCirculationAlert({
2090 item => $item_unblessed,
2091 borrower => $patron->unblessed,
2096 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2097 if C4::Context->preference("ReturnLog");
2100 # Remove any OVERDUES related debarment if the borrower has no overdues
2101 if ( $borrowernumber
2102 && $patron->debarred
2103 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2104 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2105 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2107 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2110 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2111 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2112 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType");
2113 if (C4::Context->preference("AutomaticItemReturn" ) or
2114 (C4::Context->preference("UseBranchTransferLimits") and
2115 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2117 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2118 $debug and warn "item: " . Dumper($item_unblessed);
2119 ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2120 $messages->{'WasTransfered'} = 1;
2122 $messages->{'NeedsTransfer'} = $returnbranch;
2126 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2129 =head2 MarkIssueReturned
2131 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2133 Unconditionally marks an issue as being returned by
2134 moving the C<issues> row to C<old_issues> and
2135 setting C<returndate> to the current date.
2137 if C<$returndate> is specified (in iso format), it is used as the date
2140 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2141 the old_issue is immediately anonymised
2143 Ideally, this function would be internal to C<C4::Circulation>,
2144 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2145 and offline_circ/process_koc.pl.
2149 sub MarkIssueReturned {
2150 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2152 # Retrieve the issue
2153 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2154 my $issue_id = $issue->issue_id;
2156 my $anonymouspatron;
2157 if ( $privacy == 2 ) {
2158 # The default of 0 will not work due to foreign key constraints
2159 # The anonymisation will fail if AnonymousPatron is not a valid entry
2160 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2161 # Note that a warning should appear on the about page (System information tab).
2162 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2163 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."
2164 unless Koha::Patrons->find( $anonymouspatron );
2167 my $schema = Koha::Database->schema;
2169 # FIXME Improve the return value and handle it from callers
2170 $schema->txn_do(sub {
2172 # Update the returndate value
2173 if ( $returndate ) {
2174 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2177 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2180 # Create the old_issues entry
2181 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2183 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2184 if ( $privacy == 2) {
2185 $old_checkout->borrowernumber($anonymouspatron)->store;
2188 # And finally delete the issue
2191 ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2193 if ( C4::Context->preference('StoreLastBorrower') ) {
2194 my $item = Koha::Items->find( $itemnumber );
2195 my $patron = Koha::Patrons->find( $borrowernumber );
2196 $item->last_returned_by( $patron );
2203 =head2 _debar_user_on_return
2205 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2207 C<$borrower> borrower hashref
2209 C<$item> item hashref
2211 C<$datedue> date due DateTime object
2213 C<$returndate> DateTime object representing the return time
2215 Internal function, called only by AddReturn that calculates and updates
2216 the user fine days, and debars them if necessary.
2218 Should only be called for overdue returns
2222 sub _debar_user_on_return {
2223 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2225 my $branchcode = _GetCircControlBranch( $item, $borrower );
2226 $return_date //= dt_from_string();
2228 my $circcontrol = C4::Context->preference('CircControl');
2229 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2230 { categorycode => $borrower->{categorycode},
2231 itemtype => $item->{itype},
2232 branchcode => $branchcode
2235 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2236 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2237 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2241 # finedays is in days, so hourly loans must multiply by 24
2242 # thus 1 hour late equals 1 day suspension * finedays rate
2243 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2245 # grace period is measured in the same units as the loan
2247 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2249 my $deltadays = DateTime::Duration->new(
2250 days => $chargeable_units
2252 if ( $deltadays->subtract($grace)->is_positive() ) {
2253 my $suspension_days = $deltadays * $finedays;
2255 # If the max suspension days is < than the suspension days
2256 # the suspension days is limited to this maximum period.
2257 my $max_sd = $issuing_rule->maxsuspensiondays;
2258 if ( defined $max_sd ) {
2259 $max_sd = DateTime::Duration->new( days => $max_sd );
2260 $suspension_days = $max_sd
2261 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2264 my ( $has_been_extended, $is_a_reminder );
2265 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2266 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2268 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2269 $has_been_extended = 1;
2273 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2274 # No need to / 1 and do not consider / 0
2275 $suspension_days = DateTime::Duration->new(
2276 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2281 # Use the calendar or not to calculate the debarment date
2282 if ( C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed' ) {
2283 my $calendar = Koha::Calendar->new(
2284 branchcode => $branchcode,
2285 days_mode => 'Calendar'
2287 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2290 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2293 Koha::Patron::Debarments::AddUniqueDebarment({
2294 borrowernumber => $borrower->{borrowernumber},
2295 expiration => $new_debar_dt->ymd(),
2296 type => 'SUSPENSION',
2298 # if borrower was already debarred but does not get an extra debarment
2299 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2300 my $new_debarment_str;
2301 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2303 $new_debarment_str = $borrower->{debarred};
2305 $new_debarment_str = $new_debar_dt->ymd();
2307 # FIXME Should return a DateTime object
2308 return $new_debarment_str, $is_a_reminder;
2314 =head2 _FixOverduesOnReturn
2316 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine);
2318 C<$borrowernumber> borrowernumber
2320 C<$itemnumber> itemnumber
2322 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2328 sub _FixOverduesOnReturn {
2329 my ( $borrowernumber, $item, $exemptfine ) = @_;
2330 unless( $borrowernumber ) {
2331 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2335 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2339 my $schema = Koha::Database->schema;
2341 my $result = $schema->txn_do(
2343 # check for overdue fine
2344 my $accountlines = Koha::Account::Lines->search(
2346 borrowernumber => $borrowernumber,
2347 itemnumber => $item,
2348 accounttype => 'OVERDUE',
2349 status => 'UNRETURNED'
2352 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2354 my $accountline = $accountlines->next;
2356 my $amountoutstanding = $accountline->amountoutstanding;
2358 my $account = Koha::Account->new({patron_id => $borrowernumber});
2359 my $credit = $account->add_credit(
2361 amount => $amountoutstanding,
2362 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2363 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2364 interface => C4::Context->interface,
2370 $credit->apply({ debits => $accountlines->reset, offset_type => 'Forgiven' });
2372 $accountline->status('FORGIVEN');
2374 if (C4::Context->preference("FinesLog")) {
2375 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2378 $accountline->status('RETURNED');
2381 return $accountline->store();
2388 =head2 _FixAccountForLostAndReturned
2390 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2392 Calculates the charge for a book lost and returned.
2394 Internal function, not exported, called only by AddReturn.
2398 sub _FixAccountForLostAndReturned {
2399 my $itemnumber = shift or return;
2400 my $borrowernumber = @_ ? shift : undef;
2401 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2405 # check for charge made for lost book
2406 my $accountlines = Koha::Account::Lines->search(
2408 itemnumber => $itemnumber,
2412 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2416 return unless $accountlines->count > 0;
2417 my $accountline = $accountlines->next;
2418 my $total_to_refund = 0;
2420 return unless $accountline->borrowernumber;
2421 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2422 return unless $patron; # Patron has been deleted, nobody to credit the return to
2424 my $account = $patron->account;
2427 if ( $accountline->amount > $accountline->amountoutstanding ) {
2428 # some amount has been cancelled. collect the offsets that are not writeoffs
2429 # this works because the only way to subtract from this kind of a debt is
2430 # using the UI buttons 'Pay' and 'Write off'
2431 my $credits_offsets = Koha::Account::Offsets->search({
2432 debit_id => $accountline->id,
2433 credit_id => { '!=' => undef }, # it is not the debit itself
2434 type => { '!=' => 'Writeoff' },
2435 amount => { '<' => 0 } # credits are negative on the DB
2438 $total_to_refund = ( $credits_offsets->count > 0 )
2439 ? $credits_offsets->total * -1 # credits are negative on the DB
2443 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2445 if ( $credit_total > 0 ) {
2446 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2447 $credit = $account->add_credit(
2448 { amount => $credit_total,
2449 description => 'Item Returned ' . $item_id,
2450 type => 'lost_item_return',
2451 interface => C4::Context->interface,
2452 library_id => $branchcode
2456 # TODO: ->apply should just accept the accountline
2457 $credit->apply( { debits => $accountlines->reset } );
2460 # Manually set the accounttype
2461 $accountline->discard_changes->accounttype('LR');
2462 $accountline->store;
2464 ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2466 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2467 $account->reconcile_balance;
2470 return ($credit) ? $credit->id : undef;
2473 =head2 _GetCircControlBranch
2475 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2479 Return the library code to be used to determine which circulation
2480 policy applies to a transaction. Looks up the CircControl and
2481 HomeOrHoldingBranch system preferences.
2483 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2485 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2489 sub _GetCircControlBranch {
2490 my ($item, $borrower) = @_;
2491 my $circcontrol = C4::Context->preference('CircControl');
2494 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2495 $branch= C4::Context->userenv->{'branch'};
2496 } elsif ($circcontrol eq 'PatronLibrary') {
2497 $branch=$borrower->{branchcode};
2499 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2500 $branch = $item->{$branchfield};
2501 # default to item home branch if holdingbranch is used
2502 # and is not defined
2503 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2504 $branch = $item->{homebranch};
2512 $issue = GetOpenIssue( $itemnumber );
2514 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2516 C<$itemnumber> is the item's itemnumber
2523 my ( $itemnumber ) = @_;
2524 return unless $itemnumber;
2525 my $dbh = C4::Context->dbh;
2526 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2527 $sth->execute( $itemnumber );
2528 return $sth->fetchrow_hashref();
2532 =head2 GetBiblioIssues
2534 $issues = GetBiblioIssues($biblionumber);
2536 this function get all issues from a biblionumber.
2539 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2540 tables issues and the firstname,surname & cardnumber from borrowers.
2544 sub GetBiblioIssues {
2545 my $biblionumber = shift;
2546 return unless $biblionumber;
2547 my $dbh = C4::Context->dbh;
2549 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2551 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2552 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2553 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2554 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2555 WHERE biblio.biblionumber = ?
2557 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2559 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2560 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2561 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2562 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2563 WHERE biblio.biblionumber = ?
2566 my $sth = $dbh->prepare($query);
2567 $sth->execute($biblionumber, $biblionumber);
2570 while ( my $data = $sth->fetchrow_hashref ) {
2571 push @issues, $data;
2576 =head2 GetUpcomingDueIssues
2578 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2582 sub GetUpcomingDueIssues {
2585 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2586 my $dbh = C4::Context->dbh;
2588 my $statement = <<END_SQL;
2591 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2593 LEFT JOIN items USING (itemnumber)
2594 LEFT OUTER JOIN branches USING (branchcode)
2595 WHERE returndate is NULL
2597 WHERE days_until_due >= 0 AND days_until_due <= ?
2600 my @bind_parameters = ( $params->{'days_in_advance'} );
2602 my $sth = $dbh->prepare( $statement );
2603 $sth->execute( @bind_parameters );
2604 my $upcoming_dues = $sth->fetchall_arrayref({});
2606 return $upcoming_dues;
2609 =head2 CanBookBeRenewed
2611 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2613 Find out whether a borrowed item may be renewed.
2615 C<$borrowernumber> is the borrower number of the patron who currently
2616 has the item on loan.
2618 C<$itemnumber> is the number of the item to renew.
2620 C<$override_limit>, if supplied with a true value, causes
2621 the limit on the number of times that the loan can be renewed
2622 (as controlled by the item type) to be ignored. Overriding also allows
2623 to renew sooner than "No renewal before" and to manually renew loans
2624 that are automatically renewed.
2626 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2627 item must currently be on loan to the specified borrower; renewals
2628 must be allowed for the item's type; and the borrower must not have
2629 already renewed the loan. $error will contain the reason the renewal can not proceed
2633 sub CanBookBeRenewed {
2634 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2636 my $dbh = C4::Context->dbh;
2639 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2640 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2641 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2642 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2644 my $patron = $issue->patron or return;
2646 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2648 # This item can fill one or more unfilled reserve, can those unfilled reserves
2649 # all be filled by other available items?
2651 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2653 my $schema = Koha::Database->new()->schema();
2655 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2657 # There is an item level hold on this item, no other item can fill the hold
2662 # Get all other items that could possibly fill reserves
2663 my @itemnumbers = $schema->resultset('Item')->search(
2665 biblionumber => $resrec->{biblionumber},
2668 -not => { itemnumber => $itemnumber }
2670 { columns => 'itemnumber' }
2671 )->get_column('itemnumber')->all();
2673 # Get all other reserves that could have been filled by this item
2674 my @borrowernumbers;
2676 my ( $reserve_found, $reserve, undef ) =
2677 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2679 if ($reserve_found) {
2680 push( @borrowernumbers, $reserve->{borrowernumber} );
2687 # If the count of the union of the lists of reservable items for each borrower
2688 # is equal or greater than the number of borrowers, we know that all reserves
2689 # can be filled with available items. We can get the union of the sets simply
2690 # by pushing all the elements onto an array and removing the duplicates.
2693 ITEM: foreach my $itemnumber (@itemnumbers) {
2694 my $item = Koha::Items->find( $itemnumber );
2695 next if IsItemOnHoldAndFound( $itemnumber );
2696 for my $borrowernumber (@borrowernumbers) {
2697 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2698 next unless IsAvailableForItemLevelRequest($item, $patron);
2699 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2701 push @reservable, $itemnumber;
2702 if (@reservable >= @borrowernumbers) {
2711 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2713 return ( 1, undef ) if $override_limit;
2715 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2716 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2717 { categorycode => $patron->categorycode,
2718 itemtype => $item->effective_itemtype,
2719 branchcode => $branchcode
2723 return ( 0, "too_many" )
2724 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2726 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2727 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2728 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2729 my $restricted = $patron->is_debarred;
2730 my $hasoverdues = $patron->has_overdues;
2732 if ( $restricted and $restrictionblockrenewing ) {
2733 return ( 0, 'restriction');
2734 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2735 return ( 0, 'overdue');
2738 if ( $issue->auto_renew ) {
2740 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2741 return ( 0, 'auto_account_expired' );
2744 if ( defined $issuing_rule->no_auto_renewal_after
2745 and $issuing_rule->no_auto_renewal_after ne "" ) {
2746 # Get issue_date and add no_auto_renewal_after
2747 # If this is greater than today, it's too late for renewal.
2748 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2749 $maximum_renewal_date->add(
2750 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2752 my $now = dt_from_string;
2753 if ( $now >= $maximum_renewal_date ) {
2754 return ( 0, "auto_too_late" );
2757 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2758 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2759 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2760 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2761 return ( 0, "auto_too_late" );
2765 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2766 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2767 my $amountoutstanding = $patron->account->balance;
2768 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2769 return ( 0, "auto_too_much_oweing" );
2774 if ( defined $issuing_rule->norenewalbefore
2775 and $issuing_rule->norenewalbefore ne "" )
2778 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2779 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2780 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2782 # Depending on syspref reset the exact time, only check the date
2783 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2784 and $issuing_rule->lengthunit eq 'days' )
2786 $soonestrenewal->truncate( to => 'day' );
2789 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2791 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2792 return ( 0, "too_soon" );
2794 elsif ( $issue->auto_renew ) {
2795 return ( 0, "auto_renew" );
2799 # Fallback for automatic renewals:
2800 # If norenewalbefore is undef, don't renew before due date.
2801 if ( $issue->auto_renew ) {
2802 my $now = dt_from_string;
2803 return ( 0, "auto_renew" )
2804 if $now >= dt_from_string( $issue->date_due, 'sql' );
2805 return ( 0, "auto_too_soon" );
2808 return ( 1, undef );
2813 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2817 C<$borrowernumber> is the borrower number of the patron who currently
2820 C<$itemnumber> is the number of the item to renew.
2822 C<$branch> is the library where the renewal took place (if any).
2823 The library that controls the circ policies for the renewal is retrieved from the issues record.
2825 C<$datedue> can be a DateTime object used to set the due date.
2827 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2828 this parameter is not supplied, lastreneweddate is set to the current date.
2830 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2831 from the book's item type.
2836 my $borrowernumber = shift;
2837 my $itemnumber = shift or return;
2839 my $datedue = shift;
2840 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2842 my $item_object = Koha::Items->find($itemnumber) or return;
2843 my $biblio = $item_object->biblio;
2844 my $issue = $item_object->checkout;
2845 my $item_unblessed = $item_object->unblessed;
2847 my $dbh = C4::Context->dbh;
2849 return unless $issue;
2851 $borrowernumber ||= $issue->borrowernumber;
2853 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2854 carp 'Invalid date passed to AddRenewal.';
2858 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2859 my $patron_unblessed = $patron->unblessed;
2861 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2863 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2864 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2866 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2868 # If the due date wasn't specified, calculate it by adding the
2869 # book's loan length to today's date or the current due date
2870 # based on the value of the RenewalPeriodBase syspref.
2871 my $itemtype = $item_object->effective_itemtype;
2874 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2875 dt_from_string( $issue->date_due, 'sql' ) :
2876 DateTime->now( time_zone => C4::Context->tz());
2877 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2880 my $fees = Koha::Charges::Fees->new(
2883 library => $circ_library,
2884 item => $item_object,
2885 from_date => dt_from_string( $issue->date_due, 'sql' ),
2886 to_date => dt_from_string($datedue),
2890 # Update the issues record to have the new due date, and a new count
2891 # of how many times it has been renewed.
2892 my $renews = $issue->renewals + 1;
2893 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2894 WHERE borrowernumber=?
2898 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2900 # Update the renewal count on the item, and tell zebra to reindex
2901 $renews = $item_object->renewals + 1;
2902 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2904 # Charge a new rental fee, if applicable
2905 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2906 if ( $charge > 0 ) {
2907 my $description = "Renewal of Rental Item " . $biblio->title . " " .$item_object->barcode;
2908 AddIssuingCharge($issue, $charge, $description);
2911 # Charge a new accumulate rental fee, if applicable
2912 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2913 if ( $itemtype_object ) {
2914 my $accumulate_charge = $fees->accumulate_rentalcharge();
2915 if ( $accumulate_charge > 0 ) {
2916 my $type_desc = "Renewal of Daily Rental Item " . $biblio->title . " $item_unblessed->{'barcode'}";
2917 AddIssuingCharge( $issue, $accumulate_charge, $type_desc )
2919 $charge += $accumulate_charge;
2922 # Send a renewal slip according to checkout alert preferencei
2923 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2924 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2926 branchcode => $branch,
2927 categorycode => $patron->categorycode,
2928 item_type => $itemtype,
2929 notification => 'CHECKOUT',
2931 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2932 SendCirculationAlert(
2935 item => $item_unblessed,
2936 borrower => $patron->unblessed,
2943 # Remove any OVERDUES related debarment if the borrower has no overdues
2945 && $patron->is_debarred
2946 && ! $patron->has_overdues
2947 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2949 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2952 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2953 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2956 # Add the renewal to stats
2962 itemnumber => $itemnumber,
2963 itemtype => $itemtype,
2964 location => $item_object->location,
2965 borrowernumber => $borrowernumber,
2966 ccode => $item_object->ccode,
2971 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2976 # check renewal status
2977 my ( $bornum, $itemno ) = @_;
2978 my $dbh = C4::Context->dbh;
2980 my $renewsallowed = 0;
2983 my $patron = Koha::Patrons->find( $bornum );
2984 my $item = Koha::Items->find($itemno);
2986 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2988 # Look in the issues table for this item, lent to this borrower,
2989 # and not yet returned.
2991 # FIXME - I think this function could be redone to use only one SQL call.
2992 my $sth = $dbh->prepare(
2993 "select * from issues
2994 where (borrowernumber = ?)
2995 and (itemnumber = ?)"
2997 $sth->execute( $bornum, $itemno );
2998 my $data = $sth->fetchrow_hashref;
2999 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3000 # $item and $borrower should be calculated
3001 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3003 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3004 { categorycode => $patron->categorycode,
3005 itemtype => $item->effective_itemtype,
3006 branchcode => $branchcode
3010 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3011 $renewsleft = $renewsallowed - $renewcount;
3012 if($renewsleft < 0){ $renewsleft = 0; }
3013 return ( $renewcount, $renewsallowed, $renewsleft );
3016 =head2 GetSoonestRenewDate
3018 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3020 Find out the soonest possible renew date of a borrowed item.
3022 C<$borrowernumber> is the borrower number of the patron who currently
3023 has the item on loan.
3025 C<$itemnumber> is the number of the item to renew.
3027 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3028 renew date, based on the value "No renewal before" of the applicable
3029 issuing rule. Returns the current date if the item can already be
3030 renewed, and returns undefined if the borrower, loan, or item
3035 sub GetSoonestRenewDate {
3036 my ( $borrowernumber, $itemnumber ) = @_;
3038 my $dbh = C4::Context->dbh;
3040 my $item = Koha::Items->find($itemnumber) or return;
3041 my $itemissue = $item->checkout or return;
3043 $borrowernumber ||= $itemissue->borrowernumber;
3044 my $patron = Koha::Patrons->find( $borrowernumber )
3047 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3048 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3049 { categorycode => $patron->categorycode,
3050 itemtype => $item->effective_itemtype,
3051 branchcode => $branchcode
3055 my $now = dt_from_string;
3056 return $now unless $issuing_rule;
3058 if ( defined $issuing_rule->norenewalbefore
3059 and $issuing_rule->norenewalbefore ne "" )
3061 my $soonestrenewal =
3062 dt_from_string( $itemissue->date_due )->subtract(
3063 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3065 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3066 and $issuing_rule->lengthunit eq 'days' )
3068 $soonestrenewal->truncate( to => 'day' );
3070 return $soonestrenewal if $now < $soonestrenewal;
3075 =head2 GetLatestAutoRenewDate
3077 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3079 Find out the latest possible auto renew date of a borrowed item.
3081 C<$borrowernumber> is the borrower number of the patron who currently
3082 has the item on loan.
3084 C<$itemnumber> is the number of the item to renew.
3086 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3087 auto renew date, based on the value "No auto renewal after" and the "No auto
3088 renewal after (hard limit) of the applicable issuing rule.
3089 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3090 or item cannot be found.
3094 sub GetLatestAutoRenewDate {
3095 my ( $borrowernumber, $itemnumber ) = @_;
3097 my $dbh = C4::Context->dbh;
3099 my $item = Koha::Items->find($itemnumber) or return;
3100 my $itemissue = $item->checkout or return;
3102 $borrowernumber ||= $itemissue->borrowernumber;
3103 my $patron = Koha::Patrons->find( $borrowernumber )
3106 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3107 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3108 { categorycode => $patron->categorycode,
3109 itemtype => $item->effective_itemtype,
3110 branchcode => $branchcode
3114 return unless $issuing_rule;
3116 if ( not $issuing_rule->no_auto_renewal_after
3117 or $issuing_rule->no_auto_renewal_after eq '' )
3118 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3119 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3121 my $maximum_renewal_date;
3122 if ( $issuing_rule->no_auto_renewal_after ) {
3123 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3124 $maximum_renewal_date->add(
3125 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3129 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3130 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3131 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3133 return $maximum_renewal_date;
3137 =head2 GetIssuingCharges
3139 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3141 Calculate how much it would cost for a given patron to borrow a given
3142 item, including any applicable discounts.
3144 C<$itemnumber> is the item number of item the patron wishes to borrow.
3146 C<$borrowernumber> is the patron's borrower number.
3148 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3149 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3154 sub GetIssuingCharges {
3156 # calculate charges due
3157 my ( $itemnumber, $borrowernumber ) = @_;
3159 my $dbh = C4::Context->dbh;
3162 # Get the book's item type and rental charge (via its biblioitem).
3163 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3164 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3165 $charge_query .= (C4::Context->preference('item-level_itypes'))
3166 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3167 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3169 $charge_query .= ' WHERE items.itemnumber =?';
3171 my $sth = $dbh->prepare($charge_query);
3172 $sth->execute($itemnumber);
3173 if ( my $item_data = $sth->fetchrow_hashref ) {
3174 $item_type = $item_data->{itemtype};
3175 $charge = $item_data->{rentalcharge};
3176 my $branch = C4::Context::mybranch();
3177 my $discount_query = q|SELECT rentaldiscount,
3178 issuingrules.itemtype, issuingrules.branchcode
3180 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3181 WHERE borrowers.borrowernumber = ?
3182 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3183 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3184 my $discount_sth = $dbh->prepare($discount_query);
3185 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3186 my $discount_rules = $discount_sth->fetchall_arrayref({});
3187 if (@{$discount_rules}) {
3188 # We may have multiple rules so get the most specific
3189 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3190 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3193 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3197 return ( $charge, $item_type );
3200 # Select most appropriate discount rule from those returned
3201 sub _get_discount_from_rule {
3202 my ($rules_ref, $branch, $itemtype) = @_;
3205 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3206 $discount = $rules_ref->[0]->{rentaldiscount};
3207 return (defined $discount) ? $discount : 0;
3209 # could have up to 4 does one match $branch and $itemtype
3210 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3212 $discount = $d[0]->{rentaldiscount};
3213 return (defined $discount) ? $discount : 0;
3215 # do we have item type + all branches
3216 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3218 $discount = $d[0]->{rentaldiscount};
3219 return (defined $discount) ? $discount : 0;
3221 # do we all item types + this branch
3222 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3224 $discount = $d[0]->{rentaldiscount};
3225 return (defined $discount) ? $discount : 0;
3227 # so all and all (surely we wont get here)
3228 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3230 $discount = $d[0]->{rentaldiscount};
3231 return (defined $discount) ? $discount : 0;
3237 =head2 AddIssuingCharge
3239 &AddIssuingCharge( $checkout, $charge, [$description] )
3243 sub AddIssuingCharge {
3244 my ( $checkout, $charge, $description ) = @_;
3246 # FIXME What if checkout does not exist?
3248 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3249 my $accountline = $account->add_debit(
3252 description => $description,
3254 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3255 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3256 interface => C4::Context->interface,
3258 item_id => $checkout->itemnumber,
3259 issue_id => $checkout->issue_id,
3266 GetTransfers($itemnumber);
3271 my ($itemnumber) = @_;
3273 my $dbh = C4::Context->dbh;
3280 FROM branchtransfers
3281 WHERE itemnumber = ?
3282 AND datearrived IS NULL
3284 my $sth = $dbh->prepare($query);
3285 $sth->execute($itemnumber);
3286 my @row = $sth->fetchrow_array();
3290 =head2 GetTransfersFromTo
3292 @results = GetTransfersFromTo($frombranch,$tobranch);
3294 Returns the list of pending transfers between $from and $to branch
3298 sub GetTransfersFromTo {
3299 my ( $frombranch, $tobranch ) = @_;
3300 return unless ( $frombranch && $tobranch );
3301 my $dbh = C4::Context->dbh;
3303 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3304 FROM branchtransfers
3307 AND datearrived IS NULL
3309 my $sth = $dbh->prepare($query);
3310 $sth->execute( $frombranch, $tobranch );
3313 while ( my $data = $sth->fetchrow_hashref ) {
3314 push @gettransfers, $data;
3316 return (@gettransfers);
3319 =head2 DeleteTransfer
3321 &DeleteTransfer($itemnumber);
3325 sub DeleteTransfer {
3326 my ($itemnumber) = @_;
3327 return unless $itemnumber;
3328 my $dbh = C4::Context->dbh;
3329 my $sth = $dbh->prepare(
3330 "DELETE FROM branchtransfers
3332 AND datearrived IS NULL "
3334 return $sth->execute($itemnumber);
3337 =head2 SendCirculationAlert
3339 Send out a C<check-in> or C<checkout> alert using the messaging system.
3347 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3351 Hashref of information about the item being checked in or out.
3355 Hashref of information about the borrower of the item.
3359 The branchcode from where the checkout or check-in took place.
3365 SendCirculationAlert({
3368 borrower => $borrower,
3374 sub SendCirculationAlert {
3376 my ($type, $item, $borrower, $branch) =
3377 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3378 my %message_name = (
3379 CHECKIN => 'Item_Check_in',
3380 CHECKOUT => 'Item_Checkout',
3381 RENEWAL => 'Item_Checkout',
3383 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3384 borrowernumber => $borrower->{borrowernumber},
3385 message_name => $message_name{$type},
3387 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3389 my $schema = Koha::Database->new->schema;
3390 my @transports = keys %{ $borrower_preferences->{transports} };
3392 # From the MySQL doc:
3393 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3394 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3395 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3396 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3398 for my $mtt (@transports) {
3399 my $letter = C4::Letters::GetPreparedLetter (
3400 module => 'circulation',
3401 letter_code => $type,
3402 branchcode => $branch,
3403 message_transport_type => $mtt,
3404 lang => $borrower->{lang},
3406 $issues_table => $item->{itemnumber},
3407 'items' => $item->{itemnumber},
3408 'biblio' => $item->{biblionumber},
3409 'biblioitems' => $item->{biblionumber},
3410 'borrowers' => $borrower,
3411 'branches' => $branch,
3415 $schema->storage->txn_begin;
3416 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3417 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3418 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3419 unless ( $message ) {
3420 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3421 C4::Message->enqueue($letter, $borrower, $mtt);
3423 $message->append($letter);
3426 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3427 $schema->storage->txn_commit;
3433 =head2 updateWrongTransfer
3435 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3437 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
3441 sub updateWrongTransfer {
3442 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3443 my $dbh = C4::Context->dbh;
3444 # first step validate the actual line of transfert .
3447 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3449 $sth->execute($FromLibrary,$itemNumber);
3451 # second step create a new line of branchtransfer to the right location .
3452 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3454 #third step changing holdingbranch of item
3455 UpdateHoldingbranch($FromLibrary,$itemNumber);
3458 =head2 UpdateHoldingbranch
3460 $items = UpdateHoldingbranch($branch,$itmenumber);
3462 Simple methode for updating hodlingbranch in items BDD line
3466 sub UpdateHoldingbranch {
3467 my ( $branch,$itemnumber ) = @_;
3468 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3473 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3475 this function calculates the due date given the start date and configured circulation rules,
3476 checking against the holidays calendar as per the 'useDaysMode' syspref.
3477 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3478 C<$itemtype> = itemtype code of item in question
3479 C<$branch> = location whose calendar to use
3480 C<$borrower> = Borrower object
3481 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3486 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3490 # loanlength now a href
3492 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3494 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3500 if (ref $startdate ne 'DateTime' ) {
3501 $datedue = dt_from_string($datedue);
3503 $datedue = $startdate->clone;
3507 DateTime->now( time_zone => C4::Context->tz() )
3508 ->truncate( to => 'minute' );
3512 # calculate the datedue as normal
3513 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3514 { # ignoring calendar
3515 if ( $loanlength->{lengthunit} eq 'hours' ) {
3516 $datedue->add( hours => $loanlength->{$length_key} );
3518 $datedue->add( days => $loanlength->{$length_key} );
3519 $datedue->set_hour(23);
3520 $datedue->set_minute(59);
3524 if ($loanlength->{lengthunit} eq 'hours') {
3525 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3528 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3530 my $calendar = Koha::Calendar->new( branchcode => $branch );
3531 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3532 if ($loanlength->{lengthunit} eq 'days') {
3533 $datedue->set_hour(23);
3534 $datedue->set_minute(59);
3538 # if Hard Due Dates are used, retrieve them and apply as necessary
3539 my ( $hardduedate, $hardduedatecompare ) =
3540 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3541 if ($hardduedate) { # hardduedates are currently dates
3542 $hardduedate->truncate( to => 'minute' );
3543 $hardduedate->set_hour(23);
3544 $hardduedate->set_minute(59);
3545 my $cmp = DateTime->compare( $hardduedate, $datedue );
3547 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3548 # if the calculated date is before the 'after' Hard Due Date (floor), override
3549 # if the hard due date is set to 'exactly', overrride
3550 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3551 $datedue = $hardduedate->clone;
3554 # in all other cases, keep the date due as it is
3558 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3559 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3560 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3561 if( $expiry_dt ) { #skip empty expiry date..
3562 $expiry_dt->set( hour => 23, minute => 59);
3563 my $d1= $datedue->clone->set_time_zone('floating');
3564 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3565 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3568 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3569 my $calendar = Koha::Calendar->new( branchcode => $branch );
3570 if ( $calendar->is_holiday($datedue) ) {
3571 # Don't return on a closed day
3572 $datedue = $calendar->prev_open_day( $datedue );
3581 sub CheckValidBarcode{
3583 my $dbh = C4::Context->dbh;
3584 my $query=qq|SELECT count(*)
3588 my $sth = $dbh->prepare($query);
3589 $sth->execute($barcode);
3590 my $exist=$sth->fetchrow ;
3594 =head2 IsBranchTransferAllowed
3596 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3598 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3600 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3601 Koha::Item->can_be_transferred.
3605 sub IsBranchTransferAllowed {
3606 my ( $toBranch, $fromBranch, $code ) = @_;
3608 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3610 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3611 my $dbh = C4::Context->dbh;
3613 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3614 $sth->execute( $toBranch, $fromBranch, $code );
3615 my $limit = $sth->fetchrow_hashref();
3617 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3618 if ( $limit->{'limitId'} ) {
3625 =head2 CreateBranchTransferLimit
3627 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3629 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3631 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3635 sub CreateBranchTransferLimit {
3636 my ( $toBranch, $fromBranch, $code ) = @_;
3637 return unless defined($toBranch) && defined($fromBranch);
3638 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3640 my $dbh = C4::Context->dbh;
3642 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3643 return $sth->execute( $code, $toBranch, $fromBranch );
3646 =head2 DeleteBranchTransferLimits
3648 my $result = DeleteBranchTransferLimits($frombranch);
3650 Deletes all the library transfer limits for one library. Returns the
3651 number of limits deleted, 0e0 if no limits were deleted, or undef if
3652 no arguments are supplied.
3654 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3655 fromBranch => $fromBranch
3660 sub DeleteBranchTransferLimits {
3662 return unless defined $branch;
3663 my $dbh = C4::Context->dbh;
3664 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3665 return $sth->execute($branch);
3669 my ( $borrowernumber, $itemnum ) = @_;
3671 MarkIssueReturned( $borrowernumber, $itemnum );
3672 my $patron = Koha::Patrons->find( $borrowernumber );
3673 my $item = Koha::Items->find($itemnum);
3674 my $old_note = ($item->paidfor && ($item->paidfor ne q{})) ? $item->paidfor.' / ' : q{};
3675 my @datearr = localtime(time);
3676 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3677 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3678 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3683 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3685 unless ( $mark_lost_from ) {
3686 # Temporary check to avoid regressions
3687 die q|LostItem called without $mark_lost_from, check the API.|;
3691 if ( $force_mark_returned ) {
3694 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3695 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3698 my $dbh = C4::Context->dbh();
3699 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3701 JOIN items USING (itemnumber)
3702 JOIN biblio USING (biblionumber)
3703 WHERE issues.itemnumber=?");
3704 $sth->execute($itemnumber);
3705 my $issues=$sth->fetchrow_hashref();
3707 # If a borrower lost the item, add a replacement cost to the their record
3708 if ( my $borrowernumber = $issues->{borrowernumber} ){
3709 my $patron = Koha::Patrons->find( $borrowernumber );
3711 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 0); # 1, 0 = exemptfine, no-dropbox
3712 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3714 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3715 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "$issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3716 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3717 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3720 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3723 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3724 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3725 ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3727 my $transferdeleted = DeleteTransfer($itemnumber);
3730 sub GetOfflineOperations {
3731 my $dbh = C4::Context->dbh;
3732 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3733 $sth->execute(C4::Context->userenv->{'branch'});
3734 my $results = $sth->fetchall_arrayref({});
3738 sub GetOfflineOperation {
3739 my $operationid = shift;
3740 return unless $operationid;
3741 my $dbh = C4::Context->dbh;
3742 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3743 $sth->execute( $operationid );
3744 return $sth->fetchrow_hashref;
3747 sub AddOfflineOperation {
3748 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3749 my $dbh = C4::Context->dbh;
3750 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3751 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3755 sub DeleteOfflineOperation {
3756 my $dbh = C4::Context->dbh;
3757 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3758 $sth->execute( shift );
3762 sub ProcessOfflineOperation {
3763 my $operation = shift;
3766 if ( $operation->{action} eq 'return' ) {
3767 $report = ProcessOfflineReturn( $operation );
3768 } elsif ( $operation->{action} eq 'issue' ) {
3769 $report = ProcessOfflineIssue( $operation );
3770 } elsif ( $operation->{action} eq 'payment' ) {
3771 $report = ProcessOfflinePayment( $operation );
3774 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3779 sub ProcessOfflineReturn {
3780 my $operation = shift;
3782 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3785 my $itemnumber = $item->itemnumber;
3786 my $issue = GetOpenIssue( $itemnumber );
3789 $issue->{borrowernumber},
3791 $operation->{timestamp},
3794 { renewals => 0, onloan => undef },
3795 $issue->{'biblionumber'},
3801 return "Item not issued.";
3804 return "Item not found.";
3808 sub ProcessOfflineIssue {
3809 my $operation = shift;
3811 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3814 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3816 return "Barcode not found.";
3818 my $itemnumber = $item->itemnumber;
3819 my $issue = GetOpenIssue( $itemnumber );
3821 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3823 $issue->{borrowernumber},
3825 $operation->{timestamp},
3830 $operation->{'barcode'},
3833 $operation->{timestamp},
3838 return "Borrower not found.";
3842 sub ProcessOfflinePayment {
3843 my $operation = shift;
3845 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3847 $patron->account->pay(
3849 amount => $operation->{amount},
3850 library_id => $operation->{branchcode},
3860 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3862 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3867 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3871 ? Koha::Items->find($itemnumber)
3872 : Koha::Items->find( { barcode => $barcode } );
3876 return C4::Letters::GetPreparedLetter (
3877 module => 'circulation',
3878 letter_code => 'TRANSFERSLIP',
3879 branchcode => $branch,
3881 'branches' => $to_branch,
3882 'biblio' => $item->biblionumber,
3883 'items' => $item->unblessed,
3888 =head2 CheckIfIssuedToPatron
3890 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3892 Return 1 if any record item is issued to patron, otherwise return 0
3896 sub CheckIfIssuedToPatron {
3897 my ($borrowernumber, $biblionumber) = @_;
3899 my $dbh = C4::Context->dbh;
3901 SELECT COUNT(*) FROM issues
3902 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3903 WHERE items.biblionumber = ?
3904 AND issues.borrowernumber = ?
3906 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3907 return 1 if $is_issued;
3913 IsItemIssued( $itemnumber )
3915 Return 1 if the item is on loan, otherwise return 0
3920 my $itemnumber = shift;
3921 my $dbh = C4::Context->dbh;
3922 my $sth = $dbh->prepare(q{
3925 WHERE itemnumber = ?
3927 $sth->execute($itemnumber);
3928 return $sth->fetchrow;
3931 =head2 GetAgeRestriction
3933 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3934 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3936 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3937 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3939 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3940 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3941 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3942 Negative days mean the borrower has gone past the age restriction age.
3946 sub GetAgeRestriction {
3947 my ($record_restrictions, $borrower) = @_;
3948 my $markers = C4::Context->preference('AgeRestrictionMarker');
3950 # Split $record_restrictions to something like FSK 16 or PEGI 6
3951 my @values = split ' ', uc($record_restrictions);
3952 return unless @values;
3954 # Search first occurrence of one of the markers
3955 my @markers = split /\|/, uc($markers);
3956 return unless @markers;
3959 my $restriction_year = 0;
3960 for my $value (@values) {
3962 for my $marker (@markers) {
3963 $marker =~ s/^\s+//; #remove leading spaces
3964 $marker =~ s/\s+$//; #remove trailing spaces
3965 if ( $marker eq $value ) {
3966 if ( $index <= $#values ) {
3967 $restriction_year += $values[$index];
3971 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3973 # Perhaps it is something like "K16" (as in Finland)
3974 $restriction_year += $1;
3978 last if ( $restriction_year > 0 );
3981 #Check if the borrower is age restricted for this material and for how long.
3982 if ($restriction_year && $borrower) {
3983 if ( $borrower->{'dateofbirth'} ) {
3984 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3985 $alloweddate[0] += $restriction_year;
3987 #Prevent runime eror on leap year (invalid date)
3988 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3989 $alloweddate[2] = 28;
3992 #Get how many days the borrower has to reach the age restriction
3993 my @Today = split /-/, DateTime->today->ymd();
3994 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3995 #Negative days means the borrower went past the age restriction age
3996 return ($restriction_year, $daysToAgeRestriction);
4000 return ($restriction_year);
4004 =head2 GetPendingOnSiteCheckouts
4008 sub GetPendingOnSiteCheckouts {
4009 my $dbh = C4::Context->dbh;
4010 return $dbh->selectall_arrayref(q|
4016 items.itemcallnumber,
4020 issues.date_due < NOW() AS is_overdue,
4023 borrowers.firstname,
4025 borrowers.cardnumber,
4026 borrowers.borrowernumber
4028 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4029 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4030 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4031 WHERE issues.onsite_checkout = 1
4032 |, { Slice => {} } );
4038 my ($count, $branch, $itemtype, $ccode, $newness)
4039 = @$params{qw(count branch itemtype ccode newness)};
4041 my $dbh = C4::Context->dbh;
4044 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4045 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4046 i.ccode, SUM(i.issues) AS count
4048 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4049 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4052 my (@where_strs, @where_args);
4055 push @where_strs, 'i.homebranch = ?';
4056 push @where_args, $branch;
4059 if (C4::Context->preference('item-level_itypes')){
4060 push @where_strs, 'i.itype = ?';
4061 push @where_args, $itemtype;
4063 push @where_strs, 'bi.itemtype = ?';
4064 push @where_args, $itemtype;
4068 push @where_strs, 'i.ccode = ?';
4069 push @where_args, $ccode;
4072 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4073 push @where_args, $newness;
4077 $query .= 'WHERE ' . join(' AND ', @where_strs);
4081 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4082 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4087 $query .= q{ ) xxx WHERE count > 0 };
4088 $count = int($count);
4090 $query .= "LIMIT $count";
4093 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4098 sub _CalculateAndUpdateFine {
4101 my $borrower = $params->{borrower};
4102 my $item = $params->{item};
4103 my $issue = $params->{issue};
4104 my $return_date = $params->{return_date};
4106 unless ($borrower) { carp "No borrower passed in!" && return; }
4107 unless ($item) { carp "No item passed in!" && return; }
4108 unless ($issue) { carp "No issue passed in!" && return; }
4110 my $datedue = dt_from_string( $issue->date_due );
4112 # we only need to calculate and change the fines if we want to do that on return
4113 # Should be on for hourly loans
4114 my $control = C4::Context->preference('CircControl');
4115 my $control_branchcode =
4116 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4117 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4118 : $issue->branchcode;
4120 my $date_returned = $return_date ? $return_date : dt_from_string();
4122 my ( $amount, $unitcounttotal, $unitcount ) =
4123 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4125 if ( C4::Context->preference('finesMode') eq 'production' ) {
4126 if ( $amount > 0 ) {
4127 C4::Overdues::UpdateFine({
4128 issue_id => $issue->issue_id,
4129 itemnumber => $issue->itemnumber,
4130 borrowernumber => $issue->borrowernumber,
4132 due => output_pref($datedue),
4135 elsif ($return_date) {
4137 # Backdated returns may have fines that shouldn't exist,
4138 # so in this case, we need to drop those fines to 0
4140 C4::Overdues::UpdateFine({
4141 issue_id => $issue->issue_id,
4142 itemnumber => $issue->itemnumber,
4143 borrowernumber => $issue->borrowernumber,
4145 due => output_pref($datedue),
4151 sub _item_denied_renewal {
4154 my $item = $params->{item};
4155 return unless $item;
4157 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4158 return unless $denyingrules;
4159 foreach my $field (keys %$denyingrules) {
4160 my $val = $item->$field;
4161 if( !defined $val) {
4162 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4165 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4166 # If the results matches the values in the syspref
4167 # We return true if match found
4181 Koha Development Team <http://koha-community.org/>