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 # MANDATORY CHECKS - unless item exists, nothing else matters
674 $issuingimpossible{UNKNOWN_BARCODE
} = 1;
676 return ( \
%issuingimpossible, \
%needsconfirmation ) if %issuingimpossible;
678 my $issue = Koha
::Checkouts
->find( { itemnumber
=> $item->{itemnumber
} } );
679 my $biblio = Koha
::Biblios
->find( $item->{biblionumber
} );
680 my $biblioitem = $biblio->biblioitem;
681 my $effective_itemtype = $item->{itype
}; # GetItem deals with that
682 my $dbh = C4
::Context
->dbh;
683 my $patron_unblessed = $patron->unblessed;
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($effective_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;
933 my $itemtype = Koha
::ItemTypes
->find($biblioitem->itemtype);
934 if ( $itemtype and $itemtype->notforloan == 1){
935 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
936 $issuingimpossible{NOT_FOR_LOAN
} = 1;
937 $issuingimpossible{itemtype_notforloan
} = $effective_itemtype;
939 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
940 $needsconfirmation{itemtype_notforloan
} = $effective_itemtype;
945 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
947 $issuingimpossible{WTHDRAWN
} = 1;
949 if ( $item->{'restricted'}
950 && $item->{'restricted'} == 1 )
952 $issuingimpossible{RESTRICTED
} = 1;
954 if ( $item->{'itemlost'} && C4
::Context
->preference("IssueLostItem") ne 'nothing' ) {
955 my $av = Koha
::AuthorisedValues
->search({ category
=> 'LOST', authorised_value
=> $item->{itemlost
} });
956 my $code = $av->count ?
$av->next->lib : '';
957 $needsconfirmation{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'confirm' );
958 $alerts{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'alert' );
960 if ( C4
::Context
->preference("IndependentBranches") ) {
961 my $userenv = C4
::Context
->userenv;
962 unless ( C4
::Context
->IsSuperLibrarian() ) {
963 if ( $item->{C4
::Context
->preference("HomeOrHoldingBranch")} ne $userenv->{branch
} ){
964 $issuingimpossible{ITEMNOTSAMEBRANCH
} = 1;
965 $issuingimpossible{'itemhomebranch'} = $item->{C4
::Context
->preference("HomeOrHoldingBranch")};
967 $needsconfirmation{BORRNOTSAMEBRANCH
} = $patron->branchcode
968 if ( $patron->branchcode ne $userenv->{branch
} );
972 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
974 my $rentalConfirmation = C4
::Context
->preference("RentalFeesCheckoutConfirmation");
976 if ( $rentalConfirmation ){
977 my ($rentalCharge) = GetIssuingCharges
( $item->{'itemnumber'}, $patron->borrowernumber );
978 if ( $rentalCharge > 0 ){
979 $needsconfirmation{RENTALCHARGE
} = $rentalCharge;
983 unless ( $ignore_reserves ) {
984 # See if the item is on reserve.
985 my ( $restype, $res ) = C4
::Reserves
::CheckReserves
( $item->{'itemnumber'} );
987 my $resbor = $res->{'borrowernumber'};
988 if ( $resbor ne $patron->borrowernumber ) {
989 my $patron = Koha
::Patrons
->find( $resbor );
990 if ( $restype eq "Waiting" )
992 # The item is on reserve and waiting, but has been
993 # reserved by some other patron.
994 $needsconfirmation{RESERVE_WAITING
} = 1;
995 $needsconfirmation{'resfirstname'} = $patron->firstname;
996 $needsconfirmation{'ressurname'} = $patron->surname;
997 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
998 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
999 $needsconfirmation{'resbranchcode'} = $res->{branchcode
};
1000 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1002 elsif ( $restype eq "Reserved" ) {
1003 # The item is on reserve for someone else.
1004 $needsconfirmation{RESERVED
} = 1;
1005 $needsconfirmation{'resfirstname'} = $patron->firstname;
1006 $needsconfirmation{'ressurname'} = $patron->surname;
1007 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1008 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1009 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1010 $needsconfirmation{'resreservedate'} = $res->{reservedate
};
1016 ## CHECK AGE RESTRICTION
1017 my $agerestriction = $biblioitem->agerestriction;
1018 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction
( $agerestriction, $patron->unblessed );
1019 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1020 if ( C4
::Context
->preference('AgeRestrictionOverride') ) {
1021 $needsconfirmation{AGE_RESTRICTION
} = "$agerestriction";
1024 $issuingimpossible{AGE_RESTRICTION
} = "$agerestriction";
1028 ## check for high holds decreasing loan period
1029 if ( C4
::Context
->preference('decreaseLoanHighHolds') ) {
1030 my $check = checkHighHolds
( $item, $patron_unblessed );
1032 if ( $check->{exceeded
} ) {
1033 if ($override_high_holds) {
1034 $alerts{HIGHHOLDS
} = {
1035 num_holds
=> $check->{outstanding
},
1036 duration
=> $check->{duration
},
1037 returndate
=> output_pref
( $check->{due_date
} ),
1041 $needsconfirmation{HIGHHOLDS
} = {
1042 num_holds
=> $check->{outstanding
},
1043 duration
=> $check->{duration
},
1044 returndate
=> output_pref
( $check->{due_date
} ),
1051 !C4
::Context
->preference('AllowMultipleIssuesOnABiblio') &&
1052 # don't do the multiple loans per bib check if we've
1053 # already determined that we've got a loan on the same item
1054 !$issuingimpossible{NO_MORE_RENEWALS
} &&
1055 !$needsconfirmation{RENEW_ISSUE
}
1057 # Check if borrower has already issued an item from the same biblio
1058 # Only if it's not a subscription
1059 my $biblionumber = $item->{biblionumber
};
1060 require C4
::Serials
;
1061 my $is_a_subscription = C4
::Serials
::CountSubscriptionFromBiblionumber
($biblionumber);
1062 unless ($is_a_subscription) {
1063 # FIXME Should be $patron->checkouts($args);
1064 my $checkouts = Koha
::Checkouts
->search(
1066 borrowernumber
=> $patron->borrowernumber,
1067 biblionumber
=> $biblionumber,
1073 # if we get here, we don't already have a loan on this item,
1074 # so if there are any loans on this bib, ask for confirmation
1075 if ( $checkouts->count ) {
1076 $needsconfirmation{BIBLIO_ALREADY_ISSUED
} = 1;
1081 return ( \
%issuingimpossible, \
%needsconfirmation, \
%alerts, \
%messages, );
1084 =head2 CanBookBeReturned
1086 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1088 Check whether the item can be returned to the provided branch
1092 =item C<$item> is a hash of item information as returned from GetItem
1094 =item C<$branch> is the branchcode where the return is taking place
1102 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1104 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1110 sub CanBookBeReturned
{
1111 my ($item, $branch) = @_;
1112 my $allowreturntobranch = C4
::Context
->preference("AllowReturnToBranch") || 'anywhere';
1114 # assume return is allowed to start
1118 # identify all cases where return is forbidden
1119 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1121 $message = $item->{'homebranch'};
1122 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1124 $message = $item->{'holdingbranch'};
1125 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1127 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1130 return ($allowed, $message);
1133 =head2 CheckHighHolds
1135 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1136 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1137 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1141 sub checkHighHolds
{
1142 my ( $item, $borrower ) = @_;
1143 my $branch = _GetCircControlBranch
( $item, $borrower );
1144 my $item_object = Koha
::Items
->find( $item->{itemnumber
} );
1153 my $holds = Koha
::Holds
->search( { biblionumber
=> $item->{'biblionumber'} } );
1155 if ( $holds->count() ) {
1156 $return_data->{outstanding
} = $holds->count();
1158 my $decreaseLoanHighHoldsControl = C4
::Context
->preference('decreaseLoanHighHoldsControl');
1159 my $decreaseLoanHighHoldsValue = C4
::Context
->preference('decreaseLoanHighHoldsValue');
1160 my $decreaseLoanHighHoldsIgnoreStatuses = C4
::Context
->preference('decreaseLoanHighHoldsIgnoreStatuses');
1162 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1164 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1166 # static means just more than a given number of holds on the record
1168 # If the number of holds is less than the threshold, we can stop here
1169 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1170 return $return_data;
1173 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1175 # dynamic means X more than the number of holdable items on the record
1177 # let's get the items
1178 my @items = $holds->next()->biblio()->items();
1180 # Remove any items with status defined to be ignored even if the would not make item unholdable
1181 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1182 @items = grep { !$_->$status } @items;
1185 # Remove any items that are not holdable for this patron
1186 @items = grep { CanItemBeReserved
( $borrower->{borrowernumber
}, $_->itemnumber ) eq 'OK' } @items;
1188 my $items_count = scalar @items;
1190 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1192 # If the number of holds is less than the count of items we have
1193 # plus the number of holds allowed above that count, we can stop here
1194 if ( $holds->count() <= $threshold ) {
1195 return $return_data;
1199 my $issuedate = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1201 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
1203 my $itype = $item_object->effective_itemtype;
1204 my $orig_due = C4
::Circulation
::CalcDateDue
( $issuedate, $itype, $branch, $borrower );
1206 my $decreaseLoanHighHoldsDuration = C4
::Context
->preference('decreaseLoanHighHoldsDuration');
1208 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1209 $reduced_datedue->set_hour($orig_due->hour);
1210 $reduced_datedue->set_minute($orig_due->minute);
1211 $reduced_datedue->truncate( to
=> 'minute' );
1213 if ( DateTime
->compare( $reduced_datedue, $orig_due ) == -1 ) {
1214 $return_data->{exceeded
} = 1;
1215 $return_data->{duration
} = $decreaseLoanHighHoldsDuration;
1216 $return_data->{due_date
} = $reduced_datedue;
1220 return $return_data;
1225 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1227 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1231 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1233 =item C<$barcode> is the barcode of the item being issued.
1235 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1236 Calculated if empty.
1238 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1240 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1241 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1243 AddIssue does the following things :
1245 - step 01: check that there is a borrowernumber & a barcode provided
1246 - check for RENEWAL (book issued & being issued to the same patron)
1247 - renewal YES = Calculate Charge & renew
1249 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1251 - fill reserve if reserve to this patron
1252 - cancel reserve or not, otherwise
1253 * TRANSFERT PENDING ?
1254 - complete the transfert
1262 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1264 my $onsite_checkout = $params && $params->{onsite_checkout
} ?
1 : 0;
1265 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout
};
1266 my $auto_renew = $params && $params->{auto_renew
};
1267 my $dbh = C4
::Context
->dbh;
1268 my $barcodecheck = CheckValidBarcode
($barcode);
1272 if ( $datedue && ref $datedue ne 'DateTime' ) {
1273 $datedue = dt_from_string
($datedue);
1276 # $issuedate defaults to today.
1277 if ( !defined $issuedate ) {
1278 $issuedate = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1281 if ( ref $issuedate ne 'DateTime' ) {
1282 $issuedate = dt_from_string
($issuedate);
1287 # Stop here if the patron or barcode doesn't exist
1288 if ( $borrower && $barcode && $barcodecheck ) {
1289 # find which item we issue
1290 my $item = GetItem
( '', $barcode )
1291 or return; # if we don't get an Item, abort.
1292 my $item_object = Koha
::Items
->find( { barcode
=> $barcode } );
1294 my $branch = _GetCircControlBranch
( $item, $borrower );
1296 # get actual issuing if there is one
1297 my $actualissue = Koha
::Checkouts
->find( { itemnumber
=> $item->{itemnumber
} } );
1299 # check if we just renew the issue.
1300 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1301 and not $switch_onsite_checkout ) {
1302 $datedue = AddRenewal
(
1303 $borrower->{'borrowernumber'},
1304 $item->{'itemnumber'},
1307 $issuedate, # here interpreted as the renewal date
1311 # it's NOT a renewal
1312 if ( $actualissue and not $switch_onsite_checkout ) {
1313 # This book is currently on loan, but not to the person
1314 # who wants to borrow it now. mark it returned before issuing to the new borrower
1315 my ( $allowed, $message ) = CanBookBeReturned
( $item, C4
::Context
->userenv->{branch
} );
1316 return unless $allowed;
1317 AddReturn
( $item->{'barcode'}, C4
::Context
->userenv->{'branch'} );
1320 MoveReserve
( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1322 # Starting process for transfer job (checking transfert and validate it if we have one)
1323 my ($datesent) = GetTransfers
( $item->{'itemnumber'} );
1325 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1326 my $sth = $dbh->prepare(
1327 "UPDATE branchtransfers
1328 SET datearrived = now(),
1330 comments = 'Forced branchtransfer'
1331 WHERE itemnumber= ? AND datearrived IS NULL"
1333 $sth->execute( C4
::Context
->userenv->{'branch'},
1334 $item->{'itemnumber'} );
1337 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1338 unless ($auto_renew) {
1339 my $issuing_rule = Koha
::IssuingRules
->get_effective_issuing_rule(
1340 { categorycode
=> $borrower->{categorycode
},
1341 itemtype
=> $item->{itype
},
1342 branchcode
=> $branch
1346 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1349 # Record in the database the fact that the book was issued.
1351 my $itype = $item_object->effective_itemtype;
1352 $datedue = CalcDateDue
( $issuedate, $itype, $branch, $borrower );
1355 $datedue->truncate( to
=> 'minute' );
1357 $issue = Koha
::Database
->new()->schema()->resultset('Issue')->update_or_create(
1359 borrowernumber
=> $borrower->{'borrowernumber'},
1360 itemnumber
=> $item->{'itemnumber'},
1361 issuedate
=> $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1362 date_due
=> $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1363 branchcode
=> C4
::Context
->userenv->{'branch'},
1364 onsite_checkout
=> $onsite_checkout,
1365 auto_renew
=> $auto_renew ?
1 : 0
1369 if ( C4
::Context
->preference('ReturnToShelvingCart') ) {
1370 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1371 CartToShelf
( $item->{'itemnumber'} );
1373 $item->{'issues'}++;
1374 if ( C4
::Context
->preference('UpdateTotalIssuesOnCirc') ) {
1375 UpdateTotalIssues
( $item->{'biblionumber'}, 1 );
1378 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1379 if ( $item->{'itemlost'} ) {
1381 Koha
::RefundLostItemFeeRules
->should_refund(
1383 current_branch
=> C4
::Context
->userenv->{branch
},
1384 item_home_branch
=> $item->{homebranch
},
1385 item_holding_branch
=> $item->{holdingbranch
}
1390 _FixAccountForLostAndReturned
( $item->{'itemnumber'}, undef,
1391 $item->{'barcode'} );
1397 issues
=> $item->{'issues'},
1398 holdingbranch
=> C4
::Context
->userenv->{'branch'},
1400 onloan
=> $datedue->ymd(),
1401 datelastborrowed
=> DateTime
->now( time_zone
=> C4
::Context
->tz() )->ymd(),
1403 $item->{'biblionumber'},
1404 $item->{'itemnumber'},
1407 ModDateLastSeen
( $item->{'itemnumber'} );
1409 # If it costs to borrow this book, charge it to the patron's account.
1410 my ( $charge, $itemtype ) = GetIssuingCharges
( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1411 if ( $charge > 0 ) {
1412 AddIssuingCharge
( $issue, $charge );
1413 $item->{'charge'} = $charge;
1416 # Record the fact that this book was issued.
1419 branch
=> C4
::Context
->userenv->{'branch'},
1420 type
=> ( $onsite_checkout ?
'onsite_checkout' : 'issue' ),
1422 other
=> ( $sipmode ?
"SIP-$sipmode" : '' ),
1423 itemnumber
=> $item->{'itemnumber'},
1424 itemtype
=> $item->{'itype'},
1425 location
=> $item->{location
},
1426 borrowernumber
=> $borrower->{'borrowernumber'},
1427 ccode
=> $item->{'ccode'}
1431 # Send a checkout slip.
1432 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1434 branchcode
=> $branch,
1435 categorycode
=> $borrower->{categorycode
},
1436 item_type
=> $item->{itype
},
1437 notification
=> 'CHECKOUT',
1439 if ( $circulation_alert->is_enabled_for( \
%conditions ) ) {
1440 SendCirculationAlert
(
1444 borrower
=> $borrower,
1450 "CIRCULATION", "ISSUE",
1451 $borrower->{'borrowernumber'},
1452 $item->{'itemnumber'}
1453 ) if C4
::Context
->preference("IssueLog");
1459 =head2 GetLoanLength
1461 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1463 Get loan length for an itemtype, a borrower type and a branch
1468 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1469 my $dbh = C4
::Context
->dbh;
1470 my $sth = $dbh->prepare(qq{
1471 SELECT issuelength
, lengthunit
, renewalperiod
1473 WHERE categorycode
=?
1476 AND issuelength IS NOT NULL
1479 # try to find issuelength & return the 1st available.
1480 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1481 $sth->execute( $borrowertype, $itemtype, $branchcode );
1482 my $loanlength = $sth->fetchrow_hashref;
1485 if defined($loanlength) && defined $loanlength->{issuelength
};
1487 $sth->execute( $borrowertype, '*', $branchcode );
1488 $loanlength = $sth->fetchrow_hashref;
1490 if defined($loanlength) && defined $loanlength->{issuelength
};
1492 $sth->execute( '*', $itemtype, $branchcode );
1493 $loanlength = $sth->fetchrow_hashref;
1495 if defined($loanlength) && defined $loanlength->{issuelength
};
1497 $sth->execute( '*', '*', $branchcode );
1498 $loanlength = $sth->fetchrow_hashref;
1500 if defined($loanlength) && defined $loanlength->{issuelength
};
1502 $sth->execute( $borrowertype, $itemtype, '*' );
1503 $loanlength = $sth->fetchrow_hashref;
1505 if defined($loanlength) && defined $loanlength->{issuelength
};
1507 $sth->execute( $borrowertype, '*', '*' );
1508 $loanlength = $sth->fetchrow_hashref;
1510 if defined($loanlength) && defined $loanlength->{issuelength
};
1512 $sth->execute( '*', $itemtype, '*' );
1513 $loanlength = $sth->fetchrow_hashref;
1515 if defined($loanlength) && defined $loanlength->{issuelength
};
1517 $sth->execute( '*', '*', '*' );
1518 $loanlength = $sth->fetchrow_hashref;
1520 if defined($loanlength) && defined $loanlength->{issuelength
};
1522 # if no rule is set => 0 day (hardcoded)
1526 lengthunit
=> 'days',
1532 =head2 GetHardDueDate
1534 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1536 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1540 sub GetHardDueDate
{
1541 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1543 my $issuing_rule = Koha
::IssuingRules
->get_effective_issuing_rule(
1544 { categorycode
=> $borrowertype,
1545 itemtype
=> $itemtype,
1546 branchcode
=> $branchcode
1551 if ( defined( $issuing_rule ) ) {
1552 if ( $issuing_rule->hardduedate ) {
1553 return (dt_from_string
($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1555 return (undef, undef);
1560 =head2 GetBranchBorrowerCircRule
1562 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1564 Retrieves circulation rule attributes that apply to the given
1565 branch and patron category, regardless of item type.
1566 The return value is a hashref containing the following key:
1568 maxissueqty - maximum number of loans that a
1569 patron of the given category can have at the given
1570 branch. If the value is undef, no limit.
1572 maxonsiteissueqty - maximum of on-site checkouts that a
1573 patron of the given category can have at the given
1574 branch. If the value is undef, no limit.
1576 This will first check for a specific branch and
1577 category match from branch_borrower_circ_rules.
1579 If no rule is found, it will then check default_branch_circ_rules
1580 (same branch, default category). If no rule is found,
1581 it will then check default_borrower_circ_rules (default
1582 branch, same category), then failing that, default_circ_rules
1583 (default branch, default category).
1585 If no rule has been found in the database, it will default to
1589 maxonsiteissueqty - undef
1591 C<$branchcode> and C<$categorycode> should contain the
1592 literal branch code and patron category code, respectively - no
1597 sub GetBranchBorrowerCircRule
{
1598 my ( $branchcode, $categorycode ) = @_;
1601 my $dbh = C4
::Context
->dbh();
1602 $rules = $dbh->selectrow_hashref( q
|
1603 SELECT maxissueqty
, maxonsiteissueqty
1604 FROM branch_borrower_circ_rules
1605 WHERE branchcode
= ?
1606 AND categorycode
= ?
1607 |, {}, $branchcode, $categorycode ) ;
1608 return $rules if $rules;
1610 # try same branch, default borrower category
1611 $rules = $dbh->selectrow_hashref( q
|
1612 SELECT maxissueqty
, maxonsiteissueqty
1613 FROM default_branch_circ_rules
1614 WHERE branchcode
= ?
1615 |, {}, $branchcode ) ;
1616 return $rules if $rules;
1618 # try default branch, same borrower category
1619 $rules = $dbh->selectrow_hashref( q
|
1620 SELECT maxissueqty
, maxonsiteissueqty
1621 FROM default_borrower_circ_rules
1622 WHERE categorycode
= ?
1623 |, {}, $categorycode ) ;
1624 return $rules if $rules;
1626 # try default branch, default borrower category
1627 $rules = $dbh->selectrow_hashref( q
|
1628 SELECT maxissueqty
, maxonsiteissueqty
1629 FROM default_circ_rules
1631 return $rules if $rules;
1633 # built-in default circulation rule
1635 maxissueqty
=> undef,
1636 maxonsiteissueqty
=> undef,
1640 =head2 GetBranchItemRule
1642 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1644 Retrieves circulation rule attributes that apply to the given
1645 branch and item type, regardless of patron category.
1647 The return value is a hashref containing the following keys:
1649 holdallowed => Hold policy for this branch and itemtype. Possible values:
1650 0: No holds allowed.
1651 1: Holds allowed only by patrons that have the same homebranch as the item.
1652 2: Holds allowed from any patron.
1654 returnbranch => branch to which to return item. Possible values:
1655 noreturn: do not return, let item remain where checked in (floating collections)
1656 homebranch: return to item's home branch
1657 holdingbranch: return to issuer branch
1659 This searches branchitemrules in the following order:
1661 * Same branchcode and itemtype
1662 * Same branchcode, itemtype '*'
1663 * branchcode '*', same itemtype
1664 * branchcode and itemtype '*'
1666 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1670 sub GetBranchItemRule
{
1671 my ( $branchcode, $itemtype ) = @_;
1672 my $dbh = C4
::Context
->dbh();
1676 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1677 FROM branch_item_rules
1678 WHERE branchcode = ?
1679 AND itemtype = ?', $branchcode, $itemtype],
1680 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1681 FROM default_branch_circ_rules
1682 WHERE branchcode = ?', $branchcode],
1683 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1684 FROM default_branch_item_rules
1685 WHERE itemtype = ?', $itemtype],
1686 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1687 FROM default_circ_rules'],
1690 foreach my $attempt (@attempts) {
1691 my ($query, @bind_params) = @
{$attempt};
1692 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1695 # Since branch/category and branch/itemtype use the same per-branch
1696 # defaults tables, we have to check that the key we want is set, not
1697 # just that a row was returned
1698 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1699 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1700 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1703 # built-in default circulation rule
1704 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1705 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1706 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1713 ($doreturn, $messages, $iteminformation, $borrower) =
1714 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1720 =item C<$barcode> is the bar code of the book being returned.
1722 =item C<$branch> is the code of the branch where the book is being returned.
1724 =item C<$exemptfine> indicates that overdue charges for the item will be
1727 =item C<$dropbox> indicates that the check-in date is assumed to be
1728 yesterday, or the last non-holiday as defined in C4::Calendar . If
1729 overdue charges are applied and C<$dropbox> is true, the last charge
1730 will be removed. This assumes that the fines accrual script has run
1731 for _today_. Optional.
1733 =item C<$return_date> allows the default return date to be overridden
1734 by the given return date. Optional.
1738 C<&AddReturn> returns a list of four items:
1740 C<$doreturn> is true iff the return succeeded.
1742 C<$messages> is a reference-to-hash giving feedback on the operation.
1743 The keys of the hash are:
1749 No item with this barcode exists. The value is C<$barcode>.
1753 The book is not currently on loan. The value is C<$barcode>.
1757 This book has been withdrawn/cancelled. The value should be ignored.
1759 =item C<Wrongbranch>
1761 This book has was returned to the wrong branch. The value is a hashref
1762 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1763 contain the branchcode of the incorrect and correct return library, respectively.
1767 The item was reserved. The value is a reference-to-hash whose keys are
1768 fields from the reserves table of the Koha database, and
1769 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1770 either C<Waiting>, C<Reserved>, or 0.
1772 =item C<WasReturned>
1774 Value 1 if return is successful.
1776 =item C<NeedsTransfer>
1778 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1782 C<$iteminformation> is a reference-to-hash, giving information about the
1783 returned item from the issues table.
1785 C<$borrower> is a reference-to-hash, giving information about the
1786 patron who last borrowed the book.
1791 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1793 if ($branch and not Koha
::Libraries
->find($branch)) {
1794 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4
::Context
->userenv->{'branch'};
1797 $branch = C4
::Context
->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1801 my $validTransfert = 0;
1802 my $stat_type = 'return';
1804 # get information on item
1805 my $item = GetItem
( undef, $barcode );
1807 return ( 0, { BadBarcode
=> $barcode } ); # no barcode means no item or borrower. bail out.
1810 my $itemnumber = $item->{ itemnumber
};
1811 my $itemtype = $item->{itype
}; # GetItem called effective_itemtype
1813 my $issue = Koha
::Checkouts
->find( { itemnumber
=> $itemnumber } );
1815 $patron = Koha
::Patrons
->find( $issue->borrowernumber )
1816 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1817 . Dumper
($issue->unblessed) . "\n";
1819 $messages->{'NotIssued'} = $barcode;
1820 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1822 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1823 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1824 if (C4
::Context
->preference("RecordLocalUseOnReturn")) {
1825 $messages->{'LocalUse'} = 1;
1826 $stat_type = 'localuse';
1830 if ( $item->{'location'} eq 'PROC' ) {
1831 if ( C4
::Context
->preference("InProcessingToShelvingCart") ) {
1832 $item->{'location'} = 'CART';
1835 $item->{location
} = $item->{permanent_location
};
1838 ModItem
( $item, $item->{'biblionumber'}, $item->{'itemnumber'}, { log_action
=> 0 } );
1841 # full item data, but no borrowernumber or checkout info (no issue)
1842 my $hbr = GetBranchItemRule
($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1843 # get the proper branch to which to return the item
1844 my $returnbranch = $item->{$hbr} || $branch ;
1845 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1847 my $borrowernumber = $patron ?
$patron->borrowernumber : undef; # we don't know if we had a borrower or not
1848 my $patron_unblessed = $patron ?
$patron->unblessed : {};
1850 my $yaml = C4
::Context
->preference('UpdateNotForLoanStatusOnCheckin');
1852 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1854 eval { $rules = YAML
::Load
($yaml); };
1856 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1859 foreach my $key ( keys %$rules ) {
1860 if ( $item->{notforloan
} eq $key ) {
1861 $messages->{'NotForLoanStatusUpdated'} = { from
=> $item->{notforloan
}, to
=> $rules->{$key} };
1862 ModItem
( { notforloan
=> $rules->{$key} }, undef, $itemnumber, { log_action
=> 0 } );
1869 # check if the return is allowed at this branch
1870 my ($returnallowed, $message) = CanBookBeReturned
($item, $branch);
1871 unless ($returnallowed){
1872 $messages->{'Wrongbranch'} = {
1873 Wrongbranch
=> $branch,
1874 Rightbranch
=> $message
1877 return ( $doreturn, $messages, $issue, $patron_unblessed);
1880 if ( $item->{'withdrawn'} ) { # book has been cancelled
1881 $messages->{'withdrawn'} = 1;
1882 $doreturn = 0 if C4
::Context
->preference("BlockReturnOfWithdrawnItems");
1885 if ( $item->{itemlost
} and C4
::Context
->preference("BlockReturnOfLostItems") ) {
1889 # case of a return of document (deal with issues and holdingbranch)
1890 my $today = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1894 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1895 $patron or warn "AddReturn without current borrower";
1896 my $circControlBranch;
1898 # define circControlBranch only if dropbox mode is set
1899 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1900 # FIXME: check issuedate > returndate, factoring in holidays
1902 $circControlBranch = _GetCircControlBranch
($item,$patron_unblessed);
1903 $is_overdue = $issue->is_overdue( $dropboxdate );
1905 $is_overdue = $issue->is_overdue;
1910 MarkIssueReturned
( $borrowernumber, $item->{'itemnumber'},
1911 $circControlBranch, $return_date, $patron->privacy );
1914 if ( ( C4
::Context
->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1915 _CalculateAndUpdateFine
( { issue
=> $issue, item
=> $item, borrower
=> $patron_unblessed, return_date
=> $return_date } );
1918 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 );
1920 return ( 0, { WasReturned
=> 0, DataCorrupted
=> 1 }, $issue, $patron_unblessed );
1923 # FIXME is the "= 1" right? This could be the borrower hash.
1924 $messages->{'WasReturned'} = 1;
1928 ModItem
( { onloan
=> undef }, $item->{biblionumber
}, $item->{itemnumber
}, { log_action
=> 0 } );
1931 # the holdingbranch is updated if the document is returned to another location.
1932 # this is always done regardless of whether the item was on loan or not
1933 my $item_holding_branch = $item->{ holdingbranch
};
1934 if ($item->{'holdingbranch'} ne $branch) {
1935 UpdateHoldingbranch
($branch, $item->{'itemnumber'});
1936 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1938 ModDateLastSeen
( $item->{'itemnumber'} );
1940 # check if we have a transfer for this document
1941 my ($datesent,$frombranch,$tobranch) = GetTransfers
( $item->{'itemnumber'} );
1943 # if we have a transfer to do, we update the line of transfers with the datearrived
1944 my $is_in_rotating_collection = C4
::RotatingCollections
::isItemInAnyCollection
( $item->{'itemnumber'} );
1946 if ( $tobranch eq $branch ) {
1947 my $sth = C4
::Context
->dbh->prepare(
1948 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1950 $sth->execute( $item->{'itemnumber'} );
1951 # if we have a reservation with valid transfer, we can set it's status to 'W'
1952 ShelfToCart
( $item->{'itemnumber'} ) if ( C4
::Context
->preference("ReturnToShelvingCart") );
1953 C4
::Reserves
::ModReserveStatus
($item->{'itemnumber'}, 'W');
1955 $messages->{'WrongTransfer'} = $tobranch;
1956 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1958 $validTransfert = 1;
1960 ShelfToCart
( $item->{'itemnumber'} ) if ( C4
::Context
->preference("ReturnToShelvingCart") );
1963 # fix up the accounts.....
1964 if ( $item->{'itemlost'} ) {
1965 $messages->{'WasLost'} = 1;
1966 unless ( C4
::Context
->preference("BlockReturnOfLostItems") ) {
1968 Koha
::RefundLostItemFeeRules
->should_refund(
1970 current_branch
=> C4
::Context
->userenv->{branch
},
1971 item_home_branch
=> $item->{homebranch
},
1972 item_holding_branch
=> $item_holding_branch
1977 _FixAccountForLostAndReturned
( $item->{'itemnumber'},
1978 $borrowernumber, $barcode );
1979 $messages->{'LostItemFeeRefunded'} = 1;
1984 # fix up the overdues in accounts...
1985 if ($borrowernumber) {
1986 my $fix = _FixOverduesOnReturn
($borrowernumber, $item->{itemnumber
}, $exemptfine, $dropbox);
1987 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1989 if ( $issue and $issue->is_overdue ) {
1991 $today = $dropboxdate if $dropbox;
1992 my ($debardate,$reminder) = _debar_user_on_return
( $patron_unblessed, $item, dt_from_string
($issue->date_due), $today );
1994 $messages->{'PrevDebarred'} = $debardate;
1996 $messages->{'Debarred'} = $debardate if $debardate;
1998 # there's no overdue on the item but borrower had been previously debarred
1999 } elsif ( $issue->date_due and $patron->debarred ) {
2000 if ( $patron->debarred eq "9999-12-31") {
2001 $messages->{'ForeverDebarred'} = $patron->debarred;
2003 my $borrower_debar_dt = dt_from_string
( $patron->debarred );
2004 $borrower_debar_dt->truncate(to
=> 'day');
2005 my $today_dt = $today->clone()->truncate(to
=> 'day');
2006 if ( DateTime
->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2007 $messages->{'PrevDebarred'} = $patron->debarred;
2013 # find reserves.....
2014 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2015 my ($resfound, $resrec);
2016 my $lookahead= C4
::Context
->preference('ConfirmFutureHolds'); #number of days to look for future holds
2017 ($resfound, $resrec, undef) = C4
::Reserves
::CheckReserves
( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2019 $resrec->{'ResFound'} = $resfound;
2020 $messages->{'ResFound'} = $resrec;
2023 # Record the fact that this book was returned.
2027 itemnumber
=> $itemnumber,
2028 itemtype
=> $itemtype,
2029 borrowernumber
=> $borrowernumber,
2030 ccode
=> $item->{ ccode
}
2033 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2035 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2037 branchcode
=> $branch,
2038 categorycode
=> $patron->categorycode,
2039 item_type
=> $item->{itype
},
2040 notification
=> 'CHECKIN',
2042 if ($doreturn && $circulation_alert->is_enabled_for(\
%conditions)) {
2043 SendCirculationAlert
({
2046 borrower
=> $patron->unblessed,
2051 logaction
("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2052 if C4
::Context
->preference("ReturnLog");
2055 # Remove any OVERDUES related debarment if the borrower has no overdues
2056 if ( $borrowernumber
2057 && $patron->debarred
2058 && C4
::Context
->preference('AutoRemoveOverduesRestrictions')
2059 && !Koha
::Patrons
->find( $borrowernumber )->has_overdues
2060 && @
{ GetDebarments
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' }) }
2062 DelUniqueDebarment
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' });
2065 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2066 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2067 if (C4
::Context
->preference("AutomaticItemReturn" ) or
2068 (C4
::Context
->preference("UseBranchTransferLimits") and
2069 ! IsBranchTransferAllowed
($branch, $returnbranch, $item->{C4
::Context
->preference("BranchTransferLimitsType")} )
2071 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2072 $debug and warn "item: " . Dumper
($item);
2073 ModItemTransfer
($item->{'itemnumber'}, $branch, $returnbranch);
2074 $messages->{'WasTransfered'} = 1;
2076 $messages->{'NeedsTransfer'} = $returnbranch;
2080 return ( $doreturn, $messages, $issue, ( $patron ?
$patron->unblessed : {} ));
2083 =head2 MarkIssueReturned
2085 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2087 Unconditionally marks an issue as being returned by
2088 moving the C<issues> row to C<old_issues> and
2089 setting C<returndate> to the current date, or
2090 the last non-holiday date of the branccode specified in
2091 C<dropbox_branch> . Assumes you've already checked that
2092 it's safe to do this, i.e. last non-holiday > issuedate.
2094 if C<$returndate> is specified (in iso format), it is used as the date
2095 of the return. It is ignored when a dropbox_branch is passed in.
2097 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2098 the old_issue is immediately anonymised
2100 Ideally, this function would be internal to C<C4::Circulation>,
2101 not exported, but it is currently needed by one
2102 routine in C<C4::Accounts>.
2106 sub MarkIssueReturned
{
2107 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2110 # Retrieve the issue
2111 my $issue = Koha
::Checkouts
->find( { itemnumber
=> $itemnumber } ) or return;
2112 my $issue_id = $issue->issue_id;
2114 my $anonymouspatron;
2115 if ( $privacy == 2 ) {
2116 # The default of 0 will not work due to foreign key constraints
2117 # The anonymisation will fail if AnonymousPatron is not a valid entry
2118 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2119 # Note that a warning should appear on the about page (System information tab).
2120 $anonymouspatron = C4
::Context
->preference('AnonymousPatron');
2121 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."
2122 unless Koha
::Patrons
->find( $anonymouspatron );
2124 my $database = Koha
::Database
->new();
2125 my $schema = $database->schema;
2126 my $dbh = C4
::Context
->dbh;
2128 my $query = 'UPDATE issues SET returndate=';
2130 if ($dropbox_branch) {
2131 my $calendar = Koha
::Calendar
->new( branchcode
=> $dropbox_branch );
2132 my $dropboxdate = $calendar->addDate( DateTime
->now( time_zone
=> C4
::Context
->tz), -1 );
2134 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2135 } elsif ($returndate) {
2137 push @bind, $returndate;
2139 $query .= ' now() ';
2141 $query .= ' WHERE issue_id = ?';
2142 push @bind, $issue_id;
2144 # FIXME Improve the return value and handle it from callers
2145 $schema->txn_do(sub {
2147 # Update the returndate
2148 $dbh->do( $query, undef, @bind );
2150 # We just updated the returndate, so we need to refetch $issue
2151 $issue->discard_changes;
2153 # Create the old_issues entry
2154 my $old_checkout = Koha
::Old
::Checkout
->new($issue->unblessed)->store;
2156 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2157 if ( $privacy == 2) {
2158 $dbh->do(q
|UPDATE old_issues SET borrowernumber
=? WHERE issue_id
= ?
|, undef, $anonymouspatron, $old_checkout->issue_id);
2161 # And finally delete the issue
2164 ModItem
( { 'onloan' => undef }, undef, $itemnumber, { log_action
=> 0 } );
2166 if ( C4
::Context
->preference('StoreLastBorrower') ) {
2167 my $item = Koha
::Items
->find( $itemnumber );
2168 my $patron = Koha
::Patrons
->find( $borrowernumber );
2169 $item->last_returned_by( $patron );
2176 =head2 _debar_user_on_return
2178 _debar_user_on_return($borrower, $item, $datedue, today);
2180 C<$borrower> borrower hashref
2182 C<$item> item hashref
2184 C<$datedue> date due DateTime object
2186 C<$return_date> DateTime object representing the return time
2188 Internal function, called only by AddReturn that calculates and updates
2189 the user fine days, and debars them if necessary.
2191 Should only be called for overdue returns
2195 sub _debar_user_on_return
{
2196 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2198 my $branchcode = _GetCircControlBranch
( $item, $borrower );
2200 my $circcontrol = C4
::Context
->preference('CircControl');
2201 my $issuing_rule = Koha
::IssuingRules
->get_effective_issuing_rule(
2202 { categorycode
=> $borrower->{categorycode
},
2203 itemtype
=> $item->{itype
},
2204 branchcode
=> $branchcode
2207 my $finedays = $issuing_rule ?
$issuing_rule->finedays : undef;
2208 my $unit = $issuing_rule ?
$issuing_rule->lengthunit : undef;
2209 my $chargeable_units = C4
::Overdues
::get_chargeable_units
($unit, $dt_due, $return_date, $branchcode);
2213 # finedays is in days, so hourly loans must multiply by 24
2214 # thus 1 hour late equals 1 day suspension * finedays rate
2215 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2217 # grace period is measured in the same units as the loan
2219 DateTime
::Duration
->new( $unit => $issuing_rule->firstremind );
2221 my $deltadays = DateTime
::Duration
->new(
2222 days
=> $chargeable_units
2224 if ( $deltadays->subtract($grace)->is_positive() ) {
2225 my $suspension_days = $deltadays * $finedays;
2227 # If the max suspension days is < than the suspension days
2228 # the suspension days is limited to this maximum period.
2229 my $max_sd = $issuing_rule->maxsuspensiondays;
2230 if ( defined $max_sd ) {
2231 $max_sd = DateTime
::Duration
->new( days
=> $max_sd );
2232 $suspension_days = $max_sd
2233 if DateTime
::Duration
->compare( $max_sd, $suspension_days ) < 0;
2236 my ( $has_been_extended, $is_a_reminder );
2237 if ( C4
::Context
->preference('CumulativeRestrictionPeriods') and $borrower->{debarred
} ) {
2238 my $debarment = @
{ GetDebarments
( { borrowernumber
=> $borrower->{borrowernumber
}, type
=> 'SUSPENSION' } ) }[0];
2240 $return_date = dt_from_string
( $debarment->{expiration
}, 'sql' );
2241 $has_been_extended = 1;
2245 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2246 # No need to / 1 and do not consider / 0
2247 $suspension_days = DateTime
::Duration
->new(
2248 days
=> floor
( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2253 # Use the calendar or not to calculate the debarment date
2254 if ( C4
::Context
->preference('finesCalendar') eq 'noFinesWhenClosed' ) {
2255 my $calendar = Koha
::Calendar
->new(
2256 branchcode
=> $branchcode,
2257 days_mode
=> 'Calendar'
2259 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2262 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2265 Koha
::Patron
::Debarments
::AddUniqueDebarment
({
2266 borrowernumber
=> $borrower->{borrowernumber
},
2267 expiration
=> $new_debar_dt->ymd(),
2268 type
=> 'SUSPENSION',
2270 # if borrower was already debarred but does not get an extra debarment
2271 my $patron = Koha
::Patrons
->find( $borrower->{borrowernumber
} );
2272 my $new_debarment_str;
2273 if ( $borrower->{debarred
} eq $patron->is_debarred ) {
2275 $new_debarment_str = $borrower->{debarred
};
2277 $new_debarment_str = $new_debar_dt->ymd();
2279 # FIXME Should return a DateTime object
2280 return $new_debarment_str, $is_a_reminder;
2286 =head2 _FixOverduesOnReturn
2288 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2290 C<$brn> borrowernumber
2294 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2295 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2297 Internal function, called only by AddReturn
2301 sub _FixOverduesOnReturn
{
2302 my ($borrowernumber, $item);
2303 unless ($borrowernumber = shift) {
2304 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2307 unless ($item = shift) {
2308 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2311 my ($exemptfine, $dropbox) = @_;
2312 my $dbh = C4
::Context
->dbh;
2314 # check for overdue fine
2315 my $accountline = Koha
::Account
::Lines
->search(
2317 borrowernumber
=> $borrowernumber,
2318 itemnumber
=> $item,
2320 accounttype
=> 'FU',
2325 return 0 unless $accountline; # no warning, there's just nothing to fix
2329 my $amountoutstanding = $accountline->amountoutstanding;
2331 $accountline->accounttype('FFOR');
2332 $accountline->amountoutstanding(0);
2334 Koha
::Account
::Offset
->new(
2336 debit_id
=> $accountline->id,
2338 amount
=> $amountoutstanding * -1,
2342 if (C4
::Context
->preference("FinesLog")) {
2343 &logaction
("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2345 } elsif ($dropbox && $accountline->lastincrement) {
2346 my $outstanding = $accountline->amountoutstanding - $accountline->lastincrement;
2347 my $amt = $accountline->amount - $accountline->lastincrement;
2349 Koha
::Account
::Offset
->new(
2351 debit_id
=> $accountline->id,
2353 amount
=> $accountline->lastincrement * -1,
2357 if ( C4
::Context
->preference("FinesLog") ) {
2358 &logaction
( "FINES", 'MODIFY', $borrowernumber,
2359 "Dropbox adjustment $amt, item $item" );
2362 $accountline->accounttype('F');
2364 if ( $outstanding >= 0 && $amt >= 0 ) {
2365 $accountline->amount($amt);
2366 $accountline->amountoutstanding($outstanding);
2370 $accountline->accounttype('F');
2373 return $accountline->store();
2376 =head2 _FixAccountForLostAndReturned
2378 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2380 Calculates the charge for a book lost and returned.
2382 Internal function, not exported, called only by AddReturn.
2386 sub _FixAccountForLostAndReturned
{
2387 my $itemnumber = shift or return;
2388 my $borrowernumber = @_ ?
shift : undef;
2389 my $item_id = @_ ?
shift : $itemnumber; # Send the barcode if you want that logged in the description
2391 # check for charge made for lost book
2392 my $accountline = Koha
::Account
::Lines
->search(
2394 itemnumber
=> $itemnumber,
2395 accounttype
=> { -in => [ 'L', 'Rep', 'W' ] },
2398 order_by
=> { -desc
=> [ 'date', 'accountno' ] }
2402 return unless $accountline;
2403 return if $accountline->accounttype eq 'W'; # Written off
2405 $accountline->accounttype('LR');
2406 $accountline->store();
2408 my $account = Koha
::Account
->new( { patron_id
=> $accountline->borrowernumber } );
2409 my $credit_id = $account->pay(
2411 amount
=> $accountline->amount,
2412 description
=> "Item Returned " . $item_id,
2413 account_type
=> 'CR',
2414 offset_type
=> 'Lost Item Return',
2415 lines
=> [$accountline],
2420 ModItem
( { paidfor
=> '' }, undef, $itemnumber, { log_action
=> 0 } );
2425 =head2 _GetCircControlBranch
2427 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2431 Return the library code to be used to determine which circulation
2432 policy applies to a transaction. Looks up the CircControl and
2433 HomeOrHoldingBranch system preferences.
2435 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2437 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2441 sub _GetCircControlBranch
{
2442 my ($item, $borrower) = @_;
2443 my $circcontrol = C4
::Context
->preference('CircControl');
2446 if ($circcontrol eq 'PickupLibrary' and (C4
::Context
->userenv and C4
::Context
->userenv->{'branch'}) ) {
2447 $branch= C4
::Context
->userenv->{'branch'};
2448 } elsif ($circcontrol eq 'PatronLibrary') {
2449 $branch=$borrower->{branchcode
};
2451 my $branchfield = C4
::Context
->preference('HomeOrHoldingBranch') || 'homebranch';
2452 $branch = $item->{$branchfield};
2453 # default to item home branch if holdingbranch is used
2454 # and is not defined
2455 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2456 $branch = $item->{homebranch
};
2464 $issue = GetOpenIssue( $itemnumber );
2466 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2468 C<$itemnumber> is the item's itemnumber
2475 my ( $itemnumber ) = @_;
2476 return unless $itemnumber;
2477 my $dbh = C4
::Context
->dbh;
2478 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2479 $sth->execute( $itemnumber );
2480 return $sth->fetchrow_hashref();
2484 =head2 GetBiblioIssues
2486 $issues = GetBiblioIssues($biblionumber);
2488 this function get all issues from a biblionumber.
2491 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2492 tables issues and the firstname,surname & cardnumber from borrowers.
2496 sub GetBiblioIssues
{
2497 my $biblionumber = shift;
2498 return unless $biblionumber;
2499 my $dbh = C4
::Context
->dbh;
2501 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2503 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2504 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2505 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2506 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2507 WHERE biblio.biblionumber = ?
2509 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2511 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2512 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2513 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2514 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2515 WHERE biblio.biblionumber = ?
2518 my $sth = $dbh->prepare($query);
2519 $sth->execute($biblionumber, $biblionumber);
2522 while ( my $data = $sth->fetchrow_hashref ) {
2523 push @issues, $data;
2528 =head2 GetUpcomingDueIssues
2530 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2534 sub GetUpcomingDueIssues
{
2537 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2538 my $dbh = C4
::Context
->dbh;
2540 my $statement = <<END_SQL;
2543 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2545 LEFT JOIN items USING (itemnumber)
2546 LEFT OUTER JOIN branches USING (branchcode)
2547 WHERE returndate is NULL
2549 WHERE days_until_due >= 0 AND days_until_due <= ?
2552 my @bind_parameters = ( $params->{'days_in_advance'} );
2554 my $sth = $dbh->prepare( $statement );
2555 $sth->execute( @bind_parameters );
2556 my $upcoming_dues = $sth->fetchall_arrayref({});
2558 return $upcoming_dues;
2561 =head2 CanBookBeRenewed
2563 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2565 Find out whether a borrowed item may be renewed.
2567 C<$borrowernumber> is the borrower number of the patron who currently
2568 has the item on loan.
2570 C<$itemnumber> is the number of the item to renew.
2572 C<$override_limit>, if supplied with a true value, causes
2573 the limit on the number of times that the loan can be renewed
2574 (as controlled by the item type) to be ignored. Overriding also allows
2575 to renew sooner than "No renewal before" and to manually renew loans
2576 that are automatically renewed.
2578 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2579 item must currently be on loan to the specified borrower; renewals
2580 must be allowed for the item's type; and the borrower must not have
2581 already renewed the loan. $error will contain the reason the renewal can not proceed
2585 sub CanBookBeRenewed {
2586 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2588 my $dbh = C4::Context->dbh;
2591 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2592 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return ( 0, 'no_checkout' );
2593 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2595 $borrowernumber ||= $issue->borrowernumber;
2596 my $patron = Koha::Patrons->find( $borrowernumber )
2599 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2601 # This item can fill one or more unfilled reserve, can those unfilled reserves
2602 # all be filled by other available items?
2604 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2606 my $schema = Koha::Database->new()->schema();
2608 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2610 # There is an item level hold on this item, no other item can fill the hold
2615 # Get all other items that could possibly fill reserves
2616 my @itemnumbers = $schema->resultset('Item')->search(
2618 biblionumber => $resrec->{biblionumber},
2621 -not => { itemnumber => $itemnumber }
2623 { columns => 'itemnumber' }
2624 )->get_column('itemnumber')->all();
2626 # Get all other reserves that could have been filled by this item
2627 my @borrowernumbers;
2629 my ( $reserve_found, $reserve, undef ) =
2630 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2632 if ($reserve_found) {
2633 push( @borrowernumbers, $reserve->{borrowernumber} );
2640 # If the count of the union of the lists of reservable items for each borrower
2641 # is equal or greater than the number of borrowers, we know that all reserves
2642 # can be filled with available items. We can get the union of the sets simply
2643 # by pushing all the elements onto an array and removing the duplicates.
2646 ITEM: foreach my $i (@itemnumbers) {
2647 my $item = GetItem($i);
2648 next if IsItemOnHoldAndFound($i);
2649 for my $b (@borrowernumbers) {
2650 my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2651 next unless IsAvailableForItemLevelRequest($item, $borr);
2652 next unless CanItemBeReserved($b,$i);
2654 push @reservable, $i;
2655 if (@reservable >= @borrowernumbers) {
2664 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2666 return ( 1, undef ) if $override_limit;
2668 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2669 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2670 { categorycode => $patron->categorycode,
2671 itemtype => $item->{itype},
2672 branchcode => $branchcode
2676 return ( 0, "too_many" )
2677 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2679 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2680 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2681 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2682 my $restricted = $patron->is_debarred;
2683 my $hasoverdues = $patron->has_overdues;
2685 if ( $restricted and $restrictionblockrenewing ) {
2686 return ( 0, 'restriction');
2687 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2688 return ( 0, 'overdue');
2691 if ( $issue->auto_renew ) {
2693 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2694 return ( 0, 'auto_account_expired' );
2697 if ( defined $issuing_rule->no_auto_renewal_after
2698 and $issuing_rule->no_auto_renewal_after ne "" ) {
2699 # Get issue_date and add no_auto_renewal_after
2700 # If this is greater than today, it's too late for renewal.
2701 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2702 $maximum_renewal_date->add(
2703 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2705 my $now = dt_from_string;
2706 if ( $now >= $maximum_renewal_date ) {
2707 return ( 0, "auto_too_late" );
2710 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2711 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2712 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2713 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2714 return ( 0, "auto_too_late" );
2718 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2719 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2720 my $amountoutstanding = $patron->account->balance;
2721 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2722 return ( 0, "auto_too_much_oweing" );
2727 if ( defined $issuing_rule->norenewalbefore
2728 and $issuing_rule->norenewalbefore ne "" )
2731 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2732 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2733 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2735 # Depending on syspref reset the exact time, only check the date
2736 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2737 and $issuing_rule->lengthunit eq 'days' )
2739 $soonestrenewal->truncate( to => 'day' );
2742 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2744 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2745 return ( 0, "too_soon" );
2747 elsif ( $issue->auto_renew ) {
2748 return ( 0, "auto_renew" );
2752 # Fallback for automatic renewals:
2753 # If norenewalbefore is undef, don't renew before due date.
2754 if ( $issue->auto_renew ) {
2755 my $now = dt_from_string;
2756 return ( 0, "auto_renew" )
2757 if $now >= dt_from_string( $issue->date_due, 'sql' );
2758 return ( 0, "auto_too_soon" );
2761 return ( 1, undef );
2766 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2770 C<$borrowernumber> is the borrower number of the patron who currently
2773 C<$itemnumber> is the number of the item to renew.
2775 C<$branch> is the library where the renewal took place (if any).
2776 The library that controls the circ policies for the renewal is retrieved from the issues record.
2778 C<$datedue> can be a DateTime object used to set the due date.
2780 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2781 this parameter is not supplied, lastreneweddate is set to the current date.
2783 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2784 from the book's item type.
2789 my $borrowernumber = shift;
2790 my $itemnumber = shift or return;
2792 my $datedue = shift;
2793 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2795 my $item = GetItem($itemnumber) or return;
2796 my $item_object = Koha::Items->find( $itemnumber ); # Should replace $item
2797 my $biblio = $item_object->biblio;
2799 my $dbh = C4::Context->dbh;
2801 # Find the issues record for this book
2802 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
2804 return unless $issue;
2806 $borrowernumber ||= $issue->borrowernumber;
2808 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2809 carp 'Invalid date passed to AddRenewal.';
2813 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2814 my $patron_unblessed = $patron->unblessed;
2816 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2817 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed } );
2819 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2821 # If the due date wasn't specified, calculate it by adding the
2822 # book's loan length to today's date or the current due date
2823 # based on the value of the RenewalPeriodBase syspref.
2826 my $itemtype = $item_object->effective_itemtype;
2827 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2828 dt_from_string( $issue->date_due, 'sql' ) :
2829 DateTime->now( time_zone => C4::Context->tz());
2830 $datedue = CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $patron_unblessed), $patron_unblessed, 'is a renewal');
2833 # Update the issues record to have the new due date, and a new count
2834 # of how many times it has been renewed.
2835 my $renews = $issue->renewals + 1;
2836 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2837 WHERE borrowernumber=?
2841 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2843 # Update the renewal count on the item, and tell zebra to reindex
2844 $renews = $item->{renewals} + 1;
2845 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item->{biblionumber}, $itemnumber, { log_action => 0 } );
2847 # Charge a new rental fee, if applicable?
2848 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2849 if ( $charge > 0 ) {
2850 my $accountno = getnextacctno( $borrowernumber );
2852 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2853 $sth = $dbh->prepare(
2854 "INSERT INTO accountlines
2855 (date, borrowernumber, accountno, amount, manager_id,
2856 description,accounttype, amountoutstanding, itemnumber)
2857 VALUES (now(),?,?,?,?,?,?,?,?)"
2859 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2860 "Renewal of Rental Item " . $biblio->title . " $item->{'barcode'}",
2861 'Rent', $charge, $itemnumber );
2864 # Send a renewal slip according to checkout alert preferencei
2865 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2866 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2868 branchcode => $branch,
2869 categorycode => $patron->categorycode,
2870 item_type => $item->{itype},
2871 notification => 'CHECKOUT',
2873 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2874 SendCirculationAlert(
2878 borrower => $patron->unblessed,
2885 # Remove any OVERDUES related debarment if the borrower has no overdues
2887 && $patron->is_debarred
2888 && ! $patron->has_overdues
2889 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2891 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2894 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2895 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2898 # Add the renewal to stats
2904 itemnumber => $itemnumber,
2905 itemtype => $item->{itype},
2906 location => $item->{location},
2907 borrowernumber => $borrowernumber,
2908 ccode => $item->{'ccode'}
2913 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2918 # check renewal status
2919 my ( $bornum, $itemno ) = @_;
2920 my $dbh = C4::Context->dbh;
2922 my $renewsallowed = 0;
2925 my $patron = Koha::Patrons->find( $bornum );
2926 my $item = GetItem($itemno);
2928 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2930 # Look in the issues table for this item, lent to this borrower,
2931 # and not yet returned.
2933 # FIXME - I think this function could be redone to use only one SQL call.
2934 my $sth = $dbh->prepare(
2935 "select * from issues
2936 where (borrowernumber = ?)
2937 and (itemnumber = ?)"
2939 $sth->execute( $bornum, $itemno );
2940 my $data = $sth->fetchrow_hashref;
2941 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2942 # $item and $borrower should be calculated
2943 my $branchcode = _GetCircControlBranch($item, $patron->unblessed);
2945 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2946 { categorycode => $patron->categorycode,
2947 itemtype => $item->{itype},
2948 branchcode => $branchcode
2952 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
2953 $renewsleft = $renewsallowed - $renewcount;
2954 if($renewsleft < 0){ $renewsleft = 0; }
2955 return ( $renewcount, $renewsallowed, $renewsleft );
2958 =head2 GetSoonestRenewDate
2960 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2962 Find out the soonest possible renew date of a borrowed item.
2964 C<$borrowernumber> is the borrower number of the patron who currently
2965 has the item on loan.
2967 C<$itemnumber> is the number of the item to renew.
2969 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2970 renew date, based on the value "No renewal before" of the applicable
2971 issuing rule. Returns the current date if the item can already be
2972 renewed, and returns undefined if the borrower, loan, or item
2977 sub GetSoonestRenewDate {
2978 my ( $borrowernumber, $itemnumber ) = @_;
2980 my $dbh = C4::Context->dbh;
2982 my $item = GetItem($itemnumber) or return;
2983 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2985 $borrowernumber ||= $itemissue->borrowernumber;
2986 my $patron = Koha::Patrons->find( $borrowernumber )
2989 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2990 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2991 { categorycode => $patron->categorycode,
2992 itemtype => $item->{itype},
2993 branchcode => $branchcode
2997 my $now = dt_from_string;
2998 return $now unless $issuing_rule;
3000 if ( defined $issuing_rule->norenewalbefore
3001 and $issuing_rule->norenewalbefore ne "" )
3003 my $soonestrenewal =
3004 dt_from_string( $itemissue->date_due )->subtract(
3005 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3007 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3008 and $issuing_rule->lengthunit eq 'days' )
3010 $soonestrenewal->truncate( to => 'day' );
3012 return $soonestrenewal if $now < $soonestrenewal;
3017 =head2 GetLatestAutoRenewDate
3019 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3021 Find out the latest possible auto renew date of a borrowed item.
3023 C<$borrowernumber> is the borrower number of the patron who currently
3024 has the item on loan.
3026 C<$itemnumber> is the number of the item to renew.
3028 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3029 auto renew date, based on the value "No auto renewal after" and the "No auto
3030 renewal after (hard limit) of the applicable issuing rule.
3031 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3032 or item cannot be found.
3036 sub GetLatestAutoRenewDate {
3037 my ( $borrowernumber, $itemnumber ) = @_;
3039 my $dbh = C4::Context->dbh;
3041 my $item = GetItem($itemnumber) or return;
3042 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3044 $borrowernumber ||= $itemissue->borrowernumber;
3045 my $patron = Koha::Patrons->find( $borrowernumber )
3048 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3049 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3050 { categorycode => $patron->categorycode,
3051 itemtype => $item->{itype},
3052 branchcode => $branchcode
3056 return unless $issuing_rule;
3058 if ( not $issuing_rule->no_auto_renewal_after
3059 or $issuing_rule->no_auto_renewal_after eq '' )
3060 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3061 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3063 my $maximum_renewal_date;
3064 if ( $issuing_rule->no_auto_renewal_after ) {
3065 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3066 $maximum_renewal_date->add(
3067 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3071 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3072 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3073 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3075 return $maximum_renewal_date;
3079 =head2 GetIssuingCharges
3081 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3083 Calculate how much it would cost for a given patron to borrow a given
3084 item, including any applicable discounts.
3086 C<$itemnumber> is the item number of item the patron wishes to borrow.
3088 C<$borrowernumber> is the patron's borrower number.
3090 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3091 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3096 sub GetIssuingCharges {
3098 # calculate charges due
3099 my ( $itemnumber, $borrowernumber ) = @_;
3101 my $dbh = C4::Context->dbh;
3104 # Get the book's item type and rental charge (via its biblioitem).
3105 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3106 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3107 $charge_query .= (C4::Context->preference('item-level_itypes'))
3108 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3109 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3111 $charge_query .= ' WHERE items.itemnumber =?';
3113 my $sth = $dbh->prepare($charge_query);
3114 $sth->execute($itemnumber);
3115 if ( my $item_data = $sth->fetchrow_hashref ) {
3116 $item_type = $item_data->{itemtype};
3117 $charge = $item_data->{rentalcharge};
3118 my $branch = C4::Context::mybranch();
3119 my $discount_query = q|SELECT rentaldiscount,
3120 issuingrules.itemtype, issuingrules.branchcode
3122 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3123 WHERE borrowers.borrowernumber = ?
3124 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3125 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3126 my $discount_sth = $dbh->prepare($discount_query);
3127 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3128 my $discount_rules = $discount_sth->fetchall_arrayref({});
3129 if (@{$discount_rules}) {
3130 # We may have multiple rules so get the most specific
3131 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3132 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3135 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3139 return ( $charge, $item_type );
3142 # Select most appropriate discount rule from those returned
3143 sub _get_discount_from_rule {
3144 my ($rules_ref, $branch, $itemtype) = @_;
3147 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3148 $discount = $rules_ref->[0]->{rentaldiscount};
3149 return (defined $discount) ? $discount : 0;
3151 # could have up to 4 does one match $branch and $itemtype
3152 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3154 $discount = $d[0]->{rentaldiscount};
3155 return (defined $discount) ? $discount : 0;
3157 # do we have item type + all branches
3158 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype
} eq $itemtype } @
{$rules_ref};
3160 $discount = $d[0]->{rentaldiscount
};
3161 return (defined $discount) ?
$discount : 0;
3163 # do we all item types + this branch
3164 @d = grep { $_->{branchcode
} eq $branch && $_->{itemtype
} eq q{*} } @
{$rules_ref};
3166 $discount = $d[0]->{rentaldiscount
};
3167 return (defined $discount) ?
$discount : 0;
3169 # so all and all (surely we wont get here)
3170 @d = grep { $_->{branchcode
} eq q{*} && $_->{itemtype
} eq q{*} } @
{$rules_ref};
3172 $discount = $d[0]->{rentaldiscount
};
3173 return (defined $discount) ?
$discount : 0;
3179 =head2 AddIssuingCharge
3181 &AddIssuingCharge( $checkout, $charge )
3185 sub AddIssuingCharge
{
3186 my ( $checkout, $charge ) = @_;
3188 # FIXME What if checkout does not exist?
3190 my $nextaccntno = getnextacctno
($checkout->borrowernumber);
3193 $manager_id = C4
::Context
->userenv->{'number'} if C4
::Context
->userenv;
3195 my $accountline = Koha
::Account
::Line
->new(
3197 borrowernumber
=> $checkout->borrowernumber,
3198 itemnumber
=> $checkout->itemnumber,
3199 issue_id
=> $checkout->issue_id,
3200 accountno
=> $nextaccntno,
3202 amountoutstanding
=> $charge,
3203 manager_id
=> $manager_id,
3204 description
=> 'Rental',
3205 accounttype
=> 'Rent',
3210 Koha::Account::Offset->new(
3212 debit_id => $accountline->id,
3213 type => 'Rental Fee
',
3221 GetTransfers($itemnumber);
3226 my ($itemnumber) = @_;
3228 my $dbh = C4::Context->dbh;
3235 FROM branchtransfers
3236 WHERE itemnumber
= ?
3237 AND datearrived IS NULL
3239 my $sth = $dbh->prepare($query);
3240 $sth->execute($itemnumber);
3241 my @row = $sth->fetchrow_array();
3245 =head2 GetTransfersFromTo
3247 @results = GetTransfersFromTo($frombranch,$tobranch);
3249 Returns the list of pending transfers between $from and $to branch
3253 sub GetTransfersFromTo {
3254 my ( $frombranch, $tobranch ) = @_;
3255 return unless ( $frombranch && $tobranch );
3256 my $dbh = C4::Context->dbh;
3258 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3259 FROM branchtransfers
3262 AND datearrived IS NULL
3264 my $sth = $dbh->prepare($query);
3265 $sth->execute( $frombranch, $tobranch );
3268 while ( my $data = $sth->fetchrow_hashref ) {
3269 push @gettransfers, $data;
3271 return (@gettransfers);
3274 =head2 DeleteTransfer
3276 &DeleteTransfer($itemnumber);
3280 sub DeleteTransfer {
3281 my ($itemnumber) = @_;
3282 return unless $itemnumber;
3283 my $dbh = C4::Context->dbh;
3284 my $sth = $dbh->prepare(
3285 "DELETE FROM branchtransfers
3287 AND datearrived IS NULL "
3289 return $sth->execute($itemnumber);
3292 =head2 SendCirculationAlert
3294 Send out a C<check-in> or C<checkout> alert using the messaging system.
3302 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3306 Hashref of information about the item being checked in or out.
3310 Hashref of information about the borrower of the item.
3314 The branchcode from where the checkout or check-in took place.
3320 SendCirculationAlert({
3323 borrower => $borrower,
3329 sub SendCirculationAlert {
3331 my ($type, $item, $borrower, $branch) =
3332 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3333 my %message_name = (
3334 CHECKIN => 'Item_Check_in
',
3335 CHECKOUT => 'Item_Checkout
',
3336 RENEWAL => 'Item_Checkout
',
3338 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3339 borrowernumber => $borrower->{borrowernumber},
3340 message_name => $message_name{$type},
3342 my $issues_table = ( $type eq 'CHECKOUT
' || $type eq 'RENEWAL
' ) ? 'issues
' : 'old_issues
';
3344 my $schema = Koha::Database->new->schema;
3345 my @transports = keys %{ $borrower_preferences->{transports} };
3347 # From the MySQL doc:
3348 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3349 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3350 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3351 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3353 for my $mtt (@transports) {
3354 my $letter = C4::Letters::GetPreparedLetter (
3355 module => 'circulation
',
3356 letter_code => $type,
3357 branchcode => $branch,
3358 message_transport_type => $mtt,
3359 lang => $borrower->{lang},
3361 $issues_table => $item->{itemnumber},
3362 'items
' => $item->{itemnumber},
3363 'biblio
' => $item->{biblionumber},
3364 'biblioitems
' => $item->{biblionumber},
3365 'borrowers
' => $borrower,
3366 'branches
' => $branch,
3370 $schema->storage->txn_begin;
3371 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3372 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3373 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3374 unless ( $message ) {
3375 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3376 C4::Message->enqueue($letter, $borrower, $mtt);
3378 $message->append($letter);
3381 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3382 $schema->storage->txn_commit;
3388 =head2 updateWrongTransfer
3390 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3392 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
3396 sub updateWrongTransfer {
3397 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3398 my $dbh = C4::Context->dbh;
3399 # first step validate the actual line of transfert .
3402 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer
' where itemnumber= ? AND datearrived IS NULL"
3404 $sth->execute($FromLibrary,$itemNumber);
3406 # second step create a new line of branchtransfer to the right location .
3407 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3409 #third step changing holdingbranch of item
3410 UpdateHoldingbranch($FromLibrary,$itemNumber);
3413 =head2 UpdateHoldingbranch
3415 $items = UpdateHoldingbranch($branch,$itmenumber);
3417 Simple methode for updating hodlingbranch in items BDD line
3421 sub UpdateHoldingbranch {
3422 my ( $branch,$itemnumber ) = @_;
3423 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3428 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3430 this function calculates the due date given the start date and configured circulation rules,
3431 checking against the holidays calendar as per the 'useDaysMode
' syspref.
3432 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3433 C<$itemtype> = itemtype code of item in question
3434 C<$branch> = location whose calendar to use
3435 C<$borrower> = Borrower object
3436 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3441 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3445 # loanlength now a href
3447 GetLoanLength( $borrower->{'categorycode
'}, $itemtype, $branch );
3449 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3455 if (ref $startdate ne 'DateTime
' ) {
3456 $datedue = dt_from_string($datedue);
3458 $datedue = $startdate->clone;
3462 DateTime->now( time_zone => C4::Context->tz() )
3463 ->truncate( to => 'minute
' );
3467 # calculate the datedue as normal
3468 if ( C4::Context->preference('useDaysMode
') eq 'Days
' )
3469 { # ignoring calendar
3470 if ( $loanlength->{lengthunit} eq 'hours
' ) {
3471 $datedue->add( hours => $loanlength->{$length_key} );
3473 $datedue->add( days => $loanlength->{$length_key} );
3474 $datedue->set_hour(23);
3475 $datedue->set_minute(59);
3479 if ($loanlength->{lengthunit} eq 'hours
') {
3480 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3483 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3485 my $calendar = Koha::Calendar->new( branchcode => $branch );
3486 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3487 if ($loanlength->{lengthunit} eq 'days
') {
3488 $datedue->set_hour(23);
3489 $datedue->set_minute(59);
3493 # if Hard Due Dates are used, retrieve them and apply as necessary
3494 my ( $hardduedate, $hardduedatecompare ) =
3495 GetHardDueDate( $borrower->{'categorycode
'}, $itemtype, $branch );
3496 if ($hardduedate) { # hardduedates are currently dates
3497 $hardduedate->truncate( to => 'minute
' );
3498 $hardduedate->set_hour(23);
3499 $hardduedate->set_minute(59);
3500 my $cmp = DateTime->compare( $hardduedate, $datedue );
3502 # if the calculated due date is after the 'before
' Hard Due Date (ceiling), override
3503 # if the calculated date is before the 'after
' Hard Due Date (floor), override
3504 # if the hard due date is set to 'exactly
', overrride
3505 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3506 $datedue = $hardduedate->clone;
3509 # in all other cases, keep the date due as it is
3513 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3514 if ( C4
::Context
->preference('ReturnBeforeExpiry') ) {
3515 my $expiry_dt = dt_from_string
( $borrower->{dateexpiry
}, 'iso', 'floating');
3516 if( $expiry_dt ) { #skip empty expiry date..
3517 $expiry_dt->set( hour
=> 23, minute
=> 59);
3518 my $d1= $datedue->clone->set_time_zone('floating');
3519 if ( DateTime
->compare( $d1, $expiry_dt ) == 1 ) {
3520 $datedue = $expiry_dt->clone->set_time_zone( C4
::Context
->tz );
3523 if ( C4
::Context
->preference('useDaysMode') ne 'Days' ) {
3524 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
3525 if ( $calendar->is_holiday($datedue) ) {
3526 # Don't return on a closed day
3527 $datedue = $calendar->prev_open_day( $datedue );
3536 sub CheckValidBarcode
{
3538 my $dbh = C4
::Context
->dbh;
3539 my $query=qq|SELECT count
(*)
3543 my $sth = $dbh->prepare($query);
3544 $sth->execute($barcode);
3545 my $exist=$sth->fetchrow ;
3549 =head2 IsBranchTransferAllowed
3551 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3553 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3557 sub IsBranchTransferAllowed
{
3558 my ( $toBranch, $fromBranch, $code ) = @_;
3560 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3562 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3563 my $dbh = C4
::Context
->dbh;
3565 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3566 $sth->execute( $toBranch, $fromBranch, $code );
3567 my $limit = $sth->fetchrow_hashref();
3569 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3570 if ( $limit->{'limitId'} ) {
3577 =head2 CreateBranchTransferLimit
3579 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3581 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3585 sub CreateBranchTransferLimit
{
3586 my ( $toBranch, $fromBranch, $code ) = @_;
3587 return unless defined($toBranch) && defined($fromBranch);
3588 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3590 my $dbh = C4
::Context
->dbh;
3592 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3593 return $sth->execute( $code, $toBranch, $fromBranch );
3596 =head2 DeleteBranchTransferLimits
3598 my $result = DeleteBranchTransferLimits($frombranch);
3600 Deletes all the library transfer limits for one library. Returns the
3601 number of limits deleted, 0e0 if no limits were deleted, or undef if
3602 no arguments are supplied.
3606 sub DeleteBranchTransferLimits
{
3608 return unless defined $branch;
3609 my $dbh = C4
::Context
->dbh;
3610 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3611 return $sth->execute($branch);
3615 my ( $borrowernumber, $itemnum ) = @_;
3617 MarkIssueReturned
( $borrowernumber, $itemnum );
3618 my $patron = Koha
::Patrons
->find( $borrowernumber );
3619 my $item = C4
::Items
::GetItem
( $itemnum );
3620 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ?
$item->{'paidfor'}.' / ' : q{};
3621 my @datearr = localtime(time);
3622 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3623 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3624 ModItem
({ paidfor
=> $old_note."Paid for by $bor $date" }, undef, $itemnum);
3629 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3631 unless ( $mark_lost_from ) {
3632 # Temporary check to avoid regressions
3633 die q
|LostItem called without
$mark_lost_from, check the API
.|;
3637 if ( $force_mark_returned ) {
3640 my $pref = C4
::Context
->preference('MarkLostItemsAsReturned') // q{};
3641 $mark_returned = ( $pref =~ m
|$mark_lost_from| );
3644 my $dbh = C4
::Context
->dbh();
3645 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3647 JOIN items USING (itemnumber)
3648 JOIN biblio USING (biblionumber)
3649 WHERE issues.itemnumber=?");
3650 $sth->execute($itemnumber);
3651 my $issues=$sth->fetchrow_hashref();
3653 # If a borrower lost the item, add a replacement cost to the their record
3654 if ( my $borrowernumber = $issues->{borrowernumber
} ){
3655 my $patron = Koha
::Patrons
->find( $borrowernumber );
3657 if (C4
::Context
->preference('WhenLostForgiveFine')){
3658 my $fix = _FixOverduesOnReturn
($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3659 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3661 if (C4
::Context
->preference('WhenLostChargeReplacementFee')){
3662 C4
::Accounts
::chargelostitem
($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3663 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3664 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3667 MarkIssueReturned
($borrowernumber,$itemnumber,undef,undef,$patron->privacy) if $mark_returned;
3671 sub GetOfflineOperations
{
3672 my $dbh = C4
::Context
->dbh;
3673 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3674 $sth->execute(C4
::Context
->userenv->{'branch'});
3675 my $results = $sth->fetchall_arrayref({});
3679 sub GetOfflineOperation
{
3680 my $operationid = shift;
3681 return unless $operationid;
3682 my $dbh = C4
::Context
->dbh;
3683 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3684 $sth->execute( $operationid );
3685 return $sth->fetchrow_hashref;
3688 sub AddOfflineOperation
{
3689 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3690 my $dbh = C4
::Context
->dbh;
3691 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3692 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3696 sub DeleteOfflineOperation
{
3697 my $dbh = C4
::Context
->dbh;
3698 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3699 $sth->execute( shift );
3703 sub ProcessOfflineOperation
{
3704 my $operation = shift;
3707 if ( $operation->{action
} eq 'return' ) {
3708 $report = ProcessOfflineReturn
( $operation );
3709 } elsif ( $operation->{action
} eq 'issue' ) {
3710 $report = ProcessOfflineIssue
( $operation );
3711 } elsif ( $operation->{action
} eq 'payment' ) {
3712 $report = ProcessOfflinePayment
( $operation );
3715 DeleteOfflineOperation
( $operation->{operationid
} ) if $operation->{operationid
};
3720 sub ProcessOfflineReturn
{
3721 my $operation = shift;
3723 my $item = Koha
::Items
->find({barcode
=> $operation->{barcode
}});
3726 my $itemnumber = $item->itemnumber;
3727 my $issue = GetOpenIssue
( $itemnumber );
3730 $issue->{borrowernumber
},
3733 $operation->{timestamp
},
3736 { renewals
=> 0, onloan
=> undef },
3737 $issue->{'biblionumber'},
3743 return "Item not issued.";
3746 return "Item not found.";
3750 sub ProcessOfflineIssue
{
3751 my $operation = shift;
3753 my $patron = Koha
::Patrons
->find( { cardnumber
=> $operation->{cardnumber
} } );
3756 my $item = Koha
::Items
->find({ barcode
=> $operation->{barcode
} });
3758 return "Barcode not found.";
3760 my $itemnumber = $item->itemnumber;
3761 my $issue = GetOpenIssue
( $itemnumber );
3763 if ( $issue and ( $issue->{borrowernumber
} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3765 $issue->{borrowernumber
},
3768 $operation->{timestamp
},
3773 $operation->{'barcode'},
3776 $operation->{timestamp
},
3781 return "Borrower not found.";
3785 sub ProcessOfflinePayment
{
3786 my $operation = shift;
3788 my $patron = Koha
::Patrons
->find( { cardnumber
=> $operation->{cardnumber
} });
3789 my $amount = $operation->{amount
};
3791 Koha
::Account
->new( { patron_id
=> $patron->id } )->pay( { amount
=> $amount } );
3799 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3801 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3806 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3808 my $item = GetItem
( $itemnumber, $barcode )
3811 return C4
::Letters
::GetPreparedLetter
(
3812 module
=> 'circulation',
3813 letter_code
=> 'TRANSFERSLIP',
3814 branchcode
=> $branch,
3816 'branches' => $to_branch,
3817 'biblio' => $item->{biblionumber
},
3823 =head2 CheckIfIssuedToPatron
3825 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3827 Return 1 if any record item is issued to patron, otherwise return 0
3831 sub CheckIfIssuedToPatron
{
3832 my ($borrowernumber, $biblionumber) = @_;
3834 my $dbh = C4
::Context
->dbh;
3836 SELECT COUNT
(*) FROM issues
3837 LEFT JOIN items ON items
.itemnumber
= issues
.itemnumber
3838 WHERE items
.biblionumber
= ?
3839 AND issues
.borrowernumber
= ?
3841 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3842 return 1 if $is_issued;
3848 IsItemIssued( $itemnumber )
3850 Return 1 if the item is on loan, otherwise return 0
3855 my $itemnumber = shift;
3856 my $dbh = C4
::Context
->dbh;
3857 my $sth = $dbh->prepare(q{
3860 WHERE itemnumber = ?
3862 $sth->execute($itemnumber);
3863 return $sth->fetchrow;
3866 =head2 GetAgeRestriction
3868 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3869 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3871 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3872 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3874 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3875 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3876 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3877 Negative days mean the borrower has gone past the age restriction age.
3881 sub GetAgeRestriction
{
3882 my ($record_restrictions, $borrower) = @_;
3883 my $markers = C4
::Context
->preference('AgeRestrictionMarker');
3885 # Split $record_restrictions to something like FSK 16 or PEGI 6
3886 my @values = split ' ', uc($record_restrictions);
3887 return unless @values;
3889 # Search first occurrence of one of the markers
3890 my @markers = split /\|/, uc($markers);
3891 return unless @markers;
3894 my $restriction_year = 0;
3895 for my $value (@values) {
3897 for my $marker (@markers) {
3898 $marker =~ s/^\s+//; #remove leading spaces
3899 $marker =~ s/\s+$//; #remove trailing spaces
3900 if ( $marker eq $value ) {
3901 if ( $index <= $#values ) {
3902 $restriction_year += $values[$index];
3906 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3908 # Perhaps it is something like "K16" (as in Finland)
3909 $restriction_year += $1;
3913 last if ( $restriction_year > 0 );
3916 #Check if the borrower is age restricted for this material and for how long.
3917 if ($restriction_year && $borrower) {
3918 if ( $borrower->{'dateofbirth'} ) {
3919 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3920 $alloweddate[0] += $restriction_year;
3922 #Prevent runime eror on leap year (invalid date)
3923 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3924 $alloweddate[2] = 28;
3927 #Get how many days the borrower has to reach the age restriction
3928 my @Today = split /-/, DateTime
->today->ymd();
3929 my $daysToAgeRestriction = Date_to_Days
(@alloweddate) - Date_to_Days
(@Today);
3930 #Negative days means the borrower went past the age restriction age
3931 return ($restriction_year, $daysToAgeRestriction);
3935 return ($restriction_year);
3939 =head2 GetPendingOnSiteCheckouts
3943 sub GetPendingOnSiteCheckouts
{
3944 my $dbh = C4
::Context
->dbh;
3945 return $dbh->selectall_arrayref(q
|
3951 items
.itemcallnumber
,
3955 issues
.date_due
< NOW
() AS is_overdue
,
3958 borrowers
.firstname
,
3960 borrowers
.cardnumber
,
3961 borrowers
.borrowernumber
3963 LEFT JOIN issues ON items
.itemnumber
= issues
.itemnumber
3964 LEFT JOIN biblio ON items
.biblionumber
= biblio
.biblionumber
3965 LEFT JOIN borrowers ON issues
.borrowernumber
= borrowers
.borrowernumber
3966 WHERE issues
.onsite_checkout
= 1
3967 |, { Slice
=> {} } );
3973 my ($count, $branch, $itemtype, $ccode, $newness)
3974 = @
$params{qw(count branch itemtype ccode newness)};
3976 my $dbh = C4
::Context
->dbh;
3979 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
3980 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
3981 i.ccode, SUM(i.issues) AS count
3983 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
3984 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
3987 my (@where_strs, @where_args);
3990 push @where_strs, 'i.homebranch = ?';
3991 push @where_args, $branch;
3994 if (C4
::Context
->preference('item-level_itypes')){
3995 push @where_strs, 'i.itype = ?';
3996 push @where_args, $itemtype;
3998 push @where_strs, 'bi.itemtype = ?';
3999 push @where_args, $itemtype;
4003 push @where_strs, 'i.ccode = ?';
4004 push @where_args, $ccode;
4007 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4008 push @where_args, $newness;
4012 $query .= 'WHERE ' . join(' AND ', @where_strs);
4016 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4017 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4022 $query .= q{ ) xxx WHERE count > 0 };
4023 $count = int($count);
4025 $query .= "LIMIT $count";
4028 my $rows = $dbh->selectall_arrayref($query, { Slice
=> {} }, @where_args);
4033 sub _CalculateAndUpdateFine
{
4036 my $borrower = $params->{borrower
};
4037 my $item = $params->{item
};
4038 my $issue = $params->{issue
};
4039 my $return_date = $params->{return_date
};
4041 unless ($borrower) { carp
"No borrower passed in!" && return; }
4042 unless ($item) { carp
"No item passed in!" && return; }
4043 unless ($issue) { carp
"No issue passed in!" && return; }
4045 my $datedue = dt_from_string
( $issue->date_due );
4047 # we only need to calculate and change the fines if we want to do that on return
4048 # Should be on for hourly loans
4049 my $control = C4
::Context
->preference('CircControl');
4050 my $control_branchcode =
4051 ( $control eq 'ItemHomeLibrary' ) ?
$item->{homebranch
}
4052 : ( $control eq 'PatronLibrary' ) ?
$borrower->{branchcode
}
4053 : $issue->branchcode;
4055 my $date_returned = $return_date ? dt_from_string
($return_date) : dt_from_string
();
4057 my ( $amount, $type, $unitcounttotal ) =
4058 C4
::Overdues
::CalcFine
( $item, $borrower->{categorycode
}, $control_branchcode, $datedue, $date_returned );
4062 if ( C4
::Context
->preference('finesMode') eq 'production' ) {
4063 if ( $amount > 0 ) {
4064 C4
::Overdues
::UpdateFine
({
4065 issue_id
=> $issue->issue_id,
4066 itemnumber
=> $issue->itemnumber,
4067 borrowernumber
=> $issue->borrowernumber,
4070 due
=> output_pref
($datedue),
4073 elsif ($return_date) {
4075 # Backdated returns may have fines that shouldn't exist,
4076 # so in this case, we need to drop those fines to 0
4078 C4
::Overdues
::UpdateFine
({
4079 issue_id
=> $issue->issue_id,
4080 itemnumber
=> $issue->itemnumber,
4081 borrowernumber
=> $issue->borrowernumber,
4084 due
=> output_pref
($datedue),
4096 Koha Development Team <http://koha-community.org/>