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;
320 my $itemnumber = $item->itemnumber;
321 my $issue = GetOpenIssue($itemnumber);
322 # get branches of book...
323 my $hbr = $item->homebranch;
324 my $fbr = $item->holdingbranch;
326 # if using Branch Transfer Limits
327 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
328 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
329 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
330 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
331 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
334 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
335 $messages->{'NotAllowed'} = $tbr . "::" . $code;
340 # can't transfer book if is already there....
341 if ( $fbr eq $tbr ) {
342 $messages->{'DestinationEqualsHolding'} = 1;
346 # check if it is still issued to someone, return it...
348 AddReturn( $barcode, $fbr );
349 $messages->{'WasReturned'} = $issue->borrowernumber;
353 # That'll save a database query.
354 my ( $resfound, $resrec, undef ) =
355 CheckReserves( $itemnumber );
356 if ( $resfound and not $ignoreRs ) {
357 $resrec->{'ResFound'} = $resfound;
359 # $messages->{'ResFound'} = $resrec;
363 #actually do the transfer....
365 ModItemTransfer( $itemnumber, $fbr, $tbr );
367 # don't need to update MARC anymore, we do it in batch now
368 $messages->{'WasTransfered'} = 1;
371 ModDateLastSeen( $itemnumber );
372 return ( $dotransfer, $messages );
377 my $borrower = shift;
378 my $biblionumber = 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,$borrower);
388 my $type = (C4::Context->preference('item-level_itypes'))
389 ? $item->{'itype'} # item-level
390 : $item->{'itemtype'}; # biblio-level
392 # given branch, patron category, and item type, determine
393 # applicable issuing rule
394 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
396 categorycode => $cat_borrower,
398 branchcode => $branch,
399 rule_name => 'maxissueqty',
402 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
404 categorycode => $cat_borrower,
406 branchcode => $branch,
407 rule_name => 'maxonsiteissueqty',
412 # if a rule is found and has a loan limit set, count
413 # how many loans the patron already has that meet that
415 if (defined($maxissueqty_rule) and defined($maxissueqty_rule->rule_value)) {
418 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
420 JOIN items USING (itemnumber)
423 my $rule_itemtype = $maxissueqty_rule->itemtype;
424 unless ($rule_itemtype) {
425 # matching rule has the default item type, so count only
426 # those existing loans that don't fall under a more
428 if (C4::Context->preference('item-level_itypes')) {
429 $count_query .= " WHERE items.itype NOT IN (
430 SELECT itemtype FROM issuingrules
432 AND (categorycode = ? OR categorycode = ?)
436 $count_query .= " JOIN biblioitems USING (biblionumber)
437 WHERE biblioitems.itemtype NOT IN (
438 SELECT itemtype FROM issuingrules
440 AND (categorycode = ? OR categorycode = ?)
444 push @bind_params, $maxissueqty_rule->branchcode;
445 push @bind_params, $maxissueqty_rule->categorycode;
446 push @bind_params, $cat_borrower;
448 # rule has specific item type, so count loans of that
450 if (C4::Context->preference('item-level_itypes')) {
451 $count_query .= " WHERE items.itype = ? ";
453 $count_query .= " JOIN biblioitems USING (biblionumber)
454 WHERE biblioitems.itemtype= ? ";
456 push @bind_params, $type;
459 $count_query .= " AND borrowernumber = ? ";
460 push @bind_params, $borrower->{'borrowernumber'};
461 my $rule_branch = $maxissueqty_rule->branchcode;
463 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
464 $count_query .= " AND issues.branchcode = ? ";
465 push @bind_params, $rule_branch;
466 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
467 ; # if branch is the patron's home branch, then count all loans by patron
469 $count_query .= " AND items.homebranch = ? ";
470 push @bind_params, $rule_branch;
474 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
476 my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
477 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
479 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
480 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
482 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
483 count => $onsite_checkout_count,
484 max_allowed => $max_onsite_checkouts_allowed,
488 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
489 my $delta = $switch_onsite_checkout ? 1 : 0;
490 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
492 reason => 'TOO_MANY_CHECKOUTS',
493 count => $checkout_count,
494 max_allowed => $max_checkouts_allowed,
497 } elsif ( not $onsite_checkout ) {
498 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
500 reason => 'TOO_MANY_CHECKOUTS',
501 count => $checkout_count - $onsite_checkout_count,
502 max_allowed => $max_checkouts_allowed,
508 # Now count total loans against the limit for the branch
509 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
510 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
511 my @bind_params = ();
512 my $branch_count_query = q|
513 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
515 JOIN items USING (itemnumber)
516 WHERE borrowernumber = ?
518 push @bind_params, $borrower->{borrowernumber};
520 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
521 $branch_count_query .= " AND issues.branchcode = ? ";
522 push @bind_params, $branch;
523 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
524 ; # if branch is the patron's home branch, then count all loans by patron
526 $branch_count_query .= " AND items.homebranch = ? ";
527 push @bind_params, $branch;
529 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
530 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
531 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
533 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
534 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
536 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
537 count => $onsite_checkout_count,
538 max_allowed => $max_onsite_checkouts_allowed,
542 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
543 my $delta = $switch_onsite_checkout ? 1 : 0;
544 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
546 reason => 'TOO_MANY_CHECKOUTS',
547 count => $checkout_count,
548 max_allowed => $max_checkouts_allowed,
551 } elsif ( not $onsite_checkout ) {
552 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
554 reason => 'TOO_MANY_CHECKOUTS',
555 count => $checkout_count - $onsite_checkout_count,
556 max_allowed => $max_checkouts_allowed,
562 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
563 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
566 # OK, the patron can issue !!!
570 =head2 CanBookBeIssued
572 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
573 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
575 Check if a book can be issued.
577 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
579 IMPORTANT: The assumption by users of this routine is that causes blocking
580 the issue are keyed by uppercase labels and other returned
581 data is keyed in lower case!
585 =item C<$patron> is a Koha::Patron
587 =item C<$barcode> is the bar code of the book being issued.
589 =item C<$duedates> is a DateTime object.
591 =item C<$inprocess> boolean switch
593 =item C<$ignore_reserves> boolean switch
595 =item C<$params> Hashref of additional parameters
598 override_high_holds - Ignore high holds
599 onsite_checkout - Checkout is an onsite checkout that will not leave the library
607 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
608 Possible values are :
614 sticky due date is invalid
618 borrower gone with no address
622 borrower declared it's card lost
628 =head3 UNKNOWN_BARCODE
642 item is restricted (set by ??)
644 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
645 could be prevented, but ones that can be overriden by the operator.
647 Possible values are :
655 renewing, not issuing
657 =head3 ISSUED_TO_ANOTHER
659 issued to someone else.
663 reserved for someone else.
667 sticky due date is invalid or due date in the past
671 if the borrower borrows to much things
675 sub CanBookBeIssued {
676 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
677 my %needsconfirmation; # filled with problems that needs confirmations
678 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
679 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
680 my %messages; # filled with information messages that should be displayed.
682 my $onsite_checkout = $params->{onsite_checkout} || 0;
683 my $override_high_holds = $params->{override_high_holds} || 0;
685 my $item_object = Koha::Items->find({barcode => $barcode });
687 # MANDATORY CHECKS - unless item exists, nothing else matters
688 unless ( $item_object ) {
689 $issuingimpossible{UNKNOWN_BARCODE} = 1;
691 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
693 my $item_unblessed = $item_object->unblessed; # Transition...
694 my $issue = $item_object->checkout;
695 my $biblio = $item_object->biblio;
697 my $biblioitem = $biblio->biblioitem;
698 my $effective_itemtype = $item_object->effective_itemtype;
699 my $dbh = C4::Context->dbh;
700 my $patron_unblessed = $patron->unblessed;
702 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
704 # DUE DATE is OK ? -- should already have checked.
706 if ($duedate && ref $duedate ne 'DateTime') {
707 $duedate = dt_from_string($duedate);
709 my $now = DateTime->now( time_zone => C4::Context->tz() );
710 unless ( $duedate ) {
711 my $issuedate = $now->clone();
713 my $branch = $circ_library;
714 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $branch, $patron_unblessed );
716 # Offline circ calls AddIssue directly, doesn't run through here
717 # So issuingimpossible should be ok.
720 my $fees = Koha::Charges::Fees->new(
723 library => $circ_library,
724 item => $item_object,
730 my $today = $now->clone();
731 $today->truncate( to => 'minute');
732 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
733 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
736 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
742 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
743 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
745 branch => C4::Context->userenv->{'branch'},
747 itemnumber => $item_object->itemnumber,
748 itemtype => $effective_itemtype,
749 borrowernumber => $patron->borrowernumber,
750 ccode => $item_object->ccode}
752 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
753 return( { STATS => 1 }, {});
756 if ( $patron->gonenoaddress == 1 ) {
757 $issuingimpossible{GNA} = 1;
760 if ( $patron->lost == 1 ) {
761 $issuingimpossible{CARD_LOST} = 1;
763 if ( $patron->is_debarred ) {
764 $issuingimpossible{DEBARRED} = 1;
767 if ( $patron->is_expired ) {
768 $issuingimpossible{EXPIRED} = 1;
776 my $account = $patron->account;
777 my $balance = $account->balance;
778 my $non_issues_charges = $account->non_issues_charges;
779 my $other_charges = $balance - $non_issues_charges;
781 my $amountlimit = C4::Context->preference("noissuescharge");
782 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
783 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
785 # Check the debt of this patrons guarantees
786 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
787 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
788 if ( defined $no_issues_charge_guarantees ) {
789 my @guarantees = $patron->guarantees();
790 my $guarantees_non_issues_charges;
791 foreach my $g ( @guarantees ) {
792 $guarantees_non_issues_charges += $g->account->non_issues_charges;
795 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
796 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
797 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
798 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
799 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
800 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
804 if ( C4::Context->preference("IssuingInProcess") ) {
805 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
806 $issuingimpossible{DEBT} = $non_issues_charges;
807 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
808 $needsconfirmation{DEBT} = $non_issues_charges;
809 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
810 $needsconfirmation{DEBT} = $non_issues_charges;
814 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
815 $needsconfirmation{DEBT} = $non_issues_charges;
816 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
817 $issuingimpossible{DEBT} = $non_issues_charges;
818 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
819 $needsconfirmation{DEBT} = $non_issues_charges;
823 if ($balance > 0 && $other_charges > 0) {
824 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
827 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
828 $patron_unblessed = $patron->unblessed;
830 if ( my $debarred_date = $patron->is_debarred ) {
831 # patron has accrued fine days or has a restriction. $count is a date
832 if ($debarred_date eq '9999-12-31') {
833 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
836 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
838 } elsif ( my $num_overdues = $patron->has_overdues ) {
839 ## patron has outstanding overdue loans
840 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
841 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
843 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
844 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
849 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
851 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
853 # Already issued to current borrower.
854 # If it is an on-site checkout if it can be switched to a normal checkout
855 # or ask whether the loan should be renewed
857 if ( $issue->onsite_checkout
858 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
859 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
861 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
862 $patron->borrowernumber,
863 $item_object->itemnumber,
865 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
866 if ( $renewerror eq 'onsite_checkout' ) {
867 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
870 $issuingimpossible{NO_MORE_RENEWALS} = 1;
874 $needsconfirmation{RENEW_ISSUE} = 1;
880 # issued to someone else
882 my $patron = Koha::Patrons->find( $issue->borrowernumber );
884 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
886 unless ( $can_be_returned ) {
887 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
888 $issuingimpossible{branch_to_return} = $message;
890 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
891 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
893 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
894 $needsconfirmation{issued_firstname} = $patron->firstname;
895 $needsconfirmation{issued_surname} = $patron->surname;
896 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
897 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
902 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
904 my $switch_onsite_checkout = (
905 C4::Context->preference('SwitchOnSiteCheckouts')
907 and $issue->onsite_checkout
908 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
909 my $toomany = TooMany( $patron_unblessed, $item_object->biblionumber, $item_unblessed, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
910 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
911 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
912 if ( $toomany->{max_allowed} == 0 ) {
913 $needsconfirmation{PATRON_CANT} = 1;
915 if ( C4::Context->preference("AllowTooManyOverride") ) {
916 $needsconfirmation{TOO_MANY} = $toomany->{reason};
917 $needsconfirmation{current_loan_count} = $toomany->{count};
918 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
920 $issuingimpossible{TOO_MANY} = $toomany->{reason};
921 $issuingimpossible{current_loan_count} = $toomany->{count};
922 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
927 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
929 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
930 my $wants_check = $patron->wants_check_for_previous_checkout;
931 $needsconfirmation{PREVISSUE} = 1
932 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
937 if ( $item_object->notforloan )
939 if(!C4::Context->preference("AllowNotForLoanOverride")){
940 $issuingimpossible{NOT_FOR_LOAN} = 1;
941 $issuingimpossible{item_notforloan} = $item_object->notforloan;
943 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
944 $needsconfirmation{item_notforloan} = $item_object->notforloan;
948 # we have to check itemtypes.notforloan also
949 if (C4::Context->preference('item-level_itypes')){
950 # this should probably be a subroutine
951 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
952 $sth->execute($effective_itemtype);
953 my $notforloan=$sth->fetchrow_hashref();
954 if ($notforloan->{'notforloan'}) {
955 if (!C4::Context->preference("AllowNotForLoanOverride")) {
956 $issuingimpossible{NOT_FOR_LOAN} = 1;
957 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
959 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
960 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
965 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
966 if ( $itemtype and $itemtype->notforloan == 1){
967 if (!C4::Context->preference("AllowNotForLoanOverride")) {
968 $issuingimpossible{NOT_FOR_LOAN} = 1;
969 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
971 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
972 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
977 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
979 $issuingimpossible{WTHDRAWN} = 1;
981 if ( $item_object->restricted
982 && $item_object->restricted == 1 )
984 $issuingimpossible{RESTRICTED} = 1;
986 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
987 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
988 my $code = $av->count ? $av->next->lib : '';
989 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
990 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
992 if ( C4::Context->preference("IndependentBranches") ) {
993 my $userenv = C4::Context->userenv;
994 unless ( C4::Context->IsSuperLibrarian() ) {
995 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
996 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
997 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
998 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1000 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1001 if ( $patron->branchcode ne $userenv->{branch} );
1005 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1007 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1009 if ( $rentalConfirmation ){
1010 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1011 my $itemtype = Koha::ItemTypes->find( $item_object->itype ); # GetItem sets effective itemtype
1012 $rentalCharge += $fees->accumulate_rentalcharge({ from => dt_from_string(), to => $duedate });
1013 if ( $rentalCharge > 0 ){
1014 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1018 unless ( $ignore_reserves ) {
1019 # See if the item is on reserve.
1020 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1022 my $resbor = $res->{'borrowernumber'};
1023 if ( $resbor ne $patron->borrowernumber ) {
1024 my $patron = Koha::Patrons->find( $resbor );
1025 if ( $restype eq "Waiting" )
1027 # The item is on reserve and waiting, but has been
1028 # reserved by some other patron.
1029 $needsconfirmation{RESERVE_WAITING} = 1;
1030 $needsconfirmation{'resfirstname'} = $patron->firstname;
1031 $needsconfirmation{'ressurname'} = $patron->surname;
1032 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1033 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1034 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1035 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1037 elsif ( $restype eq "Reserved" ) {
1038 # The item is on reserve for someone else.
1039 $needsconfirmation{RESERVED} = 1;
1040 $needsconfirmation{'resfirstname'} = $patron->firstname;
1041 $needsconfirmation{'ressurname'} = $patron->surname;
1042 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1043 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1044 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1045 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1051 ## CHECK AGE RESTRICTION
1052 my $agerestriction = $biblioitem->agerestriction;
1053 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1054 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1055 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1056 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1059 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1063 ## check for high holds decreasing loan period
1064 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1065 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1067 if ( $check->{exceeded} ) {
1068 if ($override_high_holds) {
1069 $alerts{HIGHHOLDS} = {
1070 num_holds => $check->{outstanding},
1071 duration => $check->{duration},
1072 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1076 $needsconfirmation{HIGHHOLDS} = {
1077 num_holds => $check->{outstanding},
1078 duration => $check->{duration},
1079 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1086 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1087 # don't do the multiple loans per bib check if we've
1088 # already determined that we've got a loan on the same item
1089 !$issuingimpossible{NO_MORE_RENEWALS} &&
1090 !$needsconfirmation{RENEW_ISSUE}
1092 # Check if borrower has already issued an item from the same biblio
1093 # Only if it's not a subscription
1094 my $biblionumber = $item_object->biblionumber;
1095 require C4::Serials;
1096 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1097 unless ($is_a_subscription) {
1098 # FIXME Should be $patron->checkouts($args);
1099 my $checkouts = Koha::Checkouts->search(
1101 borrowernumber => $patron->borrowernumber,
1102 biblionumber => $biblionumber,
1108 # if we get here, we don't already have a loan on this item,
1109 # so if there are any loans on this bib, ask for confirmation
1110 if ( $checkouts->count ) {
1111 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1116 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1119 =head2 CanBookBeReturned
1121 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1123 Check whether the item can be returned to the provided branch
1127 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1129 =item C<$branch> is the branchcode where the return is taking place
1137 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1139 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1145 sub CanBookBeReturned {
1146 my ($item, $branch) = @_;
1147 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1149 # assume return is allowed to start
1153 # identify all cases where return is forbidden
1154 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1156 $message = $item->{'homebranch'};
1157 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1159 $message = $item->{'holdingbranch'};
1160 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1162 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1165 return ($allowed, $message);
1168 =head2 CheckHighHolds
1170 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1171 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1172 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1176 sub checkHighHolds {
1177 my ( $item, $borrower ) = @_;
1178 my $branch = _GetCircControlBranch( $item, $borrower );
1179 my $item_object = Koha::Items->find( $item->{itemnumber} );
1188 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1190 if ( $holds->count() ) {
1191 $return_data->{outstanding} = $holds->count();
1193 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1194 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1195 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1197 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1199 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1201 # static means just more than a given number of holds on the record
1203 # If the number of holds is less than the threshold, we can stop here
1204 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1205 return $return_data;
1208 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1210 # dynamic means X more than the number of holdable items on the record
1212 # let's get the items
1213 my @items = $holds->next()->biblio()->items();
1215 # Remove any items with status defined to be ignored even if the would not make item unholdable
1216 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1217 @items = grep { !$_->$status } @items;
1220 # Remove any items that are not holdable for this patron
1221 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber )->{status} eq 'OK' } @items;
1223 my $items_count = scalar @items;
1225 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1227 # If the number of holds is less than the count of items we have
1228 # plus the number of holds allowed above that count, we can stop here
1229 if ( $holds->count() <= $threshold ) {
1230 return $return_data;
1234 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1236 my $calendar = Koha::Calendar->new( branchcode => $branch );
1238 my $itype = $item_object->effective_itemtype;
1239 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1241 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1243 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1244 $reduced_datedue->set_hour($orig_due->hour);
1245 $reduced_datedue->set_minute($orig_due->minute);
1246 $reduced_datedue->truncate( to => 'minute' );
1248 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1249 $return_data->{exceeded} = 1;
1250 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1251 $return_data->{due_date} = $reduced_datedue;
1255 return $return_data;
1260 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1262 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1266 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1268 =item C<$barcode> is the barcode of the item being issued.
1270 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1271 Calculated if empty.
1273 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1275 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1276 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1278 AddIssue does the following things :
1280 - step 01: check that there is a borrowernumber & a barcode provided
1281 - check for RENEWAL (book issued & being issued to the same patron)
1282 - renewal YES = Calculate Charge & renew
1284 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1286 - fill reserve if reserve to this patron
1287 - cancel reserve or not, otherwise
1288 * TRANSFERT PENDING ?
1289 - complete the transfert
1297 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1299 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1300 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1301 my $auto_renew = $params && $params->{auto_renew};
1302 my $dbh = C4::Context->dbh;
1303 my $barcodecheck = CheckValidBarcode($barcode);
1307 if ( $datedue && ref $datedue ne 'DateTime' ) {
1308 $datedue = dt_from_string($datedue);
1311 # $issuedate defaults to today.
1312 if ( !defined $issuedate ) {
1313 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1316 if ( ref $issuedate ne 'DateTime' ) {
1317 $issuedate = dt_from_string($issuedate);
1322 # Stop here if the patron or barcode doesn't exist
1323 if ( $borrower && $barcode && $barcodecheck ) {
1324 # find which item we issue
1325 my $item_object = Koha::Items->find({ barcode => $barcode })
1326 or return; # if we don't get an Item, abort.
1327 my $item_unblessed = $item_object->unblessed;
1329 my $branch = _GetCircControlBranch( $item_unblessed, $borrower );
1331 # get actual issuing if there is one
1332 my $actualissue = $item_object->checkout;
1334 # check if we just renew the issue.
1335 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1336 and not $switch_onsite_checkout ) {
1337 $datedue = AddRenewal(
1338 $borrower->{'borrowernumber'},
1339 $item_object->itemnumber,
1342 $issuedate, # here interpreted as the renewal date
1347 my $itype = $item_object->effective_itemtype;
1348 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1351 $datedue->truncate( to => 'minute' );
1353 my $patron = Koha::Patrons->find( $borrower );
1354 my $library = Koha::Libraries->find( $branch );
1355 my $fees = Koha::Charges::Fees->new(
1358 library => $library,
1359 item => $item_object,
1360 to_date => $datedue,
1364 # it's NOT a renewal
1365 if ( $actualissue and not $switch_onsite_checkout ) {
1366 # This book is currently on loan, but not to the person
1367 # who wants to borrow it now. mark it returned before issuing to the new borrower
1368 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1369 return unless $allowed;
1370 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1373 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1375 # Starting process for transfer job (checking transfert and validate it if we have one)
1376 my ($datesent) = GetTransfers( $item_object->itemnumber );
1378 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1379 my $sth = $dbh->prepare(
1380 "UPDATE branchtransfers
1381 SET datearrived = now(),
1383 comments = 'Forced branchtransfer'
1384 WHERE itemnumber= ? AND datearrived IS NULL"
1386 $sth->execute( C4::Context->userenv->{'branch'},
1387 $item_object->itemnumber );
1390 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1391 unless ($auto_renew) {
1392 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1393 { categorycode => $borrower->{categorycode},
1394 itemtype => $item_object->effective_itemtype,
1395 branchcode => $branch
1399 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1402 # Record in the database the fact that the book was issued.
1404 my $itype = $item_object->effective_itemtype;
1405 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1408 $datedue->truncate( to => 'minute' );
1410 my $issue_attributes = {
1411 borrowernumber => $borrower->{'borrowernumber'},
1412 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1413 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1414 branchcode => C4::Context->userenv->{'branch'},
1415 onsite_checkout => $onsite_checkout,
1416 auto_renew => $auto_renew ? 1 : 0,
1419 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1421 $issue->set($issue_attributes)->store;
1424 $issue = Koha::Checkout->new(
1426 itemnumber => $item_object->itemnumber,
1432 if ( $item_object->location eq 'CART' && $item_object->permanent_location ne 'CART' ) {
1433 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1434 CartToShelf( $item_object->itemnumber );
1437 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1438 UpdateTotalIssues( $item_object->biblionumber, 1 );
1441 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1442 if ( $item_object->itemlost ) {
1444 Koha::RefundLostItemFeeRules->should_refund(
1446 current_branch => C4::Context->userenv->{branch},
1447 item_home_branch => $item_object->homebranch,
1448 item_holding_branch => $item_object->holdingbranch,
1453 _FixAccountForLostAndReturned( $item_object->itemnumber, undef,
1454 $item_object->barcode );
1460 issues => $item_object->issues + 1,
1461 holdingbranch => C4::Context->userenv->{'branch'},
1463 onloan => $datedue->ymd(),
1464 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1466 $item_object->biblionumber,
1467 $item_object->itemnumber,
1470 ModDateLastSeen( $item_object->itemnumber );
1472 # If it costs to borrow this book, charge it to the patron's account.
1473 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1474 if ( $charge > 0 ) {
1475 my $description = "Rental";
1476 AddIssuingCharge( $issue, $charge, $description );
1479 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1480 if ( $itemtype_object ) {
1481 my $accumulate_charge = $fees->accumulate_rentalcharge();
1482 if ( $accumulate_charge > 0 ) {
1483 AddIssuingCharge( $issue, $accumulate_charge, 'Daily rental' ) if $accumulate_charge > 0;
1484 $charge += $accumulate_charge;
1485 $item_unblessed->{charge} = $charge;
1489 # Record the fact that this book was issued.
1492 branch => C4::Context->userenv->{'branch'},
1493 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1495 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1496 itemnumber => $item_object->itemnumber,
1497 itemtype => $item_object->effective_itemtype,
1498 location => $item_object->location,
1499 borrowernumber => $borrower->{'borrowernumber'},
1500 ccode => $item_object->ccode,
1504 # Send a checkout slip.
1505 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1507 branchcode => $branch,
1508 categorycode => $borrower->{categorycode},
1509 item_type => $item_object->effective_itemtype,
1510 notification => 'CHECKOUT',
1512 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1513 SendCirculationAlert(
1516 item => $item_object->unblessed,
1517 borrower => $borrower,
1523 "CIRCULATION", "ISSUE",
1524 $borrower->{'borrowernumber'},
1525 $item_object->itemnumber,
1526 ) if C4::Context->preference("IssueLog");
1532 =head2 GetLoanLength
1534 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1536 Get loan length for an itemtype, a borrower type and a branch
1541 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1542 my $dbh = C4::Context->dbh;
1543 my $sth = $dbh->prepare(qq{
1544 SELECT issuelength, lengthunit, renewalperiod
1546 WHERE categorycode=?
1549 AND issuelength IS NOT NULL
1552 # try to find issuelength & return the 1st available.
1553 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1554 $sth->execute( $borrowertype, $itemtype, $branchcode );
1555 my $loanlength = $sth->fetchrow_hashref;
1558 if defined($loanlength) && defined $loanlength->{issuelength};
1560 $sth->execute( $borrowertype, '*', $branchcode );
1561 $loanlength = $sth->fetchrow_hashref;
1563 if defined($loanlength) && defined $loanlength->{issuelength};
1565 $sth->execute( '*', $itemtype, $branchcode );
1566 $loanlength = $sth->fetchrow_hashref;
1568 if defined($loanlength) && defined $loanlength->{issuelength};
1570 $sth->execute( '*', '*', $branchcode );
1571 $loanlength = $sth->fetchrow_hashref;
1573 if defined($loanlength) && defined $loanlength->{issuelength};
1575 $sth->execute( $borrowertype, $itemtype, '*' );
1576 $loanlength = $sth->fetchrow_hashref;
1578 if defined($loanlength) && defined $loanlength->{issuelength};
1580 $sth->execute( $borrowertype, '*', '*' );
1581 $loanlength = $sth->fetchrow_hashref;
1583 if defined($loanlength) && defined $loanlength->{issuelength};
1585 $sth->execute( '*', $itemtype, '*' );
1586 $loanlength = $sth->fetchrow_hashref;
1588 if defined($loanlength) && defined $loanlength->{issuelength};
1590 $sth->execute( '*', '*', '*' );
1591 $loanlength = $sth->fetchrow_hashref;
1593 if defined($loanlength) && defined $loanlength->{issuelength};
1595 # if no rule is set => 0 day (hardcoded)
1599 lengthunit => 'days',
1605 =head2 GetHardDueDate
1607 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1609 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1613 sub GetHardDueDate {
1614 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1616 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1617 { categorycode => $borrowertype,
1618 itemtype => $itemtype,
1619 branchcode => $branchcode
1624 if ( defined( $issuing_rule ) ) {
1625 if ( $issuing_rule->hardduedate ) {
1626 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1628 return (undef, undef);
1633 =head2 GetBranchBorrowerCircRule
1635 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1637 Retrieves circulation rule attributes that apply to the given
1638 branch and patron category, regardless of item type.
1639 The return value is a hashref containing the following key:
1641 patron_maxissueqty - maximum number of loans that a
1642 patron of the given category can have at the given
1643 branch. If the value is undef, no limit.
1645 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1646 patron of the given category can have at the given
1647 branch. If the value is undef, no limit.
1649 This will check for different branch/category combinations in the following order:
1653 default branch and category
1655 If no rule has been found in the database, it will default to
1658 patron_maxissueqty - undef
1659 patron_maxonsiteissueqty - undef
1661 C<$branchcode> and C<$categorycode> should contain the
1662 literal branch code and patron category code, respectively - no
1667 sub GetBranchBorrowerCircRule {
1668 my ( $branchcode, $categorycode ) = @_;
1670 # Initialize default values
1672 patron_maxissueqty => undef,
1673 patron_maxonsiteissueqty => undef,
1677 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1678 my $rule = Koha::CirculationRules->get_effective_rule(
1680 categorycode => $categorycode,
1682 branchcode => $branchcode,
1683 rule_name => $rule_name,
1687 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1693 =head2 GetBranchItemRule
1695 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1697 Retrieves circulation rule attributes that apply to the given
1698 branch and item type, regardless of patron category.
1700 The return value is a hashref containing the following keys:
1702 holdallowed => Hold policy for this branch and itemtype. Possible values:
1703 0: No holds allowed.
1704 1: Holds allowed only by patrons that have the same homebranch as the item.
1705 2: Holds allowed from any patron.
1707 returnbranch => branch to which to return item. Possible values:
1708 noreturn: do not return, let item remain where checked in (floating collections)
1709 homebranch: return to item's home branch
1710 holdingbranch: return to issuer branch
1712 This searches branchitemrules in the following order:
1714 * Same branchcode and itemtype
1715 * Same branchcode, itemtype '*'
1716 * branchcode '*', same itemtype
1717 * branchcode and itemtype '*'
1719 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1723 sub GetBranchItemRule {
1724 my ( $branchcode, $itemtype ) = @_;
1725 my $dbh = C4::Context->dbh();
1729 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1730 FROM branch_item_rules
1731 WHERE branchcode = ?
1732 AND itemtype = ?', $branchcode, $itemtype],
1733 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1734 FROM default_branch_circ_rules
1735 WHERE branchcode = ?', $branchcode],
1736 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1737 FROM default_branch_item_rules
1738 WHERE itemtype = ?', $itemtype],
1739 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1740 FROM default_circ_rules'],
1743 foreach my $attempt (@attempts) {
1744 my ($query, @bind_params) = @{$attempt};
1745 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1748 # Since branch/category and branch/itemtype use the same per-branch
1749 # defaults tables, we have to check that the key we want is set, not
1750 # just that a row was returned
1751 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1752 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1753 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1756 # built-in default circulation rule
1757 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1758 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1759 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1766 ($doreturn, $messages, $iteminformation, $borrower) =
1767 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1773 =item C<$barcode> is the bar code of the book being returned.
1775 =item C<$branch> is the code of the branch where the book is being returned.
1777 =item C<$exemptfine> indicates that overdue charges for the item will be
1780 =item C<$return_date> allows the default return date to be overridden
1781 by the given return date. Optional.
1785 C<&AddReturn> returns a list of four items:
1787 C<$doreturn> is true iff the return succeeded.
1789 C<$messages> is a reference-to-hash giving feedback on the operation.
1790 The keys of the hash are:
1796 No item with this barcode exists. The value is C<$barcode>.
1800 The book is not currently on loan. The value is C<$barcode>.
1804 This book has been withdrawn/cancelled. The value should be ignored.
1806 =item C<Wrongbranch>
1808 This book has was returned to the wrong branch. The value is a hashref
1809 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1810 contain the branchcode of the incorrect and correct return library, respectively.
1814 The item was reserved. The value is a reference-to-hash whose keys are
1815 fields from the reserves table of the Koha database, and
1816 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1817 either C<Waiting>, C<Reserved>, or 0.
1819 =item C<WasReturned>
1821 Value 1 if return is successful.
1823 =item C<NeedsTransfer>
1825 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1829 C<$iteminformation> is a reference-to-hash, giving information about the
1830 returned item from the issues table.
1832 C<$borrower> is a reference-to-hash, giving information about the
1833 patron who last borrowed the book.
1838 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1840 if ($branch and not Koha::Libraries->find($branch)) {
1841 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1844 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1845 $return_date //= dt_from_string();
1849 my $validTransfert = 0;
1850 my $stat_type = 'return';
1852 # get information on item
1853 my $item = Koha::Items->find({ barcode => $barcode });
1855 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1858 my $itemnumber = $item->itemnumber;
1859 my $itemtype = $item->effective_itemtype;
1861 my $issue = $item->checkout;
1863 $patron = $issue->patron
1864 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1865 . Dumper($issue->unblessed) . "\n";
1867 $messages->{'NotIssued'} = $barcode;
1868 ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1869 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1871 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1872 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1873 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1874 $messages->{'LocalUse'} = 1;
1875 $stat_type = 'localuse';
1879 my $item_unblessed = $item->unblessed;
1880 # full item data, but no borrowernumber or checkout info (no issue)
1881 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1882 # get the proper branch to which to return the item
1883 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1884 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1886 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1887 my $patron_unblessed = $patron ? $patron->unblessed : {};
1889 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1890 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1891 if ($update_loc_rules) {
1892 if (defined $update_loc_rules->{_ALL_}) {
1893 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->{permanent_location}; }
1894 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1895 if ( $item->{location} ne $update_loc_rules->{_ALL_}) {
1896 $messages->{'ItemLocationUpdated'} = { from => $item->{location}, to => $update_loc_rules->{_ALL_} };
1897 ModItem( { location => $update_loc_rules->{_ALL_} }, undef, $itemnumber );
1901 foreach my $key ( keys %$update_loc_rules ) {
1902 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->{permanent_location}; }
1903 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1904 if ( ($item->{location} eq $key && $item->{location} ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->{location} eq '' && $update_loc_rules->{$key} ne '') ) {
1905 $messages->{'ItemLocationUpdated'} = { from => $item->{location}, to => $update_loc_rules->{$key} };
1906 ModItem( { location => $update_loc_rules->{$key} }, undef, $itemnumber );
1913 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1915 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1917 eval { $rules = YAML::Load($yaml); };
1919 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1922 foreach my $key ( keys %$rules ) {
1923 if ( $item->notforloan eq $key ) {
1924 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1925 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1932 # check if the return is allowed at this branch
1933 my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1934 unless ($returnallowed){
1935 $messages->{'Wrongbranch'} = {
1936 Wrongbranch => $branch,
1937 Rightbranch => $message
1940 return ( $doreturn, $messages, $issue, $patron_unblessed);
1943 if ( $item->withdrawn ) { # book has been cancelled
1944 $messages->{'withdrawn'} = 1;
1945 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1948 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1952 # case of a return of document (deal with issues and holdingbranch)
1955 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1956 $patron or warn "AddReturn without current borrower";
1957 $is_overdue = $issue->is_overdue( $return_date );
1961 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1964 if ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue ) {
1965 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1968 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 );
1970 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1973 # FIXME is the "= 1" right? This could be the borrower hash.
1974 $messages->{'WasReturned'} = 1;
1978 ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1981 # the holdingbranch is updated if the document is returned to another location.
1982 # this is always done regardless of whether the item was on loan or not
1983 my $item_holding_branch = $item->holdingbranch;
1984 if ($item->holdingbranch ne $branch) {
1985 UpdateHoldingbranch($branch, $item->itemnumber);
1986 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1989 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1990 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
1992 # check if we have a transfer for this document
1993 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
1995 # if we have a transfer to do, we update the line of transfers with the datearrived
1996 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
1998 if ( $tobranch eq $branch ) {
1999 my $sth = C4::Context->dbh->prepare(
2000 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2002 $sth->execute( $item->itemnumber );
2003 # if we have a reservation with valid transfer, we can set it's status to 'W'
2004 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2006 $messages->{'WrongTransfer'} = $tobranch;
2007 $messages->{'WrongTransferItem'} = $item->itemnumber;
2009 $validTransfert = 1;
2012 # fix up the accounts.....
2013 if ( $item->itemlost ) {
2014 $messages->{'WasLost'} = 1;
2015 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2017 Koha::RefundLostItemFeeRules->should_refund(
2019 current_branch => C4::Context->userenv->{branch},
2020 item_home_branch => $item->homebranch,
2021 item_holding_branch => $item_holding_branch
2026 _FixAccountForLostAndReturned( $item->itemnumber,
2027 $borrowernumber, $barcode );
2028 $messages->{'LostItemFeeRefunded'} = 1;
2033 # fix up the overdues in accounts...
2034 if ($borrowernumber) {
2035 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine );
2036 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2038 if ( $issue and $issue->is_overdue ) {
2040 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $return_date );
2042 $messages->{'PrevDebarred'} = $debardate;
2044 $messages->{'Debarred'} = $debardate if $debardate;
2046 # there's no overdue on the item but borrower had been previously debarred
2047 } elsif ( $issue->date_due and $patron->debarred ) {
2048 if ( $patron->debarred eq "9999-12-31") {
2049 $messages->{'ForeverDebarred'} = $patron->debarred;
2051 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2052 $borrower_debar_dt->truncate(to => 'day');
2053 my $today_dt = $return_date->clone()->truncate(to => 'day');
2054 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2055 $messages->{'PrevDebarred'} = $patron->debarred;
2061 # find reserves.....
2062 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2063 my ($resfound, $resrec);
2064 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2065 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2067 $resrec->{'ResFound'} = $resfound;
2068 $messages->{'ResFound'} = $resrec;
2071 # Record the fact that this book was returned.
2075 itemnumber => $itemnumber,
2076 itemtype => $itemtype,
2077 borrowernumber => $borrowernumber,
2078 ccode => $item->ccode,
2081 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2083 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2085 branchcode => $branch,
2086 categorycode => $patron->categorycode,
2087 item_type => $itemtype,
2088 notification => 'CHECKIN',
2090 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2091 SendCirculationAlert({
2093 item => $item_unblessed,
2094 borrower => $patron->unblessed,
2099 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2100 if C4::Context->preference("ReturnLog");
2103 # Remove any OVERDUES related debarment if the borrower has no overdues
2104 if ( $borrowernumber
2105 && $patron->debarred
2106 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2107 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2108 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2110 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2113 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2114 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2115 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType");
2116 if (C4::Context->preference("AutomaticItemReturn" ) or
2117 (C4::Context->preference("UseBranchTransferLimits") and
2118 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2120 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2121 $debug and warn "item: " . Dumper($item_unblessed);
2122 ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2123 $messages->{'WasTransfered'} = 1;
2125 $messages->{'NeedsTransfer'} = $returnbranch;
2129 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2132 =head2 MarkIssueReturned
2134 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2136 Unconditionally marks an issue as being returned by
2137 moving the C<issues> row to C<old_issues> and
2138 setting C<returndate> to the current date.
2140 if C<$returndate> is specified (in iso format), it is used as the date
2143 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2144 the old_issue is immediately anonymised
2146 Ideally, this function would be internal to C<C4::Circulation>,
2147 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2148 and offline_circ/process_koc.pl.
2152 sub MarkIssueReturned {
2153 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2155 # Retrieve the issue
2156 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2157 my $issue_id = $issue->issue_id;
2159 my $anonymouspatron;
2160 if ( $privacy == 2 ) {
2161 # The default of 0 will not work due to foreign key constraints
2162 # The anonymisation will fail if AnonymousPatron is not a valid entry
2163 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2164 # Note that a warning should appear on the about page (System information tab).
2165 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2166 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."
2167 unless Koha::Patrons->find( $anonymouspatron );
2170 my $schema = Koha::Database->schema;
2172 # FIXME Improve the return value and handle it from callers
2173 $schema->txn_do(sub {
2175 # Update the returndate value
2176 if ( $returndate ) {
2177 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2180 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2183 # Create the old_issues entry
2184 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2186 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2187 if ( $privacy == 2) {
2188 $old_checkout->borrowernumber($anonymouspatron)->store;
2191 # And finally delete the issue
2194 ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2196 if ( C4::Context->preference('StoreLastBorrower') ) {
2197 my $item = Koha::Items->find( $itemnumber );
2198 my $patron = Koha::Patrons->find( $borrowernumber );
2199 $item->last_returned_by( $patron );
2206 =head2 _debar_user_on_return
2208 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2210 C<$borrower> borrower hashref
2212 C<$item> item hashref
2214 C<$datedue> date due DateTime object
2216 C<$returndate> DateTime object representing the return time
2218 Internal function, called only by AddReturn that calculates and updates
2219 the user fine days, and debars them if necessary.
2221 Should only be called for overdue returns
2225 sub _debar_user_on_return {
2226 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2228 my $branchcode = _GetCircControlBranch( $item, $borrower );
2229 $return_date //= dt_from_string();
2231 my $circcontrol = C4::Context->preference('CircControl');
2232 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2233 { categorycode => $borrower->{categorycode},
2234 itemtype => $item->{itype},
2235 branchcode => $branchcode
2238 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2239 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2240 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2244 # finedays is in days, so hourly loans must multiply by 24
2245 # thus 1 hour late equals 1 day suspension * finedays rate
2246 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2248 # grace period is measured in the same units as the loan
2250 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2252 my $deltadays = DateTime::Duration->new(
2253 days => $chargeable_units
2255 if ( $deltadays->subtract($grace)->is_positive() ) {
2256 my $suspension_days = $deltadays * $finedays;
2258 # If the max suspension days is < than the suspension days
2259 # the suspension days is limited to this maximum period.
2260 my $max_sd = $issuing_rule->maxsuspensiondays;
2261 if ( defined $max_sd ) {
2262 $max_sd = DateTime::Duration->new( days => $max_sd );
2263 $suspension_days = $max_sd
2264 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2267 my ( $has_been_extended, $is_a_reminder );
2268 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2269 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2271 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2272 $has_been_extended = 1;
2276 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2277 # No need to / 1 and do not consider / 0
2278 $suspension_days = DateTime::Duration->new(
2279 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2284 # Use the calendar or not to calculate the debarment date
2285 if ( C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed' ) {
2286 my $calendar = Koha::Calendar->new(
2287 branchcode => $branchcode,
2288 days_mode => 'Calendar'
2290 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2293 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2296 Koha::Patron::Debarments::AddUniqueDebarment({
2297 borrowernumber => $borrower->{borrowernumber},
2298 expiration => $new_debar_dt->ymd(),
2299 type => 'SUSPENSION',
2301 # if borrower was already debarred but does not get an extra debarment
2302 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2303 my $new_debarment_str;
2304 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2306 $new_debarment_str = $borrower->{debarred};
2308 $new_debarment_str = $new_debar_dt->ymd();
2310 # FIXME Should return a DateTime object
2311 return $new_debarment_str, $is_a_reminder;
2317 =head2 _FixOverduesOnReturn
2319 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine);
2321 C<$borrowernumber> borrowernumber
2323 C<$itemnumber> itemnumber
2325 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2331 sub _FixOverduesOnReturn {
2332 my ( $borrowernumber, $item, $exemptfine ) = @_;
2333 unless( $borrowernumber ) {
2334 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2338 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2342 # check for overdue fine
2343 my $accountline = Koha::Account::Lines->search(
2345 borrowernumber => $borrowernumber,
2346 itemnumber => $item,
2347 accounttype => 'OVERDUE',
2348 status => 'UNRETURNED'
2351 return 0 unless $accountline; # no warning, there's just nothing to fix
2354 my $amountoutstanding = $accountline->amountoutstanding;
2356 $accountline->status('FORGIVEN');
2357 $accountline->amountoutstanding(0);
2359 Koha::Account::Offset->new(
2361 debit_id => $accountline->id,
2363 amount => $amountoutstanding * -1,
2367 if (C4::Context->preference("FinesLog")) {
2368 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2371 $accountline->status('RETURNED');
2374 return $accountline->store();
2377 =head2 _FixAccountForLostAndReturned
2379 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2381 Calculates the charge for a book lost and returned.
2383 Internal function, not exported, called only by AddReturn.
2387 sub _FixAccountForLostAndReturned {
2388 my $itemnumber = shift or return;
2389 my $borrowernumber = @_ ? shift : undef;
2390 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2394 # check for charge made for lost book
2395 my $accountlines = Koha::Account::Lines->search(
2397 itemnumber => $itemnumber,
2398 accounttype => { -in => [ 'L', 'W' ] },
2401 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2405 return unless $accountlines->count > 0;
2406 my $accountline = $accountlines->next;
2407 my $total_to_refund = 0;
2408 my $account = Koha::Patrons->find( $accountline->borrowernumber )->account;
2411 if ( $accountline->amount > $accountline->amountoutstanding ) {
2412 # some amount has been cancelled. collect the offsets that are not writeoffs
2413 # this works because the only way to subtract from this kind of a debt is
2414 # using the UI buttons 'Pay' and 'Write off'
2415 my $credits_offsets = Koha::Account::Offsets->search({
2416 debit_id => $accountline->id,
2417 credit_id => { '!=' => undef }, # it is not the debit itself
2418 type => { '!=' => 'Writeoff' },
2419 amount => { '<' => 0 } # credits are negative on the DB
2422 $total_to_refund = ( $credits_offsets->count > 0 )
2423 ? $credits_offsets->total * -1 # credits are negative on the DB
2427 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2429 if ( $credit_total > 0 ) {
2430 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2431 $credit = $account->add_credit(
2432 { amount => $credit_total,
2433 description => 'Item Returned ' . $item_id,
2434 type => 'lost_item_return',
2435 interface => C4::Context->interface,
2436 library_id => $branchcode
2440 # TODO: ->apply should just accept the accountline
2441 $credit->apply( { debits => $accountlines->reset } );
2444 # Manually set the accounttype
2445 $accountline->discard_changes->accounttype('LR');
2446 $accountline->store;
2448 ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2450 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2451 $account->reconcile_balance;
2454 return ($credit) ? $credit->id : undef;
2457 =head2 _GetCircControlBranch
2459 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2463 Return the library code to be used to determine which circulation
2464 policy applies to a transaction. Looks up the CircControl and
2465 HomeOrHoldingBranch system preferences.
2467 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2469 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2473 sub _GetCircControlBranch {
2474 my ($item, $borrower) = @_;
2475 my $circcontrol = C4::Context->preference('CircControl');
2478 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2479 $branch= C4::Context->userenv->{'branch'};
2480 } elsif ($circcontrol eq 'PatronLibrary') {
2481 $branch=$borrower->{branchcode};
2483 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2484 $branch = $item->{$branchfield};
2485 # default to item home branch if holdingbranch is used
2486 # and is not defined
2487 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2488 $branch = $item->{homebranch};
2496 $issue = GetOpenIssue( $itemnumber );
2498 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2500 C<$itemnumber> is the item's itemnumber
2507 my ( $itemnumber ) = @_;
2508 return unless $itemnumber;
2509 my $dbh = C4::Context->dbh;
2510 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2511 $sth->execute( $itemnumber );
2512 return $sth->fetchrow_hashref();
2516 =head2 GetBiblioIssues
2518 $issues = GetBiblioIssues($biblionumber);
2520 this function get all issues from a biblionumber.
2523 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2524 tables issues and the firstname,surname & cardnumber from borrowers.
2528 sub GetBiblioIssues {
2529 my $biblionumber = shift;
2530 return unless $biblionumber;
2531 my $dbh = C4::Context->dbh;
2533 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2535 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2536 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2537 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2538 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2539 WHERE biblio.biblionumber = ?
2541 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2543 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2544 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2545 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2546 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2547 WHERE biblio.biblionumber = ?
2550 my $sth = $dbh->prepare($query);
2551 $sth->execute($biblionumber, $biblionumber);
2554 while ( my $data = $sth->fetchrow_hashref ) {
2555 push @issues, $data;
2560 =head2 GetUpcomingDueIssues
2562 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2566 sub GetUpcomingDueIssues {
2569 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2570 my $dbh = C4::Context->dbh;
2572 my $statement = <<END_SQL;
2575 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2577 LEFT JOIN items USING (itemnumber)
2578 LEFT OUTER JOIN branches USING (branchcode)
2579 WHERE returndate is NULL
2581 WHERE days_until_due >= 0 AND days_until_due <= ?
2584 my @bind_parameters = ( $params->{'days_in_advance'} );
2586 my $sth = $dbh->prepare( $statement );
2587 $sth->execute( @bind_parameters );
2588 my $upcoming_dues = $sth->fetchall_arrayref({});
2590 return $upcoming_dues;
2593 =head2 CanBookBeRenewed
2595 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2597 Find out whether a borrowed item may be renewed.
2599 C<$borrowernumber> is the borrower number of the patron who currently
2600 has the item on loan.
2602 C<$itemnumber> is the number of the item to renew.
2604 C<$override_limit>, if supplied with a true value, causes
2605 the limit on the number of times that the loan can be renewed
2606 (as controlled by the item type) to be ignored. Overriding also allows
2607 to renew sooner than "No renewal before" and to manually renew loans
2608 that are automatically renewed.
2610 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2611 item must currently be on loan to the specified borrower; renewals
2612 must be allowed for the item's type; and the borrower must not have
2613 already renewed the loan. $error will contain the reason the renewal can not proceed
2617 sub CanBookBeRenewed {
2618 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2620 my $dbh = C4::Context->dbh;
2623 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2624 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2625 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2626 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2628 my $patron = $issue->patron or return;
2630 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2632 # This item can fill one or more unfilled reserve, can those unfilled reserves
2633 # all be filled by other available items?
2635 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2637 my $schema = Koha::Database->new()->schema();
2639 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2641 # There is an item level hold on this item, no other item can fill the hold
2646 # Get all other items that could possibly fill reserves
2647 my @itemnumbers = $schema->resultset('Item')->search(
2649 biblionumber => $resrec->{biblionumber},
2652 -not => { itemnumber => $itemnumber }
2654 { columns => 'itemnumber' }
2655 )->get_column('itemnumber')->all();
2657 # Get all other reserves that could have been filled by this item
2658 my @borrowernumbers;
2660 my ( $reserve_found, $reserve, undef ) =
2661 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2663 if ($reserve_found) {
2664 push( @borrowernumbers, $reserve->{borrowernumber} );
2671 # If the count of the union of the lists of reservable items for each borrower
2672 # is equal or greater than the number of borrowers, we know that all reserves
2673 # can be filled with available items. We can get the union of the sets simply
2674 # by pushing all the elements onto an array and removing the duplicates.
2677 ITEM: foreach my $i (@itemnumbers) {
2678 my $item = Koha::Items->find($i)->unblessed;
2679 next if IsItemOnHoldAndFound($i);
2680 for my $b (@borrowernumbers) {
2681 my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2682 next unless IsAvailableForItemLevelRequest($item, $borr);
2683 next unless CanItemBeReserved($b,$i);
2685 push @reservable, $i;
2686 if (@reservable >= @borrowernumbers) {
2695 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2697 return ( 1, undef ) if $override_limit;
2699 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2700 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2701 { categorycode => $patron->categorycode,
2702 itemtype => $item->effective_itemtype,
2703 branchcode => $branchcode
2707 return ( 0, "too_many" )
2708 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2710 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2711 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2712 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2713 my $restricted = $patron->is_debarred;
2714 my $hasoverdues = $patron->has_overdues;
2716 if ( $restricted and $restrictionblockrenewing ) {
2717 return ( 0, 'restriction');
2718 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2719 return ( 0, 'overdue');
2722 if ( $issue->auto_renew ) {
2724 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2725 return ( 0, 'auto_account_expired' );
2728 if ( defined $issuing_rule->no_auto_renewal_after
2729 and $issuing_rule->no_auto_renewal_after ne "" ) {
2730 # Get issue_date and add no_auto_renewal_after
2731 # If this is greater than today, it's too late for renewal.
2732 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2733 $maximum_renewal_date->add(
2734 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2736 my $now = dt_from_string;
2737 if ( $now >= $maximum_renewal_date ) {
2738 return ( 0, "auto_too_late" );
2741 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2742 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2743 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2744 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2745 return ( 0, "auto_too_late" );
2749 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2750 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2751 my $amountoutstanding = $patron->account->balance;
2752 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2753 return ( 0, "auto_too_much_oweing" );
2758 if ( defined $issuing_rule->norenewalbefore
2759 and $issuing_rule->norenewalbefore ne "" )
2762 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2763 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2764 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2766 # Depending on syspref reset the exact time, only check the date
2767 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2768 and $issuing_rule->lengthunit eq 'days' )
2770 $soonestrenewal->truncate( to => 'day' );
2773 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2775 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2776 return ( 0, "too_soon" );
2778 elsif ( $issue->auto_renew ) {
2779 return ( 0, "auto_renew" );
2783 # Fallback for automatic renewals:
2784 # If norenewalbefore is undef, don't renew before due date.
2785 if ( $issue->auto_renew ) {
2786 my $now = dt_from_string;
2787 return ( 0, "auto_renew" )
2788 if $now >= dt_from_string( $issue->date_due, 'sql' );
2789 return ( 0, "auto_too_soon" );
2792 return ( 1, undef );
2797 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2801 C<$borrowernumber> is the borrower number of the patron who currently
2804 C<$itemnumber> is the number of the item to renew.
2806 C<$branch> is the library where the renewal took place (if any).
2807 The library that controls the circ policies for the renewal is retrieved from the issues record.
2809 C<$datedue> can be a DateTime object used to set the due date.
2811 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2812 this parameter is not supplied, lastreneweddate is set to the current date.
2814 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2815 from the book's item type.
2820 my $borrowernumber = shift;
2821 my $itemnumber = shift or return;
2823 my $datedue = shift;
2824 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2826 my $item_object = Koha::Items->find($itemnumber) or return;
2827 my $biblio = $item_object->biblio;
2828 my $issue = $item_object->checkout;
2829 my $item_unblessed = $item_object->unblessed;
2831 my $dbh = C4::Context->dbh;
2833 return unless $issue;
2835 $borrowernumber ||= $issue->borrowernumber;
2837 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2838 carp 'Invalid date passed to AddRenewal.';
2842 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2843 my $patron_unblessed = $patron->unblessed;
2845 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2847 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2848 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2850 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2852 # If the due date wasn't specified, calculate it by adding the
2853 # book's loan length to today's date or the current due date
2854 # based on the value of the RenewalPeriodBase syspref.
2855 my $itemtype = $item_object->effective_itemtype;
2858 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2859 dt_from_string( $issue->date_due, 'sql' ) :
2860 DateTime->now( time_zone => C4::Context->tz());
2861 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2864 my $fees = Koha::Charges::Fees->new(
2867 library => $circ_library,
2868 item => $item_object,
2869 from_date => dt_from_string( $issue->date_due, 'sql' ),
2870 to_date => dt_from_string($datedue),
2874 # Update the issues record to have the new due date, and a new count
2875 # of how many times it has been renewed.
2876 my $renews = $issue->renewals + 1;
2877 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2878 WHERE borrowernumber=?
2882 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2884 # Update the renewal count on the item, and tell zebra to reindex
2885 $renews = $item_object->renewals + 1;
2886 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2888 # Charge a new rental fee, if applicable
2889 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2890 if ( $charge > 0 ) {
2891 my $description = "Renewal of Rental Item " . $biblio->title . " " .$item_object->barcode;
2892 AddIssuingCharge($issue, $charge, $description);
2895 # Charge a new accumulate rental fee, if applicable
2896 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2897 if ( $itemtype_object ) {
2898 my $accumulate_charge = $fees->accumulate_rentalcharge();
2899 if ( $accumulate_charge > 0 ) {
2900 my $type_desc = "Renewal of Daily Rental Item " . $biblio->title . " $item_unblessed->{'barcode'}";
2901 AddIssuingCharge( $issue, $accumulate_charge, $type_desc )
2903 $charge += $accumulate_charge;
2906 # Send a renewal slip according to checkout alert preferencei
2907 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2908 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2910 branchcode => $branch,
2911 categorycode => $patron->categorycode,
2912 item_type => $itemtype,
2913 notification => 'CHECKOUT',
2915 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2916 SendCirculationAlert(
2919 item => $item_unblessed,
2920 borrower => $patron->unblessed,
2927 # Remove any OVERDUES related debarment if the borrower has no overdues
2929 && $patron->is_debarred
2930 && ! $patron->has_overdues
2931 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2933 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2936 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2937 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2940 # Add the renewal to stats
2946 itemnumber => $itemnumber,
2947 itemtype => $itemtype,
2948 location => $item_object->location,
2949 borrowernumber => $borrowernumber,
2950 ccode => $item_object->ccode,
2955 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2960 # check renewal status
2961 my ( $bornum, $itemno ) = @_;
2962 my $dbh = C4::Context->dbh;
2964 my $renewsallowed = 0;
2967 my $patron = Koha::Patrons->find( $bornum );
2968 my $item = Koha::Items->find($itemno);
2970 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2972 # Look in the issues table for this item, lent to this borrower,
2973 # and not yet returned.
2975 # FIXME - I think this function could be redone to use only one SQL call.
2976 my $sth = $dbh->prepare(
2977 "select * from issues
2978 where (borrowernumber = ?)
2979 and (itemnumber = ?)"
2981 $sth->execute( $bornum, $itemno );
2982 my $data = $sth->fetchrow_hashref;
2983 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2984 # $item and $borrower should be calculated
2985 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
2987 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2988 { categorycode => $patron->categorycode,
2989 itemtype => $item->effective_itemtype,
2990 branchcode => $branchcode
2994 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
2995 $renewsleft = $renewsallowed - $renewcount;
2996 if($renewsleft < 0){ $renewsleft = 0; }
2997 return ( $renewcount, $renewsallowed, $renewsleft );
3000 =head2 GetSoonestRenewDate
3002 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3004 Find out the soonest possible renew date of a borrowed item.
3006 C<$borrowernumber> is the borrower number of the patron who currently
3007 has the item on loan.
3009 C<$itemnumber> is the number of the item to renew.
3011 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3012 renew date, based on the value "No renewal before" of the applicable
3013 issuing rule. Returns the current date if the item can already be
3014 renewed, and returns undefined if the borrower, loan, or item
3019 sub GetSoonestRenewDate {
3020 my ( $borrowernumber, $itemnumber ) = @_;
3022 my $dbh = C4::Context->dbh;
3024 my $item = Koha::Items->find($itemnumber) or return;
3025 my $itemissue = $item->checkout or return;
3027 $borrowernumber ||= $itemissue->borrowernumber;
3028 my $patron = Koha::Patrons->find( $borrowernumber )
3031 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3032 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3033 { categorycode => $patron->categorycode,
3034 itemtype => $item->effective_itemtype,
3035 branchcode => $branchcode
3039 my $now = dt_from_string;
3040 return $now unless $issuing_rule;
3042 if ( defined $issuing_rule->norenewalbefore
3043 and $issuing_rule->norenewalbefore ne "" )
3045 my $soonestrenewal =
3046 dt_from_string( $itemissue->date_due )->subtract(
3047 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3049 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3050 and $issuing_rule->lengthunit eq 'days' )
3052 $soonestrenewal->truncate( to => 'day' );
3054 return $soonestrenewal if $now < $soonestrenewal;
3059 =head2 GetLatestAutoRenewDate
3061 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3063 Find out the latest possible auto renew date of a borrowed item.
3065 C<$borrowernumber> is the borrower number of the patron who currently
3066 has the item on loan.
3068 C<$itemnumber> is the number of the item to renew.
3070 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3071 auto renew date, based on the value "No auto renewal after" and the "No auto
3072 renewal after (hard limit) of the applicable issuing rule.
3073 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3074 or item cannot be found.
3078 sub GetLatestAutoRenewDate {
3079 my ( $borrowernumber, $itemnumber ) = @_;
3081 my $dbh = C4::Context->dbh;
3083 my $item = Koha::Items->find($itemnumber) or return;
3084 my $itemissue = $item->checkout or return;
3086 $borrowernumber ||= $itemissue->borrowernumber;
3087 my $patron = Koha::Patrons->find( $borrowernumber )
3090 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3091 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3092 { categorycode => $patron->categorycode,
3093 itemtype => $item->effective_itemtype,
3094 branchcode => $branchcode
3098 return unless $issuing_rule;
3100 if ( not $issuing_rule->no_auto_renewal_after
3101 or $issuing_rule->no_auto_renewal_after eq '' )
3102 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3103 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3105 my $maximum_renewal_date;
3106 if ( $issuing_rule->no_auto_renewal_after ) {
3107 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3108 $maximum_renewal_date->add(
3109 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3113 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3114 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3115 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3117 return $maximum_renewal_date;
3121 =head2 GetIssuingCharges
3123 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3125 Calculate how much it would cost for a given patron to borrow a given
3126 item, including any applicable discounts.
3128 C<$itemnumber> is the item number of item the patron wishes to borrow.
3130 C<$borrowernumber> is the patron's borrower number.
3132 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3133 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3138 sub GetIssuingCharges {
3140 # calculate charges due
3141 my ( $itemnumber, $borrowernumber ) = @_;
3143 my $dbh = C4::Context->dbh;
3146 # Get the book's item type and rental charge (via its biblioitem).
3147 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3148 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3149 $charge_query .= (C4::Context->preference('item-level_itypes'))
3150 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3151 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3153 $charge_query .= ' WHERE items.itemnumber =?';
3155 my $sth = $dbh->prepare($charge_query);
3156 $sth->execute($itemnumber);
3157 if ( my $item_data = $sth->fetchrow_hashref ) {
3158 $item_type = $item_data->{itemtype};
3159 $charge = $item_data->{rentalcharge};
3160 my $branch = C4::Context::mybranch();
3161 my $discount_query = q|SELECT rentaldiscount,
3162 issuingrules.itemtype, issuingrules.branchcode
3164 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3165 WHERE borrowers.borrowernumber = ?
3166 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3167 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3168 my $discount_sth = $dbh->prepare($discount_query);
3169 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3170 my $discount_rules = $discount_sth->fetchall_arrayref({});
3171 if (@{$discount_rules}) {
3172 # We may have multiple rules so get the most specific
3173 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3174 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3177 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3181 return ( $charge, $item_type );
3184 # Select most appropriate discount rule from those returned
3185 sub _get_discount_from_rule {
3186 my ($rules_ref, $branch, $itemtype) = @_;
3189 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3190 $discount = $rules_ref->[0]->{rentaldiscount};
3191 return (defined $discount) ? $discount : 0;
3193 # could have up to 4 does one match $branch and $itemtype
3194 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3196 $discount = $d[0]->{rentaldiscount};
3197 return (defined $discount) ? $discount : 0;
3199 # do we have item type + all branches
3200 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3202 $discount = $d[0]->{rentaldiscount};
3203 return (defined $discount) ? $discount : 0;
3205 # do we all item types + this branch
3206 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3208 $discount = $d[0]->{rentaldiscount};
3209 return (defined $discount) ? $discount : 0;
3211 # so all and all (surely we wont get here)
3212 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3214 $discount = $d[0]->{rentaldiscount};
3215 return (defined $discount) ? $discount : 0;
3221 =head2 AddIssuingCharge
3223 &AddIssuingCharge( $checkout, $charge, [$description] )
3227 sub AddIssuingCharge {
3228 my ( $checkout, $charge, $description ) = @_;
3230 # FIXME What if checkout does not exist?
3232 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3233 my $accountline = $account->add_debit(
3236 description => $description,
3238 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3239 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3240 interface => C4::Context->interface,
3242 item_id => $checkout->itemnumber,
3243 issue_id => $checkout->issue_id,
3250 GetTransfers($itemnumber);
3255 my ($itemnumber) = @_;
3257 my $dbh = C4::Context->dbh;
3264 FROM branchtransfers
3265 WHERE itemnumber = ?
3266 AND datearrived IS NULL
3268 my $sth = $dbh->prepare($query);
3269 $sth->execute($itemnumber);
3270 my @row = $sth->fetchrow_array();
3274 =head2 GetTransfersFromTo
3276 @results = GetTransfersFromTo($frombranch,$tobranch);
3278 Returns the list of pending transfers between $from and $to branch
3282 sub GetTransfersFromTo {
3283 my ( $frombranch, $tobranch ) = @_;
3284 return unless ( $frombranch && $tobranch );
3285 my $dbh = C4::Context->dbh;
3287 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3288 FROM branchtransfers
3291 AND datearrived IS NULL
3293 my $sth = $dbh->prepare($query);
3294 $sth->execute( $frombranch, $tobranch );
3297 while ( my $data = $sth->fetchrow_hashref ) {
3298 push @gettransfers, $data;
3300 return (@gettransfers);
3303 =head2 DeleteTransfer
3305 &DeleteTransfer($itemnumber);
3309 sub DeleteTransfer {
3310 my ($itemnumber) = @_;
3311 return unless $itemnumber;
3312 my $dbh = C4::Context->dbh;
3313 my $sth = $dbh->prepare(
3314 "DELETE FROM branchtransfers
3316 AND datearrived IS NULL "
3318 return $sth->execute($itemnumber);
3321 =head2 SendCirculationAlert
3323 Send out a C<check-in> or C<checkout> alert using the messaging system.
3331 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3335 Hashref of information about the item being checked in or out.
3339 Hashref of information about the borrower of the item.
3343 The branchcode from where the checkout or check-in took place.
3349 SendCirculationAlert({
3352 borrower => $borrower,
3358 sub SendCirculationAlert {
3360 my ($type, $item, $borrower, $branch) =
3361 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3362 my %message_name = (
3363 CHECKIN => 'Item_Check_in',
3364 CHECKOUT => 'Item_Checkout',
3365 RENEWAL => 'Item_Checkout',
3367 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3368 borrowernumber => $borrower->{borrowernumber},
3369 message_name => $message_name{$type},
3371 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3373 my $schema = Koha::Database->new->schema;
3374 my @transports = keys %{ $borrower_preferences->{transports} };
3376 # From the MySQL doc:
3377 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3378 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3379 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3380 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3382 for my $mtt (@transports) {
3383 my $letter = C4::Letters::GetPreparedLetter (
3384 module => 'circulation',
3385 letter_code => $type,
3386 branchcode => $branch,
3387 message_transport_type => $mtt,
3388 lang => $borrower->{lang},
3390 $issues_table => $item->{itemnumber},
3391 'items' => $item->{itemnumber},
3392 'biblio' => $item->{biblionumber},
3393 'biblioitems' => $item->{biblionumber},
3394 'borrowers' => $borrower,
3395 'branches' => $branch,
3399 $schema->storage->txn_begin;
3400 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3401 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3402 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3403 unless ( $message ) {
3404 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3405 C4::Message->enqueue($letter, $borrower, $mtt);
3407 $message->append($letter);
3410 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3411 $schema->storage->txn_commit;
3417 =head2 updateWrongTransfer
3419 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3421 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
3425 sub updateWrongTransfer {
3426 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3427 my $dbh = C4::Context->dbh;
3428 # first step validate the actual line of transfert .
3431 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3433 $sth->execute($FromLibrary,$itemNumber);
3435 # second step create a new line of branchtransfer to the right location .
3436 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3438 #third step changing holdingbranch of item
3439 UpdateHoldingbranch($FromLibrary,$itemNumber);
3442 =head2 UpdateHoldingbranch
3444 $items = UpdateHoldingbranch($branch,$itmenumber);
3446 Simple methode for updating hodlingbranch in items BDD line
3450 sub UpdateHoldingbranch {
3451 my ( $branch,$itemnumber ) = @_;
3452 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3457 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3459 this function calculates the due date given the start date and configured circulation rules,
3460 checking against the holidays calendar as per the 'useDaysMode' syspref.
3461 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3462 C<$itemtype> = itemtype code of item in question
3463 C<$branch> = location whose calendar to use
3464 C<$borrower> = Borrower object
3465 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3470 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3474 # loanlength now a href
3476 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3478 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3484 if (ref $startdate ne 'DateTime' ) {
3485 $datedue = dt_from_string($datedue);
3487 $datedue = $startdate->clone;
3491 DateTime->now( time_zone => C4::Context->tz() )
3492 ->truncate( to => 'minute' );
3496 # calculate the datedue as normal
3497 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3498 { # ignoring calendar
3499 if ( $loanlength->{lengthunit} eq 'hours' ) {
3500 $datedue->add( hours => $loanlength->{$length_key} );
3502 $datedue->add( days => $loanlength->{$length_key} );
3503 $datedue->set_hour(23);
3504 $datedue->set_minute(59);
3508 if ($loanlength->{lengthunit} eq 'hours') {
3509 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3512 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3514 my $calendar = Koha::Calendar->new( branchcode => $branch );
3515 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3516 if ($loanlength->{lengthunit} eq 'days') {
3517 $datedue->set_hour(23);
3518 $datedue->set_minute(59);
3522 # if Hard Due Dates are used, retrieve them and apply as necessary
3523 my ( $hardduedate, $hardduedatecompare ) =
3524 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3525 if ($hardduedate) { # hardduedates are currently dates
3526 $hardduedate->truncate( to => 'minute' );
3527 $hardduedate->set_hour(23);
3528 $hardduedate->set_minute(59);
3529 my $cmp = DateTime->compare( $hardduedate, $datedue );
3531 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3532 # if the calculated date is before the 'after' Hard Due Date (floor), override
3533 # if the hard due date is set to 'exactly', overrride
3534 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3535 $datedue = $hardduedate->clone;
3538 # in all other cases, keep the date due as it is
3542 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3543 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3544 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3545 if( $expiry_dt ) { #skip empty expiry date..
3546 $expiry_dt->set( hour => 23, minute => 59);
3547 my $d1= $datedue->clone->set_time_zone('floating');
3548 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3549 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3552 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3553 my $calendar = Koha::Calendar->new( branchcode => $branch );
3554 if ( $calendar->is_holiday($datedue) ) {
3555 # Don't return on a closed day
3556 $datedue = $calendar->prev_open_day( $datedue );
3565 sub CheckValidBarcode{
3567 my $dbh = C4::Context->dbh;
3568 my $query=qq|SELECT count(*)
3572 my $sth = $dbh->prepare($query);
3573 $sth->execute($barcode);
3574 my $exist=$sth->fetchrow ;
3578 =head2 IsBranchTransferAllowed
3580 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3582 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3584 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3585 Koha::Item->can_be_transferred.
3589 sub IsBranchTransferAllowed {
3590 my ( $toBranch, $fromBranch, $code ) = @_;
3592 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3594 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3595 my $dbh = C4::Context->dbh;
3597 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3598 $sth->execute( $toBranch, $fromBranch, $code );
3599 my $limit = $sth->fetchrow_hashref();
3601 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3602 if ( $limit->{'limitId'} ) {
3609 =head2 CreateBranchTransferLimit
3611 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3613 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3615 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3619 sub CreateBranchTransferLimit {
3620 my ( $toBranch, $fromBranch, $code ) = @_;
3621 return unless defined($toBranch) && defined($fromBranch);
3622 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3624 my $dbh = C4::Context->dbh;
3626 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3627 return $sth->execute( $code, $toBranch, $fromBranch );
3630 =head2 DeleteBranchTransferLimits
3632 my $result = DeleteBranchTransferLimits($frombranch);
3634 Deletes all the library transfer limits for one library. Returns the
3635 number of limits deleted, 0e0 if no limits were deleted, or undef if
3636 no arguments are supplied.
3638 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3639 fromBranch => $fromBranch
3644 sub DeleteBranchTransferLimits {
3646 return unless defined $branch;
3647 my $dbh = C4::Context->dbh;
3648 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3649 return $sth->execute($branch);
3653 my ( $borrowernumber, $itemnum ) = @_;
3655 MarkIssueReturned( $borrowernumber, $itemnum );
3656 my $patron = Koha::Patrons->find( $borrowernumber );
3657 my $item = Koha::Items->find($itemnum);
3658 my $old_note = ($item->paidfor && ($item->paidfor ne q{})) ? $item->paidfor.' / ' : q{};
3659 my @datearr = localtime(time);
3660 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3661 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3662 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3667 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3669 unless ( $mark_lost_from ) {
3670 # Temporary check to avoid regressions
3671 die q|LostItem called without $mark_lost_from, check the API.|;
3675 if ( $force_mark_returned ) {
3678 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3679 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3682 my $dbh = C4::Context->dbh();
3683 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3685 JOIN items USING (itemnumber)
3686 JOIN biblio USING (biblionumber)
3687 WHERE issues.itemnumber=?");
3688 $sth->execute($itemnumber);
3689 my $issues=$sth->fetchrow_hashref();
3691 # If a borrower lost the item, add a replacement cost to the their record
3692 if ( my $borrowernumber = $issues->{borrowernumber} ){
3693 my $patron = Koha::Patrons->find( $borrowernumber );
3695 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 0); # 1, 0 = exemptfine, no-dropbox
3696 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3698 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3699 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "$issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3700 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3701 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3704 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3707 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3708 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3709 ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3711 my $transferdeleted = DeleteTransfer($itemnumber);
3714 sub GetOfflineOperations {
3715 my $dbh = C4::Context->dbh;
3716 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3717 $sth->execute(C4::Context->userenv->{'branch'});
3718 my $results = $sth->fetchall_arrayref({});
3722 sub GetOfflineOperation {
3723 my $operationid = shift;
3724 return unless $operationid;
3725 my $dbh = C4::Context->dbh;
3726 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3727 $sth->execute( $operationid );
3728 return $sth->fetchrow_hashref;
3731 sub AddOfflineOperation {
3732 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3733 my $dbh = C4::Context->dbh;
3734 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3735 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3739 sub DeleteOfflineOperation {
3740 my $dbh = C4::Context->dbh;
3741 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3742 $sth->execute( shift );
3746 sub ProcessOfflineOperation {
3747 my $operation = shift;
3750 if ( $operation->{action} eq 'return' ) {
3751 $report = ProcessOfflineReturn( $operation );
3752 } elsif ( $operation->{action} eq 'issue' ) {
3753 $report = ProcessOfflineIssue( $operation );
3754 } elsif ( $operation->{action} eq 'payment' ) {
3755 $report = ProcessOfflinePayment( $operation );
3758 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3763 sub ProcessOfflineReturn {
3764 my $operation = shift;
3766 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3769 my $itemnumber = $item->itemnumber;
3770 my $issue = GetOpenIssue( $itemnumber );
3773 $issue->{borrowernumber},
3775 $operation->{timestamp},
3778 { renewals => 0, onloan => undef },
3779 $issue->{'biblionumber'},
3785 return "Item not issued.";
3788 return "Item not found.";
3792 sub ProcessOfflineIssue {
3793 my $operation = shift;
3795 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3798 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3800 return "Barcode not found.";
3802 my $itemnumber = $item->itemnumber;
3803 my $issue = GetOpenIssue( $itemnumber );
3805 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3807 $issue->{borrowernumber},
3809 $operation->{timestamp},
3814 $operation->{'barcode'},
3817 $operation->{timestamp},
3822 return "Borrower not found.";
3826 sub ProcessOfflinePayment {
3827 my $operation = shift;
3829 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3831 $patron->account->pay(
3833 amount => $operation->{amount},
3834 library_id => $operation->{branchcode},
3844 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3846 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3851 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3855 ? Koha::Items->find($itemnumber)
3856 : Koha::Items->find( { barcode => $barcode } );
3860 return C4::Letters::GetPreparedLetter (
3861 module => 'circulation',
3862 letter_code => 'TRANSFERSLIP',
3863 branchcode => $branch,
3865 'branches' => $to_branch,
3866 'biblio' => $item->biblionumber,
3867 'items' => $item->unblessed,
3872 =head2 CheckIfIssuedToPatron
3874 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3876 Return 1 if any record item is issued to patron, otherwise return 0
3880 sub CheckIfIssuedToPatron {
3881 my ($borrowernumber, $biblionumber) = @_;
3883 my $dbh = C4::Context->dbh;
3885 SELECT COUNT(*) FROM issues
3886 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3887 WHERE items.biblionumber = ?
3888 AND issues.borrowernumber = ?
3890 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3891 return 1 if $is_issued;
3897 IsItemIssued( $itemnumber )
3899 Return 1 if the item is on loan, otherwise return 0
3904 my $itemnumber = shift;
3905 my $dbh = C4::Context->dbh;
3906 my $sth = $dbh->prepare(q{
3909 WHERE itemnumber = ?
3911 $sth->execute($itemnumber);
3912 return $sth->fetchrow;
3915 =head2 GetAgeRestriction
3917 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3918 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3920 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3921 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3923 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3924 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3925 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3926 Negative days mean the borrower has gone past the age restriction age.
3930 sub GetAgeRestriction {
3931 my ($record_restrictions, $borrower) = @_;
3932 my $markers = C4::Context->preference('AgeRestrictionMarker');
3934 # Split $record_restrictions to something like FSK 16 or PEGI 6
3935 my @values = split ' ', uc($record_restrictions);
3936 return unless @values;
3938 # Search first occurrence of one of the markers
3939 my @markers = split /\|/, uc($markers);
3940 return unless @markers;
3943 my $restriction_year = 0;
3944 for my $value (@values) {
3946 for my $marker (@markers) {
3947 $marker =~ s/^\s+//; #remove leading spaces
3948 $marker =~ s/\s+$//; #remove trailing spaces
3949 if ( $marker eq $value ) {
3950 if ( $index <= $#values ) {
3951 $restriction_year += $values[$index];
3955 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3957 # Perhaps it is something like "K16" (as in Finland)
3958 $restriction_year += $1;
3962 last if ( $restriction_year > 0 );
3965 #Check if the borrower is age restricted for this material and for how long.
3966 if ($restriction_year && $borrower) {
3967 if ( $borrower->{'dateofbirth'} ) {
3968 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3969 $alloweddate[0] += $restriction_year;
3971 #Prevent runime eror on leap year (invalid date)
3972 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3973 $alloweddate[2] = 28;
3976 #Get how many days the borrower has to reach the age restriction
3977 my @Today = split /-/, DateTime->today->ymd();
3978 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3979 #Negative days means the borrower went past the age restriction age
3980 return ($restriction_year, $daysToAgeRestriction);
3984 return ($restriction_year);
3988 =head2 GetPendingOnSiteCheckouts
3992 sub GetPendingOnSiteCheckouts {
3993 my $dbh = C4::Context->dbh;
3994 return $dbh->selectall_arrayref(q|
4000 items.itemcallnumber,
4004 issues.date_due < NOW() AS is_overdue,
4007 borrowers.firstname,
4009 borrowers.cardnumber,
4010 borrowers.borrowernumber
4012 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4013 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4014 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4015 WHERE issues.onsite_checkout = 1
4016 |, { Slice => {} } );
4022 my ($count, $branch, $itemtype, $ccode, $newness)
4023 = @$params{qw(count branch itemtype ccode newness)};
4025 my $dbh = C4::Context->dbh;
4028 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4029 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4030 i.ccode, SUM(i.issues) AS count
4032 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4033 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4036 my (@where_strs, @where_args);
4039 push @where_strs, 'i.homebranch = ?';
4040 push @where_args, $branch;
4043 if (C4::Context->preference('item-level_itypes')){
4044 push @where_strs, 'i.itype = ?';
4045 push @where_args, $itemtype;
4047 push @where_strs, 'bi.itemtype = ?';
4048 push @where_args, $itemtype;
4052 push @where_strs, 'i.ccode = ?';
4053 push @where_args, $ccode;
4056 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4057 push @where_args, $newness;
4061 $query .= 'WHERE ' . join(' AND ', @where_strs);
4065 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4066 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4071 $query .= q{ ) xxx WHERE count > 0 };
4072 $count = int($count);
4074 $query .= "LIMIT $count";
4077 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4082 sub _CalculateAndUpdateFine {
4085 my $borrower = $params->{borrower};
4086 my $item = $params->{item};
4087 my $issue = $params->{issue};
4088 my $return_date = $params->{return_date};
4090 unless ($borrower) { carp "No borrower passed in!" && return; }
4091 unless ($item) { carp "No item passed in!" && return; }
4092 unless ($issue) { carp "No issue passed in!" && return; }
4094 my $datedue = dt_from_string( $issue->date_due );
4096 # we only need to calculate and change the fines if we want to do that on return
4097 # Should be on for hourly loans
4098 my $control = C4::Context->preference('CircControl');
4099 my $control_branchcode =
4100 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4101 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4102 : $issue->branchcode;
4104 my $date_returned = $return_date ? $return_date : dt_from_string();
4106 my ( $amount, $unitcounttotal, $unitcount ) =
4107 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4109 if ( C4::Context->preference('finesMode') eq 'production' ) {
4110 if ( $amount > 0 ) {
4111 C4::Overdues::UpdateFine({
4112 issue_id => $issue->issue_id,
4113 itemnumber => $issue->itemnumber,
4114 borrowernumber => $issue->borrowernumber,
4116 due => output_pref($datedue),
4119 elsif ($return_date) {
4121 # Backdated returns may have fines that shouldn't exist,
4122 # so in this case, we need to drop those fines to 0
4124 C4::Overdues::UpdateFine({
4125 issue_id => $issue->issue_id,
4126 itemnumber => $issue->itemnumber,
4127 borrowernumber => $issue->borrowernumber,
4129 due => output_pref($datedue),
4135 sub _item_denied_renewal {
4138 my $item = $params->{item};
4139 return unless $item;
4141 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4142 return unless $denyingrules;
4143 foreach my $field (keys %$denyingrules) {
4144 my $val = $item->$field;
4145 if( !defined $val) {
4146 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4149 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4150 # If the results matches the values in the syspref
4151 # We return true if match found
4165 Koha Development Team <http://koha-community.org/>