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
;
56 use Koha
::RefundLostItemFeeRule
;
57 use Koha
::RefundLostItemFeeRules
;
58 use Koha
::Account
::Lines
;
59 use Koha
::Account
::Offsets
;
61 use List
::MoreUtils
qw( uniq );
62 use Scalar
::Util
qw( looks_like_number );
72 use vars
qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
78 # FIXME subs that should probably be elsewhere
83 &GetPendingOnSiteCheckouts
86 # subs to deal with issuing a book
94 &GetLatestAutoRenewDate
96 &GetBranchBorrowerCircRule
100 &CheckIfIssuedToPatron
105 # subs to deal with returns
111 # subs to deal with transfers
118 &IsBranchTransferAllowed
119 &CreateBranchTransferLimit
120 &DeleteBranchTransferLimits
124 # subs to deal with offline circulation
126 &GetOfflineOperations
129 &DeleteOfflineOperation
130 &ProcessOfflineOperation
136 C4::Circulation - Koha circulation module
144 The functions in this module deal with circulation, issues, and
145 returns, as well as general information about the library.
146 Also deals with inventory.
152 $str = &barcodedecode($barcode, [$filter]);
154 Generic filter function for barcode string.
155 Called on every circ if the System Pref itemBarcodeInputFilter is set.
156 Will do some manipulation of the barcode for systems that deliver a barcode
157 to circulation.pl that differs from the barcode stored for the item.
158 For proper functioning of this filter, calling the function on the
159 correct barcode string (items.barcode) should return an unaltered barcode.
161 The optional $filter argument is to allow for testing or explicit
162 behavior that ignores the System Pref. Valid values are the same as the
167 # FIXME -- the &decode fcn below should be wrapped into this one.
168 # FIXME -- these plugins should be moved out of Circulation.pm
171 my ($barcode, $filter) = @_;
172 my $branch = C4
::Context
::mybranch
();
173 $filter = C4
::Context
->preference('itemBarcodeInputFilter') unless $filter;
174 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
175 if ($filter eq 'whitespace') {
177 } elsif ($filter eq 'cuecat') {
179 my @fields = split( /\./, $barcode );
180 my @results = map( decode
($_), @fields[ 1 .. $#fields ] );
181 ($#results == 2) and return $results[2];
182 } elsif ($filter eq 'T-prefix') {
183 if ($barcode =~ /^[Tt](\d)/) {
184 (defined($1) and $1 eq '0') and return $barcode;
185 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
187 return sprintf("T%07d", $barcode);
188 # FIXME: $barcode could be "T1", causing warning: substr outside of string
189 # Why drop the nonzero digit after the T?
190 # Why pass non-digits (or empty string) to "T%07d"?
191 } elsif ($filter eq 'libsuite8') {
192 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
193 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
194 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
196 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
199 } elsif ($filter eq 'EAN13') {
200 my $ean = CheckDigits
('ean');
201 if ( $ean->is_valid($barcode) ) {
202 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
203 $barcode = '0' x
( 13 - length($barcode) ) . $barcode;
205 warn "# [$barcode] not valid EAN-13/UPC-A\n";
208 return $barcode; # return barcode, modified or not
213 $str = &decode($chunk);
215 Decodes a segment of a string emitted by a CueCat barcode scanner and
218 FIXME: Should be replaced with Barcode::Cuecat from CPAN
219 or Javascript based decoding on the client side.
226 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
227 my @s = map { index( $seq, $_ ); } split( //, $encoded );
228 my $l = ( $#s + 1 ) % 4;
231 # warn "Error: Cuecat decode parsing failed!";
239 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
241 chr( ( $n >> 16 ) ^ 67 )
242 .chr( ( $n >> 8 & 255 ) ^ 67 )
243 .chr( ( $n & 255 ) ^ 67 );
246 $r = substr( $r, 0, length($r) - $l );
252 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
253 $barcode, $ignore_reserves);
255 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
257 C<$newbranch> is the code for the branch to which the item should be transferred.
259 C<$barcode> is the barcode of the item to be transferred.
261 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
262 Otherwise, if an item is reserved, the transfer fails.
264 Returns three values:
270 is true if the transfer was successful.
274 is a reference-to-hash which may have any of the following keys:
280 There is no item in the catalog with the given barcode. The value is C<$barcode>.
282 =item C<DestinationEqualsHolding>
284 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.
288 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.
292 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>.
294 =item C<WasTransferred>
296 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
305 my ( $tbr, $barcode, $ignoreRs ) = @_;
308 my $item = Koha
::Items
->find( { barcode
=> $barcode } );
312 $messages->{'BadBarcode'} = $barcode;
316 my $itemnumber = $item->itemnumber;
317 my $issue = GetOpenIssue
($itemnumber);
318 # get branches of book...
319 my $hbr = $item->homebranch;
320 my $fbr = $item->holdingbranch;
322 # if using Branch Transfer Limits
323 if ( C4
::Context
->preference("UseBranchTransferLimits") == 1 ) {
324 my $code = C4
::Context
->preference("BranchTransferLimitsType") eq 'ccode' ?
$item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
325 if ( C4
::Context
->preference("item-level_itypes") && C4
::Context
->preference("BranchTransferLimitsType") eq 'itemtype' ) {
326 if ( ! IsBranchTransferAllowed
( $tbr, $fbr, $item->itype ) ) {
327 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
330 } elsif ( ! IsBranchTransferAllowed
( $tbr, $fbr, $code ) ) {
331 $messages->{'NotAllowed'} = $tbr . "::" . $code;
336 # can't transfer book if is already there....
337 if ( $fbr eq $tbr ) {
338 $messages->{'DestinationEqualsHolding'} = 1;
342 # check if it is still issued to someone, return it...
344 AddReturn
( $barcode, $fbr );
345 $messages->{'WasReturned'} = $issue->borrowernumber;
349 # That'll save a database query.
350 my ( $resfound, $resrec, undef ) =
351 CheckReserves
( $itemnumber );
352 if ( $resfound and not $ignoreRs ) {
353 $resrec->{'ResFound'} = $resfound;
355 # $messages->{'ResFound'} = $resrec;
359 #actually do the transfer....
361 ModItemTransfer
( $itemnumber, $fbr, $tbr );
363 # don't need to update MARC anymore, we do it in batch now
364 $messages->{'WasTransfered'} = 1;
367 ModDateLastSeen
( $itemnumber );
368 return ( $dotransfer, $messages );
373 my $borrower = shift;
374 my $biblionumber = shift;
377 my $onsite_checkout = $params->{onsite_checkout
} || 0;
378 my $switch_onsite_checkout = $params->{switch_onsite_checkout
} || 0;
379 my $cat_borrower = $borrower->{'categorycode'};
380 my $dbh = C4
::Context
->dbh;
382 # Get which branchcode we need
383 $branch = _GetCircControlBranch
($item,$borrower);
384 my $type = (C4
::Context
->preference('item-level_itypes'))
385 ?
$item->{'itype'} # item-level
386 : $item->{'itemtype'}; # biblio-level
388 # given branch, patron category, and item type, determine
389 # applicable issuing rule
390 my $issuing_rule = Koha
::IssuingRules
->get_effective_issuing_rule(
391 { categorycode
=> $cat_borrower,
393 branchcode
=> $branch
398 # if a rule is found and has a loan limit set, count
399 # how many loans the patron already has that meet that
401 if (defined($issuing_rule) and defined($issuing_rule->maxissueqty)) {
404 SELECT COUNT
(*) AS total
, COALESCE
(SUM
(onsite_checkout
), 0) AS onsite_checkouts
406 JOIN items USING
(itemnumber
)
409 my $rule_itemtype = $issuing_rule->itemtype;
410 if ($rule_itemtype eq "*") {
411 # matching rule has the default item type, so count only
412 # those existing loans that don't fall under a more
414 if (C4
::Context
->preference('item-level_itypes')) {
415 $count_query .= " WHERE items.itype NOT IN (
416 SELECT itemtype FROM issuingrules
418 AND (categorycode = ? OR categorycode = ?)
422 $count_query .= " JOIN biblioitems USING (biblionumber)
423 WHERE biblioitems.itemtype NOT IN (
424 SELECT itemtype FROM issuingrules
426 AND (categorycode = ? OR categorycode = ?)
430 push @bind_params, $issuing_rule->branchcode;
431 push @bind_params, $issuing_rule->categorycode;
432 push @bind_params, $cat_borrower;
434 # rule has specific item type, so count loans of that
436 if (C4
::Context
->preference('item-level_itypes')) {
437 $count_query .= " WHERE items.itype = ? ";
439 $count_query .= " JOIN biblioitems USING (biblionumber)
440 WHERE biblioitems.itemtype= ? ";
442 push @bind_params, $type;
445 $count_query .= " AND borrowernumber = ? ";
446 push @bind_params, $borrower->{'borrowernumber'};
447 my $rule_branch = $issuing_rule->branchcode;
448 if ($rule_branch ne "*") {
449 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
450 $count_query .= " AND issues.branchcode = ? ";
451 push @bind_params, $branch;
452 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
453 ; # if branch is the patron's home branch, then count all loans by patron
455 $count_query .= " AND items.homebranch = ? ";
456 push @bind_params, $branch;
460 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
462 my $max_checkouts_allowed = $issuing_rule->maxissueqty;
463 my $max_onsite_checkouts_allowed = $issuing_rule->maxonsiteissueqty;
465 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
466 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
468 reason
=> 'TOO_MANY_ONSITE_CHECKOUTS',
469 count
=> $onsite_checkout_count,
470 max_allowed
=> $max_onsite_checkouts_allowed,
474 if ( C4
::Context
->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
475 my $delta = $switch_onsite_checkout ?
1 : 0;
476 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
478 reason
=> 'TOO_MANY_CHECKOUTS',
479 count
=> $checkout_count,
480 max_allowed
=> $max_checkouts_allowed,
483 } elsif ( not $onsite_checkout ) {
484 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
486 reason
=> 'TOO_MANY_CHECKOUTS',
487 count
=> $checkout_count - $onsite_checkout_count,
488 max_allowed
=> $max_checkouts_allowed,
494 # Now count total loans against the limit for the branch
495 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule
($branch, $cat_borrower);
496 if (defined($branch_borrower_circ_rule->{maxissueqty
})) {
497 my @bind_params = ();
498 my $branch_count_query = q
|
499 SELECT COUNT
(*) AS total
, COALESCE
(SUM
(onsite_checkout
), 0) AS onsite_checkouts
501 JOIN items USING
(itemnumber
)
502 WHERE borrowernumber
= ?
504 push @bind_params, $borrower->{borrowernumber
};
506 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
507 $branch_count_query .= " AND issues.branchcode = ? ";
508 push @bind_params, $branch;
509 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
510 ; # if branch is the patron's home branch, then count all loans by patron
512 $branch_count_query .= " AND items.homebranch = ? ";
513 push @bind_params, $branch;
515 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
516 my $max_checkouts_allowed = $branch_borrower_circ_rule->{maxissueqty
};
517 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{maxonsiteissueqty
};
519 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
520 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
522 reason
=> 'TOO_MANY_ONSITE_CHECKOUTS',
523 count
=> $onsite_checkout_count,
524 max_allowed
=> $max_onsite_checkouts_allowed,
528 if ( C4
::Context
->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
529 my $delta = $switch_onsite_checkout ?
1 : 0;
530 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
532 reason
=> 'TOO_MANY_CHECKOUTS',
533 count
=> $checkout_count,
534 max_allowed
=> $max_checkouts_allowed,
537 } elsif ( not $onsite_checkout ) {
538 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
540 reason
=> 'TOO_MANY_CHECKOUTS',
541 count
=> $checkout_count - $onsite_checkout_count,
542 max_allowed
=> $max_checkouts_allowed,
548 if ( not defined( $issuing_rule ) and not defined($branch_borrower_circ_rule->{maxissueqty
}) ) {
549 return { reason
=> 'NO_RULE_DEFINED', max_allowed
=> 0 };
552 # OK, the patron can issue !!!
556 =head2 CanBookBeIssued
558 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
559 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
561 Check if a book can be issued.
563 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
565 IMPORTANT: The assumption by users of this routine is that causes blocking
566 the issue are keyed by uppercase labels and other returned
567 data is keyed in lower case!
571 =item C<$patron> is a Koha::Patron
573 =item C<$barcode> is the bar code of the book being issued.
575 =item C<$duedates> is a DateTime object.
577 =item C<$inprocess> boolean switch
579 =item C<$ignore_reserves> boolean switch
581 =item C<$params> Hashref of additional parameters
584 override_high_holds - Ignore high holds
585 onsite_checkout - Checkout is an onsite checkout that will not leave the library
593 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
594 Possible values are :
600 sticky due date is invalid
604 borrower gone with no address
608 borrower declared it's card lost
614 =head3 UNKNOWN_BARCODE
628 item is restricted (set by ??)
630 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
631 could be prevented, but ones that can be overriden by the operator.
633 Possible values are :
641 renewing, not issuing
643 =head3 ISSUED_TO_ANOTHER
645 issued to someone else.
649 reserved for someone else.
653 sticky due date is invalid or due date in the past
657 if the borrower borrows to much things
661 sub CanBookBeIssued
{
662 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
663 my %needsconfirmation; # filled with problems that needs confirmations
664 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
665 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
666 my %messages; # filled with information messages that should be displayed.
668 my $onsite_checkout = $params->{onsite_checkout
} || 0;
669 my $override_high_holds = $params->{override_high_holds
} || 0;
671 my $item = GetItem
(undef, $barcode );
672 my $issue = Koha
::Checkouts
->find( { itemnumber
=> $item->{itemnumber
} } );
673 my $biblio = Koha
::Biblios
->find( $item->{biblionumber
} );
674 my $biblioitem = $biblio->biblioitem;
675 my $effective_itemtype = $item->{itype
}; # GetItem deals with that
676 my $dbh = C4
::Context
->dbh;
677 my $patron_unblessed = $patron->unblessed;
679 # MANDATORY CHECKS - unless item exists, nothing else matters
680 unless ( $item->{barcode
} ) {
681 $issuingimpossible{UNKNOWN_BARCODE
} = 1;
683 return ( \
%issuingimpossible, \
%needsconfirmation ) if %issuingimpossible;
686 # DUE DATE is OK ? -- should already have checked.
688 if ($duedate && ref $duedate ne 'DateTime') {
689 $duedate = dt_from_string
($duedate);
691 my $now = DateTime
->now( time_zone
=> C4
::Context
->tz() );
692 unless ( $duedate ) {
693 my $issuedate = $now->clone();
695 my $branch = _GetCircControlBranch
($item, $patron_unblessed);
696 $duedate = CalcDateDue
( $issuedate, $effective_itemtype, $branch, $patron_unblessed );
698 # Offline circ calls AddIssue directly, doesn't run through here
699 # So issuingimpossible should be ok.
702 my $today = $now->clone();
703 $today->truncate( to
=> 'minute');
704 if (DateTime
->compare($duedate,$today) == -1 ) { # duedate cannot be before now
705 $needsconfirmation{INVALID_DATE
} = output_pref
($duedate);
708 $issuingimpossible{INVALID_DATE
} = output_pref
($duedate);
714 if ( $patron->category->category_type eq 'X' && ( $item->{barcode
} )) {
715 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
717 branch
=> C4
::Context
->userenv->{'branch'},
719 itemnumber
=> $item->{'itemnumber'},
720 itemtype
=> $effective_itemtype,
721 borrowernumber
=> $patron->borrowernumber,
722 ccode
=> $item->{'ccode'}}
724 ModDateLastSeen
( $item->{'itemnumber'} );
725 return( { STATS
=> 1 }, {});
728 if ( $patron->gonenoaddress == 1 ) {
729 $issuingimpossible{GNA
} = 1;
732 if ( $patron->lost == 1 ) {
733 $issuingimpossible{CARD_LOST
} = 1;
735 if ( $patron->is_debarred ) {
736 $issuingimpossible{DEBARRED
} = 1;
739 if ( $patron->is_expired ) {
740 $issuingimpossible{EXPIRED
} = 1;
748 my $account = $patron->account;
749 my $balance = $account->balance;
750 my $non_issues_charges = $account->non_issues_charges;
751 my $other_charges = $balance - $non_issues_charges;
753 my $amountlimit = C4
::Context
->preference("noissuescharge");
754 my $allowfineoverride = C4
::Context
->preference("AllowFineOverride");
755 my $allfinesneedoverride = C4
::Context
->preference("AllFinesNeedOverride");
757 # Check the debt of this patrons guarantees
758 my $no_issues_charge_guarantees = C4
::Context
->preference("NoIssuesChargeGuarantees");
759 $no_issues_charge_guarantees = undef unless looks_like_number
( $no_issues_charge_guarantees );
760 if ( defined $no_issues_charge_guarantees ) {
761 my @guarantees = $patron->guarantees();
762 my $guarantees_non_issues_charges;
763 foreach my $g ( @guarantees ) {
764 $guarantees_non_issues_charges += $g->account->non_issues_charges;
767 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
768 $issuingimpossible{DEBT_GUARANTEES
} = $guarantees_non_issues_charges;
769 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
770 $needsconfirmation{DEBT_GUARANTEES
} = $guarantees_non_issues_charges;
771 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
772 $needsconfirmation{DEBT_GUARANTEES
} = $guarantees_non_issues_charges;
776 if ( C4
::Context
->preference("IssuingInProcess") ) {
777 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
778 $issuingimpossible{DEBT
} = $non_issues_charges;
779 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
780 $needsconfirmation{DEBT
} = $non_issues_charges;
781 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
782 $needsconfirmation{DEBT
} = $non_issues_charges;
786 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
787 $needsconfirmation{DEBT
} = $non_issues_charges;
788 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
789 $issuingimpossible{DEBT
} = $non_issues_charges;
790 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
791 $needsconfirmation{DEBT
} = $non_issues_charges;
795 if ($balance > 0 && $other_charges > 0) {
796 $alerts{OTHER_CHARGES
} = sprintf( "%.2f", $other_charges );
799 $patron = Koha
::Patrons
->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
800 $patron_unblessed = $patron->unblessed;
802 if ( my $debarred_date = $patron->is_debarred ) {
803 # patron has accrued fine days or has a restriction. $count is a date
804 if ($debarred_date eq '9999-12-31') {
805 $issuingimpossible{USERBLOCKEDNOENDDATE
} = $debarred_date;
808 $issuingimpossible{USERBLOCKEDWITHENDDATE
} = $debarred_date;
810 } elsif ( my $num_overdues = $patron->has_overdues ) {
811 ## patron has outstanding overdue loans
812 if ( C4
::Context
->preference("OverduesBlockCirc") eq 'block'){
813 $issuingimpossible{USERBLOCKEDOVERDUE
} = $num_overdues;
815 elsif ( C4
::Context
->preference("OverduesBlockCirc") eq 'confirmation'){
816 $needsconfirmation{USERBLOCKEDOVERDUE
} = $num_overdues;
821 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
823 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
825 # Already issued to current borrower.
826 # If it is an on-site checkout if it can be switched to a normal checkout
827 # or ask whether the loan should be renewed
829 if ( $issue->onsite_checkout
830 and C4
::Context
->preference('SwitchOnSiteCheckouts') ) {
831 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED
} = 1;
833 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed
(
834 $patron->borrowernumber,
835 $item->{'itemnumber'},
837 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
838 if ( $renewerror eq 'onsite_checkout' ) {
839 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS
} = 1;
842 $issuingimpossible{NO_MORE_RENEWALS
} = 1;
846 $needsconfirmation{RENEW_ISSUE
} = 1;
852 # issued to someone else
854 my $patron = Koha
::Patrons
->find( $issue->borrowernumber );
856 my ( $can_be_returned, $message ) = CanBookBeReturned
( $item, C4
::Context
->userenv->{branch
} );
858 unless ( $can_be_returned ) {
859 $issuingimpossible{RETURN_IMPOSSIBLE
} = 1;
860 $issuingimpossible{branch_to_return
} = $message;
862 $needsconfirmation{ISSUED_TO_ANOTHER
} = 1;
863 $needsconfirmation{issued_firstname
} = $patron->firstname;
864 $needsconfirmation{issued_surname
} = $patron->surname;
865 $needsconfirmation{issued_cardnumber
} = $patron->cardnumber;
866 $needsconfirmation{issued_borrowernumber
} = $patron->borrowernumber;
870 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
872 my $switch_onsite_checkout = (
873 C4
::Context
->preference('SwitchOnSiteCheckouts')
875 and $issue->onsite_checkout
876 and $issue->borrowernumber == $patron->borrowernumber ?
1 : 0 );
877 my $toomany = TooMany
( $patron_unblessed, $item->{biblionumber
}, $item, { onsite_checkout
=> $onsite_checkout, switch_onsite_checkout
=> $switch_onsite_checkout, } );
878 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
879 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE
} ) {
880 if ( $toomany->{max_allowed
} == 0 ) {
881 $needsconfirmation{PATRON_CANT
} = 1;
883 if ( C4
::Context
->preference("AllowTooManyOverride") ) {
884 $needsconfirmation{TOO_MANY
} = $toomany->{reason
};
885 $needsconfirmation{current_loan_count
} = $toomany->{count
};
886 $needsconfirmation{max_loans_allowed
} = $toomany->{max_allowed
};
888 $issuingimpossible{TOO_MANY
} = $toomany->{reason
};
889 $issuingimpossible{current_loan_count
} = $toomany->{count
};
890 $issuingimpossible{max_loans_allowed
} = $toomany->{max_allowed
};
895 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
897 $patron = Koha
::Patrons
->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
898 my $wants_check = $patron->wants_check_for_previous_checkout;
899 $needsconfirmation{PREVISSUE
} = 1
900 if ($wants_check and $patron->do_check_for_previous_checkout($item));
905 if ( $item->{'notforloan'} )
907 if(!C4
::Context
->preference("AllowNotForLoanOverride")){
908 $issuingimpossible{NOT_FOR_LOAN
} = 1;
909 $issuingimpossible{item_notforloan
} = $item->{'notforloan'};
911 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
912 $needsconfirmation{item_notforloan
} = $item->{'notforloan'};
916 # we have to check itemtypes.notforloan also
917 if (C4
::Context
->preference('item-level_itypes')){
918 # this should probably be a subroutine
919 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
920 $sth->execute($item->{'itemtype'});
921 my $notforloan=$sth->fetchrow_hashref();
922 if ($notforloan->{'notforloan'}) {
923 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
924 $issuingimpossible{NOT_FOR_LOAN
} = 1;
925 $issuingimpossible{itemtype_notforloan
} = $effective_itemtype;
927 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
928 $needsconfirmation{itemtype_notforloan
} = $effective_itemtype;
932 elsif ($biblioitem->notforloan == 1){
933 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
934 $issuingimpossible{NOT_FOR_LOAN
} = 1;
935 $issuingimpossible{itemtype_notforloan
} = $effective_itemtype;
937 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
938 $needsconfirmation{itemtype_notforloan
} = $effective_itemtype;
942 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
944 $issuingimpossible{WTHDRAWN
} = 1;
946 if ( $item->{'restricted'}
947 && $item->{'restricted'} == 1 )
949 $issuingimpossible{RESTRICTED
} = 1;
951 if ( $item->{'itemlost'} && C4
::Context
->preference("IssueLostItem") ne 'nothing' ) {
952 my $av = Koha
::AuthorisedValues
->search({ category
=> 'LOST', authorised_value
=> $item->{itemlost
} });
953 my $code = $av->count ?
$av->next->lib : '';
954 $needsconfirmation{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'confirm' );
955 $alerts{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'alert' );
957 if ( C4
::Context
->preference("IndependentBranches") ) {
958 my $userenv = C4
::Context
->userenv;
959 unless ( C4
::Context
->IsSuperLibrarian() ) {
960 if ( $item->{C4
::Context
->preference("HomeOrHoldingBranch")} ne $userenv->{branch
} ){
961 $issuingimpossible{ITEMNOTSAMEBRANCH
} = 1;
962 $issuingimpossible{'itemhomebranch'} = $item->{C4
::Context
->preference("HomeOrHoldingBranch")};
964 $needsconfirmation{BORRNOTSAMEBRANCH
} = $patron->branchcode
965 if ( $patron->branchcode ne $userenv->{branch
} );
969 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
971 my $rentalConfirmation = C4
::Context
->preference("RentalFeesCheckoutConfirmation");
973 if ( $rentalConfirmation ){
974 my ($rentalCharge) = GetIssuingCharges
( $item->{'itemnumber'}, $patron->borrowernumber );
975 if ( $rentalCharge > 0 ){
976 $needsconfirmation{RENTALCHARGE
} = $rentalCharge;
980 unless ( $ignore_reserves ) {
981 # See if the item is on reserve.
982 my ( $restype, $res ) = C4
::Reserves
::CheckReserves
( $item->{'itemnumber'} );
984 my $resbor = $res->{'borrowernumber'};
985 if ( $resbor ne $patron->borrowernumber ) {
986 my $patron = Koha
::Patrons
->find( $resbor );
987 if ( $restype eq "Waiting" )
989 # The item is on reserve and waiting, but has been
990 # reserved by some other patron.
991 $needsconfirmation{RESERVE_WAITING
} = 1;
992 $needsconfirmation{'resfirstname'} = $patron->firstname;
993 $needsconfirmation{'ressurname'} = $patron->surname;
994 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
995 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
996 $needsconfirmation{'resbranchcode'} = $res->{branchcode
};
997 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
999 elsif ( $restype eq "Reserved" ) {
1000 # The item is on reserve for someone else.
1001 $needsconfirmation{RESERVED
} = 1;
1002 $needsconfirmation{'resfirstname'} = $patron->firstname;
1003 $needsconfirmation{'ressurname'} = $patron->surname;
1004 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1005 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1006 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1007 $needsconfirmation{'resreservedate'} = $res->{reservedate
};
1013 ## CHECK AGE RESTRICTION
1014 my $agerestriction = $biblioitem->agerestriction;
1015 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction
( $agerestriction, $patron->unblessed );
1016 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1017 if ( C4
::Context
->preference('AgeRestrictionOverride') ) {
1018 $needsconfirmation{AGE_RESTRICTION
} = "$agerestriction";
1021 $issuingimpossible{AGE_RESTRICTION
} = "$agerestriction";
1025 ## check for high holds decreasing loan period
1026 if ( C4
::Context
->preference('decreaseLoanHighHolds') ) {
1027 my $check = checkHighHolds
( $item, $patron_unblessed );
1029 if ( $check->{exceeded
} ) {
1030 if ($override_high_holds) {
1031 $alerts{HIGHHOLDS
} = {
1032 num_holds
=> $check->{outstanding
},
1033 duration
=> $check->{duration
},
1034 returndate
=> output_pref
( $check->{due_date
} ),
1038 $needsconfirmation{HIGHHOLDS
} = {
1039 num_holds
=> $check->{outstanding
},
1040 duration
=> $check->{duration
},
1041 returndate
=> output_pref
( $check->{due_date
} ),
1048 !C4
::Context
->preference('AllowMultipleIssuesOnABiblio') &&
1049 # don't do the multiple loans per bib check if we've
1050 # already determined that we've got a loan on the same item
1051 !$issuingimpossible{NO_MORE_RENEWALS
} &&
1052 !$needsconfirmation{RENEW_ISSUE
}
1054 # Check if borrower has already issued an item from the same biblio
1055 # Only if it's not a subscription
1056 my $biblionumber = $item->{biblionumber
};
1057 require C4
::Serials
;
1058 my $is_a_subscription = C4
::Serials
::CountSubscriptionFromBiblionumber
($biblionumber);
1059 unless ($is_a_subscription) {
1060 # FIXME Should be $patron->checkouts($args);
1061 my $checkouts = Koha
::Checkouts
->search(
1063 borrowernumber
=> $patron->borrowernumber,
1064 biblionumber
=> $biblionumber,
1070 # if we get here, we don't already have a loan on this item,
1071 # so if there are any loans on this bib, ask for confirmation
1072 if ( $checkouts->count ) {
1073 $needsconfirmation{BIBLIO_ALREADY_ISSUED
} = 1;
1078 return ( \
%issuingimpossible, \
%needsconfirmation, \
%alerts, \
%messages, );
1081 =head2 CanBookBeReturned
1083 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1085 Check whether the item can be returned to the provided branch
1089 =item C<$item> is a hash of item information as returned from GetItem
1091 =item C<$branch> is the branchcode where the return is taking place
1099 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1101 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1107 sub CanBookBeReturned
{
1108 my ($item, $branch) = @_;
1109 my $allowreturntobranch = C4
::Context
->preference("AllowReturnToBranch") || 'anywhere';
1111 # assume return is allowed to start
1115 # identify all cases where return is forbidden
1116 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1118 $message = $item->{'homebranch'};
1119 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1121 $message = $item->{'holdingbranch'};
1122 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1124 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1127 return ($allowed, $message);
1130 =head2 CheckHighHolds
1132 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1133 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1134 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1138 sub checkHighHolds
{
1139 my ( $item, $borrower ) = @_;
1140 my $branch = _GetCircControlBranch
( $item, $borrower );
1141 my $item_object = Koha
::Items
->find( $item->{itemnumber
} );
1150 my $holds = Koha
::Holds
->search( { biblionumber
=> $item->{'biblionumber'} } );
1152 if ( $holds->count() ) {
1153 $return_data->{outstanding
} = $holds->count();
1155 my $decreaseLoanHighHoldsControl = C4
::Context
->preference('decreaseLoanHighHoldsControl');
1156 my $decreaseLoanHighHoldsValue = C4
::Context
->preference('decreaseLoanHighHoldsValue');
1157 my $decreaseLoanHighHoldsIgnoreStatuses = C4
::Context
->preference('decreaseLoanHighHoldsIgnoreStatuses');
1159 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1161 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1163 # static means just more than a given number of holds on the record
1165 # If the number of holds is less than the threshold, we can stop here
1166 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1167 return $return_data;
1170 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1172 # dynamic means X more than the number of holdable items on the record
1174 # let's get the items
1175 my @items = $holds->next()->biblio()->items();
1177 # Remove any items with status defined to be ignored even if the would not make item unholdable
1178 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1179 @items = grep { !$_->$status } @items;
1182 # Remove any items that are not holdable for this patron
1183 @items = grep { CanItemBeReserved
( $borrower->{borrowernumber
}, $_->itemnumber ) eq 'OK' } @items;
1185 my $items_count = scalar @items;
1187 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1189 # If the number of holds is less than the count of items we have
1190 # plus the number of holds allowed above that count, we can stop here
1191 if ( $holds->count() <= $threshold ) {
1192 return $return_data;
1196 my $issuedate = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1198 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
1200 my $itype = $item_object->effective_itemtype;
1201 my $orig_due = C4
::Circulation
::CalcDateDue
( $issuedate, $itype, $branch, $borrower );
1203 my $decreaseLoanHighHoldsDuration = C4
::Context
->preference('decreaseLoanHighHoldsDuration');
1205 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1206 $reduced_datedue->set_hour($orig_due->hour);
1207 $reduced_datedue->set_minute($orig_due->minute);
1208 $reduced_datedue->truncate( to
=> 'minute' );
1210 if ( DateTime
->compare( $reduced_datedue, $orig_due ) == -1 ) {
1211 $return_data->{exceeded
} = 1;
1212 $return_data->{duration
} = $decreaseLoanHighHoldsDuration;
1213 $return_data->{due_date
} = $reduced_datedue;
1217 return $return_data;
1222 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1224 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1228 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1230 =item C<$barcode> is the barcode of the item being issued.
1232 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1233 Calculated if empty.
1235 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1237 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1238 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1240 AddIssue does the following things :
1242 - step 01: check that there is a borrowernumber & a barcode provided
1243 - check for RENEWAL (book issued & being issued to the same patron)
1244 - renewal YES = Calculate Charge & renew
1246 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1248 - fill reserve if reserve to this patron
1249 - cancel reserve or not, otherwise
1250 * TRANSFERT PENDING ?
1251 - complete the transfert
1259 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1261 my $onsite_checkout = $params && $params->{onsite_checkout
} ?
1 : 0;
1262 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout
};
1263 my $auto_renew = $params && $params->{auto_renew
};
1264 my $dbh = C4
::Context
->dbh;
1265 my $barcodecheck = CheckValidBarcode
($barcode);
1269 if ( $datedue && ref $datedue ne 'DateTime' ) {
1270 $datedue = dt_from_string
($datedue);
1273 # $issuedate defaults to today.
1274 if ( !defined $issuedate ) {
1275 $issuedate = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1278 if ( ref $issuedate ne 'DateTime' ) {
1279 $issuedate = dt_from_string
($issuedate);
1284 # Stop here if the patron or barcode doesn't exist
1285 if ( $borrower && $barcode && $barcodecheck ) {
1286 # find which item we issue
1287 my $item = GetItem
( '', $barcode )
1288 or return; # if we don't get an Item, abort.
1289 my $item_object = Koha
::Items
->find( { barcode
=> $barcode } );
1291 my $branch = _GetCircControlBranch
( $item, $borrower );
1293 # get actual issuing if there is one
1294 my $actualissue = Koha
::Checkouts
->find( { itemnumber
=> $item->{itemnumber
} } );
1296 # check if we just renew the issue.
1297 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1298 and not $switch_onsite_checkout ) {
1299 $datedue = AddRenewal
(
1300 $borrower->{'borrowernumber'},
1301 $item->{'itemnumber'},
1304 $issuedate, # here interpreted as the renewal date
1308 # it's NOT a renewal
1309 if ( $actualissue and not $switch_onsite_checkout ) {
1310 # This book is currently on loan, but not to the person
1311 # who wants to borrow it now. mark it returned before issuing to the new borrower
1312 my ( $allowed, $message ) = CanBookBeReturned
( $item, C4
::Context
->userenv->{branch
} );
1313 return unless $allowed;
1314 AddReturn
( $item->{'barcode'}, C4
::Context
->userenv->{'branch'} );
1317 MoveReserve
( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1319 # Starting process for transfer job (checking transfert and validate it if we have one)
1320 my ($datesent) = GetTransfers
( $item->{'itemnumber'} );
1322 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1323 my $sth = $dbh->prepare(
1324 "UPDATE branchtransfers
1325 SET datearrived = now(),
1327 comments = 'Forced branchtransfer'
1328 WHERE itemnumber= ? AND datearrived IS NULL"
1330 $sth->execute( C4
::Context
->userenv->{'branch'},
1331 $item->{'itemnumber'} );
1334 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1335 unless ($auto_renew) {
1336 my $issuing_rule = Koha
::IssuingRules
->get_effective_issuing_rule(
1337 { categorycode
=> $borrower->{categorycode
},
1338 itemtype
=> $item->{itype
},
1339 branchcode
=> $branch
1343 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1346 # Record in the database the fact that the book was issued.
1348 my $itype = $item_object->effective_itemtype;
1349 $datedue = CalcDateDue
( $issuedate, $itype, $branch, $borrower );
1352 $datedue->truncate( to
=> 'minute' );
1354 $issue = Koha
::Database
->new()->schema()->resultset('Issue')->update_or_create(
1356 borrowernumber
=> $borrower->{'borrowernumber'},
1357 itemnumber
=> $item->{'itemnumber'},
1358 issuedate
=> $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1359 date_due
=> $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1360 branchcode
=> C4
::Context
->userenv->{'branch'},
1361 onsite_checkout
=> $onsite_checkout,
1362 auto_renew
=> $auto_renew ?
1 : 0
1366 if ( C4
::Context
->preference('ReturnToShelvingCart') ) {
1367 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1368 CartToShelf
( $item->{'itemnumber'} );
1370 $item->{'issues'}++;
1371 if ( C4
::Context
->preference('UpdateTotalIssuesOnCirc') ) {
1372 UpdateTotalIssues
( $item->{'biblionumber'}, 1 );
1375 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1376 if ( $item->{'itemlost'} ) {
1378 Koha
::RefundLostItemFeeRules
->should_refund(
1380 current_branch
=> C4
::Context
->userenv->{branch
},
1381 item_home_branch
=> $item->{homebranch
},
1382 item_holding_branch
=> $item->{holdingbranch
}
1387 _FixAccountForLostAndReturned
( $item->{'itemnumber'}, undef,
1388 $item->{'barcode'} );
1394 issues
=> $item->{'issues'},
1395 holdingbranch
=> C4
::Context
->userenv->{'branch'},
1397 onloan
=> $datedue->ymd(),
1398 datelastborrowed
=> DateTime
->now( time_zone
=> C4
::Context
->tz() )->ymd(),
1400 $item->{'biblionumber'},
1401 $item->{'itemnumber'},
1404 ModDateLastSeen
( $item->{'itemnumber'} );
1406 # If it costs to borrow this book, charge it to the patron's account.
1407 my ( $charge, $itemtype ) = GetIssuingCharges
( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1408 if ( $charge > 0 ) {
1409 AddIssuingCharge
( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $charge );
1410 $item->{'charge'} = $charge;
1413 # Record the fact that this book was issued.
1416 branch
=> C4
::Context
->userenv->{'branch'},
1417 type
=> ( $onsite_checkout ?
'onsite_checkout' : 'issue' ),
1419 other
=> ( $sipmode ?
"SIP-$sipmode" : '' ),
1420 itemnumber
=> $item->{'itemnumber'},
1421 itemtype
=> $item->{'itype'},
1422 location
=> $item->{location
},
1423 borrowernumber
=> $borrower->{'borrowernumber'},
1424 ccode
=> $item->{'ccode'}
1428 # Send a checkout slip.
1429 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1431 branchcode
=> $branch,
1432 categorycode
=> $borrower->{categorycode
},
1433 item_type
=> $item->{itype
},
1434 notification
=> 'CHECKOUT',
1436 if ( $circulation_alert->is_enabled_for( \
%conditions ) ) {
1437 SendCirculationAlert
(
1441 borrower
=> $borrower,
1447 "CIRCULATION", "ISSUE",
1448 $borrower->{'borrowernumber'},
1449 $item->{'itemnumber'}
1450 ) if C4
::Context
->preference("IssueLog");
1456 =head2 GetLoanLength
1458 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1460 Get loan length for an itemtype, a borrower type and a branch
1465 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1466 my $dbh = C4
::Context
->dbh;
1467 my $sth = $dbh->prepare(qq{
1468 SELECT issuelength
, lengthunit
, renewalperiod
1470 WHERE categorycode
=?
1473 AND issuelength IS NOT NULL
1476 # try to find issuelength & return the 1st available.
1477 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1478 $sth->execute( $borrowertype, $itemtype, $branchcode );
1479 my $loanlength = $sth->fetchrow_hashref;
1482 if defined($loanlength) && defined $loanlength->{issuelength
};
1484 $sth->execute( $borrowertype, '*', $branchcode );
1485 $loanlength = $sth->fetchrow_hashref;
1487 if defined($loanlength) && defined $loanlength->{issuelength
};
1489 $sth->execute( '*', $itemtype, $branchcode );
1490 $loanlength = $sth->fetchrow_hashref;
1492 if defined($loanlength) && defined $loanlength->{issuelength
};
1494 $sth->execute( '*', '*', $branchcode );
1495 $loanlength = $sth->fetchrow_hashref;
1497 if defined($loanlength) && defined $loanlength->{issuelength
};
1499 $sth->execute( $borrowertype, $itemtype, '*' );
1500 $loanlength = $sth->fetchrow_hashref;
1502 if defined($loanlength) && defined $loanlength->{issuelength
};
1504 $sth->execute( $borrowertype, '*', '*' );
1505 $loanlength = $sth->fetchrow_hashref;
1507 if defined($loanlength) && defined $loanlength->{issuelength
};
1509 $sth->execute( '*', $itemtype, '*' );
1510 $loanlength = $sth->fetchrow_hashref;
1512 if defined($loanlength) && defined $loanlength->{issuelength
};
1514 $sth->execute( '*', '*', '*' );
1515 $loanlength = $sth->fetchrow_hashref;
1517 if defined($loanlength) && defined $loanlength->{issuelength
};
1519 # if no rule is set => 0 day (hardcoded)
1523 lengthunit
=> 'days',
1529 =head2 GetHardDueDate
1531 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1533 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1537 sub GetHardDueDate
{
1538 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1540 my $issuing_rule = Koha
::IssuingRules
->get_effective_issuing_rule(
1541 { categorycode
=> $borrowertype,
1542 itemtype
=> $itemtype,
1543 branchcode
=> $branchcode
1548 if ( defined( $issuing_rule ) ) {
1549 if ( $issuing_rule->hardduedate ) {
1550 return (dt_from_string
($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1552 return (undef, undef);
1557 =head2 GetBranchBorrowerCircRule
1559 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1561 Retrieves circulation rule attributes that apply to the given
1562 branch and patron category, regardless of item type.
1563 The return value is a hashref containing the following key:
1565 maxissueqty - maximum number of loans that a
1566 patron of the given category can have at the given
1567 branch. If the value is undef, no limit.
1569 maxonsiteissueqty - maximum of on-site checkouts that a
1570 patron of the given category can have at the given
1571 branch. If the value is undef, no limit.
1573 This will first check for a specific branch and
1574 category match from branch_borrower_circ_rules.
1576 If no rule is found, it will then check default_branch_circ_rules
1577 (same branch, default category). If no rule is found,
1578 it will then check default_borrower_circ_rules (default
1579 branch, same category), then failing that, default_circ_rules
1580 (default branch, default category).
1582 If no rule has been found in the database, it will default to
1586 maxonsiteissueqty - undef
1588 C<$branchcode> and C<$categorycode> should contain the
1589 literal branch code and patron category code, respectively - no
1594 sub GetBranchBorrowerCircRule
{
1595 my ( $branchcode, $categorycode ) = @_;
1598 my $dbh = C4
::Context
->dbh();
1599 $rules = $dbh->selectrow_hashref( q
|
1600 SELECT maxissueqty
, maxonsiteissueqty
1601 FROM branch_borrower_circ_rules
1602 WHERE branchcode
= ?
1603 AND categorycode
= ?
1604 |, {}, $branchcode, $categorycode ) ;
1605 return $rules if $rules;
1607 # try same branch, default borrower category
1608 $rules = $dbh->selectrow_hashref( q
|
1609 SELECT maxissueqty
, maxonsiteissueqty
1610 FROM default_branch_circ_rules
1611 WHERE branchcode
= ?
1612 |, {}, $branchcode ) ;
1613 return $rules if $rules;
1615 # try default branch, same borrower category
1616 $rules = $dbh->selectrow_hashref( q
|
1617 SELECT maxissueqty
, maxonsiteissueqty
1618 FROM default_borrower_circ_rules
1619 WHERE categorycode
= ?
1620 |, {}, $categorycode ) ;
1621 return $rules if $rules;
1623 # try default branch, default borrower category
1624 $rules = $dbh->selectrow_hashref( q
|
1625 SELECT maxissueqty
, maxonsiteissueqty
1626 FROM default_circ_rules
1628 return $rules if $rules;
1630 # built-in default circulation rule
1632 maxissueqty
=> undef,
1633 maxonsiteissueqty
=> undef,
1637 =head2 GetBranchItemRule
1639 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1641 Retrieves circulation rule attributes that apply to the given
1642 branch and item type, regardless of patron category.
1644 The return value is a hashref containing the following keys:
1646 holdallowed => Hold policy for this branch and itemtype. Possible values:
1647 0: No holds allowed.
1648 1: Holds allowed only by patrons that have the same homebranch as the item.
1649 2: Holds allowed from any patron.
1651 returnbranch => branch to which to return item. Possible values:
1652 noreturn: do not return, let item remain where checked in (floating collections)
1653 homebranch: return to item's home branch
1654 holdingbranch: return to issuer branch
1656 This searches branchitemrules in the following order:
1658 * Same branchcode and itemtype
1659 * Same branchcode, itemtype '*'
1660 * branchcode '*', same itemtype
1661 * branchcode and itemtype '*'
1663 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1667 sub GetBranchItemRule
{
1668 my ( $branchcode, $itemtype ) = @_;
1669 my $dbh = C4
::Context
->dbh();
1673 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1674 FROM branch_item_rules
1675 WHERE branchcode = ?
1676 AND itemtype = ?', $branchcode, $itemtype],
1677 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1678 FROM default_branch_circ_rules
1679 WHERE branchcode = ?', $branchcode],
1680 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1681 FROM default_branch_item_rules
1682 WHERE itemtype = ?', $itemtype],
1683 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1684 FROM default_circ_rules'],
1687 foreach my $attempt (@attempts) {
1688 my ($query, @bind_params) = @
{$attempt};
1689 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1692 # Since branch/category and branch/itemtype use the same per-branch
1693 # defaults tables, we have to check that the key we want is set, not
1694 # just that a row was returned
1695 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1696 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1697 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1700 # built-in default circulation rule
1701 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1702 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1703 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1710 ($doreturn, $messages, $iteminformation, $borrower) =
1711 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1717 =item C<$barcode> is the bar code of the book being returned.
1719 =item C<$branch> is the code of the branch where the book is being returned.
1721 =item C<$exemptfine> indicates that overdue charges for the item will be
1724 =item C<$dropbox> indicates that the check-in date is assumed to be
1725 yesterday, or the last non-holiday as defined in C4::Calendar . If
1726 overdue charges are applied and C<$dropbox> is true, the last charge
1727 will be removed. This assumes that the fines accrual script has run
1728 for _today_. Optional.
1730 =item C<$return_date> allows the default return date to be overridden
1731 by the given return date. Optional.
1735 C<&AddReturn> returns a list of four items:
1737 C<$doreturn> is true iff the return succeeded.
1739 C<$messages> is a reference-to-hash giving feedback on the operation.
1740 The keys of the hash are:
1746 No item with this barcode exists. The value is C<$barcode>.
1750 The book is not currently on loan. The value is C<$barcode>.
1754 This book has been withdrawn/cancelled. The value should be ignored.
1756 =item C<Wrongbranch>
1758 This book has was returned to the wrong branch. The value is a hashref
1759 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1760 contain the branchcode of the incorrect and correct return library, respectively.
1764 The item was reserved. The value is a reference-to-hash whose keys are
1765 fields from the reserves table of the Koha database, and
1766 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1767 either C<Waiting>, C<Reserved>, or 0.
1769 =item C<WasReturned>
1771 Value 1 if return is successful.
1773 =item C<NeedsTransfer>
1775 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1779 C<$iteminformation> is a reference-to-hash, giving information about the
1780 returned item from the issues table.
1782 C<$borrower> is a reference-to-hash, giving information about the
1783 patron who last borrowed the book.
1788 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1790 if ($branch and not Koha
::Libraries
->find($branch)) {
1791 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4
::Context
->userenv->{'branch'};
1794 $branch = C4
::Context
->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1798 my $validTransfert = 0;
1799 my $stat_type = 'return';
1801 # get information on item
1802 my $item = GetItem
( undef, $barcode );
1804 return ( 0, { BadBarcode
=> $barcode } ); # no barcode means no item or borrower. bail out.
1807 my $itemnumber = $item->{ itemnumber
};
1808 my $itemtype = $item->{itype
}; # GetItem called effective_itemtype
1810 my $issue = Koha
::Checkouts
->find( { itemnumber
=> $itemnumber } );
1812 $patron = Koha
::Patrons
->find( $issue->borrowernumber )
1813 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1814 . Dumper
($issue->unblessed) . "\n";
1816 $messages->{'NotIssued'} = $barcode;
1817 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1819 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1820 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1821 if (C4
::Context
->preference("RecordLocalUseOnReturn")) {
1822 $messages->{'LocalUse'} = 1;
1823 $stat_type = 'localuse';
1827 if ( $item->{'location'} eq 'PROC' ) {
1828 if ( C4
::Context
->preference("InProcessingToShelvingCart") ) {
1829 $item->{'location'} = 'CART';
1832 $item->{location
} = $item->{permanent_location
};
1835 ModItem
( $item, $item->{'biblionumber'}, $item->{'itemnumber'}, { log_action
=> 0 } );
1838 # full item data, but no borrowernumber or checkout info (no issue)
1839 my $hbr = GetBranchItemRule
($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1840 # get the proper branch to which to return the item
1841 my $returnbranch = $item->{$hbr} || $branch ;
1842 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1844 my $borrowernumber = $patron ?
$patron->borrowernumber : undef; # we don't know if we had a borrower or not
1845 my $patron_unblessed = $patron ?
$patron->unblessed : {};
1847 my $yaml = C4
::Context
->preference('UpdateNotForLoanStatusOnCheckin');
1849 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1851 eval { $rules = YAML
::Load
($yaml); };
1853 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1856 foreach my $key ( keys %$rules ) {
1857 if ( $item->{notforloan
} eq $key ) {
1858 $messages->{'NotForLoanStatusUpdated'} = { from
=> $item->{notforloan
}, to
=> $rules->{$key} };
1859 ModItem
( { notforloan
=> $rules->{$key} }, undef, $itemnumber, { log_action
=> 0 } );
1866 # check if the return is allowed at this branch
1867 my ($returnallowed, $message) = CanBookBeReturned
($item, $branch);
1868 unless ($returnallowed){
1869 $messages->{'Wrongbranch'} = {
1870 Wrongbranch
=> $branch,
1871 Rightbranch
=> $message
1874 return ( $doreturn, $messages, $issue, $patron_unblessed);
1877 if ( $item->{'withdrawn'} ) { # book has been cancelled
1878 $messages->{'withdrawn'} = 1;
1879 $doreturn = 0 if C4
::Context
->preference("BlockReturnOfWithdrawnItems");
1882 if ( $item->{itemlost
} and C4
::Context
->preference("BlockReturnOfLostItems") ) {
1886 # case of a return of document (deal with issues and holdingbranch)
1887 my $today = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1891 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1892 $patron or warn "AddReturn without current borrower";
1893 my $circControlBranch;
1895 # define circControlBranch only if dropbox mode is set
1896 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1897 # FIXME: check issuedate > returndate, factoring in holidays
1899 $circControlBranch = _GetCircControlBranch
($item,$patron_unblessed);
1900 $is_overdue = $issue->is_overdue( $dropboxdate );
1902 $is_overdue = $issue->is_overdue;
1907 MarkIssueReturned
( $borrowernumber, $item->{'itemnumber'},
1908 $circControlBranch, $return_date, $patron->privacy );
1911 if ( ( C4
::Context
->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1912 _CalculateAndUpdateFine
( { issue
=> $issue, item
=> $item, borrower
=> $patron_unblessed, return_date
=> $return_date } );
1915 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 );
1917 return ( 0, { WasReturned
=> 0, DataCorrupted
=> 1 }, $issue, $patron_unblessed );
1920 # FIXME is the "= 1" right? This could be the borrower hash.
1921 $messages->{'WasReturned'} = 1;
1925 ModItem
( { onloan
=> undef }, $item->{biblionumber
}, $item->{itemnumber
}, { log_action
=> 0 } );
1928 # the holdingbranch is updated if the document is returned to another location.
1929 # this is always done regardless of whether the item was on loan or not
1930 my $item_holding_branch = $item->{ holdingbranch
};
1931 if ($item->{'holdingbranch'} ne $branch) {
1932 UpdateHoldingbranch
($branch, $item->{'itemnumber'});
1933 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1935 ModDateLastSeen
( $item->{'itemnumber'} );
1937 # check if we have a transfer for this document
1938 my ($datesent,$frombranch,$tobranch) = GetTransfers
( $item->{'itemnumber'} );
1940 # if we have a transfer to do, we update the line of transfers with the datearrived
1941 my $is_in_rotating_collection = C4
::RotatingCollections
::isItemInAnyCollection
( $item->{'itemnumber'} );
1943 if ( $tobranch eq $branch ) {
1944 my $sth = C4
::Context
->dbh->prepare(
1945 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1947 $sth->execute( $item->{'itemnumber'} );
1948 # if we have a reservation with valid transfer, we can set it's status to 'W'
1949 ShelfToCart
( $item->{'itemnumber'} ) if ( C4
::Context
->preference("ReturnToShelvingCart") );
1950 C4
::Reserves
::ModReserveStatus
($item->{'itemnumber'}, 'W');
1952 $messages->{'WrongTransfer'} = $tobranch;
1953 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1955 $validTransfert = 1;
1957 ShelfToCart
( $item->{'itemnumber'} ) if ( C4
::Context
->preference("ReturnToShelvingCart") );
1960 # fix up the accounts.....
1961 if ( $item->{'itemlost'} ) {
1962 $messages->{'WasLost'} = 1;
1963 unless ( C4
::Context
->preference("BlockReturnOfLostItems") ) {
1965 Koha
::RefundLostItemFeeRules
->should_refund(
1967 current_branch
=> C4
::Context
->userenv->{branch
},
1968 item_home_branch
=> $item->{homebranch
},
1969 item_holding_branch
=> $item_holding_branch
1974 _FixAccountForLostAndReturned
( $item->{'itemnumber'},
1975 $borrowernumber, $barcode );
1976 $messages->{'LostItemFeeRefunded'} = 1;
1981 # fix up the overdues in accounts...
1982 if ($borrowernumber) {
1983 my $fix = _FixOverduesOnReturn
($borrowernumber, $item->{itemnumber
}, $exemptfine, $dropbox);
1984 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1986 if ( $issue and $issue->is_overdue ) {
1988 $today = $dropboxdate if $dropbox;
1989 my ($debardate,$reminder) = _debar_user_on_return
( $patron_unblessed, $item, dt_from_string
($issue->date_due), $today );
1991 $messages->{'PrevDebarred'} = $debardate;
1993 $messages->{'Debarred'} = $debardate if $debardate;
1995 # there's no overdue on the item but borrower had been previously debarred
1996 } elsif ( $issue->date_due and $patron->debarred ) {
1997 if ( $patron->debarred eq "9999-12-31") {
1998 $messages->{'ForeverDebarred'} = $patron->debarred;
2000 my $borrower_debar_dt = dt_from_string
( $patron->debarred );
2001 $borrower_debar_dt->truncate(to
=> 'day');
2002 my $today_dt = $today->clone()->truncate(to
=> 'day');
2003 if ( DateTime
->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2004 $messages->{'PrevDebarred'} = $patron->debarred;
2010 # find reserves.....
2011 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2012 my ($resfound, $resrec);
2013 my $lookahead= C4
::Context
->preference('ConfirmFutureHolds'); #number of days to look for future holds
2014 ($resfound, $resrec, undef) = C4
::Reserves
::CheckReserves
( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2016 $resrec->{'ResFound'} = $resfound;
2017 $messages->{'ResFound'} = $resrec;
2020 # Record the fact that this book was returned.
2024 itemnumber
=> $itemnumber,
2025 itemtype
=> $itemtype,
2026 borrowernumber
=> $borrowernumber,
2027 ccode
=> $item->{ ccode
}
2030 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2032 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2034 branchcode
=> $branch,
2035 categorycode
=> $patron->categorycode,
2036 item_type
=> $item->{itype
},
2037 notification
=> 'CHECKIN',
2039 if ($doreturn && $circulation_alert->is_enabled_for(\
%conditions)) {
2040 SendCirculationAlert
({
2043 borrower
=> $patron->unblessed,
2048 logaction
("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2049 if C4
::Context
->preference("ReturnLog");
2052 # Remove any OVERDUES related debarment if the borrower has no overdues
2053 if ( $borrowernumber
2054 && $patron->debarred
2055 && C4
::Context
->preference('AutoRemoveOverduesRestrictions')
2056 && !Koha
::Patrons
->find( $borrowernumber )->has_overdues
2057 && @
{ GetDebarments
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' }) }
2059 DelUniqueDebarment
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' });
2062 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2063 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2064 if (C4
::Context
->preference("AutomaticItemReturn" ) or
2065 (C4
::Context
->preference("UseBranchTransferLimits") and
2066 ! IsBranchTransferAllowed
($branch, $returnbranch, $item->{C4
::Context
->preference("BranchTransferLimitsType")} )
2068 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2069 $debug and warn "item: " . Dumper
($item);
2070 ModItemTransfer
($item->{'itemnumber'}, $branch, $returnbranch);
2071 $messages->{'WasTransfered'} = 1;
2073 $messages->{'NeedsTransfer'} = $returnbranch;
2077 return ( $doreturn, $messages, $issue, ( $patron ?
$patron->unblessed : {} ));
2080 =head2 MarkIssueReturned
2082 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2084 Unconditionally marks an issue as being returned by
2085 moving the C<issues> row to C<old_issues> and
2086 setting C<returndate> to the current date, or
2087 the last non-holiday date of the branccode specified in
2088 C<dropbox_branch> . Assumes you've already checked that
2089 it's safe to do this, i.e. last non-holiday > issuedate.
2091 if C<$returndate> is specified (in iso format), it is used as the date
2092 of the return. It is ignored when a dropbox_branch is passed in.
2094 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2095 the old_issue is immediately anonymised
2097 Ideally, this function would be internal to C<C4::Circulation>,
2098 not exported, but it is currently needed by one
2099 routine in C<C4::Accounts>.
2103 sub MarkIssueReturned
{
2104 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2107 # Retrieve the issue
2108 my $issue = Koha
::Checkouts
->find( { itemnumber
=> $itemnumber } ) or return;
2109 my $issue_id = $issue->issue_id;
2111 my $anonymouspatron;
2112 if ( $privacy == 2 ) {
2113 # The default of 0 will not work due to foreign key constraints
2114 # The anonymisation will fail if AnonymousPatron is not a valid entry
2115 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2116 # Note that a warning should appear on the about page (System information tab).
2117 $anonymouspatron = C4
::Context
->preference('AnonymousPatron');
2118 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."
2119 unless Koha
::Patrons
->find( $anonymouspatron );
2121 my $database = Koha
::Database
->new();
2122 my $schema = $database->schema;
2123 my $dbh = C4
::Context
->dbh;
2125 my $query = 'UPDATE issues SET returndate=';
2127 if ($dropbox_branch) {
2128 my $calendar = Koha
::Calendar
->new( branchcode
=> $dropbox_branch );
2129 my $dropboxdate = $calendar->addDate( DateTime
->now( time_zone
=> C4
::Context
->tz), -1 );
2131 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2132 } elsif ($returndate) {
2134 push @bind, $returndate;
2136 $query .= ' now() ';
2138 $query .= ' WHERE issue_id = ?';
2139 push @bind, $issue_id;
2141 # FIXME Improve the return value and handle it from callers
2142 $schema->txn_do(sub {
2144 # Update the returndate
2145 $dbh->do( $query, undef, @bind );
2147 # We just updated the returndate, so we need to refetch $issue
2148 $issue->discard_changes;
2150 # Create the old_issues entry
2151 my $old_checkout = Koha
::Old
::Checkout
->new($issue->unblessed)->store;
2153 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2154 if ( $privacy == 2) {
2155 $dbh->do(q
|UPDATE old_issues SET borrowernumber
=? WHERE issue_id
= ?
|, undef, $anonymouspatron, $old_checkout->issue_id);
2158 # And finally delete the issue
2161 ModItem
( { 'onloan' => undef }, undef, $itemnumber, { log_action
=> 0 } );
2163 if ( C4
::Context
->preference('StoreLastBorrower') ) {
2164 my $item = Koha
::Items
->find( $itemnumber );
2165 my $patron = Koha
::Patrons
->find( $borrowernumber );
2166 $item->last_returned_by( $patron );
2173 =head2 _debar_user_on_return
2175 _debar_user_on_return($borrower, $item, $datedue, today);
2177 C<$borrower> borrower hashref
2179 C<$item> item hashref
2181 C<$datedue> date due DateTime object
2183 C<$return_date> DateTime object representing the return time
2185 Internal function, called only by AddReturn that calculates and updates
2186 the user fine days, and debars them if necessary.
2188 Should only be called for overdue returns
2192 sub _debar_user_on_return
{
2193 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2195 my $branchcode = _GetCircControlBranch
( $item, $borrower );
2197 my $circcontrol = C4
::Context
->preference('CircControl');
2198 my $issuing_rule = Koha
::IssuingRules
->get_effective_issuing_rule(
2199 { categorycode
=> $borrower->{categorycode
},
2200 itemtype
=> $item->{itype
},
2201 branchcode
=> $branchcode
2204 my $finedays = $issuing_rule ?
$issuing_rule->finedays : undef;
2205 my $unit = $issuing_rule ?
$issuing_rule->lengthunit : undef;
2206 my $chargeable_units = C4
::Overdues
::get_chargeable_units
($unit, $dt_due, $return_date, $branchcode);
2210 # finedays is in days, so hourly loans must multiply by 24
2211 # thus 1 hour late equals 1 day suspension * finedays rate
2212 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2214 # grace period is measured in the same units as the loan
2216 DateTime
::Duration
->new( $unit => $issuing_rule->firstremind );
2218 my $deltadays = DateTime
::Duration
->new(
2219 days
=> $chargeable_units
2221 if ( $deltadays->subtract($grace)->is_positive() ) {
2222 my $suspension_days = $deltadays * $finedays;
2224 # If the max suspension days is < than the suspension days
2225 # the suspension days is limited to this maximum period.
2226 my $max_sd = $issuing_rule->maxsuspensiondays;
2227 if ( defined $max_sd ) {
2228 $max_sd = DateTime
::Duration
->new( days
=> $max_sd );
2229 $suspension_days = $max_sd
2230 if DateTime
::Duration
->compare( $max_sd, $suspension_days ) < 0;
2233 my ( $has_been_extended, $is_a_reminder );
2234 if ( C4
::Context
->preference('CumulativeRestrictionPeriods') and $borrower->{debarred
} ) {
2235 my $debarment = @
{ GetDebarments
( { borrowernumber
=> $borrower->{borrowernumber
}, type
=> 'SUSPENSION' } ) }[0];
2237 $return_date = dt_from_string
( $debarment->{expiration
}, 'sql' );
2238 $has_been_extended = 1;
2242 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2243 # No need to / 1 and do not consider / 0
2244 $suspension_days = DateTime
::Duration
->new(
2245 days
=> floor
( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2250 $return_date->clone()->add_duration( $suspension_days );
2252 Koha
::Patron
::Debarments
::AddUniqueDebarment
({
2253 borrowernumber
=> $borrower->{borrowernumber
},
2254 expiration
=> $new_debar_dt->ymd(),
2255 type
=> 'SUSPENSION',
2257 # if borrower was already debarred but does not get an extra debarment
2258 my $patron = Koha
::Patrons
->find( $borrower->{borrowernumber
} );
2259 my $new_debarment_str;
2260 if ( $borrower->{debarred
} eq $patron->is_debarred ) {
2262 $new_debarment_str = $borrower->{debarred
};
2264 $new_debarment_str = $new_debar_dt->ymd();
2266 # FIXME Should return a DateTime object
2267 return $new_debarment_str, $is_a_reminder;
2273 =head2 _FixOverduesOnReturn
2275 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2277 C<$brn> borrowernumber
2281 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2282 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2284 Internal function, called only by AddReturn
2288 sub _FixOverduesOnReturn
{
2289 my ($borrowernumber, $item);
2290 unless ($borrowernumber = shift) {
2291 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2294 unless ($item = shift) {
2295 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2298 my ($exemptfine, $dropbox) = @_;
2299 my $dbh = C4
::Context
->dbh;
2301 # check for overdue fine
2302 my $accountline = Koha
::Account
::Lines
->search(
2304 borrowernumber
=> $borrowernumber,
2305 itemnumber
=> $item,
2307 accounttype
=> 'FU',
2312 return 0 unless $accountline; # no warning, there's just nothing to fix
2316 my $amountoutstanding = $accountline->amountoutstanding;
2318 $accountline->accounttype('FFOR');
2319 $accountline->amountoutstanding(0);
2321 Koha
::Account
::Offset
->new(
2323 debit_id
=> $accountline->id,
2325 amount
=> $amountoutstanding * -1,
2329 if (C4
::Context
->preference("FinesLog")) {
2330 &logaction
("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2332 } elsif ($dropbox && $accountline->lastincrement) {
2333 my $outstanding = $accountline->amountoutstanding - $accountline->lastincrement;
2334 my $amt = $accountline->amount - $accountline->lastincrement;
2336 Koha
::Account
::Offset
->new(
2338 debit_id
=> $accountline->id,
2340 amount
=> $accountline->lastincrement * -1,
2344 if ( C4
::Context
->preference("FinesLog") ) {
2345 &logaction
( "FINES", 'MODIFY', $borrowernumber,
2346 "Dropbox adjustment $amt, item $item" );
2349 $accountline->accounttype('F');
2351 if ( $outstanding >= 0 && $amt >= 0 ) {
2352 $accountline->amount($amt);
2353 $accountline->amountoutstanding($outstanding);
2357 $accountline->accounttype('F');
2360 return $accountline->store();
2363 =head2 _FixAccountForLostAndReturned
2365 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2367 Calculates the charge for a book lost and returned.
2369 Internal function, not exported, called only by AddReturn.
2373 sub _FixAccountForLostAndReturned
{
2374 my $itemnumber = shift or return;
2375 my $borrowernumber = @_ ?
shift : undef;
2376 my $item_id = @_ ?
shift : $itemnumber; # Send the barcode if you want that logged in the description
2378 # check for charge made for lost book
2379 my $accountline = Koha
::Account
::Lines
->search(
2381 itemnumber
=> $itemnumber,
2382 accounttype
=> { -in => [ 'L', 'Rep', 'W' ] },
2385 order_by
=> { -desc
=> [ 'date', 'accountno' ] }
2389 return unless $accountline;
2390 return if $accountline->accounttype eq 'W'; # Written off
2392 $accountline->accounttype('LR');
2393 $accountline->store();
2395 my $account = Koha
::Account
->new( { patron_id
=> $accountline->borrowernumber } );
2396 my $credit_id = $account->pay(
2398 amount
=> $accountline->amount,
2399 description
=> "Item Returned " . $item_id,
2400 account_type
=> 'CR',
2401 offset_type
=> 'Lost Item Return',
2402 accounlines
=> [$accountline],
2407 ModItem
( { paidfor
=> '' }, undef, $itemnumber, { log_action
=> 0 } );
2412 =head2 _GetCircControlBranch
2414 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2418 Return the library code to be used to determine which circulation
2419 policy applies to a transaction. Looks up the CircControl and
2420 HomeOrHoldingBranch system preferences.
2422 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2424 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2428 sub _GetCircControlBranch
{
2429 my ($item, $borrower) = @_;
2430 my $circcontrol = C4
::Context
->preference('CircControl');
2433 if ($circcontrol eq 'PickupLibrary' and (C4
::Context
->userenv and C4
::Context
->userenv->{'branch'}) ) {
2434 $branch= C4
::Context
->userenv->{'branch'};
2435 } elsif ($circcontrol eq 'PatronLibrary') {
2436 $branch=$borrower->{branchcode
};
2438 my $branchfield = C4
::Context
->preference('HomeOrHoldingBranch') || 'homebranch';
2439 $branch = $item->{$branchfield};
2440 # default to item home branch if holdingbranch is used
2441 # and is not defined
2442 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2443 $branch = $item->{homebranch
};
2451 $issue = GetOpenIssue( $itemnumber );
2453 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2455 C<$itemnumber> is the item's itemnumber
2462 my ( $itemnumber ) = @_;
2463 return unless $itemnumber;
2464 my $dbh = C4
::Context
->dbh;
2465 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2466 $sth->execute( $itemnumber );
2467 return $sth->fetchrow_hashref();
2471 =head2 GetBiblioIssues
2473 $issues = GetBiblioIssues($biblionumber);
2475 this function get all issues from a biblionumber.
2478 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2479 tables issues and the firstname,surname & cardnumber from borrowers.
2483 sub GetBiblioIssues
{
2484 my $biblionumber = shift;
2485 return unless $biblionumber;
2486 my $dbh = C4
::Context
->dbh;
2488 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2490 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2491 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2492 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2493 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2494 WHERE biblio.biblionumber = ?
2496 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2498 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2499 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2500 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2501 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2502 WHERE biblio.biblionumber = ?
2505 my $sth = $dbh->prepare($query);
2506 $sth->execute($biblionumber, $biblionumber);
2509 while ( my $data = $sth->fetchrow_hashref ) {
2510 push @issues, $data;
2515 =head2 GetUpcomingDueIssues
2517 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2521 sub GetUpcomingDueIssues
{
2524 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2525 my $dbh = C4
::Context
->dbh;
2527 my $statement = <<END_SQL;
2530 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2532 LEFT JOIN items USING (itemnumber)
2533 LEFT OUTER JOIN branches USING (branchcode)
2534 WHERE returndate is NULL
2536 WHERE days_until_due >= 0 AND days_until_due <= ?
2539 my @bind_parameters = ( $params->{'days_in_advance'} );
2541 my $sth = $dbh->prepare( $statement );
2542 $sth->execute( @bind_parameters );
2543 my $upcoming_dues = $sth->fetchall_arrayref({});
2545 return $upcoming_dues;
2548 =head2 CanBookBeRenewed
2550 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2552 Find out whether a borrowed item may be renewed.
2554 C<$borrowernumber> is the borrower number of the patron who currently
2555 has the item on loan.
2557 C<$itemnumber> is the number of the item to renew.
2559 C<$override_limit>, if supplied with a true value, causes
2560 the limit on the number of times that the loan can be renewed
2561 (as controlled by the item type) to be ignored. Overriding also allows
2562 to renew sooner than "No renewal before" and to manually renew loans
2563 that are automatically renewed.
2565 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2566 item must currently be on loan to the specified borrower; renewals
2567 must be allowed for the item's type; and the borrower must not have
2568 already renewed the loan. $error will contain the reason the renewal can not proceed
2572 sub CanBookBeRenewed {
2573 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2575 my $dbh = C4::Context->dbh;
2578 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2579 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return ( 0, 'no_checkout' );
2580 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2582 $borrowernumber ||= $issue->borrowernumber;
2583 my $patron = Koha::Patrons->find( $borrowernumber )
2586 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2588 # This item can fill one or more unfilled reserve, can those unfilled reserves
2589 # all be filled by other available items?
2591 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2593 my $schema = Koha::Database->new()->schema();
2595 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2597 # There is an item level hold on this item, no other item can fill the hold
2602 # Get all other items that could possibly fill reserves
2603 my @itemnumbers = $schema->resultset('Item')->search(
2605 biblionumber => $resrec->{biblionumber},
2608 -not => { itemnumber => $itemnumber }
2610 { columns => 'itemnumber' }
2611 )->get_column('itemnumber')->all();
2613 # Get all other reserves that could have been filled by this item
2614 my @borrowernumbers;
2616 my ( $reserve_found, $reserve, undef ) =
2617 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2619 if ($reserve_found) {
2620 push( @borrowernumbers, $reserve->{borrowernumber} );
2627 # If the count of the union of the lists of reservable items for each borrower
2628 # is equal or greater than the number of borrowers, we know that all reserves
2629 # can be filled with available items. We can get the union of the sets simply
2630 # by pushing all the elements onto an array and removing the duplicates.
2633 ITEM: foreach my $i (@itemnumbers) {
2634 my $item = GetItem($i);
2635 next if IsItemOnHoldAndFound($i);
2636 for my $b (@borrowernumbers) {
2637 my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2638 next unless IsAvailableForItemLevelRequest($item, $borr);
2639 next unless CanItemBeReserved($b,$i);
2641 push @reservable, $i;
2642 if (@reservable >= @borrowernumbers) {
2651 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2653 return ( 1, undef ) if $override_limit;
2655 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2656 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2657 { categorycode => $patron->categorycode,
2658 itemtype => $item->{itype},
2659 branchcode => $branchcode
2663 return ( 0, "too_many" )
2664 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2666 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2667 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2668 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2669 my $restricted = $patron->is_debarred;
2670 my $hasoverdues = $patron->has_overdues;
2672 if ( $restricted and $restrictionblockrenewing ) {
2673 return ( 0, 'restriction');
2674 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2675 return ( 0, 'overdue');
2678 if ( $issue->auto_renew ) {
2680 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2681 return ( 0, 'auto_account_expired' );
2684 if ( defined $issuing_rule->no_auto_renewal_after
2685 and $issuing_rule->no_auto_renewal_after ne "" ) {
2686 # Get issue_date and add no_auto_renewal_after
2687 # If this is greater than today, it's too late for renewal.
2688 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2689 $maximum_renewal_date->add(
2690 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2692 my $now = dt_from_string;
2693 if ( $now >= $maximum_renewal_date ) {
2694 return ( 0, "auto_too_late" );
2697 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2698 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2699 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2700 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2701 return ( 0, "auto_too_late" );
2705 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2706 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2707 my $amountoutstanding = $patron->account->balance;
2708 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2709 return ( 0, "auto_too_much_oweing" );
2714 if ( defined $issuing_rule->norenewalbefore
2715 and $issuing_rule->norenewalbefore ne "" )
2718 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2719 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2720 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2722 # Depending on syspref reset the exact time, only check the date
2723 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2724 and $issuing_rule->lengthunit eq 'days' )
2726 $soonestrenewal->truncate( to => 'day' );
2729 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2731 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2732 return ( 0, "too_soon" );
2734 elsif ( $issue->auto_renew ) {
2735 return ( 0, "auto_renew" );
2739 # Fallback for automatic renewals:
2740 # If norenewalbefore is undef, don't renew before due date.
2741 if ( $issue->auto_renew ) {
2742 my $now = dt_from_string;
2743 return ( 0, "auto_renew" )
2744 if $now >= dt_from_string( $issue->date_due, 'sql' );
2745 return ( 0, "auto_too_soon" );
2748 return ( 1, undef );
2753 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2757 C<$borrowernumber> is the borrower number of the patron who currently
2760 C<$itemnumber> is the number of the item to renew.
2762 C<$branch> is the library where the renewal took place (if any).
2763 The library that controls the circ policies for the renewal is retrieved from the issues record.
2765 C<$datedue> can be a DateTime object used to set the due date.
2767 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2768 this parameter is not supplied, lastreneweddate is set to the current date.
2770 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2771 from the book's item type.
2776 my $borrowernumber = shift;
2777 my $itemnumber = shift or return;
2779 my $datedue = shift;
2780 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2782 my $item = GetItem($itemnumber) or return;
2783 my $item_object = Koha::Items->find( $itemnumber ); # Should replace $item
2784 my $biblio = $item_object->biblio;
2786 my $dbh = C4::Context->dbh;
2788 # Find the issues record for this book
2789 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
2791 return unless $issue;
2793 $borrowernumber ||= $issue->borrowernumber;
2795 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2796 carp 'Invalid date passed to AddRenewal.';
2800 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2801 my $patron_unblessed = $patron->unblessed;
2803 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2804 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed } );
2806 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2808 # If the due date wasn't specified, calculate it by adding the
2809 # book's loan length to today's date or the current due date
2810 # based on the value of the RenewalPeriodBase syspref.
2813 my $itemtype = $item_object->effective_itemtype;
2814 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2815 dt_from_string( $issue->date_due, 'sql' ) :
2816 DateTime->now( time_zone => C4::Context->tz());
2817 $datedue = CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $patron_unblessed), $patron_unblessed, 'is a renewal');
2820 # Update the issues record to have the new due date, and a new count
2821 # of how many times it has been renewed.
2822 my $renews = $issue->renewals + 1;
2823 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2824 WHERE borrowernumber=?
2828 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2830 # Update the renewal count on the item, and tell zebra to reindex
2831 $renews = $item->{renewals} + 1;
2832 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item->{biblionumber}, $itemnumber, { log_action => 0 } );
2834 # Charge a new rental fee, if applicable?
2835 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2836 if ( $charge > 0 ) {
2837 my $accountno = getnextacctno( $borrowernumber );
2839 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2840 $sth = $dbh->prepare(
2841 "INSERT INTO accountlines
2842 (date, borrowernumber, accountno, amount, manager_id,
2843 description,accounttype, amountoutstanding, itemnumber)
2844 VALUES (now(),?,?,?,?,?,?,?,?)"
2846 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2847 "Renewal of Rental Item " . $biblio->title . " $item->{'barcode'}",
2848 'Rent', $charge, $itemnumber );
2851 # Send a renewal slip according to checkout alert preferencei
2852 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2853 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2855 branchcode => $branch,
2856 categorycode => $patron->categorycode,
2857 item_type => $item->{itype},
2858 notification => 'CHECKOUT',
2860 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2861 SendCirculationAlert(
2865 borrower => $patron->unblessed,
2872 # Remove any OVERDUES related debarment if the borrower has no overdues
2874 && $patron->is_debarred
2875 && ! $patron->has_overdues
2876 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2878 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2881 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2882 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2885 # Add the renewal to stats
2891 itemnumber => $itemnumber,
2892 itemtype => $item->{itype},
2893 location => $item->{location},
2894 borrowernumber => $borrowernumber,
2895 ccode => $item->{'ccode'}
2900 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2905 # check renewal status
2906 my ( $bornum, $itemno ) = @_;
2907 my $dbh = C4::Context->dbh;
2909 my $renewsallowed = 0;
2912 my $patron = Koha::Patrons->find( $bornum );
2913 my $item = GetItem($itemno);
2915 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2917 # Look in the issues table for this item, lent to this borrower,
2918 # and not yet returned.
2920 # FIXME - I think this function could be redone to use only one SQL call.
2921 my $sth = $dbh->prepare(
2922 "select * from issues
2923 where (borrowernumber = ?)
2924 and (itemnumber = ?)"
2926 $sth->execute( $bornum, $itemno );
2927 my $data = $sth->fetchrow_hashref;
2928 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2929 # $item and $borrower should be calculated
2930 my $branchcode = _GetCircControlBranch($item, $patron->unblessed);
2932 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2933 { categorycode => $patron->categorycode,
2934 itemtype => $item->{itype},
2935 branchcode => $branchcode
2939 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
2940 $renewsleft = $renewsallowed - $renewcount;
2941 if($renewsleft < 0){ $renewsleft = 0; }
2942 return ( $renewcount, $renewsallowed, $renewsleft );
2945 =head2 GetSoonestRenewDate
2947 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2949 Find out the soonest possible renew date of a borrowed item.
2951 C<$borrowernumber> is the borrower number of the patron who currently
2952 has the item on loan.
2954 C<$itemnumber> is the number of the item to renew.
2956 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2957 renew date, based on the value "No renewal before" of the applicable
2958 issuing rule. Returns the current date if the item can already be
2959 renewed, and returns undefined if the borrower, loan, or item
2964 sub GetSoonestRenewDate {
2965 my ( $borrowernumber, $itemnumber ) = @_;
2967 my $dbh = C4::Context->dbh;
2969 my $item = GetItem($itemnumber) or return;
2970 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2972 $borrowernumber ||= $itemissue->borrowernumber;
2973 my $patron = Koha::Patrons->find( $borrowernumber )
2976 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2977 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2978 { categorycode => $patron->categorycode,
2979 itemtype => $item->{itype},
2980 branchcode => $branchcode
2984 my $now = dt_from_string;
2985 return $now unless $issuing_rule;
2987 if ( defined $issuing_rule->norenewalbefore
2988 and $issuing_rule->norenewalbefore ne "" )
2990 my $soonestrenewal =
2991 dt_from_string( $itemissue->date_due )->subtract(
2992 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2994 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2995 and $issuing_rule->lengthunit eq 'days' )
2997 $soonestrenewal->truncate( to => 'day' );
2999 return $soonestrenewal if $now < $soonestrenewal;
3004 =head2 GetLatestAutoRenewDate
3006 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3008 Find out the latest possible auto renew date of a borrowed item.
3010 C<$borrowernumber> is the borrower number of the patron who currently
3011 has the item on loan.
3013 C<$itemnumber> is the number of the item to renew.
3015 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3016 auto renew date, based on the value "No auto renewal after" and the "No auto
3017 renewal after (hard limit) of the applicable issuing rule.
3018 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3019 or item cannot be found.
3023 sub GetLatestAutoRenewDate {
3024 my ( $borrowernumber, $itemnumber ) = @_;
3026 my $dbh = C4::Context->dbh;
3028 my $item = GetItem($itemnumber) or return;
3029 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3031 $borrowernumber ||= $itemissue->borrowernumber;
3032 my $patron = Koha::Patrons->find( $borrowernumber )
3035 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3036 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3037 { categorycode => $patron->categorycode,
3038 itemtype => $item->{itype},
3039 branchcode => $branchcode
3043 return unless $issuing_rule;
3045 if ( not $issuing_rule->no_auto_renewal_after
3046 or $issuing_rule->no_auto_renewal_after eq '' )
3047 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3048 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3050 my $maximum_renewal_date;
3051 if ( $issuing_rule->no_auto_renewal_after ) {
3052 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3053 $maximum_renewal_date->add(
3054 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3058 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3059 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3060 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3062 return $maximum_renewal_date;
3066 =head2 GetIssuingCharges
3068 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3070 Calculate how much it would cost for a given patron to borrow a given
3071 item, including any applicable discounts.
3073 C<$itemnumber> is the item number of item the patron wishes to borrow.
3075 C<$borrowernumber> is the patron's borrower number.
3077 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3078 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3083 sub GetIssuingCharges {
3085 # calculate charges due
3086 my ( $itemnumber, $borrowernumber ) = @_;
3088 my $dbh = C4::Context->dbh;
3091 # Get the book's item type and rental charge (via its biblioitem).
3092 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3093 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3094 $charge_query .= (C4::Context->preference('item-level_itypes'))
3095 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3096 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3098 $charge_query .= ' WHERE items.itemnumber =?';
3100 my $sth = $dbh->prepare($charge_query);
3101 $sth->execute($itemnumber);
3102 if ( my $item_data = $sth->fetchrow_hashref ) {
3103 $item_type = $item_data->{itemtype};
3104 $charge = $item_data->{rentalcharge};
3105 my $branch = C4::Context::mybranch();
3106 my $discount_query = q|SELECT rentaldiscount,
3107 issuingrules.itemtype, issuingrules.branchcode
3109 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3110 WHERE borrowers.borrowernumber = ?
3111 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3112 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3113 my $discount_sth = $dbh->prepare($discount_query);
3114 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3115 my $discount_rules = $discount_sth->fetchall_arrayref({});
3116 if (@{$discount_rules}) {
3117 # We may have multiple rules so get the most specific
3118 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3119 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3122 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3126 return ( $charge, $item_type );
3129 # Select most appropriate discount rule from those returned
3130 sub _get_discount_from_rule {
3131 my ($rules_ref, $branch, $itemtype) = @_;
3134 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3135 $discount = $rules_ref->[0]->{rentaldiscount};
3136 return (defined $discount) ? $discount : 0;
3138 # could have up to 4 does one match $branch and $itemtype
3139 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3141 $discount = $d[0]->{rentaldiscount};
3142 return (defined $discount) ? $discount : 0;
3144 # do we have item type + all branches
3145 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype
} eq $itemtype } @
{$rules_ref};
3147 $discount = $d[0]->{rentaldiscount
};
3148 return (defined $discount) ?
$discount : 0;
3150 # do we all item types + this branch
3151 @d = grep { $_->{branchcode
} eq $branch && $_->{itemtype
} eq q{*} } @
{$rules_ref};
3153 $discount = $d[0]->{rentaldiscount
};
3154 return (defined $discount) ?
$discount : 0;
3156 # so all and all (surely we wont get here)
3157 @d = grep { $_->{branchcode
} eq q{*} && $_->{itemtype
} eq q{*} } @
{$rules_ref};
3159 $discount = $d[0]->{rentaldiscount
};
3160 return (defined $discount) ?
$discount : 0;
3166 =head2 AddIssuingCharge
3168 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3172 sub AddIssuingCharge
{
3173 my ( $itemnumber, $borrowernumber, $charge ) = @_;
3175 my $nextaccntno = getnextacctno
($borrowernumber);
3178 $manager_id = C4
::Context
->userenv->{'number'} if C4
::Context
->userenv;
3180 my $accountline = Koha
::Account
::Line
->new(
3182 borrowernumber
=> $borrowernumber,
3183 itemnumber
=> $itemnumber,
3184 accountno
=> $nextaccntno,
3186 amountoutstanding
=> $charge,
3187 manager_id
=> $manager_id,
3188 description
=> 'Rental',
3189 accounttype
=> 'Rent',
3194 Koha::Account::Offset->new(
3196 debit_id => $accountline->id,
3197 type => 'Rental Fee
',
3205 GetTransfers($itemnumber);
3210 my ($itemnumber) = @_;
3212 my $dbh = C4::Context->dbh;
3219 FROM branchtransfers
3220 WHERE itemnumber
= ?
3221 AND datearrived IS NULL
3223 my $sth = $dbh->prepare($query);
3224 $sth->execute($itemnumber);
3225 my @row = $sth->fetchrow_array();
3229 =head2 GetTransfersFromTo
3231 @results = GetTransfersFromTo($frombranch,$tobranch);
3233 Returns the list of pending transfers between $from and $to branch
3237 sub GetTransfersFromTo {
3238 my ( $frombranch, $tobranch ) = @_;
3239 return unless ( $frombranch && $tobranch );
3240 my $dbh = C4::Context->dbh;
3242 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3243 FROM branchtransfers
3246 AND datearrived IS NULL
3248 my $sth = $dbh->prepare($query);
3249 $sth->execute( $frombranch, $tobranch );
3252 while ( my $data = $sth->fetchrow_hashref ) {
3253 push @gettransfers, $data;
3255 return (@gettransfers);
3258 =head2 DeleteTransfer
3260 &DeleteTransfer($itemnumber);
3264 sub DeleteTransfer {
3265 my ($itemnumber) = @_;
3266 return unless $itemnumber;
3267 my $dbh = C4::Context->dbh;
3268 my $sth = $dbh->prepare(
3269 "DELETE FROM branchtransfers
3271 AND datearrived IS NULL "
3273 return $sth->execute($itemnumber);
3276 =head2 SendCirculationAlert
3278 Send out a C<check-in> or C<checkout> alert using the messaging system.
3286 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3290 Hashref of information about the item being checked in or out.
3294 Hashref of information about the borrower of the item.
3298 The branchcode from where the checkout or check-in took place.
3304 SendCirculationAlert({
3307 borrower => $borrower,
3313 sub SendCirculationAlert {
3315 my ($type, $item, $borrower, $branch) =
3316 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3317 my %message_name = (
3318 CHECKIN => 'Item_Check_in
',
3319 CHECKOUT => 'Item_Checkout
',
3320 RENEWAL => 'Item_Checkout
',
3322 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3323 borrowernumber => $borrower->{borrowernumber},
3324 message_name => $message_name{$type},
3326 my $issues_table = ( $type eq 'CHECKOUT
' || $type eq 'RENEWAL
' ) ? 'issues
' : 'old_issues
';
3328 my $schema = Koha::Database->new->schema;
3329 my @transports = keys %{ $borrower_preferences->{transports} };
3331 # From the MySQL doc:
3332 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3333 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3334 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3335 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3337 for my $mtt (@transports) {
3338 my $letter = C4::Letters::GetPreparedLetter (
3339 module => 'circulation
',
3340 letter_code => $type,
3341 branchcode => $branch,
3342 message_transport_type => $mtt,
3343 lang => $borrower->{lang},
3345 $issues_table => $item->{itemnumber},
3346 'items
' => $item->{itemnumber},
3347 'biblio
' => $item->{biblionumber},
3348 'biblioitems
' => $item->{biblionumber},
3349 'borrowers
' => $borrower,
3350 'branches
' => $branch,
3354 $schema->storage->txn_begin;
3355 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3356 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3357 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3358 unless ( $message ) {
3359 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3360 C4::Message->enqueue($letter, $borrower, $mtt);
3362 $message->append($letter);
3365 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3366 $schema->storage->txn_commit;
3372 =head2 updateWrongTransfer
3374 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3376 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
3380 sub updateWrongTransfer {
3381 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3382 my $dbh = C4::Context->dbh;
3383 # first step validate the actual line of transfert .
3386 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer
' where itemnumber= ? AND datearrived IS NULL"
3388 $sth->execute($FromLibrary,$itemNumber);
3390 # second step create a new line of branchtransfer to the right location .
3391 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3393 #third step changing holdingbranch of item
3394 UpdateHoldingbranch($FromLibrary,$itemNumber);
3397 =head2 UpdateHoldingbranch
3399 $items = UpdateHoldingbranch($branch,$itmenumber);
3401 Simple methode for updating hodlingbranch in items BDD line
3405 sub UpdateHoldingbranch {
3406 my ( $branch,$itemnumber ) = @_;
3407 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3412 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3414 this function calculates the due date given the start date and configured circulation rules,
3415 checking against the holidays calendar as per the 'useDaysMode
' syspref.
3416 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3417 C<$itemtype> = itemtype code of item in question
3418 C<$branch> = location whose calendar to use
3419 C<$borrower> = Borrower object
3420 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3425 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3429 # loanlength now a href
3431 GetLoanLength( $borrower->{'categorycode
'}, $itemtype, $branch );
3433 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3439 if (ref $startdate ne 'DateTime
' ) {
3440 $datedue = dt_from_string($datedue);
3442 $datedue = $startdate->clone;
3446 DateTime->now( time_zone => C4::Context->tz() )
3447 ->truncate( to => 'minute
' );
3451 # calculate the datedue as normal
3452 if ( C4::Context->preference('useDaysMode
') eq 'Days
' )
3453 { # ignoring calendar
3454 if ( $loanlength->{lengthunit} eq 'hours
' ) {
3455 $datedue->add( hours => $loanlength->{$length_key} );
3457 $datedue->add( days => $loanlength->{$length_key} );
3458 $datedue->set_hour(23);
3459 $datedue->set_minute(59);
3463 if ($loanlength->{lengthunit} eq 'hours
') {
3464 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3467 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3469 my $calendar = Koha::Calendar->new( branchcode => $branch );
3470 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3471 if ($loanlength->{lengthunit} eq 'days
') {
3472 $datedue->set_hour(23);
3473 $datedue->set_minute(59);
3477 # if Hard Due Dates are used, retrieve them and apply as necessary
3478 my ( $hardduedate, $hardduedatecompare ) =
3479 GetHardDueDate( $borrower->{'categorycode
'}, $itemtype, $branch );
3480 if ($hardduedate) { # hardduedates are currently dates
3481 $hardduedate->truncate( to => 'minute
' );
3482 $hardduedate->set_hour(23);
3483 $hardduedate->set_minute(59);
3484 my $cmp = DateTime->compare( $hardduedate, $datedue );
3486 # if the calculated due date is after the 'before
' Hard Due Date (ceiling), override
3487 # if the calculated date is before the 'after
' Hard Due Date (floor), override
3488 # if the hard due date is set to 'exactly
', overrride
3489 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3490 $datedue = $hardduedate->clone;
3493 # in all other cases, keep the date due as it is
3497 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3498 if ( C4
::Context
->preference('ReturnBeforeExpiry') ) {
3499 my $expiry_dt = dt_from_string
( $borrower->{dateexpiry
}, 'iso', 'floating');
3500 if( $expiry_dt ) { #skip empty expiry date..
3501 $expiry_dt->set( hour
=> 23, minute
=> 59);
3502 my $d1= $datedue->clone->set_time_zone('floating');
3503 if ( DateTime
->compare( $d1, $expiry_dt ) == 1 ) {
3504 $datedue = $expiry_dt->clone->set_time_zone( C4
::Context
->tz );
3507 if ( C4
::Context
->preference('useDaysMode') ne 'Days' ) {
3508 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
3509 if ( $calendar->is_holiday($datedue) ) {
3510 # Don't return on a closed day
3511 $datedue = $calendar->prev_open_day( $datedue );
3520 sub CheckValidBarcode
{
3522 my $dbh = C4
::Context
->dbh;
3523 my $query=qq|SELECT count
(*)
3527 my $sth = $dbh->prepare($query);
3528 $sth->execute($barcode);
3529 my $exist=$sth->fetchrow ;
3533 =head2 IsBranchTransferAllowed
3535 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3537 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3541 sub IsBranchTransferAllowed
{
3542 my ( $toBranch, $fromBranch, $code ) = @_;
3544 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3546 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3547 my $dbh = C4
::Context
->dbh;
3549 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3550 $sth->execute( $toBranch, $fromBranch, $code );
3551 my $limit = $sth->fetchrow_hashref();
3553 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3554 if ( $limit->{'limitId'} ) {
3561 =head2 CreateBranchTransferLimit
3563 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3565 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3569 sub CreateBranchTransferLimit
{
3570 my ( $toBranch, $fromBranch, $code ) = @_;
3571 return unless defined($toBranch) && defined($fromBranch);
3572 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3574 my $dbh = C4
::Context
->dbh;
3576 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3577 return $sth->execute( $code, $toBranch, $fromBranch );
3580 =head2 DeleteBranchTransferLimits
3582 my $result = DeleteBranchTransferLimits($frombranch);
3584 Deletes all the library transfer limits for one library. Returns the
3585 number of limits deleted, 0e0 if no limits were deleted, or undef if
3586 no arguments are supplied.
3590 sub DeleteBranchTransferLimits
{
3592 return unless defined $branch;
3593 my $dbh = C4
::Context
->dbh;
3594 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3595 return $sth->execute($branch);
3599 my ( $borrowernumber, $itemnum ) = @_;
3601 MarkIssueReturned
( $borrowernumber, $itemnum );
3602 my $patron = Koha
::Patrons
->find( $borrowernumber );
3603 my $item = C4
::Items
::GetItem
( $itemnum );
3604 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ?
$item->{'paidfor'}.' / ' : q{};
3605 my @datearr = localtime(time);
3606 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3607 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3608 ModItem
({ paidfor
=> $old_note."Paid for by $bor $date" }, undef, $itemnum);
3613 my ($itemnumber, $mark_returned) = @_;
3615 $mark_returned //= C4
::Context
->preference('MarkLostItemsAsReturned');
3617 my $dbh = C4
::Context
->dbh();
3618 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3620 JOIN items USING (itemnumber)
3621 JOIN biblio USING (biblionumber)
3622 WHERE issues.itemnumber=?");
3623 $sth->execute($itemnumber);
3624 my $issues=$sth->fetchrow_hashref();
3626 # If a borrower lost the item, add a replacement cost to the their record
3627 if ( my $borrowernumber = $issues->{borrowernumber
} ){
3628 my $patron = Koha
::Patrons
->find( $borrowernumber );
3630 if (C4
::Context
->preference('WhenLostForgiveFine')){
3631 my $fix = _FixOverduesOnReturn
($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3632 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3634 if (C4
::Context
->preference('WhenLostChargeReplacementFee')){
3635 C4
::Accounts
::chargelostitem
($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3636 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3637 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3640 MarkIssueReturned
($borrowernumber,$itemnumber,undef,undef,$patron->privacy) if $mark_returned;
3644 sub GetOfflineOperations
{
3645 my $dbh = C4
::Context
->dbh;
3646 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3647 $sth->execute(C4
::Context
->userenv->{'branch'});
3648 my $results = $sth->fetchall_arrayref({});
3652 sub GetOfflineOperation
{
3653 my $operationid = shift;
3654 return unless $operationid;
3655 my $dbh = C4
::Context
->dbh;
3656 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3657 $sth->execute( $operationid );
3658 return $sth->fetchrow_hashref;
3661 sub AddOfflineOperation
{
3662 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3663 my $dbh = C4
::Context
->dbh;
3664 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3665 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3669 sub DeleteOfflineOperation
{
3670 my $dbh = C4
::Context
->dbh;
3671 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3672 $sth->execute( shift );
3676 sub ProcessOfflineOperation
{
3677 my $operation = shift;
3680 if ( $operation->{action
} eq 'return' ) {
3681 $report = ProcessOfflineReturn
( $operation );
3682 } elsif ( $operation->{action
} eq 'issue' ) {
3683 $report = ProcessOfflineIssue
( $operation );
3684 } elsif ( $operation->{action
} eq 'payment' ) {
3685 $report = ProcessOfflinePayment
( $operation );
3688 DeleteOfflineOperation
( $operation->{operationid
} ) if $operation->{operationid
};
3693 sub ProcessOfflineReturn
{
3694 my $operation = shift;
3696 my $item = Koha
::Items
->find({barcode
=> $operation->{barcode
}});
3699 my $itemnumber = $item->itemnumber;
3700 my $issue = GetOpenIssue
( $itemnumber );
3703 $issue->{borrowernumber
},
3706 $operation->{timestamp
},
3709 { renewals
=> 0, onloan
=> undef },
3710 $issue->{'biblionumber'},
3716 return "Item not issued.";
3719 return "Item not found.";
3723 sub ProcessOfflineIssue
{
3724 my $operation = shift;
3726 my $patron = Koha
::Patrons
->find( { cardnumber
=> $operation->{cardnumber
} } );
3729 my $item = Koha
::Items
->find({ barcode
=> $operation->{barcode
} });
3731 return "Barcode not found.";
3733 my $itemnumber = $item->itemnumber;
3734 my $issue = GetOpenIssue
( $itemnumber );
3736 if ( $issue and ( $issue->{borrowernumber
} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3738 $issue->{borrowernumber
},
3741 $operation->{timestamp
},
3746 $operation->{'barcode'},
3749 $operation->{timestamp
},
3754 return "Borrower not found.";
3758 sub ProcessOfflinePayment
{
3759 my $operation = shift;
3761 my $patron = Koha
::Patrons
->find( { cardnumber
=> $operation->{cardnumber
} });
3762 my $amount = $operation->{amount
};
3764 Koha
::Account
->new( { patron_id
=> $patron->id } )->pay( { amount
=> $amount } );
3772 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3774 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3779 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3781 my $item = GetItem
( $itemnumber, $barcode )
3784 return C4
::Letters
::GetPreparedLetter
(
3785 module
=> 'circulation',
3786 letter_code
=> 'TRANSFERSLIP',
3787 branchcode
=> $branch,
3789 'branches' => $to_branch,
3790 'biblio' => $item->{biblionumber
},
3796 =head2 CheckIfIssuedToPatron
3798 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3800 Return 1 if any record item is issued to patron, otherwise return 0
3804 sub CheckIfIssuedToPatron
{
3805 my ($borrowernumber, $biblionumber) = @_;
3807 my $dbh = C4
::Context
->dbh;
3809 SELECT COUNT
(*) FROM issues
3810 LEFT JOIN items ON items
.itemnumber
= issues
.itemnumber
3811 WHERE items
.biblionumber
= ?
3812 AND issues
.borrowernumber
= ?
3814 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3815 return 1 if $is_issued;
3821 IsItemIssued( $itemnumber )
3823 Return 1 if the item is on loan, otherwise return 0
3828 my $itemnumber = shift;
3829 my $dbh = C4
::Context
->dbh;
3830 my $sth = $dbh->prepare(q{
3833 WHERE itemnumber = ?
3835 $sth->execute($itemnumber);
3836 return $sth->fetchrow;
3839 =head2 GetAgeRestriction
3841 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3842 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3844 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3845 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3847 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3848 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3849 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3850 Negative days mean the borrower has gone past the age restriction age.
3854 sub GetAgeRestriction
{
3855 my ($record_restrictions, $borrower) = @_;
3856 my $markers = C4
::Context
->preference('AgeRestrictionMarker');
3858 # Split $record_restrictions to something like FSK 16 or PEGI 6
3859 my @values = split ' ', uc($record_restrictions);
3860 return unless @values;
3862 # Search first occurrence of one of the markers
3863 my @markers = split /\|/, uc($markers);
3864 return unless @markers;
3867 my $restriction_year = 0;
3868 for my $value (@values) {
3870 for my $marker (@markers) {
3871 $marker =~ s/^\s+//; #remove leading spaces
3872 $marker =~ s/\s+$//; #remove trailing spaces
3873 if ( $marker eq $value ) {
3874 if ( $index <= $#values ) {
3875 $restriction_year += $values[$index];
3879 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3881 # Perhaps it is something like "K16" (as in Finland)
3882 $restriction_year += $1;
3886 last if ( $restriction_year > 0 );
3889 #Check if the borrower is age restricted for this material and for how long.
3890 if ($restriction_year && $borrower) {
3891 if ( $borrower->{'dateofbirth'} ) {
3892 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3893 $alloweddate[0] += $restriction_year;
3895 #Prevent runime eror on leap year (invalid date)
3896 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3897 $alloweddate[2] = 28;
3900 #Get how many days the borrower has to reach the age restriction
3901 my @Today = split /-/, DateTime
->today->ymd();
3902 my $daysToAgeRestriction = Date_to_Days
(@alloweddate) - Date_to_Days
(@Today);
3903 #Negative days means the borrower went past the age restriction age
3904 return ($restriction_year, $daysToAgeRestriction);
3908 return ($restriction_year);
3912 =head2 GetPendingOnSiteCheckouts
3916 sub GetPendingOnSiteCheckouts
{
3917 my $dbh = C4
::Context
->dbh;
3918 return $dbh->selectall_arrayref(q
|
3924 items
.itemcallnumber
,
3928 issues
.date_due
< NOW
() AS is_overdue
,
3931 borrowers
.firstname
,
3933 borrowers
.cardnumber
,
3934 borrowers
.borrowernumber
3936 LEFT JOIN issues ON items
.itemnumber
= issues
.itemnumber
3937 LEFT JOIN biblio ON items
.biblionumber
= biblio
.biblionumber
3938 LEFT JOIN borrowers ON issues
.borrowernumber
= borrowers
.borrowernumber
3939 WHERE issues
.onsite_checkout
= 1
3940 |, { Slice
=> {} } );
3946 my ($count, $branch, $itemtype, $ccode, $newness)
3947 = @
$params{qw(count branch itemtype ccode newness)};
3949 my $dbh = C4
::Context
->dbh;
3952 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
3953 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
3954 i.ccode, SUM(i.issues) AS count
3956 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
3957 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
3960 my (@where_strs, @where_args);
3963 push @where_strs, 'i.homebranch = ?';
3964 push @where_args, $branch;
3967 if (C4
::Context
->preference('item-level_itypes')){
3968 push @where_strs, 'i.itype = ?';
3969 push @where_args, $itemtype;
3971 push @where_strs, 'bi.itemtype = ?';
3972 push @where_args, $itemtype;
3976 push @where_strs, 'i.ccode = ?';
3977 push @where_args, $ccode;
3980 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
3981 push @where_args, $newness;
3985 $query .= 'WHERE ' . join(' AND ', @where_strs);
3989 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
3990 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
3995 $query .= q{ ) xxx WHERE count > 0 };
3996 $count = int($count);
3998 $query .= "LIMIT $count";
4001 my $rows = $dbh->selectall_arrayref($query, { Slice
=> {} }, @where_args);
4006 sub _CalculateAndUpdateFine
{
4009 my $borrower = $params->{borrower
};
4010 my $item = $params->{item
};
4011 my $issue = $params->{issue
};
4012 my $return_date = $params->{return_date
};
4014 unless ($borrower) { carp
"No borrower passed in!" && return; }
4015 unless ($item) { carp
"No item passed in!" && return; }
4016 unless ($issue) { carp
"No issue passed in!" && return; }
4018 my $datedue = dt_from_string
( $issue->date_due );
4020 # we only need to calculate and change the fines if we want to do that on return
4021 # Should be on for hourly loans
4022 my $control = C4
::Context
->preference('CircControl');
4023 my $control_branchcode =
4024 ( $control eq 'ItemHomeLibrary' ) ?
$item->{homebranch
}
4025 : ( $control eq 'PatronLibrary' ) ?
$borrower->{branchcode
}
4026 : $issue->branchcode;
4028 my $date_returned = $return_date ? dt_from_string
($return_date) : dt_from_string
();
4030 my ( $amount, $type, $unitcounttotal ) =
4031 C4
::Overdues
::CalcFine
( $item, $borrower->{categorycode
}, $control_branchcode, $datedue, $date_returned );
4035 if ( C4
::Context
->preference('finesMode') eq 'production' ) {
4036 if ( $amount > 0 ) {
4037 C4
::Overdues
::UpdateFine
({
4038 issue_id
=> $issue->issue_id,
4039 itemnumber
=> $issue->itemnumber,
4040 borrowernumber
=> $issue->borrowernumber,
4043 due
=> output_pref
($datedue),
4046 elsif ($return_date) {
4048 # Backdated returns may have fines that shouldn't exist,
4049 # so in this case, we need to drop those fines to 0
4051 C4
::Overdues
::UpdateFine
({
4052 issue_id
=> $issue->issue_id,
4053 itemnumber
=> $issue->itemnumber,
4054 borrowernumber
=> $issue->borrowernumber,
4057 due
=> output_pref
($datedue),
4069 Koha Development Team <http://koha-community.org/>