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 $itype = $item_object->effective_itemtype;
1244 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1246 categorycode => $borrower->{categorycode},
1248 branchcode => $branchcode,
1251 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1253 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1255 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1257 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1258 $reduced_datedue->set_hour($orig_due->hour);
1259 $reduced_datedue->set_minute($orig_due->minute);
1260 $reduced_datedue->truncate( to => 'minute' );
1262 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1263 $return_data->{exceeded} = 1;
1264 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1265 $return_data->{due_date} = $reduced_datedue;
1269 return $return_data;
1274 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1276 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1280 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1282 =item C<$barcode> is the barcode of the item being issued.
1284 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1285 Calculated if empty.
1287 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1289 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1290 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1292 AddIssue does the following things :
1294 - step 01: check that there is a borrowernumber & a barcode provided
1295 - check for RENEWAL (book issued & being issued to the same patron)
1296 - renewal YES = Calculate Charge & renew
1298 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1300 - fill reserve if reserve to this patron
1301 - cancel reserve or not, otherwise
1302 * TRANSFERT PENDING ?
1303 - complete the transfert
1311 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1313 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1314 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1315 my $auto_renew = $params && $params->{auto_renew};
1316 my $dbh = C4::Context->dbh;
1317 my $barcodecheck = CheckValidBarcode($barcode);
1321 if ( $datedue && ref $datedue ne 'DateTime' ) {
1322 $datedue = dt_from_string($datedue);
1325 # $issuedate defaults to today.
1326 if ( !defined $issuedate ) {
1327 $issuedate = dt_from_string();
1330 if ( ref $issuedate ne 'DateTime' ) {
1331 $issuedate = dt_from_string($issuedate);
1336 # Stop here if the patron or barcode doesn't exist
1337 if ( $borrower && $barcode && $barcodecheck ) {
1338 # find which item we issue
1339 my $item_object = Koha::Items->find({ barcode => $barcode })
1340 or return; # if we don't get an Item, abort.
1341 my $item_unblessed = $item_object->unblessed;
1343 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1345 # get actual issuing if there is one
1346 my $actualissue = $item_object->checkout;
1348 # check if we just renew the issue.
1349 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1350 and not $switch_onsite_checkout ) {
1351 $datedue = AddRenewal(
1352 $borrower->{'borrowernumber'},
1353 $item_object->itemnumber,
1356 $issuedate, # here interpreted as the renewal date
1361 my $itype = $item_object->effective_itemtype;
1362 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1365 $datedue->truncate( to => 'minute' );
1367 my $patron = Koha::Patrons->find( $borrower );
1368 my $library = Koha::Libraries->find( $branchcode );
1369 my $fees = Koha::Charges::Fees->new(
1372 library => $library,
1373 item => $item_object,
1374 to_date => $datedue,
1378 # it's NOT a renewal
1379 if ( $actualissue and not $switch_onsite_checkout ) {
1380 # This book is currently on loan, but not to the person
1381 # who wants to borrow it now. mark it returned before issuing to the new borrower
1382 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1383 return unless $allowed;
1384 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1387 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1389 # Starting process for transfer job (checking transfert and validate it if we have one)
1390 my ($datesent) = GetTransfers( $item_object->itemnumber );
1392 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1393 my $sth = $dbh->prepare(
1394 "UPDATE branchtransfers
1395 SET datearrived = now(),
1397 comments = 'Forced branchtransfer'
1398 WHERE itemnumber= ? AND datearrived IS NULL"
1400 $sth->execute( C4::Context->userenv->{'branch'},
1401 $item_object->itemnumber );
1404 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1405 unless ($auto_renew) {
1406 my $rule = Koha::CirculationRules->get_effective_rule(
1408 categorycode => $borrower->{categorycode},
1409 itemtype => $item_object->effective_itemtype,
1410 branchcode => $branchcode,
1411 rule_name => 'auto_renew'
1415 $auto_renew = $rule->rule_value if $rule;
1418 # Record in the database the fact that the book was issued.
1420 my $itype = $item_object->effective_itemtype;
1421 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1424 $datedue->truncate( to => 'minute' );
1426 my $issue_attributes = {
1427 borrowernumber => $borrower->{'borrowernumber'},
1428 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1429 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1430 branchcode => C4::Context->userenv->{'branch'},
1431 onsite_checkout => $onsite_checkout,
1432 auto_renew => $auto_renew ? 1 : 0,
1435 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1437 $issue->set($issue_attributes)->store;
1440 $issue = Koha::Checkout->new(
1442 itemnumber => $item_object->itemnumber,
1447 if ( $item_object->location && $item_object->location eq 'CART'
1448 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1449 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1450 CartToShelf( $item_object->itemnumber );
1453 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1454 UpdateTotalIssues( $item_object->biblionumber, 1 );
1457 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1458 if ( $item_object->itemlost ) {
1460 Koha::RefundLostItemFeeRules->should_refund(
1462 current_branch => C4::Context->userenv->{branch},
1463 item_home_branch => $item_object->homebranch,
1464 item_holding_branch => $item_object->holdingbranch,
1469 _FixAccountForLostAndFound( $item_object->itemnumber, undef,
1470 $item_object->barcode );
1474 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1475 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1476 $item_object->itemlost(0);
1477 $item_object->onloan($datedue->ymd());
1478 $item_object->datelastborrowed( dt_from_string()->ymd() );
1479 $item_object->store({log_action => 0});
1480 ModDateLastSeen( $item_object->itemnumber );
1482 # If it costs to borrow this book, charge it to the patron's account.
1483 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1484 if ( $charge && $charge > 0 ) {
1485 AddIssuingCharge( $issue, $charge, 'RENT' );
1488 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1489 if ( $itemtype_object ) {
1490 my $accumulate_charge = $fees->accumulate_rentalcharge();
1491 if ( $accumulate_charge > 0 ) {
1492 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1493 $charge += $accumulate_charge;
1494 $item_unblessed->{charge} = $charge;
1498 # Record the fact that this book was issued.
1501 branch => C4::Context->userenv->{'branch'},
1502 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1504 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1505 itemnumber => $item_object->itemnumber,
1506 itemtype => $item_object->effective_itemtype,
1507 location => $item_object->location,
1508 borrowernumber => $borrower->{'borrowernumber'},
1509 ccode => $item_object->ccode,
1513 # Send a checkout slip.
1514 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1516 branchcode => $branchcode,
1517 categorycode => $borrower->{categorycode},
1518 item_type => $item_object->effective_itemtype,
1519 notification => 'CHECKOUT',
1521 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1522 SendCirculationAlert(
1525 item => $item_object->unblessed,
1526 borrower => $borrower,
1527 branch => $branchcode,
1532 "CIRCULATION", "ISSUE",
1533 $borrower->{'borrowernumber'},
1534 $item_object->itemnumber,
1535 ) if C4::Context->preference("IssueLog");
1541 =head2 GetLoanLength
1543 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1545 Get loan length for an itemtype, a borrower type and a branch
1550 my ( $categorycode, $itemtype, $branchcode ) = @_;
1552 # Set search precedences
1555 categorycode => $categorycode,
1556 itemtype => $itemtype,
1557 branchcode => $branchcode,
1560 categorycode => $categorycode,
1562 branchcode => $branchcode,
1565 categorycode => undef,
1566 itemtype => $itemtype,
1567 branchcode => $branchcode,
1570 categorycode => undef,
1572 branchcode => $branchcode,
1575 categorycode => $categorycode,
1576 itemtype => $itemtype,
1577 branchcode => undef,
1580 categorycode => $categorycode,
1582 branchcode => undef,
1585 categorycode => undef,
1586 itemtype => $itemtype,
1587 branchcode => undef,
1590 categorycode => undef,
1592 branchcode => undef,
1596 # Initialize default values
1600 lengthunit => 'days',
1604 foreach my $rule_name (qw( issuelength renewalperiod lengthunit )) {
1605 foreach my $params (@params) {
1606 my $rule = Koha::CirculationRules->search(
1608 rule_name => $rule_name,
1614 $rules->{$rule_name} = $rule->rule_value;
1624 =head2 GetHardDueDate
1626 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1628 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1632 sub GetHardDueDate {
1633 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1635 my $rules = Koha::CirculationRules->get_effective_rules(
1637 categorycode => $borrowertype,
1638 itemtype => $itemtype,
1639 branchcode => $branchcode,
1640 rules => [ 'hardduedate', 'hardduedatecompare' ],
1644 if ( defined( $rules->{hardduedate} ) ) {
1645 if ( $rules->{hardduedate} ) {
1646 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1649 return ( undef, undef );
1654 =head2 GetBranchBorrowerCircRule
1656 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1658 Retrieves circulation rule attributes that apply to the given
1659 branch and patron category, regardless of item type.
1660 The return value is a hashref containing the following key:
1662 patron_maxissueqty - maximum number of loans that a
1663 patron of the given category can have at the given
1664 branch. If the value is undef, no limit.
1666 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1667 patron of the given category can have at the given
1668 branch. If the value is undef, no limit.
1670 This will check for different branch/category combinations in the following order:
1674 default branch and category
1676 If no rule has been found in the database, it will default to
1679 patron_maxissueqty - undef
1680 patron_maxonsiteissueqty - undef
1682 C<$branchcode> and C<$categorycode> should contain the
1683 literal branch code and patron category code, respectively - no
1688 sub GetBranchBorrowerCircRule {
1689 my ( $branchcode, $categorycode ) = @_;
1691 # Initialize default values
1693 patron_maxissueqty => undef,
1694 patron_maxonsiteissueqty => undef,
1698 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1699 my $rule = Koha::CirculationRules->get_effective_rule(
1701 categorycode => $categorycode,
1703 branchcode => $branchcode,
1704 rule_name => $rule_name,
1708 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1714 =head2 GetBranchItemRule
1716 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1718 Retrieves circulation rule attributes that apply to the given
1719 branch and item type, regardless of patron category.
1721 The return value is a hashref containing the following keys:
1723 holdallowed => Hold policy for this branch and itemtype. Possible values:
1724 0: No holds allowed.
1725 1: Holds allowed only by patrons that have the same homebranch as the item.
1726 2: Holds allowed from any patron.
1728 returnbranch => branch to which to return item. Possible values:
1729 noreturn: do not return, let item remain where checked in (floating collections)
1730 homebranch: return to item's home branch
1731 holdingbranch: return to issuer branch
1733 This searches branchitemrules in the following order:
1735 * Same branchcode and itemtype
1736 * Same branchcode, itemtype '*'
1737 * branchcode '*', same itemtype
1738 * branchcode and itemtype '*'
1740 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1744 sub GetBranchItemRule {
1745 my ( $branchcode, $itemtype ) = @_;
1748 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1750 branchcode => $branchcode,
1751 itemtype => $itemtype,
1752 rule_name => 'holdallowed',
1755 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1757 branchcode => $branchcode,
1758 itemtype => $itemtype,
1759 rule_name => 'hold_fulfillment_policy',
1762 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1764 branchcode => $branchcode,
1765 itemtype => $itemtype,
1766 rule_name => 'returnbranch',
1770 # built-in default circulation rule
1772 $rules->{holdallowed} = defined $holdallowed_rule
1773 ? $holdallowed_rule->rule_value
1775 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1776 ? $hold_fulfillment_policy_rule->rule_value
1778 $rules->{returnbranch} = defined $returnbranch_rule
1779 ? $returnbranch_rule->rule_value
1787 ($doreturn, $messages, $iteminformation, $borrower) =
1788 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1794 =item C<$barcode> is the bar code of the book being returned.
1796 =item C<$branch> is the code of the branch where the book is being returned.
1798 =item C<$exemptfine> indicates that overdue charges for the item will be
1801 =item C<$return_date> allows the default return date to be overridden
1802 by the given return date. Optional.
1806 C<&AddReturn> returns a list of four items:
1808 C<$doreturn> is true iff the return succeeded.
1810 C<$messages> is a reference-to-hash giving feedback on the operation.
1811 The keys of the hash are:
1817 No item with this barcode exists. The value is C<$barcode>.
1821 The book is not currently on loan. The value is C<$barcode>.
1825 This book has been withdrawn/cancelled. The value should be ignored.
1827 =item C<Wrongbranch>
1829 This book has was returned to the wrong branch. The value is a hashref
1830 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1831 contain the branchcode of the incorrect and correct return library, respectively.
1835 The item was reserved. The value is a reference-to-hash whose keys are
1836 fields from the reserves table of the Koha database, and
1837 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1838 either C<Waiting>, C<Reserved>, or 0.
1840 =item C<WasReturned>
1842 Value 1 if return is successful.
1844 =item C<NeedsTransfer>
1846 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1850 C<$iteminformation> is a reference-to-hash, giving information about the
1851 returned item from the issues table.
1853 C<$borrower> is a reference-to-hash, giving information about the
1854 patron who last borrowed the book.
1859 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1861 if ($branch and not Koha::Libraries->find($branch)) {
1862 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1865 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1866 my $return_date_specified = !!$return_date;
1867 $return_date //= dt_from_string();
1871 my $validTransfert = 0;
1872 my $stat_type = 'return';
1874 # get information on item
1875 my $item = Koha::Items->find({ barcode => $barcode });
1877 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1880 my $itemnumber = $item->itemnumber;
1881 my $itemtype = $item->effective_itemtype;
1883 my $issue = $item->checkout;
1885 $patron = $issue->patron
1886 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1887 . Dumper($issue->unblessed) . "\n";
1889 $messages->{'NotIssued'} = $barcode;
1890 $item->onloan(undef)->store if defined $item->onloan;
1892 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1894 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1895 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1896 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1897 $messages->{'LocalUse'} = 1;
1898 $stat_type = 'localuse';
1902 # full item data, but no borrowernumber or checkout info (no issue)
1903 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1904 # get the proper branch to which to return the item
1905 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1906 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1907 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1909 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1910 my $patron_unblessed = $patron ? $patron->unblessed : {};
1912 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1913 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1914 if ($update_loc_rules) {
1915 if (defined $update_loc_rules->{_ALL_}) {
1916 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1917 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1918 if ( $item->location ne $update_loc_rules->{_ALL_}) {
1919 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1920 $item->location($update_loc_rules->{_ALL_})->store;
1924 foreach my $key ( keys %$update_loc_rules ) {
1925 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1926 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1927 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1928 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1929 $item->location($update_loc_rules->{$key})->store;
1936 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1938 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1940 eval { $rules = YAML::Load($yaml); };
1942 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1945 foreach my $key ( keys %$rules ) {
1946 if ( $item->notforloan eq $key ) {
1947 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1948 $item->notforloan($rules->{$key})->store({ log_action => 0 });
1955 # check if the return is allowed at this branch
1956 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
1957 unless ($returnallowed){
1958 $messages->{'Wrongbranch'} = {
1959 Wrongbranch => $branch,
1960 Rightbranch => $message
1963 return ( $doreturn, $messages, $issue, $patron_unblessed);
1966 if ( $item->withdrawn ) { # book has been cancelled
1967 $messages->{'withdrawn'} = 1;
1968 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1971 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1975 # case of a return of document (deal with issues and holdingbranch)
1977 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1978 $patron or warn "AddReturn without current borrower";
1982 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1987 C4::Context->preference('CalculateFinesOnReturn')
1988 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
1993 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1996 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 );
1998 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2001 # FIXME is the "= 1" right? This could be the borrower hash.
2002 $messages->{'WasReturned'} = 1;
2006 $item->onloan(undef)->store({ log_action => 0 });
2009 # the holdingbranch is updated if the document is returned to another location.
2010 # this is always done regardless of whether the item was on loan or not
2011 my $item_holding_branch = $item->holdingbranch;
2012 if ($item->holdingbranch ne $branch) {
2013 $item->holdingbranch($branch)->store;
2016 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2017 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
2019 # check if we have a transfer for this document
2020 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2022 # if we have a transfer to do, we update the line of transfers with the datearrived
2023 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2025 if ( $tobranch eq $branch ) {
2026 my $sth = C4::Context->dbh->prepare(
2027 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2029 $sth->execute( $item->itemnumber );
2030 # if we have a reservation with valid transfer, we can set it's status to 'W'
2031 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2033 $messages->{'WrongTransfer'} = $tobranch;
2034 $messages->{'WrongTransferItem'} = $item->itemnumber;
2036 $validTransfert = 1;
2039 # fix up the accounts.....
2040 if ( $item->itemlost ) {
2041 $messages->{'WasLost'} = 1;
2042 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2044 Koha::RefundLostItemFeeRules->should_refund(
2046 current_branch => C4::Context->userenv->{branch},
2047 item_home_branch => $item->homebranch,
2048 item_holding_branch => $item_holding_branch
2053 _FixAccountForLostAndFound( $item->itemnumber,
2054 $borrowernumber, $barcode );
2055 $messages->{'LostItemFeeRefunded'} = 1;
2060 # fix up the overdues in accounts...
2061 if ($borrowernumber) {
2062 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2063 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2065 if ( $issue and $issue->is_overdue($return_date) ) {
2067 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2069 $messages->{'PrevDebarred'} = $debardate;
2071 $messages->{'Debarred'} = $debardate if $debardate;
2073 # there's no overdue on the item but borrower had been previously debarred
2074 } elsif ( $issue->date_due and $patron->debarred ) {
2075 if ( $patron->debarred eq "9999-12-31") {
2076 $messages->{'ForeverDebarred'} = $patron->debarred;
2078 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2079 $borrower_debar_dt->truncate(to => 'day');
2080 my $today_dt = $return_date->clone()->truncate(to => 'day');
2081 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2082 $messages->{'PrevDebarred'} = $patron->debarred;
2088 # find reserves.....
2089 # launch the Checkreserves routine to find any holds
2090 my ($resfound, $resrec);
2091 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2092 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2093 # 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)
2094 if ( $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2095 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2096 $resfound = 'Reserved';
2097 $resrec = $hold->unblessed;
2100 $resrec->{'ResFound'} = $resfound;
2101 $messages->{'ResFound'} = $resrec;
2104 # Record the fact that this book was returned.
2108 itemnumber => $itemnumber,
2109 itemtype => $itemtype,
2110 location => $item->location,
2111 borrowernumber => $borrowernumber,
2112 ccode => $item->ccode,
2115 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2117 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2119 branchcode => $branch,
2120 categorycode => $patron->categorycode,
2121 item_type => $itemtype,
2122 notification => 'CHECKIN',
2124 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2125 SendCirculationAlert({
2127 item => $item->unblessed,
2128 borrower => $patron->unblessed,
2133 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2134 if C4::Context->preference("ReturnLog");
2137 # Check if this item belongs to a biblio record that is attached to an
2138 # ILL request, if it is we need to update the ILL request's status
2139 if (C4::Context->preference('CirculateILL')) {
2140 my $request = Koha::Illrequests->find(
2141 { biblio_id => $item->biblio->biblionumber }
2143 $request->status('RET') if $request;
2146 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2147 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2148 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2149 if (C4::Context->preference("AutomaticItemReturn" ) or
2150 (C4::Context->preference("UseBranchTransferLimits") and
2151 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2153 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2154 $debug and warn "item: " . Dumper($item->unblessed);
2155 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger);
2156 $messages->{'WasTransfered'} = 1;
2158 $messages->{'NeedsTransfer'} = $returnbranch;
2159 $messages->{'TransferTrigger'} = $transfer_trigger;
2163 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2164 my $claims = Koha::Checkouts::ReturnClaims->search(
2166 itemnumber => $item->id,
2167 resolution => undef,
2171 if ( $claims->count ) {
2172 $messages->{ReturnClaims} = $claims;
2176 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2179 =head2 MarkIssueReturned
2181 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2183 Unconditionally marks an issue as being returned by
2184 moving the C<issues> row to C<old_issues> and
2185 setting C<returndate> to the current date.
2187 if C<$returndate> is specified (in iso format), it is used as the date
2190 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2191 the old_issue is immediately anonymised
2193 Ideally, this function would be internal to C<C4::Circulation>,
2194 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2195 and offline_circ/process_koc.pl.
2199 sub MarkIssueReturned {
2200 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2202 # Retrieve the issue
2203 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2205 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2207 my $issue_id = $issue->issue_id;
2209 my $anonymouspatron;
2210 if ( $privacy && $privacy == 2 ) {
2211 # The default of 0 will not work due to foreign key constraints
2212 # The anonymisation will fail if AnonymousPatron is not a valid entry
2213 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2214 # Note that a warning should appear on the about page (System information tab).
2215 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2216 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."
2217 unless Koha::Patrons->find( $anonymouspatron );
2220 my $schema = Koha::Database->schema;
2222 # FIXME Improve the return value and handle it from callers
2223 $schema->txn_do(sub {
2225 my $patron = Koha::Patrons->find( $borrowernumber );
2227 # Update the returndate value
2228 if ( $returndate ) {
2229 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2232 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2235 # Create the old_issues entry
2236 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2238 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2239 if ( $privacy && $privacy == 2) {
2240 $old_checkout->borrowernumber($anonymouspatron)->store;
2243 # And finally delete the issue
2246 $issue->item->onloan(undef)->store({ log_action => 0 });
2248 if ( C4::Context->preference('StoreLastBorrower') ) {
2249 my $item = Koha::Items->find( $itemnumber );
2250 $item->last_returned_by( $patron );
2253 # Remove any OVERDUES related debarment if the borrower has no overdues
2254 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2255 && $patron->debarred
2256 && !$patron->has_overdues
2257 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2259 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2267 =head2 _debar_user_on_return
2269 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2271 C<$borrower> borrower hashref
2273 C<$item> item hashref
2275 C<$datedue> date due DateTime object
2277 C<$returndate> DateTime object representing the return time
2279 Internal function, called only by AddReturn that calculates and updates
2280 the user fine days, and debars them if necessary.
2282 Should only be called for overdue returns
2284 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2289 sub _calculate_new_debar_dt {
2290 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2292 my $branchcode = _GetCircControlBranch( $item, $borrower );
2293 my $circcontrol = C4::Context->preference('CircControl');
2294 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2295 { categorycode => $borrower->{categorycode},
2296 itemtype => $item->{itype},
2297 branchcode => $branchcode,
2302 'maxsuspensiondays',
2303 'suspension_chargeperiod',
2307 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2308 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2309 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2311 return unless $finedays;
2313 # finedays is in days, so hourly loans must multiply by 24
2314 # thus 1 hour late equals 1 day suspension * finedays rate
2315 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2317 # grace period is measured in the same units as the loan
2319 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2321 my $deltadays = DateTime::Duration->new(
2322 days => $chargeable_units
2325 if ( $deltadays->subtract($grace)->is_positive() ) {
2326 my $suspension_days = $deltadays * $finedays;
2328 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2329 # No need to / 1 and do not consider / 0
2330 $suspension_days = DateTime::Duration->new(
2331 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2335 # If the max suspension days is < than the suspension days
2336 # the suspension days is limited to this maximum period.
2337 my $max_sd = $issuing_rule->{maxsuspensiondays};
2338 if ( defined $max_sd && $max_sd ne '' ) {
2339 $max_sd = DateTime::Duration->new( days => $max_sd );
2340 $suspension_days = $max_sd
2341 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2344 my ( $has_been_extended );
2345 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2346 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2348 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2349 $has_been_extended = 1;
2354 # Use the calendar or not to calculate the debarment date
2355 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2356 my $calendar = Koha::Calendar->new(
2357 branchcode => $branchcode,
2358 days_mode => 'Calendar'
2360 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2363 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2365 return $new_debar_dt;
2370 sub _debar_user_on_return {
2371 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2373 $return_date //= dt_from_string();
2375 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2377 return unless $new_debar_dt;
2379 Koha::Patron::Debarments::AddUniqueDebarment({
2380 borrowernumber => $borrower->{borrowernumber},
2381 expiration => $new_debar_dt->ymd(),
2382 type => 'SUSPENSION',
2384 # if borrower was already debarred but does not get an extra debarment
2385 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2386 my ($new_debarment_str, $is_a_reminder);
2387 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2389 $new_debarment_str = $borrower->{debarred};
2391 $new_debarment_str = $new_debar_dt->ymd();
2393 # FIXME Should return a DateTime object
2394 return $new_debarment_str, $is_a_reminder;
2397 =head2 _FixOverduesOnReturn
2399 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2401 C<$borrowernumber> borrowernumber
2403 C<$itemnumber> itemnumber
2405 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2407 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2413 sub _FixOverduesOnReturn {
2414 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2415 unless( $borrowernumber ) {
2416 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2420 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2424 warn "_FixOverduesOnReturn() not supplied valid status";
2428 my $schema = Koha::Database->schema;
2430 my $result = $schema->txn_do(
2432 # check for overdue fine
2433 my $accountlines = Koha::Account::Lines->search(
2435 borrowernumber => $borrowernumber,
2436 itemnumber => $item,
2437 debit_type_code => 'OVERDUE',
2438 status => 'UNRETURNED'
2441 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2443 my $accountline = $accountlines->next;
2444 my $payments = $accountline->credits;
2446 my $amountoutstanding = $accountline->amountoutstanding;
2447 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2448 $accountline->delete;
2449 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2450 my $account = Koha::Account->new({patron_id => $borrowernumber});
2451 my $credit = $account->add_credit(
2453 amount => $amountoutstanding,
2454 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2455 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2456 interface => C4::Context->interface,
2462 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2464 if (C4::Context->preference("FinesLog")) {
2465 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2468 $accountline->status('FORGIVEN');
2469 $accountline->store();
2471 $accountline->status($status);
2472 $accountline->store();
2481 =head2 _FixAccountForLostAndFound
2483 &_FixAccountForLostAndFound($itemnumber, [$borrowernumber, $barcode]);
2485 Finds the most recent lost item charge for this item and refunds the borrower
2486 appropriatly, taking into account any payments or writeoffs already applied
2489 Internal function, not exported, called only by AddReturn.
2493 sub _FixAccountForLostAndFound {
2494 my $itemnumber = shift or return;
2495 my $borrowernumber = @_ ? shift : undef;
2496 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2500 # check for charge made for lost book
2501 my $accountlines = Koha::Account::Lines->search(
2503 itemnumber => $itemnumber,
2504 debit_type_code => 'LOST',
2505 status => [ undef, { '<>' => 'FOUND' } ]
2508 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2512 return unless $accountlines->count > 0;
2513 my $accountline = $accountlines->next;
2514 my $total_to_refund = 0;
2516 return unless $accountline->borrowernumber;
2517 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2518 return unless $patron; # Patron has been deleted, nobody to credit the return to
2520 my $account = $patron->account;
2523 if ( $accountline->amount > $accountline->amountoutstanding ) {
2524 # some amount has been cancelled. collect the offsets that are not writeoffs
2525 # this works because the only way to subtract from this kind of a debt is
2526 # using the UI buttons 'Pay' and 'Write off'
2527 my $credits_offsets = Koha::Account::Offsets->search({
2528 debit_id => $accountline->id,
2529 credit_id => { '!=' => undef }, # it is not the debit itself
2530 type => { '!=' => 'Writeoff' },
2531 amount => { '<' => 0 } # credits are negative on the DB
2534 $total_to_refund = ( $credits_offsets->count > 0 )
2535 ? $credits_offsets->total * -1 # credits are negative on the DB
2539 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2541 if ( $credit_total > 0 ) {
2542 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2543 $credit = $account->add_credit(
2545 amount => $credit_total,
2546 description => 'Item found ' . $item_id,
2547 type => 'LOST_FOUND',
2548 interface => C4::Context->interface,
2549 library_id => $branchcode,
2550 item_id => $itemnumber
2554 $credit->apply( { debits => [ $accountline ] } );
2557 # Update the account status
2558 $accountline->discard_changes->status('FOUND');
2559 $accountline->store;
2561 $accountline->item->paidfor('')->store({ log_action => 0 });
2563 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2564 $account->reconcile_balance;
2567 return ($credit) ? $credit->id : undef;
2570 =head2 _GetCircControlBranch
2572 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2576 Return the library code to be used to determine which circulation
2577 policy applies to a transaction. Looks up the CircControl and
2578 HomeOrHoldingBranch system preferences.
2580 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2582 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2586 sub _GetCircControlBranch {
2587 my ($item, $borrower) = @_;
2588 my $circcontrol = C4::Context->preference('CircControl');
2591 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2592 $branch= C4::Context->userenv->{'branch'};
2593 } elsif ($circcontrol eq 'PatronLibrary') {
2594 $branch=$borrower->{branchcode};
2596 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2597 $branch = $item->{$branchfield};
2598 # default to item home branch if holdingbranch is used
2599 # and is not defined
2600 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2601 $branch = $item->{homebranch};
2609 $issue = GetOpenIssue( $itemnumber );
2611 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2613 C<$itemnumber> is the item's itemnumber
2620 my ( $itemnumber ) = @_;
2621 return unless $itemnumber;
2622 my $dbh = C4::Context->dbh;
2623 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2624 $sth->execute( $itemnumber );
2625 return $sth->fetchrow_hashref();
2629 =head2 GetBiblioIssues
2631 $issues = GetBiblioIssues($biblionumber);
2633 this function get all issues from a biblionumber.
2636 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2637 tables issues and the firstname,surname & cardnumber from borrowers.
2641 sub GetBiblioIssues {
2642 my $biblionumber = shift;
2643 return unless $biblionumber;
2644 my $dbh = C4::Context->dbh;
2646 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2648 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2649 LEFT JOIN items ON 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 = ?
2654 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2656 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2657 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2658 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2659 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2660 WHERE biblio.biblionumber = ?
2663 my $sth = $dbh->prepare($query);
2664 $sth->execute($biblionumber, $biblionumber);
2667 while ( my $data = $sth->fetchrow_hashref ) {
2668 push @issues, $data;
2673 =head2 GetUpcomingDueIssues
2675 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2679 sub GetUpcomingDueIssues {
2682 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2683 my $dbh = C4::Context->dbh;
2685 my $statement = <<END_SQL;
2688 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2690 LEFT JOIN items USING (itemnumber)
2691 LEFT OUTER JOIN branches USING (branchcode)
2692 WHERE returndate is NULL
2694 WHERE days_until_due >= 0 AND days_until_due <= ?
2697 my @bind_parameters = ( $params->{'days_in_advance'} );
2699 my $sth = $dbh->prepare( $statement );
2700 $sth->execute( @bind_parameters );
2701 my $upcoming_dues = $sth->fetchall_arrayref({});
2703 return $upcoming_dues;
2706 =head2 CanBookBeRenewed
2708 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2710 Find out whether a borrowed item may be renewed.
2712 C<$borrowernumber> is the borrower number of the patron who currently
2713 has the item on loan.
2715 C<$itemnumber> is the number of the item to renew.
2717 C<$override_limit>, if supplied with a true value, causes
2718 the limit on the number of times that the loan can be renewed
2719 (as controlled by the item type) to be ignored. Overriding also allows
2720 to renew sooner than "No renewal before" and to manually renew loans
2721 that are automatically renewed.
2723 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2724 item must currently be on loan to the specified borrower; renewals
2725 must be allowed for the item's type; and the borrower must not have
2726 already renewed the loan. $error will contain the reason the renewal can not proceed
2730 sub CanBookBeRenewed {
2731 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2733 my $dbh = C4::Context->dbh;
2737 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2738 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2739 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2740 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2742 my $patron = $issue->patron or return;
2744 # override_limit will override anything else except on_reserve
2745 unless ( $override_limit ){
2746 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2747 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2749 categorycode => $patron->categorycode,
2750 itemtype => $item->effective_itemtype,
2751 branchcode => $branchcode,
2754 'no_auto_renewal_after',
2755 'no_auto_renewal_after_hard_limit',
2762 return ( 0, "too_many" )
2763 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2765 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2766 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2767 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2768 my $restricted = $patron->is_debarred;
2769 my $hasoverdues = $patron->has_overdues;
2771 if ( $restricted and $restrictionblockrenewing ) {
2772 return ( 0, 'restriction');
2773 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2774 return ( 0, 'overdue');
2777 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2779 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2780 return ( 0, 'auto_account_expired' );
2783 if ( defined $issuing_rule->{no_auto_renewal_after}
2784 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2785 # Get issue_date and add no_auto_renewal_after
2786 # If this is greater than today, it's too late for renewal.
2787 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2788 $maximum_renewal_date->add(
2789 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2791 my $now = dt_from_string;
2792 if ( $now >= $maximum_renewal_date ) {
2793 return ( 0, "auto_too_late" );
2796 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2797 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2798 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2799 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2800 return ( 0, "auto_too_late" );
2804 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2805 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2806 my $amountoutstanding =
2807 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2808 ? $patron->account->balance
2809 : $patron->account->outstanding_debits->total_outstanding;
2810 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2811 return ( 0, "auto_too_much_oweing" );
2816 if ( defined $issuing_rule->{norenewalbefore}
2817 and $issuing_rule->{norenewalbefore} ne "" )
2820 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2821 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2822 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2824 # Depending on syspref reset the exact time, only check the date
2825 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2826 and $issuing_rule->{lengthunit} eq 'days' )
2828 $soonestrenewal->truncate( to => 'day' );
2831 if ( $soonestrenewal > dt_from_string() )
2833 return ( 0, "auto_too_soon" ) if $issue->auto_renew && $patron->autorenew_checkouts;
2834 return ( 0, "too_soon" );
2836 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2841 # Fallback for automatic renewals:
2842 # If norenewalbefore is undef, don't renew before due date.
2843 if ( $issue->auto_renew && !$auto_renew && $patron->autorenew_checkouts ) {
2844 my $now = dt_from_string;
2845 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2848 return ( 0, "auto_too_soon" );
2853 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2855 # This item can fill one or more unfilled reserve, can those unfilled reserves
2856 # all be filled by other available items?
2858 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2860 my $schema = Koha::Database->new()->schema();
2862 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2864 # There is an item level hold on this item, no other item can fill the hold
2869 # Get all other items that could possibly fill reserves
2870 my @itemnumbers = $schema->resultset('Item')->search(
2872 biblionumber => $resrec->{biblionumber},
2875 -not => { itemnumber => $itemnumber }
2877 { columns => 'itemnumber' }
2878 )->get_column('itemnumber')->all();
2880 # Get all other reserves that could have been filled by this item
2881 my @borrowernumbers;
2883 my ( $reserve_found, $reserve, undef ) =
2884 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2886 if ($reserve_found) {
2887 push( @borrowernumbers, $reserve->{borrowernumber} );
2894 # If the count of the union of the lists of reservable items for each borrower
2895 # is equal or greater than the number of borrowers, we know that all reserves
2896 # can be filled with available items. We can get the union of the sets simply
2897 # by pushing all the elements onto an array and removing the duplicates.
2900 ITEM: foreach my $itemnumber (@itemnumbers) {
2901 my $item = Koha::Items->find( $itemnumber );
2902 next if IsItemOnHoldAndFound( $itemnumber );
2903 for my $borrowernumber (@borrowernumbers) {
2904 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2905 next unless IsAvailableForItemLevelRequest($item, $patron);
2906 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2908 push @reservable, $itemnumber;
2909 if (@reservable >= @borrowernumbers) {
2918 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2919 return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
2921 return ( 1, undef );
2926 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2930 C<$borrowernumber> is the borrower number of the patron who currently
2933 C<$itemnumber> is the number of the item to renew.
2935 C<$branch> is the library where the renewal took place (if any).
2936 The library that controls the circ policies for the renewal is retrieved from the issues record.
2938 C<$datedue> can be a DateTime object used to set the due date.
2940 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2941 this parameter is not supplied, lastreneweddate is set to the current date.
2943 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2944 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2945 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2948 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2949 from the book's item type.
2954 my $borrowernumber = shift;
2955 my $itemnumber = shift or return;
2957 my $datedue = shift;
2958 my $lastreneweddate = shift || dt_from_string();
2959 my $skipfinecalc = shift;
2961 my $item_object = Koha::Items->find($itemnumber) or return;
2962 my $biblio = $item_object->biblio;
2963 my $issue = $item_object->checkout;
2964 my $item_unblessed = $item_object->unblessed;
2966 my $dbh = C4::Context->dbh;
2968 return unless $issue;
2970 $borrowernumber ||= $issue->borrowernumber;
2972 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2973 carp 'Invalid date passed to AddRenewal.';
2977 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2978 my $patron_unblessed = $patron->unblessed;
2980 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2982 my $schema = Koha::Database->schema;
2983 $schema->txn_do(sub{
2985 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
2986 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2988 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2990 # If the due date wasn't specified, calculate it by adding the
2991 # book's loan length to today's date or the current due date
2992 # based on the value of the RenewalPeriodBase syspref.
2993 my $itemtype = $item_object->effective_itemtype;
2996 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2997 dt_from_string( $issue->date_due, 'sql' ) :
2999 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3002 my $fees = Koha::Charges::Fees->new(
3005 library => $circ_library,
3006 item => $item_object,
3007 from_date => dt_from_string( $issue->date_due, 'sql' ),
3008 to_date => dt_from_string($datedue),
3012 # Update the issues record to have the new due date, and a new count
3013 # of how many times it has been renewed.
3014 my $renews = ( $issue->renewals || 0 ) + 1;
3015 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3016 WHERE borrowernumber=?
3020 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3022 # Update the renewal count on the item, and tell zebra to reindex
3023 $renews = ( $item_object->renewals || 0 ) + 1;
3024 $item_object->renewals($renews);
3025 $item_object->onloan($datedue);
3026 $item_object->store({ log_action => 0 });
3028 # Charge a new rental fee, if applicable
3029 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3030 if ( $charge > 0 ) {
3031 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3034 # Charge a new accumulate rental fee, if applicable
3035 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3036 if ( $itemtype_object ) {
3037 my $accumulate_charge = $fees->accumulate_rentalcharge();
3038 if ( $accumulate_charge > 0 ) {
3039 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3041 $charge += $accumulate_charge;
3044 # Send a renewal slip according to checkout alert preferencei
3045 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3046 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3048 branchcode => $branch,
3049 categorycode => $patron->categorycode,
3050 item_type => $itemtype,
3051 notification => 'CHECKOUT',
3053 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3054 SendCirculationAlert(
3057 item => $item_unblessed,
3058 borrower => $patron->unblessed,
3065 # Remove any OVERDUES related debarment if the borrower has no overdues
3067 && $patron->is_debarred
3068 && ! $patron->has_overdues
3069 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3071 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3074 # Add the renewal to stats
3077 branch => $item_object->renewal_branchcode({branch => $branch}),
3080 itemnumber => $itemnumber,
3081 itemtype => $itemtype,
3082 location => $item_object->location,
3083 borrowernumber => $borrowernumber,
3084 ccode => $item_object->ccode,
3089 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3096 # check renewal status
3097 my ( $bornum, $itemno ) = @_;
3098 my $dbh = C4::Context->dbh;
3100 my $renewsallowed = 0;
3103 my $patron = Koha::Patrons->find( $bornum );
3104 my $item = Koha::Items->find($itemno);
3106 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3108 # Look in the issues table for this item, lent to this borrower,
3109 # and not yet returned.
3111 # FIXME - I think this function could be redone to use only one SQL call.
3112 my $sth = $dbh->prepare(
3113 "select * from issues
3114 where (borrowernumber = ?)
3115 and (itemnumber = ?)"
3117 $sth->execute( $bornum, $itemno );
3118 my $data = $sth->fetchrow_hashref;
3119 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3120 # $item and $borrower should be calculated
3121 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3123 my $rule = Koha::CirculationRules->get_effective_rule(
3125 categorycode => $patron->categorycode,
3126 itemtype => $item->effective_itemtype,
3127 branchcode => $branchcode,
3128 rule_name => 'renewalsallowed',
3132 $renewsallowed = $rule ? $rule->rule_value : 0;
3133 $renewsleft = $renewsallowed - $renewcount;
3134 if($renewsleft < 0){ $renewsleft = 0; }
3135 return ( $renewcount, $renewsallowed, $renewsleft );
3138 =head2 GetSoonestRenewDate
3140 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3142 Find out the soonest possible renew date of a borrowed item.
3144 C<$borrowernumber> is the borrower number of the patron who currently
3145 has the item on loan.
3147 C<$itemnumber> is the number of the item to renew.
3149 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3150 renew date, based on the value "No renewal before" of the applicable
3151 issuing rule. Returns the current date if the item can already be
3152 renewed, and returns undefined if the borrower, loan, or item
3157 sub GetSoonestRenewDate {
3158 my ( $borrowernumber, $itemnumber ) = @_;
3160 my $dbh = C4::Context->dbh;
3162 my $item = Koha::Items->find($itemnumber) or return;
3163 my $itemissue = $item->checkout or return;
3165 $borrowernumber ||= $itemissue->borrowernumber;
3166 my $patron = Koha::Patrons->find( $borrowernumber )
3169 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3170 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3171 { categorycode => $patron->categorycode,
3172 itemtype => $item->effective_itemtype,
3173 branchcode => $branchcode,
3181 my $now = dt_from_string;
3182 return $now unless $issuing_rule;
3184 if ( defined $issuing_rule->{norenewalbefore}
3185 and $issuing_rule->{norenewalbefore} ne "" )
3187 my $soonestrenewal =
3188 dt_from_string( $itemissue->date_due )->subtract(
3189 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3191 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3192 and $issuing_rule->{lengthunit} eq 'days' )
3194 $soonestrenewal->truncate( to => 'day' );
3196 return $soonestrenewal if $now < $soonestrenewal;
3201 =head2 GetLatestAutoRenewDate
3203 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3205 Find out the latest possible auto renew date of a borrowed item.
3207 C<$borrowernumber> is the borrower number of the patron who currently
3208 has the item on loan.
3210 C<$itemnumber> is the number of the item to renew.
3212 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3213 auto renew date, based on the value "No auto renewal after" and the "No auto
3214 renewal after (hard limit) of the applicable issuing rule.
3215 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3216 or item cannot be found.
3220 sub GetLatestAutoRenewDate {
3221 my ( $borrowernumber, $itemnumber ) = @_;
3223 my $dbh = C4::Context->dbh;
3225 my $item = Koha::Items->find($itemnumber) or return;
3226 my $itemissue = $item->checkout or return;
3228 $borrowernumber ||= $itemissue->borrowernumber;
3229 my $patron = Koha::Patrons->find( $borrowernumber )
3232 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3233 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3235 categorycode => $patron->categorycode,
3236 itemtype => $item->effective_itemtype,
3237 branchcode => $branchcode,
3239 'no_auto_renewal_after',
3240 'no_auto_renewal_after_hard_limit',
3246 return unless $circulation_rules;
3248 if ( not $circulation_rules->{no_auto_renewal_after}
3249 or $circulation_rules->{no_auto_renewal_after} eq '' )
3250 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3251 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3253 my $maximum_renewal_date;
3254 if ( $circulation_rules->{no_auto_renewal_after} ) {
3255 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3256 $maximum_renewal_date->add(
3257 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3261 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3262 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3263 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3265 return $maximum_renewal_date;
3269 =head2 GetIssuingCharges
3271 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3273 Calculate how much it would cost for a given patron to borrow a given
3274 item, including any applicable discounts.
3276 C<$itemnumber> is the item number of item the patron wishes to borrow.
3278 C<$borrowernumber> is the patron's borrower number.
3280 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3281 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3286 sub GetIssuingCharges {
3288 # calculate charges due
3289 my ( $itemnumber, $borrowernumber ) = @_;
3291 my $dbh = C4::Context->dbh;
3294 # Get the book's item type and rental charge (via its biblioitem).
3295 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3296 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3297 $charge_query .= (C4::Context->preference('item-level_itypes'))
3298 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3299 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3301 $charge_query .= ' WHERE items.itemnumber =?';
3303 my $sth = $dbh->prepare($charge_query);
3304 $sth->execute($itemnumber);
3305 if ( my $item_data = $sth->fetchrow_hashref ) {
3306 $item_type = $item_data->{itemtype};
3307 $charge = $item_data->{rentalcharge};
3308 my $branch = C4::Context::mybranch();
3309 my $patron = Koha::Patrons->find( $borrowernumber );
3310 my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3312 # We may have multiple rules so get the most specific
3313 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3316 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3320 return ( $charge, $item_type );
3323 # Select most appropriate discount rule from those returned
3324 sub _get_discount_from_rule {
3325 my ($categorycode, $branchcode, $itemtype) = @_;
3327 # Set search precedences
3330 branchcode => $branchcode,
3331 itemtype => $itemtype,
3332 categorycode => $categorycode,
3335 branchcode => undef,
3336 categorycode => $categorycode,
3337 itemtype => $itemtype,
3340 branchcode => $branchcode,
3341 categorycode => $categorycode,
3345 branchcode => undef,
3346 categorycode => $categorycode,
3351 foreach my $params (@params) {
3352 my $rule = Koha::CirculationRules->search(
3354 rule_name => 'rentaldiscount',
3359 return $rule->rule_value if $rule;
3366 =head2 AddIssuingCharge
3368 &AddIssuingCharge( $checkout, $charge, $type )
3372 sub AddIssuingCharge {
3373 my ( $checkout, $charge, $type ) = @_;
3375 # FIXME What if checkout does not exist?
3377 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3378 my $accountline = $account->add_debit(
3382 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3383 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3384 interface => C4::Context->interface,
3386 item_id => $checkout->itemnumber,
3387 issue_id => $checkout->issue_id,
3394 GetTransfers($itemnumber);
3399 my ($itemnumber) = @_;
3401 my $dbh = C4::Context->dbh;
3408 FROM branchtransfers
3409 WHERE itemnumber = ?
3410 AND datearrived IS NULL
3412 my $sth = $dbh->prepare($query);
3413 $sth->execute($itemnumber);
3414 my @row = $sth->fetchrow_array();
3418 =head2 GetTransfersFromTo
3420 @results = GetTransfersFromTo($frombranch,$tobranch);
3422 Returns the list of pending transfers between $from and $to branch
3426 sub GetTransfersFromTo {
3427 my ( $frombranch, $tobranch ) = @_;
3428 return unless ( $frombranch && $tobranch );
3429 my $dbh = C4::Context->dbh;
3431 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3432 FROM branchtransfers
3435 AND datearrived IS NULL
3437 my $sth = $dbh->prepare($query);
3438 $sth->execute( $frombranch, $tobranch );
3441 while ( my $data = $sth->fetchrow_hashref ) {
3442 push @gettransfers, $data;
3444 return (@gettransfers);
3447 =head2 DeleteTransfer
3449 &DeleteTransfer($itemnumber);
3453 sub DeleteTransfer {
3454 my ($itemnumber) = @_;
3455 return unless $itemnumber;
3456 my $dbh = C4::Context->dbh;
3457 my $sth = $dbh->prepare(
3458 "DELETE FROM branchtransfers
3460 AND datearrived IS NULL "
3462 return $sth->execute($itemnumber);
3465 =head2 SendCirculationAlert
3467 Send out a C<check-in> or C<checkout> alert using the messaging system.
3475 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3479 Hashref of information about the item being checked in or out.
3483 Hashref of information about the borrower of the item.
3487 The branchcode from where the checkout or check-in took place.
3493 SendCirculationAlert({
3496 borrower => $borrower,
3502 sub SendCirculationAlert {
3504 my ($type, $item, $borrower, $branch) =
3505 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3506 my %message_name = (
3507 CHECKIN => 'Item_Check_in',
3508 CHECKOUT => 'Item_Checkout',
3509 RENEWAL => 'Item_Checkout',
3511 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3512 borrowernumber => $borrower->{borrowernumber},
3513 message_name => $message_name{$type},
3515 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3517 my $schema = Koha::Database->new->schema;
3518 my @transports = keys %{ $borrower_preferences->{transports} };
3520 # From the MySQL doc:
3521 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3522 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3523 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3524 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3526 for my $mtt (@transports) {
3527 my $letter = C4::Letters::GetPreparedLetter (
3528 module => 'circulation',
3529 letter_code => $type,
3530 branchcode => $branch,
3531 message_transport_type => $mtt,
3532 lang => $borrower->{lang},
3534 $issues_table => $item->{itemnumber},
3535 'items' => $item->{itemnumber},
3536 'biblio' => $item->{biblionumber},
3537 'biblioitems' => $item->{biblionumber},
3538 'borrowers' => $borrower,
3539 'branches' => $branch,
3543 $schema->storage->txn_begin;
3544 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3545 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3546 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3547 unless ( $message ) {
3548 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3549 C4::Message->enqueue($letter, $borrower, $mtt);
3551 $message->append($letter);
3554 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3555 $schema->storage->txn_commit;
3561 =head2 updateWrongTransfer
3563 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3565 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
3569 sub updateWrongTransfer {
3570 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3571 my $dbh = C4::Context->dbh;
3572 # first step validate the actual line of transfert .
3575 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3577 $sth->execute($FromLibrary,$itemNumber);
3579 # second step create a new line of branchtransfer to the right location .
3580 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3582 #third step changing holdingbranch of item
3583 my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3588 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3590 this function calculates the due date given the start date and configured circulation rules,
3591 checking against the holidays calendar as per the daysmode circulation rule.
3592 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3593 C<$itemtype> = itemtype code of item in question
3594 C<$branch> = location whose calendar to use
3595 C<$borrower> = Borrower object
3596 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3601 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3605 # loanlength now a href
3607 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3609 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3615 if (ref $startdate ne 'DateTime' ) {
3616 $datedue = dt_from_string($datedue);
3618 $datedue = $startdate->clone;
3621 $datedue = dt_from_string()->truncate( to => 'minute' );
3625 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3627 categorycode => $borrower->{categorycode},
3628 itemtype => $itemtype,
3629 branchcode => $branch,
3633 # calculate the datedue as normal
3634 if ( $daysmode eq 'Days' )
3635 { # ignoring calendar
3636 if ( $loanlength->{lengthunit} eq 'hours' ) {
3637 $datedue->add( hours => $loanlength->{$length_key} );
3639 $datedue->add( days => $loanlength->{$length_key} );
3640 $datedue->set_hour(23);
3641 $datedue->set_minute(59);
3645 if ($loanlength->{lengthunit} eq 'hours') {
3646 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3649 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3651 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3652 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3653 if ($loanlength->{lengthunit} eq 'days') {
3654 $datedue->set_hour(23);
3655 $datedue->set_minute(59);
3659 # if Hard Due Dates are used, retrieve them and apply as necessary
3660 my ( $hardduedate, $hardduedatecompare ) =
3661 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3662 if ($hardduedate) { # hardduedates are currently dates
3663 $hardduedate->truncate( to => 'minute' );
3664 $hardduedate->set_hour(23);
3665 $hardduedate->set_minute(59);
3666 my $cmp = DateTime->compare( $hardduedate, $datedue );
3668 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3669 # if the calculated date is before the 'after' Hard Due Date (floor), override
3670 # if the hard due date is set to 'exactly', overrride
3671 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3672 $datedue = $hardduedate->clone;
3675 # in all other cases, keep the date due as it is
3679 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3680 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3681 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3682 if( $expiry_dt ) { #skip empty expiry date..
3683 $expiry_dt->set( hour => 23, minute => 59);
3684 my $d1= $datedue->clone->set_time_zone('floating');
3685 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3686 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3689 if ( $daysmode ne 'Days' ) {
3690 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3691 if ( $calendar->is_holiday($datedue) ) {
3692 # Don't return on a closed day
3693 $datedue = $calendar->prev_open_days( $datedue, 1 );
3702 sub CheckValidBarcode{
3704 my $dbh = C4::Context->dbh;
3705 my $query=qq|SELECT count(*)
3709 my $sth = $dbh->prepare($query);
3710 $sth->execute($barcode);
3711 my $exist=$sth->fetchrow ;
3715 =head2 IsBranchTransferAllowed
3717 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3719 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3721 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3722 Koha::Item->can_be_transferred.
3726 sub IsBranchTransferAllowed {
3727 my ( $toBranch, $fromBranch, $code ) = @_;
3729 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3731 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3732 my $dbh = C4::Context->dbh;
3734 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3735 $sth->execute( $toBranch, $fromBranch, $code );
3736 my $limit = $sth->fetchrow_hashref();
3738 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3739 if ( $limit->{'limitId'} ) {
3746 =head2 CreateBranchTransferLimit
3748 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3750 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3752 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3756 sub CreateBranchTransferLimit {
3757 my ( $toBranch, $fromBranch, $code ) = @_;
3758 return unless defined($toBranch) && defined($fromBranch);
3759 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3761 my $dbh = C4::Context->dbh;
3763 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3764 return $sth->execute( $code, $toBranch, $fromBranch );
3767 =head2 DeleteBranchTransferLimits
3769 my $result = DeleteBranchTransferLimits($frombranch);
3771 Deletes all the library transfer limits for one library. Returns the
3772 number of limits deleted, 0e0 if no limits were deleted, or undef if
3773 no arguments are supplied.
3775 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3776 fromBranch => $fromBranch
3781 sub DeleteBranchTransferLimits {
3783 return unless defined $branch;
3784 my $dbh = C4::Context->dbh;
3785 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3786 return $sth->execute($branch);
3790 my ( $borrowernumber, $itemnum ) = @_;
3791 MarkIssueReturned( $borrowernumber, $itemnum );
3796 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3798 unless ( $mark_lost_from ) {
3799 # Temporary check to avoid regressions
3800 die q|LostItem called without $mark_lost_from, check the API.|;
3804 if ( $force_mark_returned ) {
3807 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3808 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3811 my $dbh = C4::Context->dbh();
3812 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3814 JOIN items USING (itemnumber)
3815 JOIN biblio USING (biblionumber)
3816 WHERE issues.itemnumber=?");
3817 $sth->execute($itemnumber);
3818 my $issues=$sth->fetchrow_hashref();
3820 # If a borrower lost the item, add a replacement cost to the their record
3821 if ( my $borrowernumber = $issues->{borrowernumber} ){
3822 my $patron = Koha::Patrons->find( $borrowernumber );
3824 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3825 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3827 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3828 C4::Accounts::chargelostitem(
3831 $issues->{'replacementprice'},
3832 sprintf( "%s %s %s",
3833 $issues->{'title'} || q{},
3834 $issues->{'barcode'} || q{},
3835 $issues->{'itemcallnumber'} || q{},
3838 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3839 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3842 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3845 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3846 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3847 Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store;
3849 my $transferdeleted = DeleteTransfer($itemnumber);
3852 sub GetOfflineOperations {
3853 my $dbh = C4::Context->dbh;
3854 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3855 $sth->execute(C4::Context->userenv->{'branch'});
3856 my $results = $sth->fetchall_arrayref({});
3860 sub GetOfflineOperation {
3861 my $operationid = shift;
3862 return unless $operationid;
3863 my $dbh = C4::Context->dbh;
3864 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3865 $sth->execute( $operationid );
3866 return $sth->fetchrow_hashref;
3869 sub AddOfflineOperation {
3870 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3871 my $dbh = C4::Context->dbh;
3872 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3873 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3877 sub DeleteOfflineOperation {
3878 my $dbh = C4::Context->dbh;
3879 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3880 $sth->execute( shift );
3884 sub ProcessOfflineOperation {
3885 my $operation = shift;
3888 if ( $operation->{action} eq 'return' ) {
3889 $report = ProcessOfflineReturn( $operation );
3890 } elsif ( $operation->{action} eq 'issue' ) {
3891 $report = ProcessOfflineIssue( $operation );
3892 } elsif ( $operation->{action} eq 'payment' ) {
3893 $report = ProcessOfflinePayment( $operation );
3896 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3901 sub ProcessOfflineReturn {
3902 my $operation = shift;
3904 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3907 my $itemnumber = $item->itemnumber;
3908 my $issue = GetOpenIssue( $itemnumber );
3910 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3911 ModDateLastSeen( $itemnumber, $leave_item_lost );
3913 $issue->{borrowernumber},
3915 $operation->{timestamp},
3918 $item->onloan(undef);
3919 $item->store({ log_action => 0 });
3922 return "Item not issued.";
3925 return "Item not found.";
3929 sub ProcessOfflineIssue {
3930 my $operation = shift;
3932 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3935 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3937 return "Barcode not found.";
3939 my $itemnumber = $item->itemnumber;
3940 my $issue = GetOpenIssue( $itemnumber );
3942 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3944 $issue->{borrowernumber},
3946 $operation->{timestamp},
3951 $operation->{'barcode'},
3954 $operation->{timestamp},
3959 return "Borrower not found.";
3963 sub ProcessOfflinePayment {
3964 my $operation = shift;
3966 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3968 $patron->account->pay(
3970 amount => $operation->{amount},
3971 library_id => $operation->{branchcode},
3981 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3983 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3988 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3992 ? Koha::Items->find($itemnumber)
3993 : Koha::Items->find( { barcode => $barcode } );
3997 return C4::Letters::GetPreparedLetter (
3998 module => 'circulation',
3999 letter_code => 'TRANSFERSLIP',
4000 branchcode => $branch,
4002 'branches' => $to_branch,
4003 'biblio' => $item->biblionumber,
4004 'items' => $item->unblessed,
4009 =head2 CheckIfIssuedToPatron
4011 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4013 Return 1 if any record item is issued to patron, otherwise return 0
4017 sub CheckIfIssuedToPatron {
4018 my ($borrowernumber, $biblionumber) = @_;
4020 my $dbh = C4::Context->dbh;
4022 SELECT COUNT(*) FROM issues
4023 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4024 WHERE items.biblionumber = ?
4025 AND issues.borrowernumber = ?
4027 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4028 return 1 if $is_issued;
4034 IsItemIssued( $itemnumber )
4036 Return 1 if the item is on loan, otherwise return 0
4041 my $itemnumber = shift;
4042 my $dbh = C4::Context->dbh;
4043 my $sth = $dbh->prepare(q{
4046 WHERE itemnumber = ?
4048 $sth->execute($itemnumber);
4049 return $sth->fetchrow;
4052 =head2 GetAgeRestriction
4054 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4055 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4057 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4058 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4060 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4061 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4062 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4063 Negative days mean the borrower has gone past the age restriction age.
4067 sub GetAgeRestriction {
4068 my ($record_restrictions, $borrower) = @_;
4069 my $markers = C4::Context->preference('AgeRestrictionMarker');
4071 return unless $record_restrictions;
4072 # Split $record_restrictions to something like FSK 16 or PEGI 6
4073 my @values = split ' ', uc($record_restrictions);
4074 return unless @values;
4076 # Search first occurrence of one of the markers
4077 my @markers = split /\|/, uc($markers);
4078 return unless @markers;
4081 my $restriction_year = 0;
4082 for my $value (@values) {
4084 for my $marker (@markers) {
4085 $marker =~ s/^\s+//; #remove leading spaces
4086 $marker =~ s/\s+$//; #remove trailing spaces
4087 if ( $marker eq $value ) {
4088 if ( $index <= $#values ) {
4089 $restriction_year += $values[$index];
4093 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4095 # Perhaps it is something like "K16" (as in Finland)
4096 $restriction_year += $1;
4100 last if ( $restriction_year > 0 );
4103 #Check if the borrower is age restricted for this material and for how long.
4104 if ($restriction_year && $borrower) {
4105 if ( $borrower->{'dateofbirth'} ) {
4106 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4107 $alloweddate[0] += $restriction_year;
4109 #Prevent runime eror on leap year (invalid date)
4110 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4111 $alloweddate[2] = 28;
4114 #Get how many days the borrower has to reach the age restriction
4115 my @Today = split /-/, dt_from_string()->ymd();
4116 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4117 #Negative days means the borrower went past the age restriction age
4118 return ($restriction_year, $daysToAgeRestriction);
4122 return ($restriction_year);
4126 =head2 GetPendingOnSiteCheckouts
4130 sub GetPendingOnSiteCheckouts {
4131 my $dbh = C4::Context->dbh;
4132 return $dbh->selectall_arrayref(q|
4138 items.itemcallnumber,
4142 issues.date_due < NOW() AS is_overdue,
4145 borrowers.firstname,
4147 borrowers.cardnumber,
4148 borrowers.borrowernumber
4150 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4151 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4152 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4153 WHERE issues.onsite_checkout = 1
4154 |, { Slice => {} } );
4160 my ($count, $branch, $itemtype, $ccode, $newness)
4161 = @$params{qw(count branch itemtype ccode newness)};
4163 my $dbh = C4::Context->dbh;
4166 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4167 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4168 i.ccode, SUM(i.issues) AS count
4170 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4171 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4174 my (@where_strs, @where_args);
4177 push @where_strs, 'i.homebranch = ?';
4178 push @where_args, $branch;
4181 if (C4::Context->preference('item-level_itypes')){
4182 push @where_strs, 'i.itype = ?';
4183 push @where_args, $itemtype;
4185 push @where_strs, 'bi.itemtype = ?';
4186 push @where_args, $itemtype;
4190 push @where_strs, 'i.ccode = ?';
4191 push @where_args, $ccode;
4194 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4195 push @where_args, $newness;
4199 $query .= 'WHERE ' . join(' AND ', @where_strs);
4203 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4204 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4209 $query .= q{ ) xxx WHERE count > 0 };
4210 $count = int($count);
4212 $query .= "LIMIT $count";
4215 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4220 sub _CalculateAndUpdateFine {
4223 my $borrower = $params->{borrower};
4224 my $item = $params->{item};
4225 my $issue = $params->{issue};
4226 my $return_date = $params->{return_date};
4228 unless ($borrower) { carp "No borrower passed in!" && return; }
4229 unless ($item) { carp "No item passed in!" && return; }
4230 unless ($issue) { carp "No issue passed in!" && return; }
4232 my $datedue = dt_from_string( $issue->date_due );
4234 # we only need to calculate and change the fines if we want to do that on return
4235 # Should be on for hourly loans
4236 my $control = C4::Context->preference('CircControl');
4237 my $control_branchcode =
4238 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4239 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4240 : $issue->branchcode;
4242 my $date_returned = $return_date ? $return_date : dt_from_string();
4244 my ( $amount, $unitcounttotal, $unitcount ) =
4245 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4247 if ( C4::Context->preference('finesMode') eq 'production' ) {
4248 if ( $amount > 0 ) {
4249 C4::Overdues::UpdateFine({
4250 issue_id => $issue->issue_id,
4251 itemnumber => $issue->itemnumber,
4252 borrowernumber => $issue->borrowernumber,
4254 due => output_pref($datedue),
4257 elsif ($return_date) {
4259 # Backdated returns may have fines that shouldn't exist,
4260 # so in this case, we need to drop those fines to 0
4262 C4::Overdues::UpdateFine({
4263 issue_id => $issue->issue_id,
4264 itemnumber => $issue->itemnumber,
4265 borrowernumber => $issue->borrowernumber,
4267 due => output_pref($datedue),
4273 sub _item_denied_renewal {
4276 my $item = $params->{item};
4277 return unless $item;
4279 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4280 return unless $denyingrules;
4281 foreach my $field (keys %$denyingrules) {
4282 my $val = $item->$field;
4283 if( !defined $val) {
4284 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4287 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4288 # If the results matches the values in the syspref
4289 # We return true if match found
4303 Koha Development Team <http://koha-community.org/>