1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use POSIX qw( floor );
32 use C4::ItemCirculationAlertPreference;
35 use C4::Log; # logaction
36 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits;
42 use Koha::AuthorisedValues;
43 use Koha::Biblioitems;
47 use Koha::Illrequests;
50 use Koha::Patron::Debarments;
53 use Koha::Account::Lines;
55 use Koha::RefundLostItemFeeRules;
56 use Koha::Account::Lines;
57 use Koha::Account::Offsets;
58 use Koha::Config::SysPrefs;
59 use Koha::Charges::Fees;
60 use Koha::Util::SystemPreferences;
61 use Koha::Checkouts::ReturnClaims;
63 use List::MoreUtils qw( uniq any );
64 use Scalar::Util qw( looks_like_number );
74 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
80 # FIXME subs that should probably be elsewhere
85 &GetPendingOnSiteCheckouts
88 # subs to deal with issuing a book
96 &GetLatestAutoRenewDate
98 &GetBranchBorrowerCircRule
102 &CheckIfIssuedToPatron
107 # subs to deal with returns
113 # subs to deal with transfers
120 &IsBranchTransferAllowed
121 &CreateBranchTransferLimit
122 &DeleteBranchTransferLimits
126 # subs to deal with offline circulation
128 &GetOfflineOperations
131 &DeleteOfflineOperation
132 &ProcessOfflineOperation
138 C4::Circulation - Koha circulation module
146 The functions in this module deal with circulation, issues, and
147 returns, as well as general information about the library.
148 Also deals with inventory.
154 $str = &barcodedecode($barcode, [$filter]);
156 Generic filter function for barcode string.
157 Called on every circ if the System Pref itemBarcodeInputFilter is set.
158 Will do some manipulation of the barcode for systems that deliver a barcode
159 to circulation.pl that differs from the barcode stored for the item.
160 For proper functioning of this filter, calling the function on the
161 correct barcode string (items.barcode) should return an unaltered barcode.
163 The optional $filter argument is to allow for testing or explicit
164 behavior that ignores the System Pref. Valid values are the same as the
169 # FIXME -- the &decode fcn below should be wrapped into this one.
170 # FIXME -- these plugins should be moved out of Circulation.pm
173 my ($barcode, $filter) = @_;
174 my $branch = C4::Context::mybranch();
175 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
176 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
177 if ($filter eq 'whitespace') {
179 } elsif ($filter eq 'cuecat') {
181 my @fields = split( /\./, $barcode );
182 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
183 ($#results == 2) and return $results[2];
184 } elsif ($filter eq 'T-prefix') {
185 if ($barcode =~ /^[Tt](\d)/) {
186 (defined($1) and $1 eq '0') and return $barcode;
187 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
189 return sprintf("T%07d", $barcode);
190 # FIXME: $barcode could be "T1", causing warning: substr outside of string
191 # Why drop the nonzero digit after the T?
192 # Why pass non-digits (or empty string) to "T%07d"?
193 } elsif ($filter eq 'libsuite8') {
194 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
195 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
196 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
198 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
201 } elsif ($filter eq 'EAN13') {
202 my $ean = CheckDigits('ean');
203 if ( $ean->is_valid($barcode) ) {
204 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
205 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
207 warn "# [$barcode] not valid EAN-13/UPC-A\n";
210 return $barcode; # return barcode, modified or not
215 $str = &decode($chunk);
217 Decodes a segment of a string emitted by a CueCat barcode scanner and
220 FIXME: Should be replaced with Barcode::Cuecat from CPAN
221 or Javascript based decoding on the client side.
228 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
229 my @s = map { index( $seq, $_ ); } split( //, $encoded );
230 my $l = ( $#s + 1 ) % 4;
233 # warn "Error: Cuecat decode parsing failed!";
241 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
243 chr( ( $n >> 16 ) ^ 67 )
244 .chr( ( $n >> 8 & 255 ) ^ 67 )
245 .chr( ( $n & 255 ) ^ 67 );
248 $r = substr( $r, 0, length($r) - $l );
254 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
255 $barcode, $ignore_reserves, $trigger);
257 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
259 C<$newbranch> is the code for the branch to which the item should be transferred.
261 C<$barcode> is the barcode of the item to be transferred.
263 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
264 Otherwise, if an item is reserved, the transfer fails.
266 C<$trigger> is the enum value for what triggered the transfer.
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, $trigger ) = @_;
312 my $item = Koha::Items->find( { barcode => $barcode } );
316 $messages->{'BadBarcode'} = $barcode;
318 return ( $dotransfer, $messages );
321 my $itemnumber = $item->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...
347 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
349 AddReturn( $barcode, $fbr );
350 $messages->{'WasReturned'} = $issue->borrowernumber;
354 # That'll save a database query.
355 my ( $resfound, $resrec, undef ) =
356 CheckReserves( $itemnumber );
357 if ( $resfound and not $ignoreRs ) {
358 $resrec->{'ResFound'} = $resfound;
359 $messages->{'ResFound'} = $resrec;
363 #actually do the transfer....
365 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
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 $item_object = shift;
380 my $onsite_checkout = $params->{onsite_checkout} || 0;
381 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
382 my $cat_borrower = $borrower->{'categorycode'};
383 my $dbh = C4::Context->dbh;
385 # Get which branchcode we need
386 $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
387 my $type = $item_object->effective_itemtype;
389 # given branch, patron category, and item type, determine
390 # applicable issuing rule
391 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
393 categorycode => $cat_borrower,
395 branchcode => $branch,
396 rule_name => 'maxissueqty',
399 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
401 categorycode => $cat_borrower,
403 branchcode => $branch,
404 rule_name => 'maxonsiteissueqty',
409 # if a rule is found and has a loan limit set, count
410 # how many loans the patron already has that meet that
412 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne '') {
415 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
417 JOIN items USING (itemnumber)
420 my $rule_itemtype = $maxissueqty_rule->itemtype;
421 unless ($rule_itemtype) {
422 # matching rule has the default item type, so count only
423 # those existing loans that don't fall under a more
425 if (C4::Context->preference('item-level_itypes')) {
426 $count_query .= " WHERE items.itype NOT IN (
427 SELECT itemtype FROM circulation_rules
429 AND (categorycode = ? OR categorycode = ?)
430 AND itemtype IS NOT NULL
431 AND rule_name = 'maxissueqty'
434 $count_query .= " JOIN biblioitems USING (biblionumber)
435 WHERE biblioitems.itemtype NOT IN (
436 SELECT itemtype FROM circulation_rules
438 AND (categorycode = ? OR categorycode = ?)
439 AND itemtype IS NOT NULL
440 AND rule_name = 'maxissueqty'
443 push @bind_params, $maxissueqty_rule->branchcode;
444 push @bind_params, $maxissueqty_rule->categorycode;
445 push @bind_params, $cat_borrower;
447 # rule has specific item type, so count loans of that
449 if (C4::Context->preference('item-level_itypes')) {
450 $count_query .= " WHERE items.itype = ? ";
452 $count_query .= " JOIN biblioitems USING (biblionumber)
453 WHERE biblioitems.itemtype= ? ";
455 push @bind_params, $type;
458 $count_query .= " AND borrowernumber = ? ";
459 push @bind_params, $borrower->{'borrowernumber'};
460 my $rule_branch = $maxissueqty_rule->branchcode;
462 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
463 $count_query .= " AND issues.branchcode = ? ";
464 push @bind_params, $rule_branch;
465 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
466 ; # if branch is the patron's home branch, then count all loans by patron
468 $count_query .= " AND items.homebranch = ? ";
469 push @bind_params, $rule_branch;
473 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
475 my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
476 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
478 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
479 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
481 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
482 count => $onsite_checkout_count,
483 max_allowed => $max_onsite_checkouts_allowed,
487 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
488 my $delta = $switch_onsite_checkout ? 1 : 0;
489 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
491 reason => 'TOO_MANY_CHECKOUTS',
492 count => $checkout_count,
493 max_allowed => $max_checkouts_allowed,
496 } elsif ( not $onsite_checkout ) {
497 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
499 reason => 'TOO_MANY_CHECKOUTS',
500 count => $checkout_count - $onsite_checkout_count,
501 max_allowed => $max_checkouts_allowed,
507 # Now count total loans against the limit for the branch
508 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
509 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
510 my @bind_params = ();
511 my $branch_count_query = q|
512 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
514 JOIN items USING (itemnumber)
515 WHERE borrowernumber = ?
517 push @bind_params, $borrower->{borrowernumber};
519 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
520 $branch_count_query .= " AND issues.branchcode = ? ";
521 push @bind_params, $branch;
522 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
523 ; # if branch is the patron's home branch, then count all loans by patron
525 $branch_count_query .= " AND items.homebranch = ? ";
526 push @bind_params, $branch;
528 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
529 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
530 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
532 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
533 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
535 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
536 count => $onsite_checkout_count,
537 max_allowed => $max_onsite_checkouts_allowed,
541 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
542 my $delta = $switch_onsite_checkout ? 1 : 0;
543 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
545 reason => 'TOO_MANY_CHECKOUTS',
546 count => $checkout_count,
547 max_allowed => $max_checkouts_allowed,
550 } elsif ( not $onsite_checkout ) {
551 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
553 reason => 'TOO_MANY_CHECKOUTS',
554 count => $checkout_count - $onsite_checkout_count,
555 max_allowed => $max_checkouts_allowed,
561 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
562 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
565 # OK, the patron can issue !!!
569 =head2 CanBookBeIssued
571 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
572 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
574 Check if a book can be issued.
576 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
578 IMPORTANT: The assumption by users of this routine is that causes blocking
579 the issue are keyed by uppercase labels and other returned
580 data is keyed in lower case!
584 =item C<$patron> is a Koha::Patron
586 =item C<$barcode> is the bar code of the book being issued.
588 =item C<$duedates> is a DateTime object.
590 =item C<$inprocess> boolean switch
592 =item C<$ignore_reserves> boolean switch
594 =item C<$params> Hashref of additional parameters
597 override_high_holds - Ignore high holds
598 onsite_checkout - Checkout is an onsite checkout that will not leave the library
606 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
607 Possible values are :
613 sticky due date is invalid
617 borrower gone with no address
621 borrower declared it's card lost
627 =head3 UNKNOWN_BARCODE
641 item is restricted (set by ??)
643 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
644 could be prevented, but ones that can be overriden by the operator.
646 Possible values are :
654 renewing, not issuing
656 =head3 ISSUED_TO_ANOTHER
658 issued to someone else.
662 reserved for someone else.
666 sticky due date is invalid or due date in the past
670 if the borrower borrows to much things
674 sub CanBookBeIssued {
675 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
676 my %needsconfirmation; # filled with problems that needs confirmations
677 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
678 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
679 my %messages; # filled with information messages that should be displayed.
681 my $onsite_checkout = $params->{onsite_checkout} || 0;
682 my $override_high_holds = $params->{override_high_holds} || 0;
684 my $item_object = Koha::Items->find({barcode => $barcode });
686 # MANDATORY CHECKS - unless item exists, nothing else matters
687 unless ( $item_object ) {
688 $issuingimpossible{UNKNOWN_BARCODE} = 1;
690 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
692 my $item_unblessed = $item_object->unblessed; # Transition...
693 my $issue = $item_object->checkout;
694 my $biblio = $item_object->biblio;
696 my $biblioitem = $biblio->biblioitem;
697 my $effective_itemtype = $item_object->effective_itemtype;
698 my $dbh = C4::Context->dbh;
699 my $patron_unblessed = $patron->unblessed;
701 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
703 # DUE DATE is OK ? -- should already have checked.
705 if ($duedate && ref $duedate ne 'DateTime') {
706 $duedate = dt_from_string($duedate);
708 my $now = dt_from_string();
709 unless ( $duedate ) {
710 my $issuedate = $now->clone();
712 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
714 # Offline circ calls AddIssue directly, doesn't run through here
715 # So issuingimpossible should be ok.
718 my $fees = Koha::Charges::Fees->new(
721 library => $circ_library,
722 item => $item_object,
728 my $today = $now->clone();
729 $today->truncate( to => 'minute');
730 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
731 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
734 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
740 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
741 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
743 branch => C4::Context->userenv->{'branch'},
745 itemnumber => $item_object->itemnumber,
746 itemtype => $effective_itemtype,
747 borrowernumber => $patron->borrowernumber,
748 ccode => $item_object->ccode}
750 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
751 return( { STATS => 1 }, {});
754 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
755 $issuingimpossible{GNA} = 1;
758 if ( $patron->lost && $patron->lost == 1 ) {
759 $issuingimpossible{CARD_LOST} = 1;
761 if ( $patron->is_debarred ) {
762 $issuingimpossible{DEBARRED} = 1;
765 if ( $patron->is_expired ) {
766 $issuingimpossible{EXPIRED} = 1;
774 my $account = $patron->account;
775 my $balance = $account->balance;
776 my $non_issues_charges = $account->non_issues_charges;
777 my $other_charges = $balance - $non_issues_charges;
779 my $amountlimit = C4::Context->preference("noissuescharge");
780 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
781 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
783 # Check the debt of this patrons guarantees
784 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
785 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
786 if ( defined $no_issues_charge_guarantees ) {
787 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
788 my $guarantees_non_issues_charges;
789 foreach my $g ( @guarantees ) {
790 $guarantees_non_issues_charges += $g->account->non_issues_charges;
793 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
794 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
795 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
796 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
797 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
798 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
802 if ( C4::Context->preference("IssuingInProcess") ) {
803 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
804 $issuingimpossible{DEBT} = $non_issues_charges;
805 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
806 $needsconfirmation{DEBT} = $non_issues_charges;
807 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
808 $needsconfirmation{DEBT} = $non_issues_charges;
812 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
813 $needsconfirmation{DEBT} = $non_issues_charges;
814 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
815 $issuingimpossible{DEBT} = $non_issues_charges;
816 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
817 $needsconfirmation{DEBT} = $non_issues_charges;
821 if ($balance > 0 && $other_charges > 0) {
822 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
825 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
826 $patron_unblessed = $patron->unblessed;
828 if ( my $debarred_date = $patron->is_debarred ) {
829 # patron has accrued fine days or has a restriction. $count is a date
830 if ($debarred_date eq '9999-12-31') {
831 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
834 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
836 } elsif ( my $num_overdues = $patron->has_overdues ) {
837 ## patron has outstanding overdue loans
838 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
839 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
841 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
842 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
847 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
849 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
851 # Already issued to current borrower.
852 # If it is an on-site checkout if it can be switched to a normal checkout
853 # or ask whether the loan should be renewed
855 if ( $issue->onsite_checkout
856 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
857 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
859 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
860 $patron->borrowernumber,
861 $item_object->itemnumber,
863 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
864 if ( $renewerror eq 'onsite_checkout' ) {
865 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
868 $issuingimpossible{NO_MORE_RENEWALS} = 1;
872 $needsconfirmation{RENEW_ISSUE} = 1;
878 # issued to someone else
880 my $patron = Koha::Patrons->find( $issue->borrowernumber );
882 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
884 unless ( $can_be_returned ) {
885 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
886 $issuingimpossible{branch_to_return} = $message;
888 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
889 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
891 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
892 $needsconfirmation{issued_firstname} = $patron->firstname;
893 $needsconfirmation{issued_surname} = $patron->surname;
894 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
895 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
900 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
902 my $switch_onsite_checkout = (
903 C4::Context->preference('SwitchOnSiteCheckouts')
905 and $issue->onsite_checkout
906 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
907 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
908 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
909 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
910 if ( $toomany->{max_allowed} == 0 ) {
911 $needsconfirmation{PATRON_CANT} = 1;
913 if ( C4::Context->preference("AllowTooManyOverride") ) {
914 $needsconfirmation{TOO_MANY} = $toomany->{reason};
915 $needsconfirmation{current_loan_count} = $toomany->{count};
916 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
918 $issuingimpossible{TOO_MANY} = $toomany->{reason};
919 $issuingimpossible{current_loan_count} = $toomany->{count};
920 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
925 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
927 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
928 my $wants_check = $patron->wants_check_for_previous_checkout;
929 $needsconfirmation{PREVISSUE} = 1
930 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
935 if ( $item_object->notforloan )
937 if(!C4::Context->preference("AllowNotForLoanOverride")){
938 $issuingimpossible{NOT_FOR_LOAN} = 1;
939 $issuingimpossible{item_notforloan} = $item_object->notforloan;
941 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
942 $needsconfirmation{item_notforloan} = $item_object->notforloan;
946 # we have to check itemtypes.notforloan also
947 if (C4::Context->preference('item-level_itypes')){
948 # this should probably be a subroutine
949 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
950 $sth->execute($effective_itemtype);
951 my $notforloan=$sth->fetchrow_hashref();
952 if ($notforloan->{'notforloan'}) {
953 if (!C4::Context->preference("AllowNotForLoanOverride")) {
954 $issuingimpossible{NOT_FOR_LOAN} = 1;
955 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
957 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
958 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
963 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
964 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
965 if (!C4::Context->preference("AllowNotForLoanOverride")) {
966 $issuingimpossible{NOT_FOR_LOAN} = 1;
967 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
969 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
970 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
975 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
977 $issuingimpossible{WTHDRAWN} = 1;
979 if ( $item_object->restricted
980 && $item_object->restricted == 1 )
982 $issuingimpossible{RESTRICTED} = 1;
984 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
985 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
986 my $code = $av->count ? $av->next->lib : '';
987 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
988 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
990 if ( C4::Context->preference("IndependentBranches") ) {
991 my $userenv = C4::Context->userenv;
992 unless ( C4::Context->IsSuperLibrarian() ) {
993 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
994 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
995 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
996 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
998 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
999 if ( $patron->branchcode ne $userenv->{branch} );
1004 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1006 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1007 if ($rentalConfirmation) {
1008 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1010 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1011 if ($itemtype_object) {
1012 my $accumulate_charge = $fees->accumulate_rentalcharge();
1013 if ( $accumulate_charge > 0 ) {
1014 $rentalCharge += $accumulate_charge;
1018 if ( $rentalCharge > 0 ) {
1019 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1023 unless ( $ignore_reserves ) {
1024 # See if the item is on reserve.
1025 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1027 my $resbor = $res->{'borrowernumber'};
1028 if ( $resbor ne $patron->borrowernumber ) {
1029 my $patron = Koha::Patrons->find( $resbor );
1030 if ( $restype eq "Waiting" )
1032 # The item is on reserve and waiting, but has been
1033 # reserved by some other patron.
1034 $needsconfirmation{RESERVE_WAITING} = 1;
1035 $needsconfirmation{'resfirstname'} = $patron->firstname;
1036 $needsconfirmation{'ressurname'} = $patron->surname;
1037 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1038 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1039 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1040 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1041 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1043 elsif ( $restype eq "Reserved" ) {
1044 # The item is on reserve for someone else.
1045 $needsconfirmation{RESERVED} = 1;
1046 $needsconfirmation{'resfirstname'} = $patron->firstname;
1047 $needsconfirmation{'ressurname'} = $patron->surname;
1048 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1049 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1050 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1051 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1052 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1058 ## CHECK AGE RESTRICTION
1059 my $agerestriction = $biblioitem->agerestriction;
1060 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1061 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1062 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1063 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1066 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1070 ## check for high holds decreasing loan period
1071 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1072 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1074 if ( $check->{exceeded} ) {
1075 if ($override_high_holds) {
1076 $alerts{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' }),
1083 $needsconfirmation{HIGHHOLDS} = {
1084 num_holds => $check->{outstanding},
1085 duration => $check->{duration},
1086 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1093 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1094 # don't do the multiple loans per bib check if we've
1095 # already determined that we've got a loan on the same item
1096 !$issuingimpossible{NO_MORE_RENEWALS} &&
1097 !$needsconfirmation{RENEW_ISSUE}
1099 # Check if borrower has already issued an item from the same biblio
1100 # Only if it's not a subscription
1101 my $biblionumber = $item_object->biblionumber;
1102 require C4::Serials;
1103 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1104 unless ($is_a_subscription) {
1105 # FIXME Should be $patron->checkouts($args);
1106 my $checkouts = Koha::Checkouts->search(
1108 borrowernumber => $patron->borrowernumber,
1109 biblionumber => $biblionumber,
1115 # if we get here, we don't already have a loan on this item,
1116 # so if there are any loans on this bib, ask for confirmation
1117 if ( $checkouts->count ) {
1118 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1123 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1126 =head2 CanBookBeReturned
1128 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1130 Check whether the item can be returned to the provided branch
1134 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1136 =item C<$branch> is the branchcode where the return is taking place
1144 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1146 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1152 sub CanBookBeReturned {
1153 my ($item, $branch) = @_;
1154 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1156 # assume return is allowed to start
1160 # identify all cases where return is forbidden
1161 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1163 $message = $item->{'homebranch'};
1164 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1166 $message = $item->{'holdingbranch'};
1167 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1169 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1172 return ($allowed, $message);
1175 =head2 CheckHighHolds
1177 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1178 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1179 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1183 sub checkHighHolds {
1184 my ( $item, $borrower ) = @_;
1185 my $branchcode = _GetCircControlBranch( $item, $borrower );
1186 my $item_object = Koha::Items->find( $item->{itemnumber} );
1195 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1197 if ( $holds->count() ) {
1198 $return_data->{outstanding} = $holds->count();
1200 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1201 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1202 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1204 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1206 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1208 # static means just more than a given number of holds on the record
1210 # If the number of holds is less than the threshold, we can stop here
1211 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1212 return $return_data;
1215 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1217 # dynamic means X more than the number of holdable items on the record
1219 # let's get the items
1220 my @items = $holds->next()->biblio()->items()->as_list;
1222 # Remove any items with status defined to be ignored even if the would not make item unholdable
1223 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1224 @items = grep { !$_->$status } @items;
1227 # Remove any items that are not holdable for this patron
1228 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1230 my $items_count = scalar @items;
1232 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1234 # If the number of holds is less than the count of items we have
1235 # plus the number of holds allowed above that count, we can stop here
1236 if ( $holds->count() <= $threshold ) {
1237 return $return_data;
1241 my $issuedate = dt_from_string();
1243 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
1245 my $itype = $item_object->effective_itemtype;
1246 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1248 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1250 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1251 $reduced_datedue->set_hour($orig_due->hour);
1252 $reduced_datedue->set_minute($orig_due->minute);
1253 $reduced_datedue->truncate( to => 'minute' );
1255 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1256 $return_data->{exceeded} = 1;
1257 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1258 $return_data->{due_date} = $reduced_datedue;
1262 return $return_data;
1267 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1269 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1273 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1275 =item C<$barcode> is the barcode of the item being issued.
1277 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1278 Calculated if empty.
1280 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1282 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1283 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1285 AddIssue does the following things :
1287 - step 01: check that there is a borrowernumber & a barcode provided
1288 - check for RENEWAL (book issued & being issued to the same patron)
1289 - renewal YES = Calculate Charge & renew
1291 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1293 - fill reserve if reserve to this patron
1294 - cancel reserve or not, otherwise
1295 * TRANSFERT PENDING ?
1296 - complete the transfert
1304 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1306 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1307 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1308 my $auto_renew = $params && $params->{auto_renew};
1309 my $dbh = C4::Context->dbh;
1310 my $barcodecheck = CheckValidBarcode($barcode);
1314 if ( $datedue && ref $datedue ne 'DateTime' ) {
1315 $datedue = dt_from_string($datedue);
1318 # $issuedate defaults to today.
1319 if ( !defined $issuedate ) {
1320 $issuedate = dt_from_string();
1323 if ( ref $issuedate ne 'DateTime' ) {
1324 $issuedate = dt_from_string($issuedate);
1329 # Stop here if the patron or barcode doesn't exist
1330 if ( $borrower && $barcode && $barcodecheck ) {
1331 # find which item we issue
1332 my $item_object = Koha::Items->find({ barcode => $barcode })
1333 or return; # if we don't get an Item, abort.
1334 my $item_unblessed = $item_object->unblessed;
1336 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1338 # get actual issuing if there is one
1339 my $actualissue = $item_object->checkout;
1341 # check if we just renew the issue.
1342 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1343 and not $switch_onsite_checkout ) {
1344 $datedue = AddRenewal(
1345 $borrower->{'borrowernumber'},
1346 $item_object->itemnumber,
1349 $issuedate, # here interpreted as the renewal date
1354 my $itype = $item_object->effective_itemtype;
1355 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1358 $datedue->truncate( to => 'minute' );
1360 my $patron = Koha::Patrons->find( $borrower );
1361 my $library = Koha::Libraries->find( $branchcode );
1362 my $fees = Koha::Charges::Fees->new(
1365 library => $library,
1366 item => $item_object,
1367 to_date => $datedue,
1371 # it's NOT a renewal
1372 if ( $actualissue and not $switch_onsite_checkout ) {
1373 # This book is currently on loan, but not to the person
1374 # who wants to borrow it now. mark it returned before issuing to the new borrower
1375 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1376 return unless $allowed;
1377 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1380 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1382 # Starting process for transfer job (checking transfert and validate it if we have one)
1383 my ($datesent) = GetTransfers( $item_object->itemnumber );
1385 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1386 my $sth = $dbh->prepare(
1387 "UPDATE branchtransfers
1388 SET datearrived = now(),
1390 comments = 'Forced branchtransfer'
1391 WHERE itemnumber= ? AND datearrived IS NULL"
1393 $sth->execute( C4::Context->userenv->{'branch'},
1394 $item_object->itemnumber );
1397 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1398 unless ($auto_renew) {
1399 my $rule = Koha::CirculationRules->get_effective_rule(
1401 categorycode => $borrower->{categorycode},
1402 itemtype => $item_object->effective_itemtype,
1403 branchcode => $branchcode,
1404 rule_name => 'auto_renew'
1408 $auto_renew = $rule->rule_value if $rule;
1411 # Record in the database the fact that the book was issued.
1413 my $itype = $item_object->effective_itemtype;
1414 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1417 $datedue->truncate( to => 'minute' );
1419 my $issue_attributes = {
1420 borrowernumber => $borrower->{'borrowernumber'},
1421 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1422 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1423 branchcode => C4::Context->userenv->{'branch'},
1424 onsite_checkout => $onsite_checkout,
1425 auto_renew => $auto_renew ? 1 : 0,
1428 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1430 $issue->set($issue_attributes)->store;
1433 $issue = Koha::Checkout->new(
1435 itemnumber => $item_object->itemnumber,
1440 if ( $item_object->location && $item_object->location eq 'CART'
1441 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1442 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1443 CartToShelf( $item_object->itemnumber );
1446 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1447 UpdateTotalIssues( $item_object->biblionumber, 1 );
1450 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1451 if ( $item_object->itemlost ) {
1453 Koha::RefundLostItemFeeRules->should_refund(
1455 current_branch => C4::Context->userenv->{branch},
1456 item_home_branch => $item_object->homebranch,
1457 item_holding_branch => $item_object->holdingbranch,
1462 _FixAccountForLostAndFound( $item_object->itemnumber, undef,
1463 $item_object->barcode );
1467 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1468 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1469 $item_object->itemlost(0);
1470 $item_object->onloan($datedue->ymd());
1471 $item_object->datelastborrowed( dt_from_string()->ymd() );
1472 $item_object->store({log_action => 0});
1473 ModDateLastSeen( $item_object->itemnumber );
1475 # If it costs to borrow this book, charge it to the patron's account.
1476 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1477 if ( $charge && $charge > 0 ) {
1478 AddIssuingCharge( $issue, $charge, 'RENT' );
1481 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1482 if ( $itemtype_object ) {
1483 my $accumulate_charge = $fees->accumulate_rentalcharge();
1484 if ( $accumulate_charge > 0 ) {
1485 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1486 $charge += $accumulate_charge;
1487 $item_unblessed->{charge} = $charge;
1491 # Record the fact that this book was issued.
1494 branch => C4::Context->userenv->{'branch'},
1495 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1497 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1498 itemnumber => $item_object->itemnumber,
1499 itemtype => $item_object->effective_itemtype,
1500 location => $item_object->location,
1501 borrowernumber => $borrower->{'borrowernumber'},
1502 ccode => $item_object->ccode,
1506 # Send a checkout slip.
1507 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1509 branchcode => $branchcode,
1510 categorycode => $borrower->{categorycode},
1511 item_type => $item_object->effective_itemtype,
1512 notification => 'CHECKOUT',
1514 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1515 SendCirculationAlert(
1518 item => $item_object->unblessed,
1519 borrower => $borrower,
1520 branch => $branchcode,
1525 "CIRCULATION", "ISSUE",
1526 $borrower->{'borrowernumber'},
1527 $item_object->itemnumber,
1528 ) if C4::Context->preference("IssueLog");
1534 =head2 GetLoanLength
1536 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1538 Get loan length for an itemtype, a borrower type and a branch
1543 my ( $categorycode, $itemtype, $branchcode ) = @_;
1545 # Set search precedences
1548 categorycode => $categorycode,
1549 itemtype => $itemtype,
1550 branchcode => $branchcode,
1553 categorycode => $categorycode,
1555 branchcode => $branchcode,
1558 categorycode => undef,
1559 itemtype => $itemtype,
1560 branchcode => $branchcode,
1563 categorycode => undef,
1565 branchcode => $branchcode,
1568 categorycode => $categorycode,
1569 itemtype => $itemtype,
1570 branchcode => undef,
1573 categorycode => $categorycode,
1575 branchcode => undef,
1578 categorycode => undef,
1579 itemtype => $itemtype,
1580 branchcode => undef,
1583 categorycode => undef,
1585 branchcode => undef,
1589 # Initialize default values
1593 lengthunit => 'days',
1597 foreach my $rule_name (qw( issuelength renewalperiod lengthunit )) {
1598 foreach my $params (@params) {
1599 my $rule = Koha::CirculationRules->search(
1601 rule_name => $rule_name,
1607 $rules->{$rule_name} = $rule->rule_value;
1617 =head2 GetHardDueDate
1619 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1621 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1625 sub GetHardDueDate {
1626 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1628 my $rules = Koha::CirculationRules->get_effective_rules(
1630 categorycode => $borrowertype,
1631 itemtype => $itemtype,
1632 branchcode => $branchcode,
1633 rules => [ 'hardduedate', 'hardduedatecompare' ],
1637 if ( defined( $rules->{hardduedate} ) ) {
1638 if ( $rules->{hardduedate} ) {
1639 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1642 return ( undef, undef );
1647 =head2 GetBranchBorrowerCircRule
1649 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1651 Retrieves circulation rule attributes that apply to the given
1652 branch and patron category, regardless of item type.
1653 The return value is a hashref containing the following key:
1655 patron_maxissueqty - maximum number of loans that a
1656 patron of the given category can have at the given
1657 branch. If the value is undef, no limit.
1659 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1660 patron of the given category can have at the given
1661 branch. If the value is undef, no limit.
1663 This will check for different branch/category combinations in the following order:
1667 default branch and category
1669 If no rule has been found in the database, it will default to
1672 patron_maxissueqty - undef
1673 patron_maxonsiteissueqty - undef
1675 C<$branchcode> and C<$categorycode> should contain the
1676 literal branch code and patron category code, respectively - no
1681 sub GetBranchBorrowerCircRule {
1682 my ( $branchcode, $categorycode ) = @_;
1684 # Initialize default values
1686 patron_maxissueqty => undef,
1687 patron_maxonsiteissueqty => undef,
1691 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1692 my $rule = Koha::CirculationRules->get_effective_rule(
1694 categorycode => $categorycode,
1696 branchcode => $branchcode,
1697 rule_name => $rule_name,
1701 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1707 =head2 GetBranchItemRule
1709 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1711 Retrieves circulation rule attributes that apply to the given
1712 branch and item type, regardless of patron category.
1714 The return value is a hashref containing the following keys:
1716 holdallowed => Hold policy for this branch and itemtype. Possible values:
1717 0: No holds allowed.
1718 1: Holds allowed only by patrons that have the same homebranch as the item.
1719 2: Holds allowed from any patron.
1721 returnbranch => branch to which to return item. Possible values:
1722 noreturn: do not return, let item remain where checked in (floating collections)
1723 homebranch: return to item's home branch
1724 holdingbranch: return to issuer branch
1726 This searches branchitemrules in the following order:
1728 * Same branchcode and itemtype
1729 * Same branchcode, itemtype '*'
1730 * branchcode '*', same itemtype
1731 * branchcode and itemtype '*'
1733 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1737 sub GetBranchItemRule {
1738 my ( $branchcode, $itemtype ) = @_;
1741 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1743 branchcode => $branchcode,
1744 itemtype => $itemtype,
1745 rule_name => 'holdallowed',
1748 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1750 branchcode => $branchcode,
1751 itemtype => $itemtype,
1752 rule_name => 'hold_fulfillment_policy',
1755 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1757 branchcode => $branchcode,
1758 itemtype => $itemtype,
1759 rule_name => 'returnbranch',
1763 # built-in default circulation rule
1765 $rules->{holdallowed} = defined $holdallowed_rule
1766 ? $holdallowed_rule->rule_value
1768 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1769 ? $hold_fulfillment_policy_rule->rule_value
1771 $rules->{returnbranch} = defined $returnbranch_rule
1772 ? $returnbranch_rule->rule_value
1780 ($doreturn, $messages, $iteminformation, $borrower) =
1781 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1787 =item C<$barcode> is the bar code of the book being returned.
1789 =item C<$branch> is the code of the branch where the book is being returned.
1791 =item C<$exemptfine> indicates that overdue charges for the item will be
1794 =item C<$return_date> allows the default return date to be overridden
1795 by the given return date. Optional.
1799 C<&AddReturn> returns a list of four items:
1801 C<$doreturn> is true iff the return succeeded.
1803 C<$messages> is a reference-to-hash giving feedback on the operation.
1804 The keys of the hash are:
1810 No item with this barcode exists. The value is C<$barcode>.
1814 The book is not currently on loan. The value is C<$barcode>.
1818 This book has been withdrawn/cancelled. The value should be ignored.
1820 =item C<Wrongbranch>
1822 This book has was returned to the wrong branch. The value is a hashref
1823 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1824 contain the branchcode of the incorrect and correct return library, respectively.
1828 The item was reserved. The value is a reference-to-hash whose keys are
1829 fields from the reserves table of the Koha database, and
1830 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1831 either C<Waiting>, C<Reserved>, or 0.
1833 =item C<WasReturned>
1835 Value 1 if return is successful.
1837 =item C<NeedsTransfer>
1839 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1843 C<$iteminformation> is a reference-to-hash, giving information about the
1844 returned item from the issues table.
1846 C<$borrower> is a reference-to-hash, giving information about the
1847 patron who last borrowed the book.
1852 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1854 if ($branch and not Koha::Libraries->find($branch)) {
1855 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1858 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1859 my $return_date_specified = !!$return_date;
1860 $return_date //= dt_from_string();
1864 my $validTransfert = 0;
1865 my $stat_type = 'return';
1867 # get information on item
1868 my $item = Koha::Items->find({ barcode => $barcode });
1870 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1873 my $itemnumber = $item->itemnumber;
1874 my $itemtype = $item->effective_itemtype;
1876 my $issue = $item->checkout;
1878 $patron = $issue->patron
1879 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1880 . Dumper($issue->unblessed) . "\n";
1882 $messages->{'NotIssued'} = $barcode;
1883 $item->onloan(undef)->store if defined $item->onloan;
1885 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1887 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1888 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1889 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1890 $messages->{'LocalUse'} = 1;
1891 $stat_type = 'localuse';
1895 # full item data, but no borrowernumber or checkout info (no issue)
1896 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1897 # get the proper branch to which to return the item
1898 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1899 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1900 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1902 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1903 my $patron_unblessed = $patron ? $patron->unblessed : {};
1905 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1906 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1907 if ($update_loc_rules) {
1908 if (defined $update_loc_rules->{_ALL_}) {
1909 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1910 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1911 if ( $item->location ne $update_loc_rules->{_ALL_}) {
1912 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1913 $item->location($update_loc_rules->{_ALL_})->store;
1917 foreach my $key ( keys %$update_loc_rules ) {
1918 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1919 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1920 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1921 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1922 $item->location($update_loc_rules->{$key})->store;
1929 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1931 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1933 eval { $rules = YAML::Load($yaml); };
1935 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1938 foreach my $key ( keys %$rules ) {
1939 if ( $item->notforloan eq $key ) {
1940 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1941 $item->notforloan($rules->{$key})->store({ log_action => 0 });
1948 # check if the return is allowed at this branch
1949 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
1950 unless ($returnallowed){
1951 $messages->{'Wrongbranch'} = {
1952 Wrongbranch => $branch,
1953 Rightbranch => $message
1956 return ( $doreturn, $messages, $issue, $patron_unblessed);
1959 if ( $item->withdrawn ) { # book has been cancelled
1960 $messages->{'withdrawn'} = 1;
1961 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1964 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1968 # case of a return of document (deal with issues and holdingbranch)
1970 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1971 $patron or warn "AddReturn without current borrower";
1975 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1980 C4::Context->preference('CalculateFinesOnReturn')
1981 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
1986 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1989 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 );
1991 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1994 # FIXME is the "= 1" right? This could be the borrower hash.
1995 $messages->{'WasReturned'} = 1;
1999 $item->onloan(undef)->store({ log_action => 0 });
2002 # the holdingbranch is updated if the document is returned to another location.
2003 # this is always done regardless of whether the item was on loan or not
2004 my $item_holding_branch = $item->holdingbranch;
2005 if ($item->holdingbranch ne $branch) {
2006 $item->holdingbranch($branch)->store;
2009 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2010 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
2012 # check if we have a transfer for this document
2013 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2015 # if we have a transfer to do, we update the line of transfers with the datearrived
2016 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2018 if ( $tobranch eq $branch ) {
2019 my $sth = C4::Context->dbh->prepare(
2020 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2022 $sth->execute( $item->itemnumber );
2023 # if we have a reservation with valid transfer, we can set it's status to 'W'
2024 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2026 $messages->{'WrongTransfer'} = $tobranch;
2027 $messages->{'WrongTransferItem'} = $item->itemnumber;
2029 $validTransfert = 1;
2032 # fix up the accounts.....
2033 if ( $item->itemlost ) {
2034 $messages->{'WasLost'} = 1;
2035 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2037 Koha::RefundLostItemFeeRules->should_refund(
2039 current_branch => C4::Context->userenv->{branch},
2040 item_home_branch => $item->homebranch,
2041 item_holding_branch => $item_holding_branch
2046 _FixAccountForLostAndFound( $item->itemnumber,
2047 $borrowernumber, $barcode );
2048 $messages->{'LostItemFeeRefunded'} = 1;
2053 # fix up the overdues in accounts...
2054 if ($borrowernumber) {
2055 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2056 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2058 if ( $issue and $issue->is_overdue($return_date) ) {
2060 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2062 $messages->{'PrevDebarred'} = $debardate;
2064 $messages->{'Debarred'} = $debardate if $debardate;
2066 # there's no overdue on the item but borrower had been previously debarred
2067 } elsif ( $issue->date_due and $patron->debarred ) {
2068 if ( $patron->debarred eq "9999-12-31") {
2069 $messages->{'ForeverDebarred'} = $patron->debarred;
2071 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2072 $borrower_debar_dt->truncate(to => 'day');
2073 my $today_dt = $return_date->clone()->truncate(to => 'day');
2074 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2075 $messages->{'PrevDebarred'} = $patron->debarred;
2081 # find reserves.....
2082 # launch the Checkreserves routine to find any holds
2083 my ($resfound, $resrec);
2084 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2085 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2086 # if a hold is found and is waiting at another branch, change the priority back to 1 and trigger the hold (this will trigger a transfer and update the hold status properly)
2087 if ( $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2088 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2089 $resfound = 'Reserved';
2090 $resrec = $hold->unblessed;
2093 $resrec->{'ResFound'} = $resfound;
2094 $messages->{'ResFound'} = $resrec;
2097 # Record the fact that this book was returned.
2101 itemnumber => $itemnumber,
2102 itemtype => $itemtype,
2103 borrowernumber => $borrowernumber,
2104 ccode => $item->ccode,
2107 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2109 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2111 branchcode => $branch,
2112 categorycode => $patron->categorycode,
2113 item_type => $itemtype,
2114 notification => 'CHECKIN',
2116 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2117 SendCirculationAlert({
2119 item => $item->unblessed,
2120 borrower => $patron->unblessed,
2125 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2126 if C4::Context->preference("ReturnLog");
2129 # Check if this item belongs to a biblio record that is attached to an
2130 # ILL request, if it is we need to update the ILL request's status
2131 if (C4::Context->preference('CirculateILL')) {
2132 my $request = Koha::Illrequests->find(
2133 { biblio_id => $item->biblio->biblionumber }
2135 $request->status('RET') if $request;
2138 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2139 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2140 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2141 if (C4::Context->preference("AutomaticItemReturn" ) or
2142 (C4::Context->preference("UseBranchTransferLimits") and
2143 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2145 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2146 $debug and warn "item: " . Dumper($item->unblessed);
2147 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger);
2148 $messages->{'WasTransfered'} = 1;
2150 $messages->{'NeedsTransfer'} = $returnbranch;
2151 $messages->{'TransferTrigger'} = $transfer_trigger;
2155 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2156 my $claims = Koha::Checkouts::ReturnClaims->search(
2158 itemnumber => $item->id,
2159 resolution => undef,
2163 if ( $claims->count ) {
2164 $messages->{ReturnClaims} = $claims;
2168 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2171 =head2 MarkIssueReturned
2173 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2175 Unconditionally marks an issue as being returned by
2176 moving the C<issues> row to C<old_issues> and
2177 setting C<returndate> to the current date.
2179 if C<$returndate> is specified (in iso format), it is used as the date
2182 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2183 the old_issue is immediately anonymised
2185 Ideally, this function would be internal to C<C4::Circulation>,
2186 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2187 and offline_circ/process_koc.pl.
2191 sub MarkIssueReturned {
2192 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2194 # Retrieve the issue
2195 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2197 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2199 my $issue_id = $issue->issue_id;
2201 my $anonymouspatron;
2202 if ( $privacy && $privacy == 2 ) {
2203 # The default of 0 will not work due to foreign key constraints
2204 # The anonymisation will fail if AnonymousPatron is not a valid entry
2205 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2206 # Note that a warning should appear on the about page (System information tab).
2207 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2208 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."
2209 unless Koha::Patrons->find( $anonymouspatron );
2212 my $schema = Koha::Database->schema;
2214 # FIXME Improve the return value and handle it from callers
2215 $schema->txn_do(sub {
2217 my $patron = Koha::Patrons->find( $borrowernumber );
2219 # Update the returndate value
2220 if ( $returndate ) {
2221 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2224 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2227 # Create the old_issues entry
2228 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2230 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2231 if ( $privacy && $privacy == 2) {
2232 $old_checkout->borrowernumber($anonymouspatron)->store;
2235 # And finally delete the issue
2238 $issue->item->onloan(undef)->store({ log_action => 0 });
2240 if ( C4::Context->preference('StoreLastBorrower') ) {
2241 my $item = Koha::Items->find( $itemnumber );
2242 $item->last_returned_by( $patron );
2245 # Remove any OVERDUES related debarment if the borrower has no overdues
2246 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2247 && $patron->debarred
2248 && !$patron->has_overdues
2249 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2251 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2259 =head2 _debar_user_on_return
2261 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2263 C<$borrower> borrower hashref
2265 C<$item> item hashref
2267 C<$datedue> date due DateTime object
2269 C<$returndate> DateTime object representing the return time
2271 Internal function, called only by AddReturn that calculates and updates
2272 the user fine days, and debars them if necessary.
2274 Should only be called for overdue returns
2276 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2281 sub _calculate_new_debar_dt {
2282 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2284 my $branchcode = _GetCircControlBranch( $item, $borrower );
2285 my $circcontrol = C4::Context->preference('CircControl');
2286 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2287 { categorycode => $borrower->{categorycode},
2288 itemtype => $item->{itype},
2289 branchcode => $branchcode,
2294 'maxsuspensiondays',
2295 'suspension_chargeperiod',
2299 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2300 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2301 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2303 return unless $finedays;
2305 # finedays is in days, so hourly loans must multiply by 24
2306 # thus 1 hour late equals 1 day suspension * finedays rate
2307 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2309 # grace period is measured in the same units as the loan
2311 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2313 my $deltadays = DateTime::Duration->new(
2314 days => $chargeable_units
2317 if ( $deltadays->subtract($grace)->is_positive() ) {
2318 my $suspension_days = $deltadays * $finedays;
2320 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2321 # No need to / 1 and do not consider / 0
2322 $suspension_days = DateTime::Duration->new(
2323 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2327 # If the max suspension days is < than the suspension days
2328 # the suspension days is limited to this maximum period.
2329 my $max_sd = $issuing_rule->{maxsuspensiondays};
2330 if ( defined $max_sd && $max_sd ne '' ) {
2331 $max_sd = DateTime::Duration->new( days => $max_sd );
2332 $suspension_days = $max_sd
2333 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2336 my ( $has_been_extended );
2337 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2338 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2340 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2341 $has_been_extended = 1;
2346 # Use the calendar or not to calculate the debarment date
2347 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2348 my $calendar = Koha::Calendar->new(
2349 branchcode => $branchcode,
2350 days_mode => 'Calendar'
2352 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2355 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2357 return $new_debar_dt;
2362 sub _debar_user_on_return {
2363 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2365 $return_date //= dt_from_string();
2367 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2369 return unless $new_debar_dt;
2371 Koha::Patron::Debarments::AddUniqueDebarment({
2372 borrowernumber => $borrower->{borrowernumber},
2373 expiration => $new_debar_dt->ymd(),
2374 type => 'SUSPENSION',
2376 # if borrower was already debarred but does not get an extra debarment
2377 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2378 my ($new_debarment_str, $is_a_reminder);
2379 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2381 $new_debarment_str = $borrower->{debarred};
2383 $new_debarment_str = $new_debar_dt->ymd();
2385 # FIXME Should return a DateTime object
2386 return $new_debarment_str, $is_a_reminder;
2389 =head2 _FixOverduesOnReturn
2391 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2393 C<$borrowernumber> borrowernumber
2395 C<$itemnumber> itemnumber
2397 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2399 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2405 sub _FixOverduesOnReturn {
2406 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2407 unless( $borrowernumber ) {
2408 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2412 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2416 warn "_FixOverduesOnReturn() not supplied valid status";
2420 my $schema = Koha::Database->schema;
2422 my $result = $schema->txn_do(
2424 # check for overdue fine
2425 my $accountlines = Koha::Account::Lines->search(
2427 borrowernumber => $borrowernumber,
2428 itemnumber => $item,
2429 debit_type_code => 'OVERDUE',
2430 status => 'UNRETURNED'
2433 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2435 my $accountline = $accountlines->next;
2436 my $payments = $accountline->credits;
2438 my $amountoutstanding = $accountline->amountoutstanding;
2439 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2440 $accountline->delete;
2441 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2442 my $account = Koha::Account->new({patron_id => $borrowernumber});
2443 my $credit = $account->add_credit(
2445 amount => $amountoutstanding,
2446 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2447 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2448 interface => C4::Context->interface,
2454 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2456 if (C4::Context->preference("FinesLog")) {
2457 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2460 $accountline->status('FORGIVEN');
2461 $accountline->store();
2463 $accountline->status($status);
2464 $accountline->store();
2473 =head2 _FixAccountForLostAndFound
2475 &_FixAccountForLostAndFound($itemnumber, [$borrowernumber, $barcode]);
2477 Finds the most recent lost item charge for this item and refunds the borrower
2478 appropriatly, taking into account any payments or writeoffs already applied
2481 Internal function, not exported, called only by AddReturn.
2485 sub _FixAccountForLostAndFound {
2486 my $itemnumber = shift or return;
2487 my $borrowernumber = @_ ? shift : undef;
2488 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2492 # check for charge made for lost book
2493 my $accountlines = Koha::Account::Lines->search(
2495 itemnumber => $itemnumber,
2496 debit_type_code => 'LOST',
2497 status => [ undef, { '<>' => 'FOUND' } ]
2500 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2504 return unless $accountlines->count > 0;
2505 my $accountline = $accountlines->next;
2506 my $total_to_refund = 0;
2508 return unless $accountline->borrowernumber;
2509 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2510 return unless $patron; # Patron has been deleted, nobody to credit the return to
2512 my $account = $patron->account;
2515 if ( $accountline->amount > $accountline->amountoutstanding ) {
2516 # some amount has been cancelled. collect the offsets that are not writeoffs
2517 # this works because the only way to subtract from this kind of a debt is
2518 # using the UI buttons 'Pay' and 'Write off'
2519 my $credits_offsets = Koha::Account::Offsets->search({
2520 debit_id => $accountline->id,
2521 credit_id => { '!=' => undef }, # it is not the debit itself
2522 type => { '!=' => 'Writeoff' },
2523 amount => { '<' => 0 } # credits are negative on the DB
2526 $total_to_refund = ( $credits_offsets->count > 0 )
2527 ? $credits_offsets->total * -1 # credits are negative on the DB
2531 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2533 if ( $credit_total > 0 ) {
2534 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2535 $credit = $account->add_credit(
2537 amount => $credit_total,
2538 description => 'Item found ' . $item_id,
2539 type => 'LOST_FOUND',
2540 interface => C4::Context->interface,
2541 library_id => $branchcode,
2542 item_id => $itemnumber
2546 $credit->apply( { debits => [ $accountline ] } );
2549 # Update the account status
2550 $accountline->discard_changes->status('FOUND');
2551 $accountline->store;
2553 $accountline->item->paidfor('')->store({ log_action => 0 });
2555 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2556 $account->reconcile_balance;
2559 return ($credit) ? $credit->id : undef;
2562 =head2 _GetCircControlBranch
2564 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2568 Return the library code to be used to determine which circulation
2569 policy applies to a transaction. Looks up the CircControl and
2570 HomeOrHoldingBranch system preferences.
2572 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2574 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2578 sub _GetCircControlBranch {
2579 my ($item, $borrower) = @_;
2580 my $circcontrol = C4::Context->preference('CircControl');
2583 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2584 $branch= C4::Context->userenv->{'branch'};
2585 } elsif ($circcontrol eq 'PatronLibrary') {
2586 $branch=$borrower->{branchcode};
2588 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2589 $branch = $item->{$branchfield};
2590 # default to item home branch if holdingbranch is used
2591 # and is not defined
2592 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2593 $branch = $item->{homebranch};
2601 $issue = GetOpenIssue( $itemnumber );
2603 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2605 C<$itemnumber> is the item's itemnumber
2612 my ( $itemnumber ) = @_;
2613 return unless $itemnumber;
2614 my $dbh = C4::Context->dbh;
2615 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2616 $sth->execute( $itemnumber );
2617 return $sth->fetchrow_hashref();
2621 =head2 GetBiblioIssues
2623 $issues = GetBiblioIssues($biblionumber);
2625 this function get all issues from a biblionumber.
2628 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2629 tables issues and the firstname,surname & cardnumber from borrowers.
2633 sub GetBiblioIssues {
2634 my $biblionumber = shift;
2635 return unless $biblionumber;
2636 my $dbh = C4::Context->dbh;
2638 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2640 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2641 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2642 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2643 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2644 WHERE biblio.biblionumber = ?
2646 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2648 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2649 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2650 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2651 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2652 WHERE biblio.biblionumber = ?
2655 my $sth = $dbh->prepare($query);
2656 $sth->execute($biblionumber, $biblionumber);
2659 while ( my $data = $sth->fetchrow_hashref ) {
2660 push @issues, $data;
2665 =head2 GetUpcomingDueIssues
2667 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2671 sub GetUpcomingDueIssues {
2674 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2675 my $dbh = C4::Context->dbh;
2677 my $statement = <<END_SQL;
2680 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2682 LEFT JOIN items USING (itemnumber)
2683 LEFT OUTER JOIN branches USING (branchcode)
2684 WHERE returndate is NULL
2686 WHERE days_until_due >= 0 AND days_until_due <= ?
2689 my @bind_parameters = ( $params->{'days_in_advance'} );
2691 my $sth = $dbh->prepare( $statement );
2692 $sth->execute( @bind_parameters );
2693 my $upcoming_dues = $sth->fetchall_arrayref({});
2695 return $upcoming_dues;
2698 =head2 CanBookBeRenewed
2700 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2702 Find out whether a borrowed item may be renewed.
2704 C<$borrowernumber> is the borrower number of the patron who currently
2705 has the item on loan.
2707 C<$itemnumber> is the number of the item to renew.
2709 C<$override_limit>, if supplied with a true value, causes
2710 the limit on the number of times that the loan can be renewed
2711 (as controlled by the item type) to be ignored. Overriding also allows
2712 to renew sooner than "No renewal before" and to manually renew loans
2713 that are automatically renewed.
2715 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2716 item must currently be on loan to the specified borrower; renewals
2717 must be allowed for the item's type; and the borrower must not have
2718 already renewed the loan. $error will contain the reason the renewal can not proceed
2722 sub CanBookBeRenewed {
2723 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2725 my $dbh = C4::Context->dbh;
2729 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2730 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2731 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2732 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2734 my $patron = $issue->patron or return;
2736 # override_limit will override anything else except on_reserve
2737 unless ( $override_limit ){
2738 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2739 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2741 categorycode => $patron->categorycode,
2742 itemtype => $item->effective_itemtype,
2743 branchcode => $branchcode,
2746 'no_auto_renewal_after',
2747 'no_auto_renewal_after_hard_limit',
2754 return ( 0, "too_many" )
2755 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2757 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2758 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2759 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2760 my $restricted = $patron->is_debarred;
2761 my $hasoverdues = $patron->has_overdues;
2763 if ( $restricted and $restrictionblockrenewing ) {
2764 return ( 0, 'restriction');
2765 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2766 return ( 0, 'overdue');
2769 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2771 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2772 return ( 0, 'auto_account_expired' );
2775 if ( defined $issuing_rule->{no_auto_renewal_after}
2776 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2777 # Get issue_date and add no_auto_renewal_after
2778 # If this is greater than today, it's too late for renewal.
2779 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2780 $maximum_renewal_date->add(
2781 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2783 my $now = dt_from_string;
2784 if ( $now >= $maximum_renewal_date ) {
2785 return ( 0, "auto_too_late" );
2788 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2789 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2790 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2791 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2792 return ( 0, "auto_too_late" );
2796 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2797 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2798 my $amountoutstanding =
2799 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2800 ? $patron->account->balance
2801 : $patron->account->outstanding_debits->total_outstanding;
2802 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2803 return ( 0, "auto_too_much_oweing" );
2808 if ( defined $issuing_rule->{norenewalbefore}
2809 and $issuing_rule->{norenewalbefore} ne "" )
2812 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2813 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2814 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2816 # Depending on syspref reset the exact time, only check the date
2817 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2818 and $issuing_rule->{lengthunit} eq 'days' )
2820 $soonestrenewal->truncate( to => 'day' );
2823 if ( $soonestrenewal > dt_from_string() )
2825 return ( 0, "auto_too_soon" ) if $issue->auto_renew && $patron->autorenew_checkouts;
2826 return ( 0, "too_soon" );
2828 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2833 # Fallback for automatic renewals:
2834 # If norenewalbefore is undef, don't renew before due date.
2835 if ( $issue->auto_renew && !$auto_renew && $patron->autorenew_checkouts ) {
2836 my $now = dt_from_string;
2837 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2840 return ( 0, "auto_too_soon" );
2845 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2847 # This item can fill one or more unfilled reserve, can those unfilled reserves
2848 # all be filled by other available items?
2850 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2852 my $schema = Koha::Database->new()->schema();
2854 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2856 # There is an item level hold on this item, no other item can fill the hold
2861 # Get all other items that could possibly fill reserves
2862 my @itemnumbers = $schema->resultset('Item')->search(
2864 biblionumber => $resrec->{biblionumber},
2867 -not => { itemnumber => $itemnumber }
2869 { columns => 'itemnumber' }
2870 )->get_column('itemnumber')->all();
2872 # Get all other reserves that could have been filled by this item
2873 my @borrowernumbers;
2875 my ( $reserve_found, $reserve, undef ) =
2876 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2878 if ($reserve_found) {
2879 push( @borrowernumbers, $reserve->{borrowernumber} );
2886 # If the count of the union of the lists of reservable items for each borrower
2887 # is equal or greater than the number of borrowers, we know that all reserves
2888 # can be filled with available items. We can get the union of the sets simply
2889 # by pushing all the elements onto an array and removing the duplicates.
2892 ITEM: foreach my $itemnumber (@itemnumbers) {
2893 my $item = Koha::Items->find( $itemnumber );
2894 next if IsItemOnHoldAndFound( $itemnumber );
2895 for my $borrowernumber (@borrowernumbers) {
2896 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2897 next unless IsAvailableForItemLevelRequest($item, $patron);
2898 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2900 push @reservable, $itemnumber;
2901 if (@reservable >= @borrowernumbers) {
2910 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2911 return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
2913 return ( 1, undef );
2918 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2922 C<$borrowernumber> is the borrower number of the patron who currently
2925 C<$itemnumber> is the number of the item to renew.
2927 C<$branch> is the library where the renewal took place (if any).
2928 The library that controls the circ policies for the renewal is retrieved from the issues record.
2930 C<$datedue> can be a DateTime object used to set the due date.
2932 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2933 this parameter is not supplied, lastreneweddate is set to the current date.
2935 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2936 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2937 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2940 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2941 from the book's item type.
2946 my $borrowernumber = shift;
2947 my $itemnumber = shift or return;
2949 my $datedue = shift;
2950 my $lastreneweddate = shift || dt_from_string();
2951 my $skipfinecalc = shift;
2953 my $item_object = Koha::Items->find($itemnumber) or return;
2954 my $biblio = $item_object->biblio;
2955 my $issue = $item_object->checkout;
2956 my $item_unblessed = $item_object->unblessed;
2958 my $dbh = C4::Context->dbh;
2960 return unless $issue;
2962 $borrowernumber ||= $issue->borrowernumber;
2964 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2965 carp 'Invalid date passed to AddRenewal.';
2969 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2970 my $patron_unblessed = $patron->unblessed;
2972 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2974 my $schema = Koha::Database->schema;
2975 $schema->txn_do(sub{
2977 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
2978 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2980 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2982 # If the due date wasn't specified, calculate it by adding the
2983 # book's loan length to today's date or the current due date
2984 # based on the value of the RenewalPeriodBase syspref.
2985 my $itemtype = $item_object->effective_itemtype;
2988 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2989 dt_from_string( $issue->date_due, 'sql' ) :
2991 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2994 my $fees = Koha::Charges::Fees->new(
2997 library => $circ_library,
2998 item => $item_object,
2999 from_date => dt_from_string( $issue->date_due, 'sql' ),
3000 to_date => dt_from_string($datedue),
3004 # Update the issues record to have the new due date, and a new count
3005 # of how many times it has been renewed.
3006 my $renews = ( $issue->renewals || 0 ) + 1;
3007 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3008 WHERE borrowernumber=?
3012 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3014 # Update the renewal count on the item, and tell zebra to reindex
3015 $renews = ( $item_object->renewals || 0 ) + 1;
3016 $item_object->renewals($renews);
3017 $item_object->onloan($datedue);
3018 $item_object->store({ log_action => 0 });
3020 # Charge a new rental fee, if applicable
3021 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3022 if ( $charge > 0 ) {
3023 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3026 # Charge a new accumulate rental fee, if applicable
3027 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3028 if ( $itemtype_object ) {
3029 my $accumulate_charge = $fees->accumulate_rentalcharge();
3030 if ( $accumulate_charge > 0 ) {
3031 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3033 $charge += $accumulate_charge;
3036 # Send a renewal slip according to checkout alert preferencei
3037 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3038 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3040 branchcode => $branch,
3041 categorycode => $patron->categorycode,
3042 item_type => $itemtype,
3043 notification => 'CHECKOUT',
3045 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3046 SendCirculationAlert(
3049 item => $item_unblessed,
3050 borrower => $patron->unblessed,
3057 # Remove any OVERDUES related debarment if the borrower has no overdues
3059 && $patron->is_debarred
3060 && ! $patron->has_overdues
3061 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3063 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3066 # Add the renewal to stats
3069 branch => $item_object->renewal_branchcode({branch => $branch}),
3072 itemnumber => $itemnumber,
3073 itemtype => $itemtype,
3074 location => $item_object->location,
3075 borrowernumber => $borrowernumber,
3076 ccode => $item_object->ccode,
3081 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3088 # check renewal status
3089 my ( $bornum, $itemno ) = @_;
3090 my $dbh = C4::Context->dbh;
3092 my $renewsallowed = 0;
3095 my $patron = Koha::Patrons->find( $bornum );
3096 my $item = Koha::Items->find($itemno);
3098 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3100 # Look in the issues table for this item, lent to this borrower,
3101 # and not yet returned.
3103 # FIXME - I think this function could be redone to use only one SQL call.
3104 my $sth = $dbh->prepare(
3105 "select * from issues
3106 where (borrowernumber = ?)
3107 and (itemnumber = ?)"
3109 $sth->execute( $bornum, $itemno );
3110 my $data = $sth->fetchrow_hashref;
3111 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3112 # $item and $borrower should be calculated
3113 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3115 my $rule = Koha::CirculationRules->get_effective_rule(
3117 categorycode => $patron->categorycode,
3118 itemtype => $item->effective_itemtype,
3119 branchcode => $branchcode,
3120 rule_name => 'renewalsallowed',
3124 $renewsallowed = $rule ? $rule->rule_value : 0;
3125 $renewsleft = $renewsallowed - $renewcount;
3126 if($renewsleft < 0){ $renewsleft = 0; }
3127 return ( $renewcount, $renewsallowed, $renewsleft );
3130 =head2 GetSoonestRenewDate
3132 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3134 Find out the soonest possible renew date of a borrowed item.
3136 C<$borrowernumber> is the borrower number of the patron who currently
3137 has the item on loan.
3139 C<$itemnumber> is the number of the item to renew.
3141 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3142 renew date, based on the value "No renewal before" of the applicable
3143 issuing rule. Returns the current date if the item can already be
3144 renewed, and returns undefined if the borrower, loan, or item
3149 sub GetSoonestRenewDate {
3150 my ( $borrowernumber, $itemnumber ) = @_;
3152 my $dbh = C4::Context->dbh;
3154 my $item = Koha::Items->find($itemnumber) or return;
3155 my $itemissue = $item->checkout or return;
3157 $borrowernumber ||= $itemissue->borrowernumber;
3158 my $patron = Koha::Patrons->find( $borrowernumber )
3161 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3162 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3163 { categorycode => $patron->categorycode,
3164 itemtype => $item->effective_itemtype,
3165 branchcode => $branchcode,
3173 my $now = dt_from_string;
3174 return $now unless $issuing_rule;
3176 if ( defined $issuing_rule->{norenewalbefore}
3177 and $issuing_rule->{norenewalbefore} ne "" )
3179 my $soonestrenewal =
3180 dt_from_string( $itemissue->date_due )->subtract(
3181 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3183 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3184 and $issuing_rule->{lengthunit} eq 'days' )
3186 $soonestrenewal->truncate( to => 'day' );
3188 return $soonestrenewal if $now < $soonestrenewal;
3193 =head2 GetLatestAutoRenewDate
3195 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3197 Find out the latest possible auto renew date of a borrowed item.
3199 C<$borrowernumber> is the borrower number of the patron who currently
3200 has the item on loan.
3202 C<$itemnumber> is the number of the item to renew.
3204 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3205 auto renew date, based on the value "No auto renewal after" and the "No auto
3206 renewal after (hard limit) of the applicable issuing rule.
3207 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3208 or item cannot be found.
3212 sub GetLatestAutoRenewDate {
3213 my ( $borrowernumber, $itemnumber ) = @_;
3215 my $dbh = C4::Context->dbh;
3217 my $item = Koha::Items->find($itemnumber) or return;
3218 my $itemissue = $item->checkout or return;
3220 $borrowernumber ||= $itemissue->borrowernumber;
3221 my $patron = Koha::Patrons->find( $borrowernumber )
3224 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3225 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3227 categorycode => $patron->categorycode,
3228 itemtype => $item->effective_itemtype,
3229 branchcode => $branchcode,
3231 'no_auto_renewal_after',
3232 'no_auto_renewal_after_hard_limit',
3238 return unless $circulation_rules;
3240 if ( not $circulation_rules->{no_auto_renewal_after}
3241 or $circulation_rules->{no_auto_renewal_after} eq '' )
3242 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3243 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3245 my $maximum_renewal_date;
3246 if ( $circulation_rules->{no_auto_renewal_after} ) {
3247 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3248 $maximum_renewal_date->add(
3249 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3253 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3254 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3255 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3257 return $maximum_renewal_date;
3261 =head2 GetIssuingCharges
3263 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3265 Calculate how much it would cost for a given patron to borrow a given
3266 item, including any applicable discounts.
3268 C<$itemnumber> is the item number of item the patron wishes to borrow.
3270 C<$borrowernumber> is the patron's borrower number.
3272 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3273 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3278 sub GetIssuingCharges {
3280 # calculate charges due
3281 my ( $itemnumber, $borrowernumber ) = @_;
3283 my $dbh = C4::Context->dbh;
3286 # Get the book's item type and rental charge (via its biblioitem).
3287 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3288 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3289 $charge_query .= (C4::Context->preference('item-level_itypes'))
3290 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3291 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3293 $charge_query .= ' WHERE items.itemnumber =?';
3295 my $sth = $dbh->prepare($charge_query);
3296 $sth->execute($itemnumber);
3297 if ( my $item_data = $sth->fetchrow_hashref ) {
3298 $item_type = $item_data->{itemtype};
3299 $charge = $item_data->{rentalcharge};
3300 my $branch = C4::Context::mybranch();
3301 my $patron = Koha::Patrons->find( $borrowernumber );
3302 my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3304 # We may have multiple rules so get the most specific
3305 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3308 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3312 return ( $charge, $item_type );
3315 # Select most appropriate discount rule from those returned
3316 sub _get_discount_from_rule {
3317 my ($categorycode, $branchcode, $itemtype) = @_;
3319 # Set search precedences
3322 branchcode => $branchcode,
3323 itemtype => $itemtype,
3324 categorycode => $categorycode,
3327 branchcode => undef,
3328 categorycode => $categorycode,
3329 itemtype => $itemtype,
3332 branchcode => $branchcode,
3333 categorycode => $categorycode,
3337 branchcode => undef,
3338 categorycode => $categorycode,
3343 foreach my $params (@params) {
3344 my $rule = Koha::CirculationRules->search(
3346 rule_name => 'rentaldiscount',
3351 return $rule->rule_value if $rule;
3358 =head2 AddIssuingCharge
3360 &AddIssuingCharge( $checkout, $charge, $type )
3364 sub AddIssuingCharge {
3365 my ( $checkout, $charge, $type ) = @_;
3367 # FIXME What if checkout does not exist?
3369 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3370 my $accountline = $account->add_debit(
3374 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3375 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3376 interface => C4::Context->interface,
3378 item_id => $checkout->itemnumber,
3379 issue_id => $checkout->issue_id,
3386 GetTransfers($itemnumber);
3391 my ($itemnumber) = @_;
3393 my $dbh = C4::Context->dbh;
3400 FROM branchtransfers
3401 WHERE itemnumber = ?
3402 AND datearrived IS NULL
3404 my $sth = $dbh->prepare($query);
3405 $sth->execute($itemnumber);
3406 my @row = $sth->fetchrow_array();
3410 =head2 GetTransfersFromTo
3412 @results = GetTransfersFromTo($frombranch,$tobranch);
3414 Returns the list of pending transfers between $from and $to branch
3418 sub GetTransfersFromTo {
3419 my ( $frombranch, $tobranch ) = @_;
3420 return unless ( $frombranch && $tobranch );
3421 my $dbh = C4::Context->dbh;
3423 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3424 FROM branchtransfers
3427 AND datearrived IS NULL
3429 my $sth = $dbh->prepare($query);
3430 $sth->execute( $frombranch, $tobranch );
3433 while ( my $data = $sth->fetchrow_hashref ) {
3434 push @gettransfers, $data;
3436 return (@gettransfers);
3439 =head2 DeleteTransfer
3441 &DeleteTransfer($itemnumber);
3445 sub DeleteTransfer {
3446 my ($itemnumber) = @_;
3447 return unless $itemnumber;
3448 my $dbh = C4::Context->dbh;
3449 my $sth = $dbh->prepare(
3450 "DELETE FROM branchtransfers
3452 AND datearrived IS NULL "
3454 return $sth->execute($itemnumber);
3457 =head2 SendCirculationAlert
3459 Send out a C<check-in> or C<checkout> alert using the messaging system.
3467 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3471 Hashref of information about the item being checked in or out.
3475 Hashref of information about the borrower of the item.
3479 The branchcode from where the checkout or check-in took place.
3485 SendCirculationAlert({
3488 borrower => $borrower,
3494 sub SendCirculationAlert {
3496 my ($type, $item, $borrower, $branch) =
3497 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3498 my %message_name = (
3499 CHECKIN => 'Item_Check_in',
3500 CHECKOUT => 'Item_Checkout',
3501 RENEWAL => 'Item_Checkout',
3503 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3504 borrowernumber => $borrower->{borrowernumber},
3505 message_name => $message_name{$type},
3507 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3509 my $schema = Koha::Database->new->schema;
3510 my @transports = keys %{ $borrower_preferences->{transports} };
3512 # From the MySQL doc:
3513 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3514 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3515 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3516 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3518 for my $mtt (@transports) {
3519 my $letter = C4::Letters::GetPreparedLetter (
3520 module => 'circulation',
3521 letter_code => $type,
3522 branchcode => $branch,
3523 message_transport_type => $mtt,
3524 lang => $borrower->{lang},
3526 $issues_table => $item->{itemnumber},
3527 'items' => $item->{itemnumber},
3528 'biblio' => $item->{biblionumber},
3529 'biblioitems' => $item->{biblionumber},
3530 'borrowers' => $borrower,
3531 'branches' => $branch,
3535 $schema->storage->txn_begin;
3536 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3537 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3538 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3539 unless ( $message ) {
3540 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3541 C4::Message->enqueue($letter, $borrower, $mtt);
3543 $message->append($letter);
3546 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3547 $schema->storage->txn_commit;
3553 =head2 updateWrongTransfer
3555 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3557 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
3561 sub updateWrongTransfer {
3562 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3563 my $dbh = C4::Context->dbh;
3564 # first step validate the actual line of transfert .
3567 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3569 $sth->execute($FromLibrary,$itemNumber);
3571 # second step create a new line of branchtransfer to the right location .
3572 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3574 #third step changing holdingbranch of item
3575 my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3580 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3582 this function calculates the due date given the start date and configured circulation rules,
3583 checking against the holidays calendar as per the 'useDaysMode' syspref.
3584 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3585 C<$itemtype> = itemtype code of item in question
3586 C<$branch> = location whose calendar to use
3587 C<$borrower> = Borrower object
3588 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3593 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3597 # loanlength now a href
3599 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3601 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3607 if (ref $startdate ne 'DateTime' ) {
3608 $datedue = dt_from_string($datedue);
3610 $datedue = $startdate->clone;
3613 $datedue = dt_from_string()->truncate( to => 'minute' );
3617 # calculate the datedue as normal
3618 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3619 { # ignoring calendar
3620 if ( $loanlength->{lengthunit} eq 'hours' ) {
3621 $datedue->add( hours => $loanlength->{$length_key} );
3623 $datedue->add( days => $loanlength->{$length_key} );
3624 $datedue->set_hour(23);
3625 $datedue->set_minute(59);
3629 if ($loanlength->{lengthunit} eq 'hours') {
3630 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3633 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3635 my $calendar = Koha::Calendar->new( branchcode => $branch );
3636 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3637 if ($loanlength->{lengthunit} eq 'days') {
3638 $datedue->set_hour(23);
3639 $datedue->set_minute(59);
3643 # if Hard Due Dates are used, retrieve them and apply as necessary
3644 my ( $hardduedate, $hardduedatecompare ) =
3645 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3646 if ($hardduedate) { # hardduedates are currently dates
3647 $hardduedate->truncate( to => 'minute' );
3648 $hardduedate->set_hour(23);
3649 $hardduedate->set_minute(59);
3650 my $cmp = DateTime->compare( $hardduedate, $datedue );
3652 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3653 # if the calculated date is before the 'after' Hard Due Date (floor), override
3654 # if the hard due date is set to 'exactly', overrride
3655 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3656 $datedue = $hardduedate->clone;
3659 # in all other cases, keep the date due as it is
3663 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3664 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3665 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3666 if( $expiry_dt ) { #skip empty expiry date..
3667 $expiry_dt->set( hour => 23, minute => 59);
3668 my $d1= $datedue->clone->set_time_zone('floating');
3669 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3670 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3673 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3674 my $calendar = Koha::Calendar->new( branchcode => $branch );
3675 if ( $calendar->is_holiday($datedue) ) {
3676 # Don't return on a closed day
3677 $datedue = $calendar->prev_open_days( $datedue, 1 );
3686 sub CheckValidBarcode{
3688 my $dbh = C4::Context->dbh;
3689 my $query=qq|SELECT count(*)
3693 my $sth = $dbh->prepare($query);
3694 $sth->execute($barcode);
3695 my $exist=$sth->fetchrow ;
3699 =head2 IsBranchTransferAllowed
3701 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3703 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3705 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3706 Koha::Item->can_be_transferred.
3710 sub IsBranchTransferAllowed {
3711 my ( $toBranch, $fromBranch, $code ) = @_;
3713 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3715 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3716 my $dbh = C4::Context->dbh;
3718 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3719 $sth->execute( $toBranch, $fromBranch, $code );
3720 my $limit = $sth->fetchrow_hashref();
3722 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3723 if ( $limit->{'limitId'} ) {
3730 =head2 CreateBranchTransferLimit
3732 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3734 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3736 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3740 sub CreateBranchTransferLimit {
3741 my ( $toBranch, $fromBranch, $code ) = @_;
3742 return unless defined($toBranch) && defined($fromBranch);
3743 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3745 my $dbh = C4::Context->dbh;
3747 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3748 return $sth->execute( $code, $toBranch, $fromBranch );
3751 =head2 DeleteBranchTransferLimits
3753 my $result = DeleteBranchTransferLimits($frombranch);
3755 Deletes all the library transfer limits for one library. Returns the
3756 number of limits deleted, 0e0 if no limits were deleted, or undef if
3757 no arguments are supplied.
3759 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3760 fromBranch => $fromBranch
3765 sub DeleteBranchTransferLimits {
3767 return unless defined $branch;
3768 my $dbh = C4::Context->dbh;
3769 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3770 return $sth->execute($branch);
3774 my ( $borrowernumber, $itemnum ) = @_;
3775 MarkIssueReturned( $borrowernumber, $itemnum );
3780 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3782 unless ( $mark_lost_from ) {
3783 # Temporary check to avoid regressions
3784 die q|LostItem called without $mark_lost_from, check the API.|;
3788 if ( $force_mark_returned ) {
3791 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3792 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3795 my $dbh = C4::Context->dbh();
3796 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3798 JOIN items USING (itemnumber)
3799 JOIN biblio USING (biblionumber)
3800 WHERE issues.itemnumber=?");
3801 $sth->execute($itemnumber);
3802 my $issues=$sth->fetchrow_hashref();
3804 # If a borrower lost the item, add a replacement cost to the their record
3805 if ( my $borrowernumber = $issues->{borrowernumber} ){
3806 my $patron = Koha::Patrons->find( $borrowernumber );
3808 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3809 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3811 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3812 C4::Accounts::chargelostitem(
3815 $issues->{'replacementprice'},
3816 sprintf( "%s %s %s",
3817 $issues->{'title'} || q{},
3818 $issues->{'barcode'} || q{},
3819 $issues->{'itemcallnumber'} || q{},
3822 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3823 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3826 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3829 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3830 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3831 Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store;
3833 my $transferdeleted = DeleteTransfer($itemnumber);
3836 sub GetOfflineOperations {
3837 my $dbh = C4::Context->dbh;
3838 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3839 $sth->execute(C4::Context->userenv->{'branch'});
3840 my $results = $sth->fetchall_arrayref({});
3844 sub GetOfflineOperation {
3845 my $operationid = shift;
3846 return unless $operationid;
3847 my $dbh = C4::Context->dbh;
3848 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3849 $sth->execute( $operationid );
3850 return $sth->fetchrow_hashref;
3853 sub AddOfflineOperation {
3854 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3855 my $dbh = C4::Context->dbh;
3856 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3857 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3861 sub DeleteOfflineOperation {
3862 my $dbh = C4::Context->dbh;
3863 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3864 $sth->execute( shift );
3868 sub ProcessOfflineOperation {
3869 my $operation = shift;
3872 if ( $operation->{action} eq 'return' ) {
3873 $report = ProcessOfflineReturn( $operation );
3874 } elsif ( $operation->{action} eq 'issue' ) {
3875 $report = ProcessOfflineIssue( $operation );
3876 } elsif ( $operation->{action} eq 'payment' ) {
3877 $report = ProcessOfflinePayment( $operation );
3880 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3885 sub ProcessOfflineReturn {
3886 my $operation = shift;
3888 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3891 my $itemnumber = $item->itemnumber;
3892 my $issue = GetOpenIssue( $itemnumber );
3894 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3895 ModDateLastSeen( $itemnumber, $leave_item_lost );
3897 $issue->{borrowernumber},
3899 $operation->{timestamp},
3902 $item->onloan(undef);
3903 $item->store({ log_action => 0 });
3906 return "Item not issued.";
3909 return "Item not found.";
3913 sub ProcessOfflineIssue {
3914 my $operation = shift;
3916 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3919 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3921 return "Barcode not found.";
3923 my $itemnumber = $item->itemnumber;
3924 my $issue = GetOpenIssue( $itemnumber );
3926 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3928 $issue->{borrowernumber},
3930 $operation->{timestamp},
3935 $operation->{'barcode'},
3938 $operation->{timestamp},
3943 return "Borrower not found.";
3947 sub ProcessOfflinePayment {
3948 my $operation = shift;
3950 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3952 $patron->account->pay(
3954 amount => $operation->{amount},
3955 library_id => $operation->{branchcode},
3965 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3967 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3972 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3976 ? Koha::Items->find($itemnumber)
3977 : Koha::Items->find( { barcode => $barcode } );
3981 return C4::Letters::GetPreparedLetter (
3982 module => 'circulation',
3983 letter_code => 'TRANSFERSLIP',
3984 branchcode => $branch,
3986 'branches' => $to_branch,
3987 'biblio' => $item->biblionumber,
3988 'items' => $item->unblessed,
3993 =head2 CheckIfIssuedToPatron
3995 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3997 Return 1 if any record item is issued to patron, otherwise return 0
4001 sub CheckIfIssuedToPatron {
4002 my ($borrowernumber, $biblionumber) = @_;
4004 my $dbh = C4::Context->dbh;
4006 SELECT COUNT(*) FROM issues
4007 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4008 WHERE items.biblionumber = ?
4009 AND issues.borrowernumber = ?
4011 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4012 return 1 if $is_issued;
4018 IsItemIssued( $itemnumber )
4020 Return 1 if the item is on loan, otherwise return 0
4025 my $itemnumber = shift;
4026 my $dbh = C4::Context->dbh;
4027 my $sth = $dbh->prepare(q{
4030 WHERE itemnumber = ?
4032 $sth->execute($itemnumber);
4033 return $sth->fetchrow;
4036 =head2 GetAgeRestriction
4038 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4039 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4041 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4042 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4044 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4045 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4046 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4047 Negative days mean the borrower has gone past the age restriction age.
4051 sub GetAgeRestriction {
4052 my ($record_restrictions, $borrower) = @_;
4053 my $markers = C4::Context->preference('AgeRestrictionMarker');
4055 return unless $record_restrictions;
4056 # Split $record_restrictions to something like FSK 16 or PEGI 6
4057 my @values = split ' ', uc($record_restrictions);
4058 return unless @values;
4060 # Search first occurrence of one of the markers
4061 my @markers = split /\|/, uc($markers);
4062 return unless @markers;
4065 my $restriction_year = 0;
4066 for my $value (@values) {
4068 for my $marker (@markers) {
4069 $marker =~ s/^\s+//; #remove leading spaces
4070 $marker =~ s/\s+$//; #remove trailing spaces
4071 if ( $marker eq $value ) {
4072 if ( $index <= $#values ) {
4073 $restriction_year += $values[$index];
4077 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4079 # Perhaps it is something like "K16" (as in Finland)
4080 $restriction_year += $1;
4084 last if ( $restriction_year > 0 );
4087 #Check if the borrower is age restricted for this material and for how long.
4088 if ($restriction_year && $borrower) {
4089 if ( $borrower->{'dateofbirth'} ) {
4090 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4091 $alloweddate[0] += $restriction_year;
4093 #Prevent runime eror on leap year (invalid date)
4094 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4095 $alloweddate[2] = 28;
4098 #Get how many days the borrower has to reach the age restriction
4099 my @Today = split /-/, dt_from_string()->ymd();
4100 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4101 #Negative days means the borrower went past the age restriction age
4102 return ($restriction_year, $daysToAgeRestriction);
4106 return ($restriction_year);
4110 =head2 GetPendingOnSiteCheckouts
4114 sub GetPendingOnSiteCheckouts {
4115 my $dbh = C4::Context->dbh;
4116 return $dbh->selectall_arrayref(q|
4122 items.itemcallnumber,
4126 issues.date_due < NOW() AS is_overdue,
4129 borrowers.firstname,
4131 borrowers.cardnumber,
4132 borrowers.borrowernumber
4134 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4135 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4136 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4137 WHERE issues.onsite_checkout = 1
4138 |, { Slice => {} } );
4144 my ($count, $branch, $itemtype, $ccode, $newness)
4145 = @$params{qw(count branch itemtype ccode newness)};
4147 my $dbh = C4::Context->dbh;
4150 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4151 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4152 i.ccode, SUM(i.issues) AS count
4154 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4155 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4158 my (@where_strs, @where_args);
4161 push @where_strs, 'i.homebranch = ?';
4162 push @where_args, $branch;
4165 if (C4::Context->preference('item-level_itypes')){
4166 push @where_strs, 'i.itype = ?';
4167 push @where_args, $itemtype;
4169 push @where_strs, 'bi.itemtype = ?';
4170 push @where_args, $itemtype;
4174 push @where_strs, 'i.ccode = ?';
4175 push @where_args, $ccode;
4178 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4179 push @where_args, $newness;
4183 $query .= 'WHERE ' . join(' AND ', @where_strs);
4187 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4188 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4193 $query .= q{ ) xxx WHERE count > 0 };
4194 $count = int($count);
4196 $query .= "LIMIT $count";
4199 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4204 sub _CalculateAndUpdateFine {
4207 my $borrower = $params->{borrower};
4208 my $item = $params->{item};
4209 my $issue = $params->{issue};
4210 my $return_date = $params->{return_date};
4212 unless ($borrower) { carp "No borrower passed in!" && return; }
4213 unless ($item) { carp "No item passed in!" && return; }
4214 unless ($issue) { carp "No issue passed in!" && return; }
4216 my $datedue = dt_from_string( $issue->date_due );
4218 # we only need to calculate and change the fines if we want to do that on return
4219 # Should be on for hourly loans
4220 my $control = C4::Context->preference('CircControl');
4221 my $control_branchcode =
4222 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4223 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4224 : $issue->branchcode;
4226 my $date_returned = $return_date ? $return_date : dt_from_string();
4228 my ( $amount, $unitcounttotal, $unitcount ) =
4229 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4231 if ( C4::Context->preference('finesMode') eq 'production' ) {
4232 if ( $amount > 0 ) {
4233 C4::Overdues::UpdateFine({
4234 issue_id => $issue->issue_id,
4235 itemnumber => $issue->itemnumber,
4236 borrowernumber => $issue->borrowernumber,
4238 due => output_pref($datedue),
4241 elsif ($return_date) {
4243 # Backdated returns may have fines that shouldn't exist,
4244 # so in this case, we need to drop those fines to 0
4246 C4::Overdues::UpdateFine({
4247 issue_id => $issue->issue_id,
4248 itemnumber => $issue->itemnumber,
4249 borrowernumber => $issue->borrowernumber,
4251 due => output_pref($datedue),
4257 sub _item_denied_renewal {
4260 my $item = $params->{item};
4261 return unless $item;
4263 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4264 return unless $denyingrules;
4265 foreach my $field (keys %$denyingrules) {
4266 my $val = $item->$field;
4267 if( !defined $val) {
4268 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4271 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4272 # If the results matches the values in the syspref
4273 # We return true if match found
4287 Koha Development Team <http://koha-community.org/>