1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 #use warnings; FIXME - Bug 2505
25 use POSIX qw( floor );
34 use C4::ItemCirculationAlertPreference;
37 use C4::Log; # logaction
38 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
39 use C4::RotatingCollections qw(GetCollectionItemBranches);
40 use Algorithm::CheckDigits;
44 use Koha::AuthorisedValues;
45 use Koha::Biblioitems;
49 use Koha::IssuingRules;
52 use Koha::Patron::Debarments;
55 use Koha::Account::Lines;
57 use Koha::RefundLostItemFeeRules;
58 use Koha::Account::Lines;
59 use Koha::Account::Offsets;
60 use Koha::Config::SysPrefs;
61 use Koha::Charges::Fees;
62 use Koha::Util::SystemPreferences;
63 use Koha::Checkouts::ReturnClaims;
65 use List::MoreUtils qw( uniq any );
66 use Scalar::Util qw( looks_like_number );
76 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
82 # FIXME subs that should probably be elsewhere
87 &GetPendingOnSiteCheckouts
90 # subs to deal with issuing a book
98 &GetLatestAutoRenewDate
100 &GetBranchBorrowerCircRule
104 &CheckIfIssuedToPatron
109 # subs to deal with returns
115 # subs to deal with transfers
122 &IsBranchTransferAllowed
123 &CreateBranchTransferLimit
124 &DeleteBranchTransferLimits
128 # subs to deal with offline circulation
130 &GetOfflineOperations
133 &DeleteOfflineOperation
134 &ProcessOfflineOperation
140 C4::Circulation - Koha circulation module
148 The functions in this module deal with circulation, issues, and
149 returns, as well as general information about the library.
150 Also deals with inventory.
156 $str = &barcodedecode($barcode, [$filter]);
158 Generic filter function for barcode string.
159 Called on every circ if the System Pref itemBarcodeInputFilter is set.
160 Will do some manipulation of the barcode for systems that deliver a barcode
161 to circulation.pl that differs from the barcode stored for the item.
162 For proper functioning of this filter, calling the function on the
163 correct barcode string (items.barcode) should return an unaltered barcode.
165 The optional $filter argument is to allow for testing or explicit
166 behavior that ignores the System Pref. Valid values are the same as the
171 # FIXME -- the &decode fcn below should be wrapped into this one.
172 # FIXME -- these plugins should be moved out of Circulation.pm
175 my ($barcode, $filter) = @_;
176 my $branch = C4::Context::mybranch();
177 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
178 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
179 if ($filter eq 'whitespace') {
181 } elsif ($filter eq 'cuecat') {
183 my @fields = split( /\./, $barcode );
184 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
185 ($#results == 2) and return $results[2];
186 } elsif ($filter eq 'T-prefix') {
187 if ($barcode =~ /^[Tt](\d)/) {
188 (defined($1) and $1 eq '0') and return $barcode;
189 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
191 return sprintf("T%07d", $barcode);
192 # FIXME: $barcode could be "T1", causing warning: substr outside of string
193 # Why drop the nonzero digit after the T?
194 # Why pass non-digits (or empty string) to "T%07d"?
195 } elsif ($filter eq 'libsuite8') {
196 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
197 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
198 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
200 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
203 } elsif ($filter eq 'EAN13') {
204 my $ean = CheckDigits('ean');
205 if ( $ean->is_valid($barcode) ) {
206 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
207 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
209 warn "# [$barcode] not valid EAN-13/UPC-A\n";
212 return $barcode; # return barcode, modified or not
217 $str = &decode($chunk);
219 Decodes a segment of a string emitted by a CueCat barcode scanner and
222 FIXME: Should be replaced with Barcode::Cuecat from CPAN
223 or Javascript based decoding on the client side.
230 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
231 my @s = map { index( $seq, $_ ); } split( //, $encoded );
232 my $l = ( $#s + 1 ) % 4;
235 # warn "Error: Cuecat decode parsing failed!";
243 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
245 chr( ( $n >> 16 ) ^ 67 )
246 .chr( ( $n >> 8 & 255 ) ^ 67 )
247 .chr( ( $n & 255 ) ^ 67 );
250 $r = substr( $r, 0, length($r) - $l );
256 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
257 $barcode, $ignore_reserves);
259 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
261 C<$newbranch> is the code for the branch to which the item should be transferred.
263 C<$barcode> is the barcode of the item to be transferred.
265 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
266 Otherwise, if an item is reserved, the transfer fails.
268 Returns three values:
274 is true if the transfer was successful.
278 is a reference-to-hash which may have any of the following keys:
284 There is no item in the catalog with the given barcode. The value is C<$barcode>.
286 =item C<DestinationEqualsHolding>
288 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
292 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
296 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
298 =item C<WasTransferred>
300 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
309 my ( $tbr, $barcode, $ignoreRs ) = @_;
312 my $item = Koha::Items->find( { barcode => $barcode } );
316 $messages->{'BadBarcode'} = $barcode;
318 return ( $dotransfer, $messages );
321 my $itemnumber = $item->itemnumber;
322 # 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;
360 # $messages->{'ResFound'} = $resrec;
364 #actually do the transfer....
366 ModItemTransfer( $itemnumber, $fbr, $tbr );
368 # don't need to update MARC anymore, we do it in batch now
369 $messages->{'WasTransfered'} = 1;
372 ModDateLastSeen( $itemnumber );
373 return ( $dotransfer, $messages );
378 my $borrower = shift;
379 my $item_object = shift;
381 my $onsite_checkout = $params->{onsite_checkout} || 0;
382 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
383 my $cat_borrower = $borrower->{'categorycode'};
384 my $dbh = C4::Context->dbh;
386 # Get which branchcode we need
387 $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
388 my $type = $item_object->effective_itemtype;
390 # given branch, patron category, and item type, determine
391 # applicable issuing rule
392 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
394 categorycode => $cat_borrower,
396 branchcode => $branch,
397 rule_name => 'maxissueqty',
400 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
402 categorycode => $cat_borrower,
404 branchcode => $branch,
405 rule_name => 'maxonsiteissueqty',
410 # if a rule is found and has a loan limit set, count
411 # how many loans the patron already has that meet that
413 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne '') {
416 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
418 JOIN items USING (itemnumber)
421 my $rule_itemtype = $maxissueqty_rule->itemtype;
422 unless ($rule_itemtype) {
423 # matching rule has the default item type, so count only
424 # those existing loans that don't fall under a more
426 if (C4::Context->preference('item-level_itypes')) {
427 $count_query .= " WHERE items.itype NOT IN (
428 SELECT itemtype FROM issuingrules
430 AND (categorycode = ? OR categorycode = ?)
434 $count_query .= " JOIN biblioitems USING (biblionumber)
435 WHERE biblioitems.itemtype NOT IN (
436 SELECT itemtype FROM issuingrules
438 AND (categorycode = ? OR categorycode = ?)
442 push @bind_params, $maxissueqty_rule->branchcode;
443 push @bind_params, $maxissueqty_rule->categorycode;
444 push @bind_params, $cat_borrower;
446 # rule has specific item type, so count loans of that
448 if (C4::Context->preference('item-level_itypes')) {
449 $count_query .= " WHERE items.itype = ? ";
451 $count_query .= " JOIN biblioitems USING (biblionumber)
452 WHERE biblioitems.itemtype= ? ";
454 push @bind_params, $type;
457 $count_query .= " AND borrowernumber = ? ";
458 push @bind_params, $borrower->{'borrowernumber'};
459 my $rule_branch = $maxissueqty_rule->branchcode;
461 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
462 $count_query .= " AND issues.branchcode = ? ";
463 push @bind_params, $rule_branch;
464 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
465 ; # if branch is the patron's home branch, then count all loans by patron
467 $count_query .= " AND items.homebranch = ? ";
468 push @bind_params, $rule_branch;
472 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
474 my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
475 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
477 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
478 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
480 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
481 count => $onsite_checkout_count,
482 max_allowed => $max_onsite_checkouts_allowed,
486 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
487 my $delta = $switch_onsite_checkout ? 1 : 0;
488 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
490 reason => 'TOO_MANY_CHECKOUTS',
491 count => $checkout_count,
492 max_allowed => $max_checkouts_allowed,
495 } elsif ( not $onsite_checkout ) {
496 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
498 reason => 'TOO_MANY_CHECKOUTS',
499 count => $checkout_count - $onsite_checkout_count,
500 max_allowed => $max_checkouts_allowed,
506 # Now count total loans against the limit for the branch
507 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
508 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
509 my @bind_params = ();
510 my $branch_count_query = q|
511 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
513 JOIN items USING (itemnumber)
514 WHERE borrowernumber = ?
516 push @bind_params, $borrower->{borrowernumber};
518 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
519 $branch_count_query .= " AND issues.branchcode = ? ";
520 push @bind_params, $branch;
521 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
522 ; # if branch is the patron's home branch, then count all loans by patron
524 $branch_count_query .= " AND items.homebranch = ? ";
525 push @bind_params, $branch;
527 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
528 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
529 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
531 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
532 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
534 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
535 count => $onsite_checkout_count,
536 max_allowed => $max_onsite_checkouts_allowed,
540 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
541 my $delta = $switch_onsite_checkout ? 1 : 0;
542 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
544 reason => 'TOO_MANY_CHECKOUTS',
545 count => $checkout_count,
546 max_allowed => $max_checkouts_allowed,
549 } elsif ( not $onsite_checkout ) {
550 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
552 reason => 'TOO_MANY_CHECKOUTS',
553 count => $checkout_count - $onsite_checkout_count,
554 max_allowed => $max_checkouts_allowed,
560 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
561 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
564 # OK, the patron can issue !!!
568 =head2 CanBookBeIssued
570 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
571 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
573 Check if a book can be issued.
575 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
577 IMPORTANT: The assumption by users of this routine is that causes blocking
578 the issue are keyed by uppercase labels and other returned
579 data is keyed in lower case!
583 =item C<$patron> is a Koha::Patron
585 =item C<$barcode> is the bar code of the book being issued.
587 =item C<$duedates> is a DateTime object.
589 =item C<$inprocess> boolean switch
591 =item C<$ignore_reserves> boolean switch
593 =item C<$params> Hashref of additional parameters
596 override_high_holds - Ignore high holds
597 onsite_checkout - Checkout is an onsite checkout that will not leave the library
605 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
606 Possible values are :
612 sticky due date is invalid
616 borrower gone with no address
620 borrower declared it's card lost
626 =head3 UNKNOWN_BARCODE
640 item is restricted (set by ??)
642 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
643 could be prevented, but ones that can be overriden by the operator.
645 Possible values are :
653 renewing, not issuing
655 =head3 ISSUED_TO_ANOTHER
657 issued to someone else.
661 reserved for someone else.
665 sticky due date is invalid or due date in the past
669 if the borrower borrows to much things
673 sub CanBookBeIssued {
674 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
675 my %needsconfirmation; # filled with problems that needs confirmations
676 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
677 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
678 my %messages; # filled with information messages that should be displayed.
680 my $onsite_checkout = $params->{onsite_checkout} || 0;
681 my $override_high_holds = $params->{override_high_holds} || 0;
683 my $item_object = Koha::Items->find({barcode => $barcode });
685 # MANDATORY CHECKS - unless item exists, nothing else matters
686 unless ( $item_object ) {
687 $issuingimpossible{UNKNOWN_BARCODE} = 1;
689 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
691 my $item_unblessed = $item_object->unblessed; # Transition...
692 my $issue = $item_object->checkout;
693 my $biblio = $item_object->biblio;
695 my $biblioitem = $biblio->biblioitem;
696 my $effective_itemtype = $item_object->effective_itemtype;
697 my $dbh = C4::Context->dbh;
698 my $patron_unblessed = $patron->unblessed;
700 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
702 # DUE DATE is OK ? -- should already have checked.
704 if ($duedate && ref $duedate ne 'DateTime') {
705 $duedate = dt_from_string($duedate);
707 my $now = DateTime->now( time_zone => C4::Context->tz() );
708 unless ( $duedate ) {
709 my $issuedate = $now->clone();
711 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
713 # Offline circ calls AddIssue directly, doesn't run through here
714 # So issuingimpossible should be ok.
717 my $fees = Koha::Charges::Fees->new(
720 library => $circ_library,
721 item => $item_object,
727 my $today = $now->clone();
728 $today->truncate( to => 'minute');
729 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
730 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
733 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
739 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
740 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
742 branch => C4::Context->userenv->{'branch'},
744 itemnumber => $item_object->itemnumber,
745 itemtype => $effective_itemtype,
746 borrowernumber => $patron->borrowernumber,
747 ccode => $item_object->ccode}
749 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
750 return( { STATS => 1 }, {});
753 if ( $patron->gonenoaddress == 1 ) {
754 $issuingimpossible{GNA} = 1;
757 if ( $patron->lost == 1 ) {
758 $issuingimpossible{CARD_LOST} = 1;
760 if ( $patron->is_debarred ) {
761 $issuingimpossible{DEBARRED} = 1;
764 if ( $patron->is_expired ) {
765 $issuingimpossible{EXPIRED} = 1;
773 my $account = $patron->account;
774 my $balance = $account->balance;
775 my $non_issues_charges = $account->non_issues_charges;
776 my $other_charges = $balance - $non_issues_charges;
778 my $amountlimit = C4::Context->preference("noissuescharge");
779 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
780 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
782 # Check the debt of this patrons guarantees
783 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
784 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
785 if ( defined $no_issues_charge_guarantees ) {
786 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
787 my $guarantees_non_issues_charges;
788 foreach my $g ( @guarantees ) {
789 $guarantees_non_issues_charges += $g->account->non_issues_charges;
792 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
793 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
794 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
795 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
796 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
797 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
801 if ( C4::Context->preference("IssuingInProcess") ) {
802 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
803 $issuingimpossible{DEBT} = $non_issues_charges;
804 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
805 $needsconfirmation{DEBT} = $non_issues_charges;
806 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
807 $needsconfirmation{DEBT} = $non_issues_charges;
811 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
812 $needsconfirmation{DEBT} = $non_issues_charges;
813 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
814 $issuingimpossible{DEBT} = $non_issues_charges;
815 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
816 $needsconfirmation{DEBT} = $non_issues_charges;
820 if ($balance > 0 && $other_charges > 0) {
821 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
824 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
825 $patron_unblessed = $patron->unblessed;
827 if ( my $debarred_date = $patron->is_debarred ) {
828 # patron has accrued fine days or has a restriction. $count is a date
829 if ($debarred_date eq '9999-12-31') {
830 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
833 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
835 } elsif ( my $num_overdues = $patron->has_overdues ) {
836 ## patron has outstanding overdue loans
837 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
838 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
840 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
841 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
846 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
848 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
850 # Already issued to current borrower.
851 # If it is an on-site checkout if it can be switched to a normal checkout
852 # or ask whether the loan should be renewed
854 if ( $issue->onsite_checkout
855 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
856 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
858 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
859 $patron->borrowernumber,
860 $item_object->itemnumber,
862 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
863 if ( $renewerror eq 'onsite_checkout' ) {
864 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
867 $issuingimpossible{NO_MORE_RENEWALS} = 1;
871 $needsconfirmation{RENEW_ISSUE} = 1;
877 # issued to someone else
879 my $patron = Koha::Patrons->find( $issue->borrowernumber );
881 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
883 unless ( $can_be_returned ) {
884 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
885 $issuingimpossible{branch_to_return} = $message;
887 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
888 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
890 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
891 $needsconfirmation{issued_firstname} = $patron->firstname;
892 $needsconfirmation{issued_surname} = $patron->surname;
893 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
894 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
899 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
901 my $switch_onsite_checkout = (
902 C4::Context->preference('SwitchOnSiteCheckouts')
904 and $issue->onsite_checkout
905 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
906 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
907 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
908 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
909 if ( $toomany->{max_allowed} == 0 ) {
910 $needsconfirmation{PATRON_CANT} = 1;
912 if ( C4::Context->preference("AllowTooManyOverride") ) {
913 $needsconfirmation{TOO_MANY} = $toomany->{reason};
914 $needsconfirmation{current_loan_count} = $toomany->{count};
915 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
917 $issuingimpossible{TOO_MANY} = $toomany->{reason};
918 $issuingimpossible{current_loan_count} = $toomany->{count};
919 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
924 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
926 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
927 my $wants_check = $patron->wants_check_for_previous_checkout;
928 $needsconfirmation{PREVISSUE} = 1
929 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
934 if ( $item_object->notforloan )
936 if(!C4::Context->preference("AllowNotForLoanOverride")){
937 $issuingimpossible{NOT_FOR_LOAN} = 1;
938 $issuingimpossible{item_notforloan} = $item_object->notforloan;
940 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
941 $needsconfirmation{item_notforloan} = $item_object->notforloan;
945 # we have to check itemtypes.notforloan also
946 if (C4::Context->preference('item-level_itypes')){
947 # this should probably be a subroutine
948 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
949 $sth->execute($effective_itemtype);
950 my $notforloan=$sth->fetchrow_hashref();
951 if ($notforloan->{'notforloan'}) {
952 if (!C4::Context->preference("AllowNotForLoanOverride")) {
953 $issuingimpossible{NOT_FOR_LOAN} = 1;
954 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
956 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
957 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
962 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
963 if ( $itemtype and $itemtype->notforloan == 1){
964 if (!C4::Context->preference("AllowNotForLoanOverride")) {
965 $issuingimpossible{NOT_FOR_LOAN} = 1;
966 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
968 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
969 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
974 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
976 $issuingimpossible{WTHDRAWN} = 1;
978 if ( $item_object->restricted
979 && $item_object->restricted == 1 )
981 $issuingimpossible{RESTRICTED} = 1;
983 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
984 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
985 my $code = $av->count ? $av->next->lib : '';
986 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
987 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
989 if ( C4::Context->preference("IndependentBranches") ) {
990 my $userenv = C4::Context->userenv;
991 unless ( C4::Context->IsSuperLibrarian() ) {
992 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
993 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
994 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
995 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
997 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
998 if ( $patron->branchcode ne $userenv->{branch} );
1003 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1005 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1006 if ($rentalConfirmation) {
1007 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1009 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1010 if ($itemtype_object) {
1011 my $accumulate_charge = $fees->accumulate_rentalcharge();
1012 if ( $accumulate_charge > 0 ) {
1013 $rentalCharge += $accumulate_charge;
1017 if ( $rentalCharge > 0 ) {
1018 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1022 unless ( $ignore_reserves ) {
1023 # See if the item is on reserve.
1024 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1026 my $resbor = $res->{'borrowernumber'};
1027 if ( $resbor ne $patron->borrowernumber ) {
1028 my $patron = Koha::Patrons->find( $resbor );
1029 if ( $restype eq "Waiting" )
1031 # The item is on reserve and waiting, but has been
1032 # reserved by some other patron.
1033 $needsconfirmation{RESERVE_WAITING} = 1;
1034 $needsconfirmation{'resfirstname'} = $patron->firstname;
1035 $needsconfirmation{'ressurname'} = $patron->surname;
1036 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1037 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1038 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1039 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1041 elsif ( $restype eq "Reserved" ) {
1042 # The item is on reserve for someone else.
1043 $needsconfirmation{RESERVED} = 1;
1044 $needsconfirmation{'resfirstname'} = $patron->firstname;
1045 $needsconfirmation{'ressurname'} = $patron->surname;
1046 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1047 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1048 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1049 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1055 ## CHECK AGE RESTRICTION
1056 my $agerestriction = $biblioitem->agerestriction;
1057 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1058 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1059 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1060 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1063 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1067 ## check for high holds decreasing loan period
1068 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1069 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1071 if ( $check->{exceeded} ) {
1072 if ($override_high_holds) {
1073 $alerts{HIGHHOLDS} = {
1074 num_holds => $check->{outstanding},
1075 duration => $check->{duration},
1076 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1080 $needsconfirmation{HIGHHOLDS} = {
1081 num_holds => $check->{outstanding},
1082 duration => $check->{duration},
1083 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1090 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1091 # don't do the multiple loans per bib check if we've
1092 # already determined that we've got a loan on the same item
1093 !$issuingimpossible{NO_MORE_RENEWALS} &&
1094 !$needsconfirmation{RENEW_ISSUE}
1096 # Check if borrower has already issued an item from the same biblio
1097 # Only if it's not a subscription
1098 my $biblionumber = $item_object->biblionumber;
1099 require C4::Serials;
1100 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1101 unless ($is_a_subscription) {
1102 # FIXME Should be $patron->checkouts($args);
1103 my $checkouts = Koha::Checkouts->search(
1105 borrowernumber => $patron->borrowernumber,
1106 biblionumber => $biblionumber,
1112 # if we get here, we don't already have a loan on this item,
1113 # so if there are any loans on this bib, ask for confirmation
1114 if ( $checkouts->count ) {
1115 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1120 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1123 =head2 CanBookBeReturned
1125 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1127 Check whether the item can be returned to the provided branch
1131 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1133 =item C<$branch> is the branchcode where the return is taking place
1141 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1143 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1149 sub CanBookBeReturned {
1150 my ($item, $branch) = @_;
1151 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1153 # assume return is allowed to start
1157 # identify all cases where return is forbidden
1158 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1160 $message = $item->{'homebranch'};
1161 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1163 $message = $item->{'holdingbranch'};
1164 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1166 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1169 return ($allowed, $message);
1172 =head2 CheckHighHolds
1174 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1175 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1176 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1180 sub checkHighHolds {
1181 my ( $item, $borrower ) = @_;
1182 my $branchcode = _GetCircControlBranch( $item, $borrower );
1183 my $item_object = Koha::Items->find( $item->{itemnumber} );
1192 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1194 if ( $holds->count() ) {
1195 $return_data->{outstanding} = $holds->count();
1197 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1198 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1199 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1201 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1203 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1205 # static means just more than a given number of holds on the record
1207 # If the number of holds is less than the threshold, we can stop here
1208 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1209 return $return_data;
1212 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1214 # dynamic means X more than the number of holdable items on the record
1216 # let's get the items
1217 my @items = $holds->next()->biblio()->items()->as_list;
1219 # Remove any items with status defined to be ignored even if the would not make item unholdable
1220 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1221 @items = grep { !$_->$status } @items;
1224 # Remove any items that are not holdable for this patron
1225 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber )->{status} eq 'OK' } @items;
1227 my $items_count = scalar @items;
1229 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1231 # If the number of holds is less than the count of items we have
1232 # plus the number of holds allowed above that count, we can stop here
1233 if ( $holds->count() <= $threshold ) {
1234 return $return_data;
1238 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1240 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
1242 my $itype = $item_object->effective_itemtype;
1243 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1245 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1247 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1248 $reduced_datedue->set_hour($orig_due->hour);
1249 $reduced_datedue->set_minute($orig_due->minute);
1250 $reduced_datedue->truncate( to => 'minute' );
1252 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1253 $return_data->{exceeded} = 1;
1254 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1255 $return_data->{due_date} = $reduced_datedue;
1259 return $return_data;
1264 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1266 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1270 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1272 =item C<$barcode> is the barcode of the item being issued.
1274 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1275 Calculated if empty.
1277 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1279 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1280 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1282 AddIssue does the following things :
1284 - step 01: check that there is a borrowernumber & a barcode provided
1285 - check for RENEWAL (book issued & being issued to the same patron)
1286 - renewal YES = Calculate Charge & renew
1288 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1290 - fill reserve if reserve to this patron
1291 - cancel reserve or not, otherwise
1292 * TRANSFERT PENDING ?
1293 - complete the transfert
1301 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1303 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1304 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1305 my $auto_renew = $params && $params->{auto_renew};
1306 my $dbh = C4::Context->dbh;
1307 my $barcodecheck = CheckValidBarcode($barcode);
1311 if ( $datedue && ref $datedue ne 'DateTime' ) {
1312 $datedue = dt_from_string($datedue);
1315 # $issuedate defaults to today.
1316 if ( !defined $issuedate ) {
1317 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1320 if ( ref $issuedate ne 'DateTime' ) {
1321 $issuedate = dt_from_string($issuedate);
1326 # Stop here if the patron or barcode doesn't exist
1327 if ( $borrower && $barcode && $barcodecheck ) {
1328 # find which item we issue
1329 my $item_object = Koha::Items->find({ barcode => $barcode })
1330 or return; # if we don't get an Item, abort.
1331 my $item_unblessed = $item_object->unblessed;
1333 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1335 # get actual issuing if there is one
1336 my $actualissue = $item_object->checkout;
1338 # check if we just renew the issue.
1339 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1340 and not $switch_onsite_checkout ) {
1341 $datedue = AddRenewal(
1342 $borrower->{'borrowernumber'},
1343 $item_object->itemnumber,
1346 $issuedate, # here interpreted as the renewal date
1351 my $itype = $item_object->effective_itemtype;
1352 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1355 $datedue->truncate( to => 'minute' );
1357 my $patron = Koha::Patrons->find( $borrower );
1358 my $library = Koha::Libraries->find( $branchcode );
1359 my $fees = Koha::Charges::Fees->new(
1362 library => $library,
1363 item => $item_object,
1364 to_date => $datedue,
1368 # it's NOT a renewal
1369 if ( $actualissue and not $switch_onsite_checkout ) {
1370 # This book is currently on loan, but not to the person
1371 # who wants to borrow it now. mark it returned before issuing to the new borrower
1372 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1373 return unless $allowed;
1374 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1377 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1379 # Starting process for transfer job (checking transfert and validate it if we have one)
1380 my ($datesent) = GetTransfers( $item_object->itemnumber );
1382 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1383 my $sth = $dbh->prepare(
1384 "UPDATE branchtransfers
1385 SET datearrived = now(),
1387 comments = 'Forced branchtransfer'
1388 WHERE itemnumber= ? AND datearrived IS NULL"
1390 $sth->execute( C4::Context->userenv->{'branch'},
1391 $item_object->itemnumber );
1394 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1395 unless ($auto_renew) {
1396 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1397 { categorycode => $borrower->{categorycode},
1398 itemtype => $item_object->effective_itemtype,
1399 branchcode => $branchcode
1403 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1406 # Record in the database the fact that the book was issued.
1408 my $itype = $item_object->effective_itemtype;
1409 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1412 $datedue->truncate( to => 'minute' );
1414 my $issue_attributes = {
1415 borrowernumber => $borrower->{'borrowernumber'},
1416 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1417 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1418 branchcode => C4::Context->userenv->{'branch'},
1419 onsite_checkout => $onsite_checkout,
1420 auto_renew => $auto_renew ? 1 : 0,
1423 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1425 $issue->set($issue_attributes)->store;
1428 $issue = Koha::Checkout->new(
1430 itemnumber => $item_object->itemnumber,
1435 if ( $item_object->location eq 'CART' && $item_object->permanent_location ne 'CART' ) {
1436 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1437 CartToShelf( $item_object->itemnumber );
1440 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1441 UpdateTotalIssues( $item_object->biblionumber, 1 );
1444 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1445 if ( $item_object->itemlost ) {
1447 Koha::RefundLostItemFeeRules->should_refund(
1449 current_branch => C4::Context->userenv->{branch},
1450 item_home_branch => $item_object->homebranch,
1451 item_holding_branch => $item_object->holdingbranch,
1456 _FixAccountForLostAndReturned( $item_object->itemnumber, undef,
1457 $item_object->barcode );
1463 issues => $item_object->issues + 1,
1464 holdingbranch => C4::Context->userenv->{'branch'},
1466 onloan => $datedue->ymd(),
1467 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1469 $item_object->biblionumber,
1470 $item_object->itemnumber,
1473 ModDateLastSeen( $item_object->itemnumber );
1475 # If it costs to borrow this book, charge it to the patron's account.
1476 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1477 if ( $charge > 0 ) {
1478 AddIssuingCharge( $issue, $charge, 'RENT' );
1481 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1482 if ( $itemtype_object ) {
1483 my $accumulate_charge = $fees->accumulate_rentalcharge();
1484 if ( $accumulate_charge > 0 ) {
1485 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1486 $charge += $accumulate_charge;
1487 $item_unblessed->{charge} = $charge;
1491 # Record the fact that this book was issued.
1494 branch => C4::Context->userenv->{'branch'},
1495 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1497 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1498 itemnumber => $item_object->itemnumber,
1499 itemtype => $item_object->effective_itemtype,
1500 location => $item_object->location,
1501 borrowernumber => $borrower->{'borrowernumber'},
1502 ccode => $item_object->ccode,
1506 # Send a checkout slip.
1507 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1509 branchcode => $branchcode,
1510 categorycode => $borrower->{categorycode},
1511 item_type => $item_object->effective_itemtype,
1512 notification => 'CHECKOUT',
1514 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1515 SendCirculationAlert(
1518 item => $item_object->unblessed,
1519 borrower => $borrower,
1520 branch => $branchcode,
1525 "CIRCULATION", "ISSUE",
1526 $borrower->{'borrowernumber'},
1527 $item_object->itemnumber,
1528 ) if C4::Context->preference("IssueLog");
1534 =head2 GetLoanLength
1536 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1538 Get loan length for an itemtype, a borrower type and a branch
1543 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1544 my $dbh = C4::Context->dbh;
1545 my $sth = $dbh->prepare(qq{
1546 SELECT issuelength, lengthunit, renewalperiod
1548 WHERE categorycode=?
1551 AND issuelength IS NOT NULL
1554 # try to find issuelength & return the 1st available.
1555 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1556 $sth->execute( $borrowertype, $itemtype, $branchcode );
1557 my $loanlength = $sth->fetchrow_hashref;
1560 if defined($loanlength) && defined $loanlength->{issuelength};
1562 $sth->execute( $borrowertype, '*', $branchcode );
1563 $loanlength = $sth->fetchrow_hashref;
1565 if defined($loanlength) && defined $loanlength->{issuelength};
1567 $sth->execute( '*', $itemtype, $branchcode );
1568 $loanlength = $sth->fetchrow_hashref;
1570 if defined($loanlength) && defined $loanlength->{issuelength};
1572 $sth->execute( '*', '*', $branchcode );
1573 $loanlength = $sth->fetchrow_hashref;
1575 if defined($loanlength) && defined $loanlength->{issuelength};
1577 $sth->execute( $borrowertype, $itemtype, '*' );
1578 $loanlength = $sth->fetchrow_hashref;
1580 if defined($loanlength) && defined $loanlength->{issuelength};
1582 $sth->execute( $borrowertype, '*', '*' );
1583 $loanlength = $sth->fetchrow_hashref;
1585 if defined($loanlength) && defined $loanlength->{issuelength};
1587 $sth->execute( '*', $itemtype, '*' );
1588 $loanlength = $sth->fetchrow_hashref;
1590 if defined($loanlength) && defined $loanlength->{issuelength};
1592 $sth->execute( '*', '*', '*' );
1593 $loanlength = $sth->fetchrow_hashref;
1595 if defined($loanlength) && defined $loanlength->{issuelength};
1597 # if no rule is set => 0 day (hardcoded)
1601 lengthunit => 'days',
1607 =head2 GetHardDueDate
1609 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1611 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1615 sub GetHardDueDate {
1616 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1618 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1619 { categorycode => $borrowertype,
1620 itemtype => $itemtype,
1621 branchcode => $branchcode
1626 if ( defined( $issuing_rule ) ) {
1627 if ( $issuing_rule->hardduedate ) {
1628 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1630 return (undef, undef);
1635 =head2 GetBranchBorrowerCircRule
1637 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1639 Retrieves circulation rule attributes that apply to the given
1640 branch and patron category, regardless of item type.
1641 The return value is a hashref containing the following key:
1643 patron_maxissueqty - maximum number of loans that a
1644 patron of the given category can have at the given
1645 branch. If the value is undef, no limit.
1647 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1648 patron of the given category can have at the given
1649 branch. If the value is undef, no limit.
1651 This will check for different branch/category combinations in the following order:
1655 default branch and category
1657 If no rule has been found in the database, it will default to
1660 patron_maxissueqty - undef
1661 patron_maxonsiteissueqty - undef
1663 C<$branchcode> and C<$categorycode> should contain the
1664 literal branch code and patron category code, respectively - no
1669 sub GetBranchBorrowerCircRule {
1670 my ( $branchcode, $categorycode ) = @_;
1672 # Initialize default values
1674 patron_maxissueqty => undef,
1675 patron_maxonsiteissueqty => undef,
1679 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1680 my $rule = Koha::CirculationRules->get_effective_rule(
1682 categorycode => $categorycode,
1684 branchcode => $branchcode,
1685 rule_name => $rule_name,
1689 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1695 =head2 GetBranchItemRule
1697 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1699 Retrieves circulation rule attributes that apply to the given
1700 branch and item type, regardless of patron category.
1702 The return value is a hashref containing the following keys:
1704 holdallowed => Hold policy for this branch and itemtype. Possible values:
1705 0: No holds allowed.
1706 1: Holds allowed only by patrons that have the same homebranch as the item.
1707 2: Holds allowed from any patron.
1709 returnbranch => branch to which to return item. Possible values:
1710 noreturn: do not return, let item remain where checked in (floating collections)
1711 homebranch: return to item's home branch
1712 holdingbranch: return to issuer branch
1714 This searches branchitemrules in the following order:
1716 * Same branchcode and itemtype
1717 * Same branchcode, itemtype '*'
1718 * branchcode '*', same itemtype
1719 * branchcode and itemtype '*'
1721 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1725 sub GetBranchItemRule {
1726 my ( $branchcode, $itemtype ) = @_;
1729 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1731 branchcode => $branchcode,
1732 itemtype => $itemtype,
1733 rule_name => 'holdallowed',
1736 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1738 branchcode => $branchcode,
1739 itemtype => $itemtype,
1740 rule_name => 'hold_fulfillment_policy',
1743 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1745 branchcode => $branchcode,
1746 itemtype => $itemtype,
1747 rule_name => 'returnbranch',
1751 # built-in default circulation rule
1753 $rules->{holdallowed} = defined $holdallowed_rule
1754 ? $holdallowed_rule->rule_value
1756 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1757 ? $hold_fulfillment_policy_rule->rule_value
1759 $rules->{returnbranch} = defined $returnbranch_rule
1760 ? $returnbranch_rule->rule_value
1768 ($doreturn, $messages, $iteminformation, $borrower) =
1769 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1775 =item C<$barcode> is the bar code of the book being returned.
1777 =item C<$branch> is the code of the branch where the book is being returned.
1779 =item C<$exemptfine> indicates that overdue charges for the item will be
1782 =item C<$return_date> allows the default return date to be overridden
1783 by the given return date. Optional.
1787 C<&AddReturn> returns a list of four items:
1789 C<$doreturn> is true iff the return succeeded.
1791 C<$messages> is a reference-to-hash giving feedback on the operation.
1792 The keys of the hash are:
1798 No item with this barcode exists. The value is C<$barcode>.
1802 The book is not currently on loan. The value is C<$barcode>.
1806 This book has been withdrawn/cancelled. The value should be ignored.
1808 =item C<Wrongbranch>
1810 This book has was returned to the wrong branch. The value is a hashref
1811 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1812 contain the branchcode of the incorrect and correct return library, respectively.
1816 The item was reserved. The value is a reference-to-hash whose keys are
1817 fields from the reserves table of the Koha database, and
1818 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1819 either C<Waiting>, C<Reserved>, or 0.
1821 =item C<WasReturned>
1823 Value 1 if return is successful.
1825 =item C<NeedsTransfer>
1827 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1831 C<$iteminformation> is a reference-to-hash, giving information about the
1832 returned item from the issues table.
1834 C<$borrower> is a reference-to-hash, giving information about the
1835 patron who last borrowed the book.
1840 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1842 if ($branch and not Koha::Libraries->find($branch)) {
1843 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1846 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1847 $return_date //= dt_from_string();
1851 my $validTransfert = 0;
1852 my $stat_type = 'return';
1854 # get information on item
1855 my $item = Koha::Items->find({ barcode => $barcode });
1857 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1860 my $itemnumber = $item->itemnumber;
1861 my $itemtype = $item->effective_itemtype;
1863 my $issue = $item->checkout;
1865 $patron = $issue->patron
1866 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1867 . Dumper($issue->unblessed) . "\n";
1869 $messages->{'NotIssued'} = $barcode;
1870 ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1871 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1873 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1874 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1875 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1876 $messages->{'LocalUse'} = 1;
1877 $stat_type = 'localuse';
1881 my $item_unblessed = $item->unblessed;
1882 # full item data, but no borrowernumber or checkout info (no issue)
1883 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1884 # get the proper branch to which to return the item
1885 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1886 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1888 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1889 my $patron_unblessed = $patron ? $patron->unblessed : {};
1891 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1892 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1893 if ($update_loc_rules) {
1894 if (defined $update_loc_rules->{_ALL_}) {
1895 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1896 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1897 if ( $item->location ne $update_loc_rules->{_ALL_}) {
1898 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1899 ModItem( { location => $update_loc_rules->{_ALL_} }, undef, $itemnumber );
1903 foreach my $key ( keys %$update_loc_rules ) {
1904 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1905 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1906 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1907 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1908 ModItem( { location => $update_loc_rules->{$key} }, undef, $itemnumber );
1915 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1917 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1919 eval { $rules = YAML::Load($yaml); };
1921 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1924 foreach my $key ( keys %$rules ) {
1925 if ( $item->notforloan eq $key ) {
1926 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1927 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1934 # check if the return is allowed at this branch
1935 my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1936 unless ($returnallowed){
1937 $messages->{'Wrongbranch'} = {
1938 Wrongbranch => $branch,
1939 Rightbranch => $message
1942 return ( $doreturn, $messages, $issue, $patron_unblessed);
1945 if ( $item->withdrawn ) { # book has been cancelled
1946 $messages->{'withdrawn'} = 1;
1947 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1950 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1954 # case of a return of document (deal with issues and holdingbranch)
1956 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1957 $patron or warn "AddReturn without current borrower";
1961 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1964 if ( C4::Context->preference('CalculateFinesOnReturn') && !$item->itemlost ) {
1965 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1968 carp "The checkin for the following issue failed, Please go to the about page, section 'data corrupted' to know how to fix this problem ($@)" . Dumper( $issue->unblessed );
1970 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1973 # FIXME is the "= 1" right? This could be the borrower hash.
1974 $messages->{'WasReturned'} = 1;
1978 ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1981 # the holdingbranch is updated if the document is returned to another location.
1982 # this is always done regardless of whether the item was on loan or not
1983 my $item_holding_branch = $item->holdingbranch;
1984 if ($item->holdingbranch ne $branch) {
1985 UpdateHoldingbranch($branch, $item->itemnumber);
1986 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1989 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1990 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
1992 # check if we have a transfer for this document
1993 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
1995 # if we have a transfer to do, we update the line of transfers with the datearrived
1996 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
1998 if ( $tobranch eq $branch ) {
1999 my $sth = C4::Context->dbh->prepare(
2000 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2002 $sth->execute( $item->itemnumber );
2003 # if we have a reservation with valid transfer, we can set it's status to 'W'
2004 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2006 $messages->{'WrongTransfer'} = $tobranch;
2007 $messages->{'WrongTransferItem'} = $item->itemnumber;
2009 $validTransfert = 1;
2012 # fix up the accounts.....
2013 if ( $item->itemlost ) {
2014 $messages->{'WasLost'} = 1;
2015 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2017 Koha::RefundLostItemFeeRules->should_refund(
2019 current_branch => C4::Context->userenv->{branch},
2020 item_home_branch => $item->homebranch,
2021 item_holding_branch => $item_holding_branch
2026 _FixAccountForLostAndReturned( $item->itemnumber,
2027 $borrowernumber, $barcode );
2028 $messages->{'LostItemFeeRefunded'} = 1;
2033 # fix up the overdues in accounts...
2034 if ($borrowernumber) {
2035 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2036 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2038 if ( $issue and $issue->is_overdue ) {
2040 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $return_date );
2042 $messages->{'PrevDebarred'} = $debardate;
2044 $messages->{'Debarred'} = $debardate if $debardate;
2046 # there's no overdue on the item but borrower had been previously debarred
2047 } elsif ( $issue->date_due and $patron->debarred ) {
2048 if ( $patron->debarred eq "9999-12-31") {
2049 $messages->{'ForeverDebarred'} = $patron->debarred;
2051 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2052 $borrower_debar_dt->truncate(to => 'day');
2053 my $today_dt = $return_date->clone()->truncate(to => 'day');
2054 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2055 $messages->{'PrevDebarred'} = $patron->debarred;
2061 # find reserves.....
2062 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2063 my ($resfound, $resrec);
2064 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2065 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2067 $resrec->{'ResFound'} = $resfound;
2068 $messages->{'ResFound'} = $resrec;
2071 # Record the fact that this book was returned.
2075 itemnumber => $itemnumber,
2076 itemtype => $itemtype,
2077 borrowernumber => $borrowernumber,
2078 ccode => $item->ccode,
2081 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2083 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2085 branchcode => $branch,
2086 categorycode => $patron->categorycode,
2087 item_type => $itemtype,
2088 notification => 'CHECKIN',
2090 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2091 SendCirculationAlert({
2093 item => $item_unblessed,
2094 borrower => $patron->unblessed,
2099 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2100 if C4::Context->preference("ReturnLog");
2103 # Remove any OVERDUES related debarment if the borrower has no overdues
2104 if ( $borrowernumber
2105 && $patron->debarred
2106 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2107 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2108 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2110 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2113 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2114 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2115 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType");
2116 if (C4::Context->preference("AutomaticItemReturn" ) or
2117 (C4::Context->preference("UseBranchTransferLimits") and
2118 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2120 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2121 $debug and warn "item: " . Dumper($item_unblessed);
2122 ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2123 $messages->{'WasTransfered'} = 1;
2125 $messages->{'NeedsTransfer'} = $returnbranch;
2129 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2130 my $claims = Koha::Checkouts::ReturnClaims->search(
2132 itemnumber => $item->id,
2133 resolution => undef,
2137 if ( $claims->count ) {
2138 $messages->{ReturnClaims} = $claims;
2142 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2145 =head2 MarkIssueReturned
2147 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2149 Unconditionally marks an issue as being returned by
2150 moving the C<issues> row to C<old_issues> and
2151 setting C<returndate> to the current date.
2153 if C<$returndate> is specified (in iso format), it is used as the date
2156 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2157 the old_issue is immediately anonymised
2159 Ideally, this function would be internal to C<C4::Circulation>,
2160 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2161 and offline_circ/process_koc.pl.
2165 sub MarkIssueReturned {
2166 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2168 # Retrieve the issue
2169 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2171 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2173 my $issue_id = $issue->issue_id;
2175 my $anonymouspatron;
2176 if ( $privacy == 2 ) {
2177 # The default of 0 will not work due to foreign key constraints
2178 # The anonymisation will fail if AnonymousPatron is not a valid entry
2179 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2180 # Note that a warning should appear on the about page (System information tab).
2181 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2182 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."
2183 unless Koha::Patrons->find( $anonymouspatron );
2186 my $schema = Koha::Database->schema;
2188 # FIXME Improve the return value and handle it from callers
2189 $schema->txn_do(sub {
2191 # Update the returndate value
2192 if ( $returndate ) {
2193 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2196 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2199 # Create the old_issues entry
2200 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2202 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2203 if ( $privacy == 2) {
2204 $old_checkout->borrowernumber($anonymouspatron)->store;
2207 # And finally delete the issue
2210 ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2212 if ( C4::Context->preference('StoreLastBorrower') ) {
2213 my $item = Koha::Items->find( $itemnumber );
2214 my $patron = Koha::Patrons->find( $borrowernumber );
2215 $item->last_returned_by( $patron );
2222 =head2 _debar_user_on_return
2224 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2226 C<$borrower> borrower hashref
2228 C<$item> item hashref
2230 C<$datedue> date due DateTime object
2232 C<$returndate> DateTime object representing the return time
2234 Internal function, called only by AddReturn that calculates and updates
2235 the user fine days, and debars them if necessary.
2237 Should only be called for overdue returns
2239 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2244 sub _calculate_new_debar_dt {
2245 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2247 my $branchcode = _GetCircControlBranch( $item, $borrower );
2248 my $circcontrol = C4::Context->preference('CircControl');
2249 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2250 { categorycode => $borrower->{categorycode},
2251 itemtype => $item->{itype},
2252 branchcode => $branchcode
2255 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2256 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2257 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2259 return unless $finedays;
2261 # finedays is in days, so hourly loans must multiply by 24
2262 # thus 1 hour late equals 1 day suspension * finedays rate
2263 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2265 # grace period is measured in the same units as the loan
2267 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2269 my $deltadays = DateTime::Duration->new(
2270 days => $chargeable_units
2273 if ( $deltadays->subtract($grace)->is_positive() ) {
2274 my $suspension_days = $deltadays * $finedays;
2276 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2277 # No need to / 1 and do not consider / 0
2278 $suspension_days = DateTime::Duration->new(
2279 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2283 # If the max suspension days is < than the suspension days
2284 # the suspension days is limited to this maximum period.
2285 my $max_sd = $issuing_rule->maxsuspensiondays;
2286 if ( defined $max_sd ) {
2287 $max_sd = DateTime::Duration->new( days => $max_sd );
2288 $suspension_days = $max_sd
2289 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2292 my ( $has_been_extended );
2293 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2294 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2296 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2297 $has_been_extended = 1;
2302 # Use the calendar or not to calculate the debarment date
2303 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2304 my $calendar = Koha::Calendar->new(
2305 branchcode => $branchcode,
2306 days_mode => 'Calendar'
2308 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2311 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2313 return $new_debar_dt;
2318 sub _debar_user_on_return {
2319 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2321 $return_date //= dt_from_string();
2323 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2325 return unless $new_debar_dt;
2327 Koha::Patron::Debarments::AddUniqueDebarment({
2328 borrowernumber => $borrower->{borrowernumber},
2329 expiration => $new_debar_dt->ymd(),
2330 type => 'SUSPENSION',
2332 # if borrower was already debarred but does not get an extra debarment
2333 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2334 my ($new_debarment_str, $is_a_reminder);
2335 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2337 $new_debarment_str = $borrower->{debarred};
2339 $new_debarment_str = $new_debar_dt->ymd();
2341 # FIXME Should return a DateTime object
2342 return $new_debarment_str, $is_a_reminder;
2345 =head2 _FixOverduesOnReturn
2347 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2349 C<$borrowernumber> borrowernumber
2351 C<$itemnumber> itemnumber
2353 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2355 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2361 sub _FixOverduesOnReturn {
2362 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2363 unless( $borrowernumber ) {
2364 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2368 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2372 warn "_FixOverduesOnReturn() not supplied valid status";
2376 my $schema = Koha::Database->schema;
2378 my $result = $schema->txn_do(
2380 # check for overdue fine
2381 my $accountlines = Koha::Account::Lines->search(
2383 borrowernumber => $borrowernumber,
2384 itemnumber => $item,
2385 debit_type_code => 'OVERDUE',
2386 status => 'UNRETURNED'
2389 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2391 my $accountline = $accountlines->next;
2393 my $amountoutstanding = $accountline->amountoutstanding;
2395 my $account = Koha::Account->new({patron_id => $borrowernumber});
2396 my $credit = $account->add_credit(
2398 amount => $amountoutstanding,
2399 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2400 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2401 interface => C4::Context->interface,
2407 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2409 $accountline->status('FORGIVEN');
2411 if (C4::Context->preference("FinesLog")) {
2412 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2415 $accountline->status($status);
2418 return $accountline->store();
2425 =head2 _FixAccountForLostAndReturned
2427 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2429 Finds the most recent lost item charge for this item and refunds the borrower
2430 appropriatly, taking into account any payments or writeoffs already applied
2433 Internal function, not exported, called only by AddReturn.
2437 sub _FixAccountForLostAndReturned {
2438 my $itemnumber = shift or return;
2439 my $borrowernumber = @_ ? shift : undef;
2440 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2444 # check for charge made for lost book
2445 my $accountlines = Koha::Account::Lines->search(
2447 itemnumber => $itemnumber,
2448 debit_type_code => 'LOST',
2449 status => [ undef, { '<>' => 'RETURNED' } ]
2452 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2456 return unless $accountlines->count > 0;
2457 my $accountline = $accountlines->next;
2458 my $total_to_refund = 0;
2460 return unless $accountline->borrowernumber;
2461 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2462 return unless $patron; # Patron has been deleted, nobody to credit the return to
2464 my $account = $patron->account;
2467 if ( $accountline->amount > $accountline->amountoutstanding ) {
2468 # some amount has been cancelled. collect the offsets that are not writeoffs
2469 # this works because the only way to subtract from this kind of a debt is
2470 # using the UI buttons 'Pay' and 'Write off'
2471 my $credits_offsets = Koha::Account::Offsets->search({
2472 debit_id => $accountline->id,
2473 credit_id => { '!=' => undef }, # it is not the debit itself
2474 type => { '!=' => 'Writeoff' },
2475 amount => { '<' => 0 } # credits are negative on the DB
2478 $total_to_refund = ( $credits_offsets->count > 0 )
2479 ? $credits_offsets->total * -1 # credits are negative on the DB
2483 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2485 if ( $credit_total > 0 ) {
2486 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2487 $credit = $account->add_credit(
2488 { amount => $credit_total,
2489 description => 'Item Returned ' . $item_id,
2490 type => 'LOST_RETURN',
2491 interface => C4::Context->interface,
2492 library_id => $branchcode
2496 $credit->apply( { debits => [ $accountline ] } );
2499 # Update the account status
2500 $accountline->discard_changes->status('RETURNED');
2501 $accountline->store;
2503 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2504 $account->reconcile_balance;
2507 return ($credit) ? $credit->id : undef;
2510 =head2 _GetCircControlBranch
2512 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2516 Return the library code to be used to determine which circulation
2517 policy applies to a transaction. Looks up the CircControl and
2518 HomeOrHoldingBranch system preferences.
2520 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2522 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2526 sub _GetCircControlBranch {
2527 my ($item, $borrower) = @_;
2528 my $circcontrol = C4::Context->preference('CircControl');
2531 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2532 $branch= C4::Context->userenv->{'branch'};
2533 } elsif ($circcontrol eq 'PatronLibrary') {
2534 $branch=$borrower->{branchcode};
2536 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2537 $branch = $item->{$branchfield};
2538 # default to item home branch if holdingbranch is used
2539 # and is not defined
2540 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2541 $branch = $item->{homebranch};
2549 $issue = GetOpenIssue( $itemnumber );
2551 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2553 C<$itemnumber> is the item's itemnumber
2560 my ( $itemnumber ) = @_;
2561 return unless $itemnumber;
2562 my $dbh = C4::Context->dbh;
2563 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2564 $sth->execute( $itemnumber );
2565 return $sth->fetchrow_hashref();
2569 =head2 GetBiblioIssues
2571 $issues = GetBiblioIssues($biblionumber);
2573 this function get all issues from a biblionumber.
2576 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2577 tables issues and the firstname,surname & cardnumber from borrowers.
2581 sub GetBiblioIssues {
2582 my $biblionumber = shift;
2583 return unless $biblionumber;
2584 my $dbh = C4::Context->dbh;
2586 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2588 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2589 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2590 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2591 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2592 WHERE biblio.biblionumber = ?
2594 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2596 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2597 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2598 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2599 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2600 WHERE biblio.biblionumber = ?
2603 my $sth = $dbh->prepare($query);
2604 $sth->execute($biblionumber, $biblionumber);
2607 while ( my $data = $sth->fetchrow_hashref ) {
2608 push @issues, $data;
2613 =head2 GetUpcomingDueIssues
2615 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2619 sub GetUpcomingDueIssues {
2622 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2623 my $dbh = C4::Context->dbh;
2625 my $statement = <<END_SQL;
2628 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2630 LEFT JOIN items USING (itemnumber)
2631 LEFT OUTER JOIN branches USING (branchcode)
2632 WHERE returndate is NULL
2634 WHERE days_until_due >= 0 AND days_until_due <= ?
2637 my @bind_parameters = ( $params->{'days_in_advance'} );
2639 my $sth = $dbh->prepare( $statement );
2640 $sth->execute( @bind_parameters );
2641 my $upcoming_dues = $sth->fetchall_arrayref({});
2643 return $upcoming_dues;
2646 =head2 CanBookBeRenewed
2648 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2650 Find out whether a borrowed item may be renewed.
2652 C<$borrowernumber> is the borrower number of the patron who currently
2653 has the item on loan.
2655 C<$itemnumber> is the number of the item to renew.
2657 C<$override_limit>, if supplied with a true value, causes
2658 the limit on the number of times that the loan can be renewed
2659 (as controlled by the item type) to be ignored. Overriding also allows
2660 to renew sooner than "No renewal before" and to manually renew loans
2661 that are automatically renewed.
2663 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2664 item must currently be on loan to the specified borrower; renewals
2665 must be allowed for the item's type; and the borrower must not have
2666 already renewed the loan. $error will contain the reason the renewal can not proceed
2670 sub CanBookBeRenewed {
2671 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2673 my $dbh = C4::Context->dbh;
2676 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2677 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2678 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2679 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2681 my $patron = $issue->patron or return;
2683 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2685 # This item can fill one or more unfilled reserve, can those unfilled reserves
2686 # all be filled by other available items?
2688 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2690 my $schema = Koha::Database->new()->schema();
2692 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2694 # There is an item level hold on this item, no other item can fill the hold
2699 # Get all other items that could possibly fill reserves
2700 my @itemnumbers = $schema->resultset('Item')->search(
2702 biblionumber => $resrec->{biblionumber},
2705 -not => { itemnumber => $itemnumber }
2707 { columns => 'itemnumber' }
2708 )->get_column('itemnumber')->all();
2710 # Get all other reserves that could have been filled by this item
2711 my @borrowernumbers;
2713 my ( $reserve_found, $reserve, undef ) =
2714 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2716 if ($reserve_found) {
2717 push( @borrowernumbers, $reserve->{borrowernumber} );
2724 # If the count of the union of the lists of reservable items for each borrower
2725 # is equal or greater than the number of borrowers, we know that all reserves
2726 # can be filled with available items. We can get the union of the sets simply
2727 # by pushing all the elements onto an array and removing the duplicates.
2730 ITEM: foreach my $itemnumber (@itemnumbers) {
2731 my $item = Koha::Items->find( $itemnumber );
2732 next if IsItemOnHoldAndFound( $itemnumber );
2733 for my $borrowernumber (@borrowernumbers) {
2734 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2735 next unless IsAvailableForItemLevelRequest($item, $patron);
2736 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2738 push @reservable, $itemnumber;
2739 if (@reservable >= @borrowernumbers) {
2748 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2750 return ( 1, undef ) if $override_limit;
2752 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2753 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2754 { categorycode => $patron->categorycode,
2755 itemtype => $item->effective_itemtype,
2756 branchcode => $branchcode
2760 return ( 0, "too_many" )
2761 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2763 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2764 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2765 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2766 my $restricted = $patron->is_debarred;
2767 my $hasoverdues = $patron->has_overdues;
2769 if ( $restricted and $restrictionblockrenewing ) {
2770 return ( 0, 'restriction');
2771 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2772 return ( 0, 'overdue');
2775 if ( $issue->auto_renew ) {
2777 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2778 return ( 0, 'auto_account_expired' );
2781 if ( defined $issuing_rule->no_auto_renewal_after
2782 and $issuing_rule->no_auto_renewal_after ne "" ) {
2783 # Get issue_date and add no_auto_renewal_after
2784 # If this is greater than today, it's too late for renewal.
2785 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2786 $maximum_renewal_date->add(
2787 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2789 my $now = dt_from_string;
2790 if ( $now >= $maximum_renewal_date ) {
2791 return ( 0, "auto_too_late" );
2794 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2795 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2796 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2797 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2798 return ( 0, "auto_too_late" );
2802 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2803 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2804 my $amountoutstanding =
2805 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2806 ? $patron->account->balance
2807 : $patron->account->outstanding_debits->total_outstanding;
2808 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2809 return ( 0, "auto_too_much_oweing" );
2814 if ( defined $issuing_rule->norenewalbefore
2815 and $issuing_rule->norenewalbefore ne "" )
2818 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2819 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2820 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2822 # Depending on syspref reset the exact time, only check the date
2823 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2824 and $issuing_rule->lengthunit eq 'days' )
2826 $soonestrenewal->truncate( to => 'day' );
2829 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2831 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2832 return ( 0, "too_soon" );
2834 elsif ( $issue->auto_renew ) {
2835 return ( 0, "auto_renew" );
2839 # Fallback for automatic renewals:
2840 # If norenewalbefore is undef, don't renew before due date.
2841 if ( $issue->auto_renew ) {
2842 my $now = dt_from_string;
2843 return ( 0, "auto_renew" )
2844 if $now >= dt_from_string( $issue->date_due, 'sql' );
2845 return ( 0, "auto_too_soon" );
2848 return ( 1, undef );
2853 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2857 C<$borrowernumber> is the borrower number of the patron who currently
2860 C<$itemnumber> is the number of the item to renew.
2862 C<$branch> is the library where the renewal took place (if any).
2863 The library that controls the circ policies for the renewal is retrieved from the issues record.
2865 C<$datedue> can be a DateTime object used to set the due date.
2867 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2868 this parameter is not supplied, lastreneweddate is set to the current date.
2870 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2871 from the book's item type.
2876 my $borrowernumber = shift;
2877 my $itemnumber = shift or return;
2879 my $datedue = shift;
2880 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2882 my $item_object = Koha::Items->find($itemnumber) or return;
2883 my $biblio = $item_object->biblio;
2884 my $issue = $item_object->checkout;
2885 my $item_unblessed = $item_object->unblessed;
2887 my $dbh = C4::Context->dbh;
2889 return unless $issue;
2891 $borrowernumber ||= $issue->borrowernumber;
2893 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2894 carp 'Invalid date passed to AddRenewal.';
2898 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2899 my $patron_unblessed = $patron->unblessed;
2901 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2903 my $schema = Koha::Database->schema;
2904 $schema->txn_do(sub{
2906 if ( C4::Context->preference('CalculateFinesOnReturn') ) {
2907 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2909 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2911 # If the due date wasn't specified, calculate it by adding the
2912 # book's loan length to today's date or the current due date
2913 # based on the value of the RenewalPeriodBase syspref.
2914 my $itemtype = $item_object->effective_itemtype;
2917 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2918 dt_from_string( $issue->date_due, 'sql' ) :
2919 DateTime->now( time_zone => C4::Context->tz());
2920 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2923 my $fees = Koha::Charges::Fees->new(
2926 library => $circ_library,
2927 item => $item_object,
2928 from_date => dt_from_string( $issue->date_due, 'sql' ),
2929 to_date => dt_from_string($datedue),
2933 # Update the issues record to have the new due date, and a new count
2934 # of how many times it has been renewed.
2935 my $renews = $issue->renewals + 1;
2936 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2937 WHERE borrowernumber=?
2941 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2943 # Update the renewal count on the item, and tell zebra to reindex
2944 $renews = $item_object->renewals + 1;
2945 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2947 # Charge a new rental fee, if applicable
2948 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2949 if ( $charge > 0 ) {
2950 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
2953 # Charge a new accumulate rental fee, if applicable
2954 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2955 if ( $itemtype_object ) {
2956 my $accumulate_charge = $fees->accumulate_rentalcharge();
2957 if ( $accumulate_charge > 0 ) {
2958 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
2960 $charge += $accumulate_charge;
2963 # Send a renewal slip according to checkout alert preferencei
2964 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2965 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2967 branchcode => $branch,
2968 categorycode => $patron->categorycode,
2969 item_type => $itemtype,
2970 notification => 'CHECKOUT',
2972 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2973 SendCirculationAlert(
2976 item => $item_unblessed,
2977 borrower => $patron->unblessed,
2984 # Remove any OVERDUES related debarment if the borrower has no overdues
2986 && $patron->is_debarred
2987 && ! $patron->has_overdues
2988 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2990 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2993 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2994 $branch = ( C4::Context->userenv && defined C4::Context->userenv->{branch} ) ? C4::Context->userenv->{branch} : $branch;
2997 # Add the renewal to stats
3003 itemnumber => $itemnumber,
3004 itemtype => $itemtype,
3005 location => $item_object->location,
3006 borrowernumber => $borrowernumber,
3007 ccode => $item_object->ccode,
3012 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3019 # check renewal status
3020 my ( $bornum, $itemno ) = @_;
3021 my $dbh = C4::Context->dbh;
3023 my $renewsallowed = 0;
3026 my $patron = Koha::Patrons->find( $bornum );
3027 my $item = Koha::Items->find($itemno);
3029 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3031 # Look in the issues table for this item, lent to this borrower,
3032 # and not yet returned.
3034 # FIXME - I think this function could be redone to use only one SQL call.
3035 my $sth = $dbh->prepare(
3036 "select * from issues
3037 where (borrowernumber = ?)
3038 and (itemnumber = ?)"
3040 $sth->execute( $bornum, $itemno );
3041 my $data = $sth->fetchrow_hashref;
3042 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3043 # $item and $borrower should be calculated
3044 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3046 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3047 { categorycode => $patron->categorycode,
3048 itemtype => $item->effective_itemtype,
3049 branchcode => $branchcode
3053 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3054 $renewsleft = $renewsallowed - $renewcount;
3055 if($renewsleft < 0){ $renewsleft = 0; }
3056 return ( $renewcount, $renewsallowed, $renewsleft );
3059 =head2 GetSoonestRenewDate
3061 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3063 Find out the soonest possible renew date of a borrowed item.
3065 C<$borrowernumber> is the borrower number of the patron who currently
3066 has the item on loan.
3068 C<$itemnumber> is the number of the item to renew.
3070 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3071 renew date, based on the value "No renewal before" of the applicable
3072 issuing rule. Returns the current date if the item can already be
3073 renewed, and returns undefined if the borrower, loan, or item
3078 sub GetSoonestRenewDate {
3079 my ( $borrowernumber, $itemnumber ) = @_;
3081 my $dbh = C4::Context->dbh;
3083 my $item = Koha::Items->find($itemnumber) or return;
3084 my $itemissue = $item->checkout or return;
3086 $borrowernumber ||= $itemissue->borrowernumber;
3087 my $patron = Koha::Patrons->find( $borrowernumber )
3090 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3091 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3092 { categorycode => $patron->categorycode,
3093 itemtype => $item->effective_itemtype,
3094 branchcode => $branchcode
3098 my $now = dt_from_string;
3099 return $now unless $issuing_rule;
3101 if ( defined $issuing_rule->norenewalbefore
3102 and $issuing_rule->norenewalbefore ne "" )
3104 my $soonestrenewal =
3105 dt_from_string( $itemissue->date_due )->subtract(
3106 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3108 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3109 and $issuing_rule->lengthunit eq 'days' )
3111 $soonestrenewal->truncate( to => 'day' );
3113 return $soonestrenewal if $now < $soonestrenewal;
3118 =head2 GetLatestAutoRenewDate
3120 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3122 Find out the latest possible auto renew date of a borrowed item.
3124 C<$borrowernumber> is the borrower number of the patron who currently
3125 has the item on loan.
3127 C<$itemnumber> is the number of the item to renew.
3129 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3130 auto renew date, based on the value "No auto renewal after" and the "No auto
3131 renewal after (hard limit) of the applicable issuing rule.
3132 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3133 or item cannot be found.
3137 sub GetLatestAutoRenewDate {
3138 my ( $borrowernumber, $itemnumber ) = @_;
3140 my $dbh = C4::Context->dbh;
3142 my $item = Koha::Items->find($itemnumber) or return;
3143 my $itemissue = $item->checkout or return;
3145 $borrowernumber ||= $itemissue->borrowernumber;
3146 my $patron = Koha::Patrons->find( $borrowernumber )
3149 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3150 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3151 { categorycode => $patron->categorycode,
3152 itemtype => $item->effective_itemtype,
3153 branchcode => $branchcode
3157 return unless $issuing_rule;
3159 if ( not $issuing_rule->no_auto_renewal_after
3160 or $issuing_rule->no_auto_renewal_after eq '' )
3161 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3162 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3164 my $maximum_renewal_date;
3165 if ( $issuing_rule->no_auto_renewal_after ) {
3166 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3167 $maximum_renewal_date->add(
3168 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3172 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3173 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3174 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3176 return $maximum_renewal_date;
3180 =head2 GetIssuingCharges
3182 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3184 Calculate how much it would cost for a given patron to borrow a given
3185 item, including any applicable discounts.
3187 C<$itemnumber> is the item number of item the patron wishes to borrow.
3189 C<$borrowernumber> is the patron's borrower number.
3191 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3192 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3197 sub GetIssuingCharges {
3199 # calculate charges due
3200 my ( $itemnumber, $borrowernumber ) = @_;
3202 my $dbh = C4::Context->dbh;
3205 # Get the book's item type and rental charge (via its biblioitem).
3206 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3207 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3208 $charge_query .= (C4::Context->preference('item-level_itypes'))
3209 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3210 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3212 $charge_query .= ' WHERE items.itemnumber =?';
3214 my $sth = $dbh->prepare($charge_query);
3215 $sth->execute($itemnumber);
3216 if ( my $item_data = $sth->fetchrow_hashref ) {
3217 $item_type = $item_data->{itemtype};
3218 $charge = $item_data->{rentalcharge};
3219 my $branch = C4::Context::mybranch();
3220 my $discount_query = q|SELECT rentaldiscount,
3221 issuingrules.itemtype, issuingrules.branchcode
3223 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3224 WHERE borrowers.borrowernumber = ?
3225 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3226 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3227 my $discount_sth = $dbh->prepare($discount_query);
3228 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3229 my $discount_rules = $discount_sth->fetchall_arrayref({});
3230 if (@{$discount_rules}) {
3231 # We may have multiple rules so get the most specific
3232 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3233 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3236 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3240 return ( $charge, $item_type );
3243 # Select most appropriate discount rule from those returned
3244 sub _get_discount_from_rule {
3245 my ($rules_ref, $branch, $itemtype) = @_;
3248 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3249 $discount = $rules_ref->[0]->{rentaldiscount};
3250 return (defined $discount) ? $discount : 0;
3252 # could have up to 4 does one match $branch and $itemtype
3253 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3255 $discount = $d[0]->{rentaldiscount};
3256 return (defined $discount) ? $discount : 0;
3258 # do we have item type + all branches
3259 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3261 $discount = $d[0]->{rentaldiscount};
3262 return (defined $discount) ? $discount : 0;
3264 # do we all item types + this branch
3265 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3267 $discount = $d[0]->{rentaldiscount};
3268 return (defined $discount) ? $discount : 0;
3270 # so all and all (surely we wont get here)
3271 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3273 $discount = $d[0]->{rentaldiscount};
3274 return (defined $discount) ? $discount : 0;
3280 =head2 AddIssuingCharge
3282 &AddIssuingCharge( $checkout, $charge, $type )
3286 sub AddIssuingCharge {
3287 my ( $checkout, $charge, $type ) = @_;
3289 # FIXME What if checkout does not exist?
3291 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3292 my $accountline = $account->add_debit(
3296 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3297 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3298 interface => C4::Context->interface,
3300 item_id => $checkout->itemnumber,
3301 issue_id => $checkout->issue_id,
3308 GetTransfers($itemnumber);
3313 my ($itemnumber) = @_;
3315 my $dbh = C4::Context->dbh;
3322 FROM branchtransfers
3323 WHERE itemnumber = ?
3324 AND datearrived IS NULL
3326 my $sth = $dbh->prepare($query);
3327 $sth->execute($itemnumber);
3328 my @row = $sth->fetchrow_array();
3332 =head2 GetTransfersFromTo
3334 @results = GetTransfersFromTo($frombranch,$tobranch);
3336 Returns the list of pending transfers between $from and $to branch
3340 sub GetTransfersFromTo {
3341 my ( $frombranch, $tobranch ) = @_;
3342 return unless ( $frombranch && $tobranch );
3343 my $dbh = C4::Context->dbh;
3345 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3346 FROM branchtransfers
3349 AND datearrived IS NULL
3351 my $sth = $dbh->prepare($query);
3352 $sth->execute( $frombranch, $tobranch );
3355 while ( my $data = $sth->fetchrow_hashref ) {
3356 push @gettransfers, $data;
3358 return (@gettransfers);
3361 =head2 DeleteTransfer
3363 &DeleteTransfer($itemnumber);
3367 sub DeleteTransfer {
3368 my ($itemnumber) = @_;
3369 return unless $itemnumber;
3370 my $dbh = C4::Context->dbh;
3371 my $sth = $dbh->prepare(
3372 "DELETE FROM branchtransfers
3374 AND datearrived IS NULL "
3376 return $sth->execute($itemnumber);
3379 =head2 SendCirculationAlert
3381 Send out a C<check-in> or C<checkout> alert using the messaging system.
3389 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3393 Hashref of information about the item being checked in or out.
3397 Hashref of information about the borrower of the item.
3401 The branchcode from where the checkout or check-in took place.
3407 SendCirculationAlert({
3410 borrower => $borrower,
3416 sub SendCirculationAlert {
3418 my ($type, $item, $borrower, $branch) =
3419 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3420 my %message_name = (
3421 CHECKIN => 'Item_Check_in',
3422 CHECKOUT => 'Item_Checkout',
3423 RENEWAL => 'Item_Checkout',
3425 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3426 borrowernumber => $borrower->{borrowernumber},
3427 message_name => $message_name{$type},
3429 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3431 my $schema = Koha::Database->new->schema;
3432 my @transports = keys %{ $borrower_preferences->{transports} };
3434 # From the MySQL doc:
3435 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3436 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3437 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3438 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3440 for my $mtt (@transports) {
3441 my $letter = C4::Letters::GetPreparedLetter (
3442 module => 'circulation',
3443 letter_code => $type,
3444 branchcode => $branch,
3445 message_transport_type => $mtt,
3446 lang => $borrower->{lang},
3448 $issues_table => $item->{itemnumber},
3449 'items' => $item->{itemnumber},
3450 'biblio' => $item->{biblionumber},
3451 'biblioitems' => $item->{biblionumber},
3452 'borrowers' => $borrower,
3453 'branches' => $branch,
3457 $schema->storage->txn_begin;
3458 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3459 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3460 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3461 unless ( $message ) {
3462 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3463 C4::Message->enqueue($letter, $borrower, $mtt);
3465 $message->append($letter);
3468 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3469 $schema->storage->txn_commit;
3475 =head2 updateWrongTransfer
3477 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3479 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
3483 sub updateWrongTransfer {
3484 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3485 my $dbh = C4::Context->dbh;
3486 # first step validate the actual line of transfert .
3489 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3491 $sth->execute($FromLibrary,$itemNumber);
3493 # second step create a new line of branchtransfer to the right location .
3494 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3496 #third step changing holdingbranch of item
3497 UpdateHoldingbranch($FromLibrary,$itemNumber);
3500 =head2 UpdateHoldingbranch
3502 $items = UpdateHoldingbranch($branch,$itmenumber);
3504 Simple methode for updating hodlingbranch in items BDD line
3508 sub UpdateHoldingbranch {
3509 my ( $branch,$itemnumber ) = @_;
3510 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3515 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3517 this function calculates the due date given the start date and configured circulation rules,
3518 checking against the holidays calendar as per the 'useDaysMode' syspref.
3519 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3520 C<$itemtype> = itemtype code of item in question
3521 C<$branch> = location whose calendar to use
3522 C<$borrower> = Borrower object
3523 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3528 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3532 # loanlength now a href
3534 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3536 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3542 if (ref $startdate ne 'DateTime' ) {
3543 $datedue = dt_from_string($datedue);
3545 $datedue = $startdate->clone;
3549 DateTime->now( time_zone => C4::Context->tz() )
3550 ->truncate( to => 'minute' );
3554 # calculate the datedue as normal
3555 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3556 { # ignoring calendar
3557 if ( $loanlength->{lengthunit} eq 'hours' ) {
3558 $datedue->add( hours => $loanlength->{$length_key} );
3560 $datedue->add( days => $loanlength->{$length_key} );
3561 $datedue->set_hour(23);
3562 $datedue->set_minute(59);
3566 if ($loanlength->{lengthunit} eq 'hours') {
3567 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3570 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3572 my $calendar = Koha::Calendar->new( branchcode => $branch );
3573 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3574 if ($loanlength->{lengthunit} eq 'days') {
3575 $datedue->set_hour(23);
3576 $datedue->set_minute(59);
3580 # if Hard Due Dates are used, retrieve them and apply as necessary
3581 my ( $hardduedate, $hardduedatecompare ) =
3582 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3583 if ($hardduedate) { # hardduedates are currently dates
3584 $hardduedate->truncate( to => 'minute' );
3585 $hardduedate->set_hour(23);
3586 $hardduedate->set_minute(59);
3587 my $cmp = DateTime->compare( $hardduedate, $datedue );
3589 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3590 # if the calculated date is before the 'after' Hard Due Date (floor), override
3591 # if the hard due date is set to 'exactly', overrride
3592 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3593 $datedue = $hardduedate->clone;
3596 # in all other cases, keep the date due as it is
3600 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3601 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3602 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3603 if( $expiry_dt ) { #skip empty expiry date..
3604 $expiry_dt->set( hour => 23, minute => 59);
3605 my $d1= $datedue->clone->set_time_zone('floating');
3606 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3607 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3610 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3611 my $calendar = Koha::Calendar->new( branchcode => $branch );
3612 if ( $calendar->is_holiday($datedue) ) {
3613 # Don't return on a closed day
3614 $datedue = $calendar->prev_open_days( $datedue, 1 );
3623 sub CheckValidBarcode{
3625 my $dbh = C4::Context->dbh;
3626 my $query=qq|SELECT count(*)
3630 my $sth = $dbh->prepare($query);
3631 $sth->execute($barcode);
3632 my $exist=$sth->fetchrow ;
3636 =head2 IsBranchTransferAllowed
3638 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3640 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3642 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3643 Koha::Item->can_be_transferred.
3647 sub IsBranchTransferAllowed {
3648 my ( $toBranch, $fromBranch, $code ) = @_;
3650 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3652 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3653 my $dbh = C4::Context->dbh;
3655 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3656 $sth->execute( $toBranch, $fromBranch, $code );
3657 my $limit = $sth->fetchrow_hashref();
3659 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3660 if ( $limit->{'limitId'} ) {
3667 =head2 CreateBranchTransferLimit
3669 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3671 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3673 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3677 sub CreateBranchTransferLimit {
3678 my ( $toBranch, $fromBranch, $code ) = @_;
3679 return unless defined($toBranch) && defined($fromBranch);
3680 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3682 my $dbh = C4::Context->dbh;
3684 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3685 return $sth->execute( $code, $toBranch, $fromBranch );
3688 =head2 DeleteBranchTransferLimits
3690 my $result = DeleteBranchTransferLimits($frombranch);
3692 Deletes all the library transfer limits for one library. Returns the
3693 number of limits deleted, 0e0 if no limits were deleted, or undef if
3694 no arguments are supplied.
3696 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3697 fromBranch => $fromBranch
3702 sub DeleteBranchTransferLimits {
3704 return unless defined $branch;
3705 my $dbh = C4::Context->dbh;
3706 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3707 return $sth->execute($branch);
3711 my ( $borrowernumber, $itemnum ) = @_;
3712 MarkIssueReturned( $borrowernumber, $itemnum );
3717 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3719 unless ( $mark_lost_from ) {
3720 # Temporary check to avoid regressions
3721 die q|LostItem called without $mark_lost_from, check the API.|;
3725 if ( $force_mark_returned ) {
3728 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3729 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3732 my $dbh = C4::Context->dbh();
3733 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3735 JOIN items USING (itemnumber)
3736 JOIN biblio USING (biblionumber)
3737 WHERE issues.itemnumber=?");
3738 $sth->execute($itemnumber);
3739 my $issues=$sth->fetchrow_hashref();
3741 # If a borrower lost the item, add a replacement cost to the their record
3742 if ( my $borrowernumber = $issues->{borrowernumber} ){
3743 my $patron = Koha::Patrons->find( $borrowernumber );
3745 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3746 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3748 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3749 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "$issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3750 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3751 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3754 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3757 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3758 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3759 ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3761 my $transferdeleted = DeleteTransfer($itemnumber);
3764 sub GetOfflineOperations {
3765 my $dbh = C4::Context->dbh;
3766 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3767 $sth->execute(C4::Context->userenv->{'branch'});
3768 my $results = $sth->fetchall_arrayref({});
3772 sub GetOfflineOperation {
3773 my $operationid = shift;
3774 return unless $operationid;
3775 my $dbh = C4::Context->dbh;
3776 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3777 $sth->execute( $operationid );
3778 return $sth->fetchrow_hashref;
3781 sub AddOfflineOperation {
3782 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3783 my $dbh = C4::Context->dbh;
3784 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3785 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3789 sub DeleteOfflineOperation {
3790 my $dbh = C4::Context->dbh;
3791 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3792 $sth->execute( shift );
3796 sub ProcessOfflineOperation {
3797 my $operation = shift;
3800 if ( $operation->{action} eq 'return' ) {
3801 $report = ProcessOfflineReturn( $operation );
3802 } elsif ( $operation->{action} eq 'issue' ) {
3803 $report = ProcessOfflineIssue( $operation );
3804 } elsif ( $operation->{action} eq 'payment' ) {
3805 $report = ProcessOfflinePayment( $operation );
3808 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3813 sub ProcessOfflineReturn {
3814 my $operation = shift;
3816 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3819 my $itemnumber = $item->itemnumber;
3820 my $issue = GetOpenIssue( $itemnumber );
3823 $issue->{borrowernumber},
3825 $operation->{timestamp},
3828 { renewals => 0, onloan => undef },
3829 $issue->{'biblionumber'},
3835 return "Item not issued.";
3838 return "Item not found.";
3842 sub ProcessOfflineIssue {
3843 my $operation = shift;
3845 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3848 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3850 return "Barcode not found.";
3852 my $itemnumber = $item->itemnumber;
3853 my $issue = GetOpenIssue( $itemnumber );
3855 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3857 $issue->{borrowernumber},
3859 $operation->{timestamp},
3864 $operation->{'barcode'},
3867 $operation->{timestamp},
3872 return "Borrower not found.";
3876 sub ProcessOfflinePayment {
3877 my $operation = shift;
3879 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3881 $patron->account->pay(
3883 amount => $operation->{amount},
3884 library_id => $operation->{branchcode},
3894 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3896 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3901 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3905 ? Koha::Items->find($itemnumber)
3906 : Koha::Items->find( { barcode => $barcode } );
3910 return C4::Letters::GetPreparedLetter (
3911 module => 'circulation',
3912 letter_code => 'TRANSFERSLIP',
3913 branchcode => $branch,
3915 'branches' => $to_branch,
3916 'biblio' => $item->biblionumber,
3917 'items' => $item->unblessed,
3922 =head2 CheckIfIssuedToPatron
3924 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3926 Return 1 if any record item is issued to patron, otherwise return 0
3930 sub CheckIfIssuedToPatron {
3931 my ($borrowernumber, $biblionumber) = @_;
3933 my $dbh = C4::Context->dbh;
3935 SELECT COUNT(*) FROM issues
3936 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3937 WHERE items.biblionumber = ?
3938 AND issues.borrowernumber = ?
3940 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3941 return 1 if $is_issued;
3947 IsItemIssued( $itemnumber )
3949 Return 1 if the item is on loan, otherwise return 0
3954 my $itemnumber = shift;
3955 my $dbh = C4::Context->dbh;
3956 my $sth = $dbh->prepare(q{
3959 WHERE itemnumber = ?
3961 $sth->execute($itemnumber);
3962 return $sth->fetchrow;
3965 =head2 GetAgeRestriction
3967 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3968 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3970 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3971 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3973 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3974 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3975 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3976 Negative days mean the borrower has gone past the age restriction age.
3980 sub GetAgeRestriction {
3981 my ($record_restrictions, $borrower) = @_;
3982 my $markers = C4::Context->preference('AgeRestrictionMarker');
3984 # Split $record_restrictions to something like FSK 16 or PEGI 6
3985 my @values = split ' ', uc($record_restrictions);
3986 return unless @values;
3988 # Search first occurrence of one of the markers
3989 my @markers = split /\|/, uc($markers);
3990 return unless @markers;
3993 my $restriction_year = 0;
3994 for my $value (@values) {
3996 for my $marker (@markers) {
3997 $marker =~ s/^\s+//; #remove leading spaces
3998 $marker =~ s/\s+$//; #remove trailing spaces
3999 if ( $marker eq $value ) {
4000 if ( $index <= $#values ) {
4001 $restriction_year += $values[$index];
4005 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4007 # Perhaps it is something like "K16" (as in Finland)
4008 $restriction_year += $1;
4012 last if ( $restriction_year > 0 );
4015 #Check if the borrower is age restricted for this material and for how long.
4016 if ($restriction_year && $borrower) {
4017 if ( $borrower->{'dateofbirth'} ) {
4018 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4019 $alloweddate[0] += $restriction_year;
4021 #Prevent runime eror on leap year (invalid date)
4022 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4023 $alloweddate[2] = 28;
4026 #Get how many days the borrower has to reach the age restriction
4027 my @Today = split /-/, DateTime->today->ymd();
4028 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4029 #Negative days means the borrower went past the age restriction age
4030 return ($restriction_year, $daysToAgeRestriction);
4034 return ($restriction_year);
4038 =head2 GetPendingOnSiteCheckouts
4042 sub GetPendingOnSiteCheckouts {
4043 my $dbh = C4::Context->dbh;
4044 return $dbh->selectall_arrayref(q|
4050 items.itemcallnumber,
4054 issues.date_due < NOW() AS is_overdue,
4057 borrowers.firstname,
4059 borrowers.cardnumber,
4060 borrowers.borrowernumber
4062 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4063 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4064 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4065 WHERE issues.onsite_checkout = 1
4066 |, { Slice => {} } );
4072 my ($count, $branch, $itemtype, $ccode, $newness)
4073 = @$params{qw(count branch itemtype ccode newness)};
4075 my $dbh = C4::Context->dbh;
4078 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4079 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4080 i.ccode, SUM(i.issues) AS count
4082 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4083 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4086 my (@where_strs, @where_args);
4089 push @where_strs, 'i.homebranch = ?';
4090 push @where_args, $branch;
4093 if (C4::Context->preference('item-level_itypes')){
4094 push @where_strs, 'i.itype = ?';
4095 push @where_args, $itemtype;
4097 push @where_strs, 'bi.itemtype = ?';
4098 push @where_args, $itemtype;
4102 push @where_strs, 'i.ccode = ?';
4103 push @where_args, $ccode;
4106 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4107 push @where_args, $newness;
4111 $query .= 'WHERE ' . join(' AND ', @where_strs);
4115 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4116 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4121 $query .= q{ ) xxx WHERE count > 0 };
4122 $count = int($count);
4124 $query .= "LIMIT $count";
4127 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4132 sub _CalculateAndUpdateFine {
4135 my $borrower = $params->{borrower};
4136 my $item = $params->{item};
4137 my $issue = $params->{issue};
4138 my $return_date = $params->{return_date};
4140 unless ($borrower) { carp "No borrower passed in!" && return; }
4141 unless ($item) { carp "No item passed in!" && return; }
4142 unless ($issue) { carp "No issue passed in!" && return; }
4144 my $datedue = dt_from_string( $issue->date_due );
4146 # we only need to calculate and change the fines if we want to do that on return
4147 # Should be on for hourly loans
4148 my $control = C4::Context->preference('CircControl');
4149 my $control_branchcode =
4150 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4151 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4152 : $issue->branchcode;
4154 my $date_returned = $return_date ? $return_date : dt_from_string();
4156 my ( $amount, $unitcounttotal, $unitcount ) =
4157 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4159 if ( C4::Context->preference('finesMode') eq 'production' ) {
4160 if ( $amount > 0 ) {
4161 C4::Overdues::UpdateFine({
4162 issue_id => $issue->issue_id,
4163 itemnumber => $issue->itemnumber,
4164 borrowernumber => $issue->borrowernumber,
4166 due => output_pref($datedue),
4169 elsif ($return_date) {
4171 # Backdated returns may have fines that shouldn't exist,
4172 # so in this case, we need to drop those fines to 0
4174 C4::Overdues::UpdateFine({
4175 issue_id => $issue->issue_id,
4176 itemnumber => $issue->itemnumber,
4177 borrowernumber => $issue->borrowernumber,
4179 due => output_pref($datedue),
4185 sub _item_denied_renewal {
4188 my $item = $params->{item};
4189 return unless $item;
4191 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4192 return unless $denyingrules;
4193 foreach my $field (keys %$denyingrules) {
4194 my $val = $item->$field;
4195 if( !defined $val) {
4196 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4199 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4200 # If the results matches the values in the syspref
4201 # We return true if match found
4215 Koha Development Team <http://koha-community.org/>