1 package C4
::Circulation
;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use POSIX
qw( floor );
32 use C4
::ItemCirculationAlertPreference
;
35 use C4
::Log
; # logaction
36 use C4
::Overdues
qw(CalcFine UpdateFine get_chargeable_units);
37 use C4
::RotatingCollections
qw(GetCollectionItemBranches);
38 use Algorithm
::CheckDigits
;
42 use Koha
::AuthorisedValues
;
43 use Koha
::Biblioitems
;
49 use Koha
::Patron
::Debarments
;
52 use Koha
::Account
::Lines
;
54 use Koha
::RefundLostItemFeeRules
;
55 use Koha
::Account
::Lines
;
56 use Koha
::Account
::Offsets
;
57 use Koha
::Config
::SysPrefs
;
58 use Koha
::Charges
::Fees
;
59 use Koha
::Util
::SystemPreferences
;
60 use Koha
::Checkouts
::ReturnClaims
;
62 use List
::MoreUtils
qw( uniq any );
63 use Scalar
::Util
qw( looks_like_number );
73 use vars
qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
79 # FIXME subs that should probably be elsewhere
84 &GetPendingOnSiteCheckouts
87 # subs to deal with issuing a book
95 &GetLatestAutoRenewDate
97 &GetBranchBorrowerCircRule
101 &CheckIfIssuedToPatron
106 # subs to deal with returns
112 # subs to deal with transfers
119 &IsBranchTransferAllowed
120 &CreateBranchTransferLimit
121 &DeleteBranchTransferLimits
125 # subs to deal with offline circulation
127 &GetOfflineOperations
130 &DeleteOfflineOperation
131 &ProcessOfflineOperation
137 C4::Circulation - Koha circulation module
145 The functions in this module deal with circulation, issues, and
146 returns, as well as general information about the library.
147 Also deals with inventory.
153 $str = &barcodedecode($barcode, [$filter]);
155 Generic filter function for barcode string.
156 Called on every circ if the System Pref itemBarcodeInputFilter is set.
157 Will do some manipulation of the barcode for systems that deliver a barcode
158 to circulation.pl that differs from the barcode stored for the item.
159 For proper functioning of this filter, calling the function on the
160 correct barcode string (items.barcode) should return an unaltered barcode.
162 The optional $filter argument is to allow for testing or explicit
163 behavior that ignores the System Pref. Valid values are the same as the
168 # FIXME -- the &decode fcn below should be wrapped into this one.
169 # FIXME -- these plugins should be moved out of Circulation.pm
172 my ($barcode, $filter) = @_;
173 my $branch = C4
::Context
::mybranch
();
174 $filter = C4
::Context
->preference('itemBarcodeInputFilter') unless $filter;
175 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
176 if ($filter eq 'whitespace') {
178 } elsif ($filter eq 'cuecat') {
180 my @fields = split( /\./, $barcode );
181 my @results = map( decode
($_), @fields[ 1 .. $#fields ] );
182 ($#results == 2) and return $results[2];
183 } elsif ($filter eq 'T-prefix') {
184 if ($barcode =~ /^[Tt](\d)/) {
185 (defined($1) and $1 eq '0') and return $barcode;
186 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
188 return sprintf("T%07d", $barcode);
189 # FIXME: $barcode could be "T1", causing warning: substr outside of string
190 # Why drop the nonzero digit after the T?
191 # Why pass non-digits (or empty string) to "T%07d"?
192 } elsif ($filter eq 'libsuite8') {
193 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
194 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
195 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
197 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
200 } elsif ($filter eq 'EAN13') {
201 my $ean = CheckDigits
('ean');
202 if ( $ean->is_valid($barcode) ) {
203 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
204 $barcode = '0' x
( 13 - length($barcode) ) . $barcode;
206 warn "# [$barcode] not valid EAN-13/UPC-A\n";
209 return $barcode; # return barcode, modified or not
214 $str = &decode($chunk);
216 Decodes a segment of a string emitted by a CueCat barcode scanner and
219 FIXME: Should be replaced with Barcode::Cuecat from CPAN
220 or Javascript based decoding on the client side.
227 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
228 my @s = map { index( $seq, $_ ); } split( //, $encoded );
229 my $l = ( $#s + 1 ) % 4;
232 # warn "Error: Cuecat decode parsing failed!";
240 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
242 chr( ( $n >> 16 ) ^ 67 )
243 .chr( ( $n >> 8 & 255 ) ^ 67 )
244 .chr( ( $n & 255 ) ^ 67 );
247 $r = substr( $r, 0, length($r) - $l );
253 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
254 $barcode, $ignore_reserves);
256 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
258 C<$newbranch> is the code for the branch to which the item should be transferred.
260 C<$barcode> is the barcode of the item to be transferred.
262 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
263 Otherwise, if an item is reserved, the transfer fails.
265 Returns three values:
271 is true if the transfer was successful.
275 is a reference-to-hash which may have any of the following keys:
281 There is no item in the catalog with the given barcode. The value is C<$barcode>.
283 =item C<DestinationEqualsHolding>
285 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.
289 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.
293 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>.
295 =item C<WasTransferred>
297 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
306 my ( $tbr, $barcode, $ignoreRs ) = @_;
309 my $item = Koha
::Items
->find( { barcode
=> $barcode } );
313 $messages->{'BadBarcode'} = $barcode;
315 return ( $dotransfer, $messages );
318 my $itemnumber = $item->itemnumber;
319 # get branches of book...
320 my $hbr = $item->homebranch;
321 my $fbr = $item->holdingbranch;
323 # if using Branch Transfer Limits
324 if ( C4
::Context
->preference("UseBranchTransferLimits") == 1 ) {
325 my $code = C4
::Context
->preference("BranchTransferLimitsType") eq 'ccode' ?
$item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
326 if ( C4
::Context
->preference("item-level_itypes") && C4
::Context
->preference("BranchTransferLimitsType") eq 'itemtype' ) {
327 if ( ! IsBranchTransferAllowed
( $tbr, $fbr, $item->itype ) ) {
328 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
331 } elsif ( ! IsBranchTransferAllowed
( $tbr, $fbr, $code ) ) {
332 $messages->{'NotAllowed'} = $tbr . "::" . $code;
337 # can't transfer book if is already there....
338 if ( $fbr eq $tbr ) {
339 $messages->{'DestinationEqualsHolding'} = 1;
343 # check if it is still issued to someone, return it...
344 my $issue = Koha
::Checkouts
->find({ itemnumber
=> $itemnumber });
346 AddReturn
( $barcode, $fbr );
347 $messages->{'WasReturned'} = $issue->borrowernumber;
351 # That'll save a database query.
352 my ( $resfound, $resrec, undef ) =
353 CheckReserves
( $itemnumber );
354 if ( $resfound and not $ignoreRs ) {
355 $resrec->{'ResFound'} = $resfound;
357 # $messages->{'ResFound'} = $resrec;
361 #actually do the transfer....
363 ModItemTransfer
( $itemnumber, $fbr, $tbr );
365 # don't need to update MARC anymore, we do it in batch now
366 $messages->{'WasTransfered'} = 1;
369 ModDateLastSeen
( $itemnumber );
370 return ( $dotransfer, $messages );
375 my $borrower = shift;
376 my $item_object = shift;
378 my $onsite_checkout = $params->{onsite_checkout
} || 0;
379 my $switch_onsite_checkout = $params->{switch_onsite_checkout
} || 0;
380 my $cat_borrower = $borrower->{'categorycode'};
381 my $dbh = C4
::Context
->dbh;
383 # Get which branchcode we need
384 $branch = _GetCircControlBranch
($item_object->unblessed,$borrower);
385 my $type = $item_object->effective_itemtype;
387 # given branch, patron category, and item type, determine
388 # applicable issuing rule
389 my $maxissueqty_rule = Koha
::CirculationRules
->get_effective_rule(
391 categorycode
=> $cat_borrower,
393 branchcode
=> $branch,
394 rule_name
=> 'maxissueqty',
397 my $maxonsiteissueqty_rule = Koha
::CirculationRules
->get_effective_rule(
399 categorycode
=> $cat_borrower,
401 branchcode
=> $branch,
402 rule_name
=> 'maxonsiteissueqty',
407 # if a rule is found and has a loan limit set, count
408 # how many loans the patron already has that meet that
410 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne '') {
413 SELECT COUNT
(*) AS total
, COALESCE
(SUM
(onsite_checkout
), 0) AS onsite_checkouts
415 JOIN items USING
(itemnumber
)
418 my $rule_itemtype = $maxissueqty_rule->itemtype;
419 unless ($rule_itemtype) {
420 # matching rule has the default item type, so count only
421 # those existing loans that don't fall under a more
423 if (C4
::Context
->preference('item-level_itypes')) {
424 $count_query .= " WHERE items.itype NOT IN (
425 SELECT itemtype FROM circulation_rules
427 AND (categorycode = ? OR categorycode = ?)
428 AND itemtype IS NOT NULL
429 AND rule_name = 'maxissueqty'
432 $count_query .= " JOIN biblioitems USING (biblionumber)
433 WHERE biblioitems.itemtype NOT IN (
434 SELECT itemtype FROM circulation_rules
436 AND (categorycode = ? OR categorycode = ?)
437 AND itemtype IS NOT NULL
438 AND rule_name = 'maxissueqty'
441 push @bind_params, $maxissueqty_rule->branchcode;
442 push @bind_params, $maxissueqty_rule->categorycode;
443 push @bind_params, $cat_borrower;
445 # rule has specific item type, so count loans of that
447 if (C4
::Context
->preference('item-level_itypes')) {
448 $count_query .= " WHERE items.itype = ? ";
450 $count_query .= " JOIN biblioitems USING (biblionumber)
451 WHERE biblioitems.itemtype= ? ";
453 push @bind_params, $type;
456 $count_query .= " AND borrowernumber = ? ";
457 push @bind_params, $borrower->{'borrowernumber'};
458 my $rule_branch = $maxissueqty_rule->branchcode;
460 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
461 $count_query .= " AND issues.branchcode = ? ";
462 push @bind_params, $rule_branch;
463 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
464 ; # if branch is the patron's home branch, then count all loans by patron
466 $count_query .= " AND items.homebranch = ? ";
467 push @bind_params, $rule_branch;
471 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
473 my $max_checkouts_allowed = $maxissueqty_rule ?
$maxissueqty_rule->rule_value : undef;
474 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ?
$maxonsiteissueqty_rule->rule_value : undef;
476 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
477 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
479 reason
=> 'TOO_MANY_ONSITE_CHECKOUTS',
480 count
=> $onsite_checkout_count,
481 max_allowed
=> $max_onsite_checkouts_allowed,
485 if ( C4
::Context
->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
486 my $delta = $switch_onsite_checkout ?
1 : 0;
487 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
489 reason
=> 'TOO_MANY_CHECKOUTS',
490 count
=> $checkout_count,
491 max_allowed
=> $max_checkouts_allowed,
494 } elsif ( not $onsite_checkout ) {
495 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
497 reason
=> 'TOO_MANY_CHECKOUTS',
498 count
=> $checkout_count - $onsite_checkout_count,
499 max_allowed
=> $max_checkouts_allowed,
505 # Now count total loans against the limit for the branch
506 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule
($branch, $cat_borrower);
507 if (defined($branch_borrower_circ_rule->{patron_maxissueqty
}) and $branch_borrower_circ_rule->{patron_maxissueqty
} ne '') {
508 my @bind_params = ();
509 my $branch_count_query = q
|
510 SELECT COUNT
(*) AS total
, COALESCE
(SUM
(onsite_checkout
), 0) AS onsite_checkouts
512 JOIN items USING
(itemnumber
)
513 WHERE borrowernumber
= ?
515 push @bind_params, $borrower->{borrowernumber
};
517 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
518 $branch_count_query .= " AND issues.branchcode = ? ";
519 push @bind_params, $branch;
520 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
521 ; # if branch is the patron's home branch, then count all loans by patron
523 $branch_count_query .= " AND items.homebranch = ? ";
524 push @bind_params, $branch;
526 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
527 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty
};
528 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty
};
530 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
531 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
533 reason
=> 'TOO_MANY_ONSITE_CHECKOUTS',
534 count
=> $onsite_checkout_count,
535 max_allowed
=> $max_onsite_checkouts_allowed,
539 if ( C4
::Context
->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
540 my $delta = $switch_onsite_checkout ?
1 : 0;
541 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
543 reason
=> 'TOO_MANY_CHECKOUTS',
544 count
=> $checkout_count,
545 max_allowed
=> $max_checkouts_allowed,
548 } elsif ( not $onsite_checkout ) {
549 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
551 reason
=> 'TOO_MANY_CHECKOUTS',
552 count
=> $checkout_count - $onsite_checkout_count,
553 max_allowed
=> $max_checkouts_allowed,
559 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty
}) ) {
560 return { reason
=> 'NO_RULE_DEFINED', max_allowed
=> 0 };
563 # OK, the patron can issue !!!
567 =head2 CanBookBeIssued
569 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
570 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
572 Check if a book can be issued.
574 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
576 IMPORTANT: The assumption by users of this routine is that causes blocking
577 the issue are keyed by uppercase labels and other returned
578 data is keyed in lower case!
582 =item C<$patron> is a Koha::Patron
584 =item C<$barcode> is the bar code of the book being issued.
586 =item C<$duedates> is a DateTime object.
588 =item C<$inprocess> boolean switch
590 =item C<$ignore_reserves> boolean switch
592 =item C<$params> Hashref of additional parameters
595 override_high_holds - Ignore high holds
596 onsite_checkout - Checkout is an onsite checkout that will not leave the library
604 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
605 Possible values are :
611 sticky due date is invalid
615 borrower gone with no address
619 borrower declared it's card lost
625 =head3 UNKNOWN_BARCODE
639 item is restricted (set by ??)
641 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
642 could be prevented, but ones that can be overriden by the operator.
644 Possible values are :
652 renewing, not issuing
654 =head3 ISSUED_TO_ANOTHER
656 issued to someone else.
660 reserved for someone else.
664 sticky due date is invalid or due date in the past
668 if the borrower borrows to much things
672 sub CanBookBeIssued
{
673 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
674 my %needsconfirmation; # filled with problems that needs confirmations
675 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
676 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
677 my %messages; # filled with information messages that should be displayed.
679 my $onsite_checkout = $params->{onsite_checkout
} || 0;
680 my $override_high_holds = $params->{override_high_holds
} || 0;
682 my $item_object = Koha
::Items
->find({barcode
=> $barcode });
684 # MANDATORY CHECKS - unless item exists, nothing else matters
685 unless ( $item_object ) {
686 $issuingimpossible{UNKNOWN_BARCODE
} = 1;
688 return ( \
%issuingimpossible, \
%needsconfirmation ) if %issuingimpossible;
690 my $item_unblessed = $item_object->unblessed; # Transition...
691 my $issue = $item_object->checkout;
692 my $biblio = $item_object->biblio;
694 my $biblioitem = $biblio->biblioitem;
695 my $effective_itemtype = $item_object->effective_itemtype;
696 my $dbh = C4
::Context
->dbh;
697 my $patron_unblessed = $patron->unblessed;
699 my $circ_library = Koha
::Libraries
->find( _GetCircControlBranch
($item_unblessed, $patron_unblessed) );
701 # DUE DATE is OK ? -- should already have checked.
703 if ($duedate && ref $duedate ne 'DateTime') {
704 $duedate = dt_from_string
($duedate);
706 my $now = DateTime
->now( time_zone
=> C4
::Context
->tz() );
707 unless ( $duedate ) {
708 my $issuedate = $now->clone();
710 $duedate = CalcDateDue
( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
712 # Offline circ calls AddIssue directly, doesn't run through here
713 # So issuingimpossible should be ok.
716 my $fees = Koha
::Charges
::Fees
->new(
719 library
=> $circ_library,
720 item
=> $item_object,
726 my $today = $now->clone();
727 $today->truncate( to
=> 'minute');
728 if (DateTime
->compare($duedate,$today) == -1 ) { # duedate cannot be before now
729 $needsconfirmation{INVALID_DATE
} = output_pref
($duedate);
732 $issuingimpossible{INVALID_DATE
} = output_pref
($duedate);
738 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
739 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
741 branch
=> C4
::Context
->userenv->{'branch'},
743 itemnumber
=> $item_object->itemnumber,
744 itemtype
=> $effective_itemtype,
745 borrowernumber
=> $patron->borrowernumber,
746 ccode
=> $item_object->ccode}
748 ModDateLastSeen
( $item_object->itemnumber ); # FIXME Move to Koha::Item
749 return( { STATS
=> 1 }, {});
752 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
753 $issuingimpossible{GNA
} = 1;
756 if ( $patron->lost && $patron->lost == 1 ) {
757 $issuingimpossible{CARD_LOST
} = 1;
759 if ( $patron->is_debarred ) {
760 $issuingimpossible{DEBARRED
} = 1;
763 if ( $patron->is_expired ) {
764 $issuingimpossible{EXPIRED
} = 1;
772 my $account = $patron->account;
773 my $balance = $account->balance;
774 my $non_issues_charges = $account->non_issues_charges;
775 my $other_charges = $balance - $non_issues_charges;
777 my $amountlimit = C4
::Context
->preference("noissuescharge");
778 my $allowfineoverride = C4
::Context
->preference("AllowFineOverride");
779 my $allfinesneedoverride = C4
::Context
->preference("AllFinesNeedOverride");
781 # Check the debt of this patrons guarantees
782 my $no_issues_charge_guarantees = C4
::Context
->preference("NoIssuesChargeGuarantees");
783 $no_issues_charge_guarantees = undef unless looks_like_number
( $no_issues_charge_guarantees );
784 if ( defined $no_issues_charge_guarantees ) {
785 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
786 my $guarantees_non_issues_charges;
787 foreach my $g ( @guarantees ) {
788 $guarantees_non_issues_charges += $g->account->non_issues_charges;
791 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
792 $issuingimpossible{DEBT_GUARANTEES
} = $guarantees_non_issues_charges;
793 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
794 $needsconfirmation{DEBT_GUARANTEES
} = $guarantees_non_issues_charges;
795 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
796 $needsconfirmation{DEBT_GUARANTEES
} = $guarantees_non_issues_charges;
800 if ( C4
::Context
->preference("IssuingInProcess") ) {
801 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
802 $issuingimpossible{DEBT
} = $non_issues_charges;
803 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
804 $needsconfirmation{DEBT
} = $non_issues_charges;
805 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
806 $needsconfirmation{DEBT
} = $non_issues_charges;
810 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
811 $needsconfirmation{DEBT
} = $non_issues_charges;
812 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
813 $issuingimpossible{DEBT
} = $non_issues_charges;
814 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
815 $needsconfirmation{DEBT
} = $non_issues_charges;
819 if ($balance > 0 && $other_charges > 0) {
820 $alerts{OTHER_CHARGES
} = sprintf( "%.2f", $other_charges );
823 $patron = Koha
::Patrons
->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
824 $patron_unblessed = $patron->unblessed;
826 if ( my $debarred_date = $patron->is_debarred ) {
827 # patron has accrued fine days or has a restriction. $count is a date
828 if ($debarred_date eq '9999-12-31') {
829 $issuingimpossible{USERBLOCKEDNOENDDATE
} = $debarred_date;
832 $issuingimpossible{USERBLOCKEDWITHENDDATE
} = $debarred_date;
834 } elsif ( my $num_overdues = $patron->has_overdues ) {
835 ## patron has outstanding overdue loans
836 if ( C4
::Context
->preference("OverduesBlockCirc") eq 'block'){
837 $issuingimpossible{USERBLOCKEDOVERDUE
} = $num_overdues;
839 elsif ( C4
::Context
->preference("OverduesBlockCirc") eq 'confirmation'){
840 $needsconfirmation{USERBLOCKEDOVERDUE
} = $num_overdues;
845 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
847 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
849 # Already issued to current borrower.
850 # If it is an on-site checkout if it can be switched to a normal checkout
851 # or ask whether the loan should be renewed
853 if ( $issue->onsite_checkout
854 and C4
::Context
->preference('SwitchOnSiteCheckouts') ) {
855 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED
} = 1;
857 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed
(
858 $patron->borrowernumber,
859 $item_object->itemnumber,
861 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
862 if ( $renewerror eq 'onsite_checkout' ) {
863 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS
} = 1;
866 $issuingimpossible{NO_MORE_RENEWALS
} = 1;
870 $needsconfirmation{RENEW_ISSUE
} = 1;
876 # issued to someone else
878 my $patron = Koha
::Patrons
->find( $issue->borrowernumber );
880 my ( $can_be_returned, $message ) = CanBookBeReturned
( $item_unblessed, C4
::Context
->userenv->{branch
} );
882 unless ( $can_be_returned ) {
883 $issuingimpossible{RETURN_IMPOSSIBLE
} = 1;
884 $issuingimpossible{branch_to_return
} = $message;
886 if ( C4
::Context
->preference('AutoReturnCheckedOutItems') ) {
887 $alerts{RETURNED_FROM_ANOTHER
} = { patron
=> $patron };
889 $needsconfirmation{ISSUED_TO_ANOTHER
} = 1;
890 $needsconfirmation{issued_firstname
} = $patron->firstname;
891 $needsconfirmation{issued_surname
} = $patron->surname;
892 $needsconfirmation{issued_cardnumber
} = $patron->cardnumber;
893 $needsconfirmation{issued_borrowernumber
} = $patron->borrowernumber;
898 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
900 my $switch_onsite_checkout = (
901 C4
::Context
->preference('SwitchOnSiteCheckouts')
903 and $issue->onsite_checkout
904 and $issue->borrowernumber == $patron->borrowernumber ?
1 : 0 );
905 my $toomany = TooMany
( $patron_unblessed, $item_object, { onsite_checkout
=> $onsite_checkout, switch_onsite_checkout
=> $switch_onsite_checkout, } );
906 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
907 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE
} ) {
908 if ( $toomany->{max_allowed
} == 0 ) {
909 $needsconfirmation{PATRON_CANT
} = 1;
911 if ( C4
::Context
->preference("AllowTooManyOverride") ) {
912 $needsconfirmation{TOO_MANY
} = $toomany->{reason
};
913 $needsconfirmation{current_loan_count
} = $toomany->{count
};
914 $needsconfirmation{max_loans_allowed
} = $toomany->{max_allowed
};
916 $issuingimpossible{TOO_MANY
} = $toomany->{reason
};
917 $issuingimpossible{current_loan_count
} = $toomany->{count
};
918 $issuingimpossible{max_loans_allowed
} = $toomany->{max_allowed
};
923 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
925 $patron = Koha
::Patrons
->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
926 my $wants_check = $patron->wants_check_for_previous_checkout;
927 $needsconfirmation{PREVISSUE
} = 1
928 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
933 if ( $item_object->notforloan )
935 if(!C4
::Context
->preference("AllowNotForLoanOverride")){
936 $issuingimpossible{NOT_FOR_LOAN
} = 1;
937 $issuingimpossible{item_notforloan
} = $item_object->notforloan;
939 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
940 $needsconfirmation{item_notforloan
} = $item_object->notforloan;
944 # we have to check itemtypes.notforloan also
945 if (C4
::Context
->preference('item-level_itypes')){
946 # this should probably be a subroutine
947 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
948 $sth->execute($effective_itemtype);
949 my $notforloan=$sth->fetchrow_hashref();
950 if ($notforloan->{'notforloan'}) {
951 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
952 $issuingimpossible{NOT_FOR_LOAN
} = 1;
953 $issuingimpossible{itemtype_notforloan
} = $effective_itemtype;
955 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
956 $needsconfirmation{itemtype_notforloan
} = $effective_itemtype;
961 my $itemtype = Koha
::ItemTypes
->find($biblioitem->itemtype);
962 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
963 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
964 $issuingimpossible{NOT_FOR_LOAN
} = 1;
965 $issuingimpossible{itemtype_notforloan
} = $effective_itemtype;
967 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
968 $needsconfirmation{itemtype_notforloan
} = $effective_itemtype;
973 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
975 $issuingimpossible{WTHDRAWN
} = 1;
977 if ( $item_object->restricted
978 && $item_object->restricted == 1 )
980 $issuingimpossible{RESTRICTED
} = 1;
982 if ( $item_object->itemlost && C4
::Context
->preference("IssueLostItem") ne 'nothing' ) {
983 my $av = Koha
::AuthorisedValues
->search({ category
=> 'LOST', authorised_value
=> $item_object->itemlost });
984 my $code = $av->count ?
$av->next->lib : '';
985 $needsconfirmation{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'confirm' );
986 $alerts{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'alert' );
988 if ( C4
::Context
->preference("IndependentBranches") ) {
989 my $userenv = C4
::Context
->userenv;
990 unless ( C4
::Context
->IsSuperLibrarian() ) {
991 my $HomeOrHoldingBranch = C4
::Context
->preference("HomeOrHoldingBranch");
992 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch
} ){
993 $issuingimpossible{ITEMNOTSAMEBRANCH
} = 1;
994 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
996 $needsconfirmation{BORRNOTSAMEBRANCH
} = $patron->branchcode
997 if ( $patron->branchcode ne $userenv->{branch
} );
1002 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1004 my $rentalConfirmation = C4
::Context
->preference("RentalFeesCheckoutConfirmation");
1005 if ($rentalConfirmation) {
1006 my ($rentalCharge) = GetIssuingCharges
( $item_object->itemnumber, $patron->borrowernumber );
1008 my $itemtype_object = Koha
::ItemTypes
->find( $item_object->effective_itemtype );
1009 if ($itemtype_object) {
1010 my $accumulate_charge = $fees->accumulate_rentalcharge();
1011 if ( $accumulate_charge > 0 ) {
1012 $rentalCharge += $accumulate_charge;
1016 if ( $rentalCharge > 0 ) {
1017 $needsconfirmation{RENTALCHARGE
} = $rentalCharge;
1021 unless ( $ignore_reserves ) {
1022 # See if the item is on reserve.
1023 my ( $restype, $res ) = C4
::Reserves
::CheckReserves
( $item_object->itemnumber );
1025 my $resbor = $res->{'borrowernumber'};
1026 if ( $resbor ne $patron->borrowernumber ) {
1027 my $patron = Koha
::Patrons
->find( $resbor );
1028 if ( $restype eq "Waiting" )
1030 # The item is on reserve and waiting, but has been
1031 # reserved by some other patron.
1032 $needsconfirmation{RESERVE_WAITING
} = 1;
1033 $needsconfirmation{'resfirstname'} = $patron->firstname;
1034 $needsconfirmation{'ressurname'} = $patron->surname;
1035 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1036 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1037 $needsconfirmation{'resbranchcode'} = $res->{branchcode
};
1038 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1040 elsif ( $restype eq "Reserved" ) {
1041 # The item is on reserve for someone else.
1042 $needsconfirmation{RESERVED
} = 1;
1043 $needsconfirmation{'resfirstname'} = $patron->firstname;
1044 $needsconfirmation{'ressurname'} = $patron->surname;
1045 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1046 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1047 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1048 $needsconfirmation{'resreservedate'} = $res->{reservedate
};
1054 ## CHECK AGE RESTRICTION
1055 my $agerestriction = $biblioitem->agerestriction;
1056 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction
( $agerestriction, $patron->unblessed );
1057 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1058 if ( C4
::Context
->preference('AgeRestrictionOverride') ) {
1059 $needsconfirmation{AGE_RESTRICTION
} = "$agerestriction";
1062 $issuingimpossible{AGE_RESTRICTION
} = "$agerestriction";
1066 ## check for high holds decreasing loan period
1067 if ( C4
::Context
->preference('decreaseLoanHighHolds') ) {
1068 my $check = checkHighHolds
( $item_unblessed, $patron_unblessed );
1070 if ( $check->{exceeded
} ) {
1071 if ($override_high_holds) {
1072 $alerts{HIGHHOLDS
} = {
1073 num_holds
=> $check->{outstanding
},
1074 duration
=> $check->{duration
},
1075 returndate
=> output_pref
( { dt
=> dt_from_string
($check->{due_date
}), dateformat
=> 'iso', timeformat
=> '24hr' }),
1079 $needsconfirmation{HIGHHOLDS
} = {
1080 num_holds
=> $check->{outstanding
},
1081 duration
=> $check->{duration
},
1082 returndate
=> output_pref
( { dt
=> dt_from_string
($check->{due_date
}), dateformat
=> 'iso', timeformat
=> '24hr' }),
1089 !C4
::Context
->preference('AllowMultipleIssuesOnABiblio') &&
1090 # don't do the multiple loans per bib check if we've
1091 # already determined that we've got a loan on the same item
1092 !$issuingimpossible{NO_MORE_RENEWALS
} &&
1093 !$needsconfirmation{RENEW_ISSUE
}
1095 # Check if borrower has already issued an item from the same biblio
1096 # Only if it's not a subscription
1097 my $biblionumber = $item_object->biblionumber;
1098 require C4
::Serials
;
1099 my $is_a_subscription = C4
::Serials
::CountSubscriptionFromBiblionumber
($biblionumber);
1100 unless ($is_a_subscription) {
1101 # FIXME Should be $patron->checkouts($args);
1102 my $checkouts = Koha
::Checkouts
->search(
1104 borrowernumber
=> $patron->borrowernumber,
1105 biblionumber
=> $biblionumber,
1111 # if we get here, we don't already have a loan on this item,
1112 # so if there are any loans on this bib, ask for confirmation
1113 if ( $checkouts->count ) {
1114 $needsconfirmation{BIBLIO_ALREADY_ISSUED
} = 1;
1119 return ( \
%issuingimpossible, \
%needsconfirmation, \
%alerts, \
%messages, );
1122 =head2 CanBookBeReturned
1124 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1126 Check whether the item can be returned to the provided branch
1130 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1132 =item C<$branch> is the branchcode where the return is taking place
1140 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1142 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1148 sub CanBookBeReturned
{
1149 my ($item, $branch) = @_;
1150 my $allowreturntobranch = C4
::Context
->preference("AllowReturnToBranch") || 'anywhere';
1152 # assume return is allowed to start
1156 # identify all cases where return is forbidden
1157 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1159 $message = $item->{'homebranch'};
1160 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1162 $message = $item->{'holdingbranch'};
1163 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1165 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1168 return ($allowed, $message);
1171 =head2 CheckHighHolds
1173 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1174 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1175 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1179 sub checkHighHolds
{
1180 my ( $item, $borrower ) = @_;
1181 my $branchcode = _GetCircControlBranch
( $item, $borrower );
1182 my $item_object = Koha
::Items
->find( $item->{itemnumber
} );
1191 my $holds = Koha
::Holds
->search( { biblionumber
=> $item->{'biblionumber'} } );
1193 if ( $holds->count() ) {
1194 $return_data->{outstanding
} = $holds->count();
1196 my $decreaseLoanHighHoldsControl = C4
::Context
->preference('decreaseLoanHighHoldsControl');
1197 my $decreaseLoanHighHoldsValue = C4
::Context
->preference('decreaseLoanHighHoldsValue');
1198 my $decreaseLoanHighHoldsIgnoreStatuses = C4
::Context
->preference('decreaseLoanHighHoldsIgnoreStatuses');
1200 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1202 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1204 # static means just more than a given number of holds on the record
1206 # If the number of holds is less than the threshold, we can stop here
1207 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1208 return $return_data;
1211 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1213 # dynamic means X more than the number of holdable items on the record
1215 # let's get the items
1216 my @items = $holds->next()->biblio()->items()->as_list;
1218 # Remove any items with status defined to be ignored even if the would not make item unholdable
1219 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1220 @items = grep { !$_->$status } @items;
1223 # Remove any items that are not holdable for this patron
1224 @items = grep { CanItemBeReserved
( $borrower->{borrowernumber
}, $_->itemnumber )->{status
} eq 'OK' } @items;
1226 my $items_count = scalar @items;
1228 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1230 # If the number of holds is less than the count of items we have
1231 # plus the number of holds allowed above that count, we can stop here
1232 if ( $holds->count() <= $threshold ) {
1233 return $return_data;
1237 my $issuedate = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1239 my $calendar = Koha
::Calendar
->new( branchcode
=> $branchcode );
1241 my $itype = $item_object->effective_itemtype;
1242 my $orig_due = C4
::Circulation
::CalcDateDue
( $issuedate, $itype, $branchcode, $borrower );
1244 my $decreaseLoanHighHoldsDuration = C4
::Context
->preference('decreaseLoanHighHoldsDuration');
1246 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1247 $reduced_datedue->set_hour($orig_due->hour);
1248 $reduced_datedue->set_minute($orig_due->minute);
1249 $reduced_datedue->truncate( to
=> 'minute' );
1251 if ( DateTime
->compare( $reduced_datedue, $orig_due ) == -1 ) {
1252 $return_data->{exceeded
} = 1;
1253 $return_data->{duration
} = $decreaseLoanHighHoldsDuration;
1254 $return_data->{due_date
} = $reduced_datedue;
1258 return $return_data;
1263 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1265 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1269 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1271 =item C<$barcode> is the barcode of the item being issued.
1273 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1274 Calculated if empty.
1276 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1278 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1279 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1281 AddIssue does the following things :
1283 - step 01: check that there is a borrowernumber & a barcode provided
1284 - check for RENEWAL (book issued & being issued to the same patron)
1285 - renewal YES = Calculate Charge & renew
1287 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1289 - fill reserve if reserve to this patron
1290 - cancel reserve or not, otherwise
1291 * TRANSFERT PENDING ?
1292 - complete the transfert
1300 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1302 my $onsite_checkout = $params && $params->{onsite_checkout
} ?
1 : 0;
1303 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout
};
1304 my $auto_renew = $params && $params->{auto_renew
};
1305 my $dbh = C4
::Context
->dbh;
1306 my $barcodecheck = CheckValidBarcode
($barcode);
1310 if ( $datedue && ref $datedue ne 'DateTime' ) {
1311 $datedue = dt_from_string
($datedue);
1314 # $issuedate defaults to today.
1315 if ( !defined $issuedate ) {
1316 $issuedate = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1319 if ( ref $issuedate ne 'DateTime' ) {
1320 $issuedate = dt_from_string
($issuedate);
1325 # Stop here if the patron or barcode doesn't exist
1326 if ( $borrower && $barcode && $barcodecheck ) {
1327 # find which item we issue
1328 my $item_object = Koha
::Items
->find({ barcode
=> $barcode })
1329 or return; # if we don't get an Item, abort.
1330 my $item_unblessed = $item_object->unblessed;
1332 my $branchcode = _GetCircControlBranch
( $item_unblessed, $borrower );
1334 # get actual issuing if there is one
1335 my $actualissue = $item_object->checkout;
1337 # check if we just renew the issue.
1338 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1339 and not $switch_onsite_checkout ) {
1340 $datedue = AddRenewal
(
1341 $borrower->{'borrowernumber'},
1342 $item_object->itemnumber,
1345 $issuedate, # here interpreted as the renewal date
1350 my $itype = $item_object->effective_itemtype;
1351 $datedue = CalcDateDue
( $issuedate, $itype, $branchcode, $borrower );
1354 $datedue->truncate( to
=> 'minute' );
1356 my $patron = Koha
::Patrons
->find( $borrower );
1357 my $library = Koha
::Libraries
->find( $branchcode );
1358 my $fees = Koha
::Charges
::Fees
->new(
1361 library
=> $library,
1362 item
=> $item_object,
1363 to_date
=> $datedue,
1367 # it's NOT a renewal
1368 if ( $actualissue and not $switch_onsite_checkout ) {
1369 # This book is currently on loan, but not to the person
1370 # who wants to borrow it now. mark it returned before issuing to the new borrower
1371 my ( $allowed, $message ) = CanBookBeReturned
( $item_unblessed, C4
::Context
->userenv->{branch
} );
1372 return unless $allowed;
1373 AddReturn
( $item_object->barcode, C4
::Context
->userenv->{'branch'} );
1376 C4
::Reserves
::MoveReserve
( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1378 # Starting process for transfer job (checking transfert and validate it if we have one)
1379 my ($datesent) = GetTransfers
( $item_object->itemnumber );
1381 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1382 my $sth = $dbh->prepare(
1383 "UPDATE branchtransfers
1384 SET datearrived = now(),
1386 comments = 'Forced branchtransfer'
1387 WHERE itemnumber= ? AND datearrived IS NULL"
1389 $sth->execute( C4
::Context
->userenv->{'branch'},
1390 $item_object->itemnumber );
1393 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1394 unless ($auto_renew) {
1395 my $rule = Koha
::CirculationRules
->get_effective_rule(
1397 categorycode
=> $borrower->{categorycode
},
1398 itemtype
=> $item_object->effective_itemtype,
1399 branchcode
=> $branchcode,
1400 rule_name
=> 'auto_renew'
1404 $auto_renew = $rule->rule_value if $rule;
1407 # Record in the database the fact that the book was issued.
1409 my $itype = $item_object->effective_itemtype;
1410 $datedue = CalcDateDue
( $issuedate, $itype, $branchcode, $borrower );
1413 $datedue->truncate( to
=> 'minute' );
1415 my $issue_attributes = {
1416 borrowernumber
=> $borrower->{'borrowernumber'},
1417 issuedate
=> $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1418 date_due
=> $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1419 branchcode
=> C4
::Context
->userenv->{'branch'},
1420 onsite_checkout
=> $onsite_checkout,
1421 auto_renew
=> $auto_renew ?
1 : 0,
1424 $issue = Koha
::Checkouts
->find( { itemnumber
=> $item_object->itemnumber } );
1426 $issue->set($issue_attributes)->store;
1429 $issue = Koha
::Checkout
->new(
1431 itemnumber
=> $item_object->itemnumber,
1436 if ( $item_object->location && $item_object->location eq 'CART'
1437 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1438 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1439 CartToShelf
( $item_object->itemnumber );
1442 if ( C4
::Context
->preference('UpdateTotalIssuesOnCirc') ) {
1443 UpdateTotalIssues
( $item_object->biblionumber, 1 );
1446 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1447 if ( $item_object->itemlost ) {
1449 Koha
::RefundLostItemFeeRules
->should_refund(
1451 current_branch
=> C4
::Context
->userenv->{branch
},
1452 item_home_branch
=> $item_object->homebranch,
1453 item_holding_branch
=> $item_object->holdingbranch,
1458 _FixAccountForLostAndFound
( $item_object->itemnumber, undef,
1459 $item_object->barcode );
1465 issues
=> ( $item_object->issues || 0 ) + 1,
1466 holdingbranch
=> C4
::Context
->userenv->{'branch'},
1468 onloan
=> $datedue->ymd(),
1469 datelastborrowed
=> DateTime
->now( time_zone
=> C4
::Context
->tz() )->ymd(),
1471 $item_object->biblionumber,
1472 $item_object->itemnumber,
1475 ModDateLastSeen
( $item_object->itemnumber );
1477 # If it costs to borrow this book, charge it to the patron's account.
1478 my ( $charge, $itemtype ) = GetIssuingCharges
( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1479 if ( $charge && $charge > 0 ) {
1480 AddIssuingCharge
( $issue, $charge, 'RENT' );
1483 my $itemtype_object = Koha
::ItemTypes
->find( $item_object->effective_itemtype );
1484 if ( $itemtype_object ) {
1485 my $accumulate_charge = $fees->accumulate_rentalcharge();
1486 if ( $accumulate_charge > 0 ) {
1487 AddIssuingCharge
( $issue, $accumulate_charge, 'RENT_DAILY' );
1488 $charge += $accumulate_charge;
1489 $item_unblessed->{charge
} = $charge;
1493 # Record the fact that this book was issued.
1496 branch
=> C4
::Context
->userenv->{'branch'},
1497 type
=> ( $onsite_checkout ?
'onsite_checkout' : 'issue' ),
1499 other
=> ( $sipmode ?
"SIP-$sipmode" : '' ),
1500 itemnumber
=> $item_object->itemnumber,
1501 itemtype
=> $item_object->effective_itemtype,
1502 location
=> $item_object->location,
1503 borrowernumber
=> $borrower->{'borrowernumber'},
1504 ccode
=> $item_object->ccode,
1508 # Send a checkout slip.
1509 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1511 branchcode
=> $branchcode,
1512 categorycode
=> $borrower->{categorycode
},
1513 item_type
=> $item_object->effective_itemtype,
1514 notification
=> 'CHECKOUT',
1516 if ( $circulation_alert->is_enabled_for( \
%conditions ) ) {
1517 SendCirculationAlert
(
1520 item
=> $item_object->unblessed,
1521 borrower
=> $borrower,
1522 branch
=> $branchcode,
1527 "CIRCULATION", "ISSUE",
1528 $borrower->{'borrowernumber'},
1529 $item_object->itemnumber,
1530 ) if C4
::Context
->preference("IssueLog");
1536 =head2 GetLoanLength
1538 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1540 Get loan length for an itemtype, a borrower type and a branch
1545 my ( $categorycode, $itemtype, $branchcode ) = @_;
1547 # Set search precedences
1550 categorycode
=> $categorycode,
1551 itemtype
=> $itemtype,
1552 branchcode
=> $branchcode,
1555 categorycode
=> $categorycode,
1557 branchcode
=> $branchcode,
1560 categorycode
=> undef,
1561 itemtype
=> $itemtype,
1562 branchcode
=> $branchcode,
1565 categorycode
=> undef,
1567 branchcode
=> $branchcode,
1570 categorycode
=> $categorycode,
1571 itemtype
=> $itemtype,
1572 branchcode
=> undef,
1575 categorycode
=> $categorycode,
1577 branchcode
=> undef,
1580 categorycode
=> undef,
1581 itemtype
=> $itemtype,
1582 branchcode
=> undef,
1585 categorycode
=> undef,
1587 branchcode
=> undef,
1591 # Initialize default values
1595 lengthunit
=> 'days',
1599 foreach my $rule_name (qw( issuelength renewalperiod lengthunit )) {
1600 foreach my $params (@params) {
1601 my $rule = Koha
::CirculationRules
->search(
1603 rule_name
=> $rule_name,
1609 $rules->{$rule_name} = $rule->rule_value;
1619 =head2 GetHardDueDate
1621 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1623 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1627 sub GetHardDueDate
{
1628 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1630 my $rules = Koha
::CirculationRules
->get_effective_rules(
1632 categorycode
=> $borrowertype,
1633 itemtype
=> $itemtype,
1634 branchcode
=> $branchcode,
1635 rules
=> [ 'hardduedate', 'hardduedatecompare' ],
1639 if ( defined( $rules->{hardduedate
} ) ) {
1640 if ( $rules->{hardduedate
} ) {
1641 return ( dt_from_string
( $rules->{hardduedate
}, 'iso' ), $rules->{hardduedatecompare
} );
1644 return ( undef, undef );
1649 =head2 GetBranchBorrowerCircRule
1651 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1653 Retrieves circulation rule attributes that apply to the given
1654 branch and patron category, regardless of item type.
1655 The return value is a hashref containing the following key:
1657 patron_maxissueqty - maximum number of loans that a
1658 patron of the given category can have at the given
1659 branch. If the value is undef, no limit.
1661 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1662 patron of the given category can have at the given
1663 branch. If the value is undef, no limit.
1665 This will check for different branch/category combinations in the following order:
1669 default branch and category
1671 If no rule has been found in the database, it will default to
1674 patron_maxissueqty - undef
1675 patron_maxonsiteissueqty - undef
1677 C<$branchcode> and C<$categorycode> should contain the
1678 literal branch code and patron category code, respectively - no
1683 sub GetBranchBorrowerCircRule
{
1684 my ( $branchcode, $categorycode ) = @_;
1686 # Initialize default values
1688 patron_maxissueqty
=> undef,
1689 patron_maxonsiteissueqty
=> undef,
1693 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1694 my $rule = Koha
::CirculationRules
->get_effective_rule(
1696 categorycode
=> $categorycode,
1698 branchcode
=> $branchcode,
1699 rule_name
=> $rule_name,
1703 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1709 =head2 GetBranchItemRule
1711 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1713 Retrieves circulation rule attributes that apply to the given
1714 branch and item type, regardless of patron category.
1716 The return value is a hashref containing the following keys:
1718 holdallowed => Hold policy for this branch and itemtype. Possible values:
1719 0: No holds allowed.
1720 1: Holds allowed only by patrons that have the same homebranch as the item.
1721 2: Holds allowed from any patron.
1723 returnbranch => branch to which to return item. Possible values:
1724 noreturn: do not return, let item remain where checked in (floating collections)
1725 homebranch: return to item's home branch
1726 holdingbranch: return to issuer branch
1728 This searches branchitemrules in the following order:
1730 * Same branchcode and itemtype
1731 * Same branchcode, itemtype '*'
1732 * branchcode '*', same itemtype
1733 * branchcode and itemtype '*'
1735 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1739 sub GetBranchItemRule
{
1740 my ( $branchcode, $itemtype ) = @_;
1743 my $holdallowed_rule = Koha
::CirculationRules
->get_effective_rule(
1745 branchcode
=> $branchcode,
1746 itemtype
=> $itemtype,
1747 rule_name
=> 'holdallowed',
1750 my $hold_fulfillment_policy_rule = Koha
::CirculationRules
->get_effective_rule(
1752 branchcode
=> $branchcode,
1753 itemtype
=> $itemtype,
1754 rule_name
=> 'hold_fulfillment_policy',
1757 my $returnbranch_rule = Koha
::CirculationRules
->get_effective_rule(
1759 branchcode
=> $branchcode,
1760 itemtype
=> $itemtype,
1761 rule_name
=> 'returnbranch',
1765 # built-in default circulation rule
1767 $rules->{holdallowed
} = defined $holdallowed_rule
1768 ?
$holdallowed_rule->rule_value
1770 $rules->{hold_fulfillment_policy
} = defined $hold_fulfillment_policy_rule
1771 ?
$hold_fulfillment_policy_rule->rule_value
1773 $rules->{returnbranch
} = defined $returnbranch_rule
1774 ?
$returnbranch_rule->rule_value
1782 ($doreturn, $messages, $iteminformation, $borrower) =
1783 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1789 =item C<$barcode> is the bar code of the book being returned.
1791 =item C<$branch> is the code of the branch where the book is being returned.
1793 =item C<$exemptfine> indicates that overdue charges for the item will be
1796 =item C<$return_date> allows the default return date to be overridden
1797 by the given return date. Optional.
1801 C<&AddReturn> returns a list of four items:
1803 C<$doreturn> is true iff the return succeeded.
1805 C<$messages> is a reference-to-hash giving feedback on the operation.
1806 The keys of the hash are:
1812 No item with this barcode exists. The value is C<$barcode>.
1816 The book is not currently on loan. The value is C<$barcode>.
1820 This book has been withdrawn/cancelled. The value should be ignored.
1822 =item C<Wrongbranch>
1824 This book has was returned to the wrong branch. The value is a hashref
1825 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1826 contain the branchcode of the incorrect and correct return library, respectively.
1830 The item was reserved. The value is a reference-to-hash whose keys are
1831 fields from the reserves table of the Koha database, and
1832 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1833 either C<Waiting>, C<Reserved>, or 0.
1835 =item C<WasReturned>
1837 Value 1 if return is successful.
1839 =item C<NeedsTransfer>
1841 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1845 C<$iteminformation> is a reference-to-hash, giving information about the
1846 returned item from the issues table.
1848 C<$borrower> is a reference-to-hash, giving information about the
1849 patron who last borrowed the book.
1854 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1856 if ($branch and not Koha
::Libraries
->find($branch)) {
1857 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4
::Context
->userenv->{'branch'};
1860 $branch = C4
::Context
->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1861 $return_date //= dt_from_string
();
1865 my $validTransfert = 0;
1866 my $stat_type = 'return';
1868 # get information on item
1869 my $item = Koha
::Items
->find({ barcode
=> $barcode });
1871 return ( 0, { BadBarcode
=> $barcode } ); # no barcode means no item or borrower. bail out.
1874 my $itemnumber = $item->itemnumber;
1875 my $itemtype = $item->effective_itemtype;
1877 my $issue = $item->checkout;
1879 $patron = $issue->patron
1880 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1881 . Dumper
($issue->unblessed) . "\n";
1883 $messages->{'NotIssued'} = $barcode;
1884 ModItem
({ onloan
=> undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1885 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1887 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1888 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1889 if (C4
::Context
->preference("RecordLocalUseOnReturn")) {
1890 $messages->{'LocalUse'} = 1;
1891 $stat_type = 'localuse';
1895 my $item_unblessed = $item->unblessed;
1896 # full item data, but no borrowernumber or checkout info (no issue)
1897 my $hbr = GetBranchItemRule
($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1898 # get the proper branch to which to return the item
1899 my $returnbranch = $hbr ne 'noreturn' ?
$item->$hbr : $branch;
1900 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1902 my $borrowernumber = $patron ?
$patron->borrowernumber : undef; # we don't know if we had a borrower or not
1903 my $patron_unblessed = $patron ?
$patron->unblessed : {};
1905 my $update_loc_rules = get_yaml_pref_hash
('UpdateItemLocationOnCheckin');
1906 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1907 if ($update_loc_rules) {
1908 if (defined $update_loc_rules->{_ALL_
}) {
1909 if ($update_loc_rules->{_ALL_
} eq '_PERM_') { $update_loc_rules->{_ALL_
} = $item->permanent_location; }
1910 if ($update_loc_rules->{_ALL_
} eq '_BLANK_') { $update_loc_rules->{_ALL_
} = ''; }
1911 if ( $item->location ne $update_loc_rules->{_ALL_
}) {
1912 $messages->{'ItemLocationUpdated'} = { from
=> $item->location, to
=> $update_loc_rules->{_ALL_
} };
1913 ModItem
( { location
=> $update_loc_rules->{_ALL_
} }, undef, $itemnumber );
1917 foreach my $key ( keys %$update_loc_rules ) {
1918 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1919 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1920 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1921 $messages->{'ItemLocationUpdated'} = { from
=> $item->location, to
=> $update_loc_rules->{$key} };
1922 ModItem
( { location
=> $update_loc_rules->{$key} }, undef, $itemnumber );
1929 my $yaml = C4
::Context
->preference('UpdateNotForLoanStatusOnCheckin');
1931 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1933 eval { $rules = YAML
::Load
($yaml); };
1935 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1938 foreach my $key ( keys %$rules ) {
1939 if ( $item->notforloan eq $key ) {
1940 $messages->{'NotForLoanStatusUpdated'} = { from
=> $item->notforloan, to
=> $rules->{$key} };
1941 ModItem
( { notforloan
=> $rules->{$key} }, undef, $itemnumber, { log_action
=> 0 } );
1948 # check if the return is allowed at this branch
1949 my ($returnallowed, $message) = CanBookBeReturned
($item_unblessed, $branch);
1950 unless ($returnallowed){
1951 $messages->{'Wrongbranch'} = {
1952 Wrongbranch
=> $branch,
1953 Rightbranch
=> $message
1956 return ( $doreturn, $messages, $issue, $patron_unblessed);
1959 if ( $item->withdrawn ) { # book has been cancelled
1960 $messages->{'withdrawn'} = 1;
1961 $doreturn = 0 if C4
::Context
->preference("BlockReturnOfWithdrawnItems");
1964 if ( $item->itemlost and C4
::Context
->preference("BlockReturnOfLostItems") ) {
1968 # case of a return of document (deal with issues and holdingbranch)
1970 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1971 $patron or warn "AddReturn without current borrower";
1975 MarkIssueReturned
( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1978 if ( C4
::Context
->preference('CalculateFinesOnReturn') && !$item->itemlost ) {
1979 _CalculateAndUpdateFine
( { issue
=> $issue, item
=> $item_unblessed, borrower
=> $patron_unblessed, return_date
=> $return_date } );
1982 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 );
1984 return ( 0, { WasReturned
=> 0, DataCorrupted
=> 1 }, $issue, $patron_unblessed );
1987 # FIXME is the "= 1" right? This could be the borrower hash.
1988 $messages->{'WasReturned'} = 1;
1992 ModItem
( { onloan
=> undef }, $item->biblionumber, $item->itemnumber, { log_action
=> 0 } );
1995 # the holdingbranch is updated if the document is returned to another location.
1996 # this is always done regardless of whether the item was on loan or not
1997 my $item_holding_branch = $item->holdingbranch;
1998 if ($item->holdingbranch ne $branch) {
1999 UpdateHoldingbranch
($branch, $item->itemnumber);
2000 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
2003 my $leave_item_lost = C4
::Context
->preference("BlockReturnOfLostItems") ?
1 : 0;
2004 ModDateLastSeen
( $item->itemnumber, $leave_item_lost );
2006 # check if we have a transfer for this document
2007 my ($datesent,$frombranch,$tobranch) = GetTransfers
( $item->itemnumber );
2009 # if we have a transfer to do, we update the line of transfers with the datearrived
2010 my $is_in_rotating_collection = C4
::RotatingCollections
::isItemInAnyCollection
( $item->itemnumber );
2012 if ( $tobranch eq $branch ) {
2013 my $sth = C4
::Context
->dbh->prepare(
2014 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2016 $sth->execute( $item->itemnumber );
2017 # if we have a reservation with valid transfer, we can set it's status to 'W'
2018 C4
::Reserves
::ModReserveStatus
($item->itemnumber, 'W');
2020 $messages->{'WrongTransfer'} = $tobranch;
2021 $messages->{'WrongTransferItem'} = $item->itemnumber;
2023 $validTransfert = 1;
2026 # fix up the accounts.....
2027 if ( $item->itemlost ) {
2028 $messages->{'WasLost'} = 1;
2029 unless ( C4
::Context
->preference("BlockReturnOfLostItems") ) {
2031 Koha
::RefundLostItemFeeRules
->should_refund(
2033 current_branch
=> C4
::Context
->userenv->{branch
},
2034 item_home_branch
=> $item->homebranch,
2035 item_holding_branch
=> $item_holding_branch
2040 _FixAccountForLostAndFound
( $item->itemnumber,
2041 $borrowernumber, $barcode );
2042 $messages->{'LostItemFeeRefunded'} = 1;
2047 # fix up the overdues in accounts...
2048 if ($borrowernumber) {
2049 my $fix = _FixOverduesOnReturn
( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2050 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2052 if ( $issue and $issue->is_overdue ) {
2054 my ($debardate,$reminder) = _debar_user_on_return
( $patron_unblessed, $item_unblessed, dt_from_string
($issue->date_due), $return_date );
2056 $messages->{'PrevDebarred'} = $debardate;
2058 $messages->{'Debarred'} = $debardate if $debardate;
2060 # there's no overdue on the item but borrower had been previously debarred
2061 } elsif ( $issue->date_due and $patron->debarred ) {
2062 if ( $patron->debarred eq "9999-12-31") {
2063 $messages->{'ForeverDebarred'} = $patron->debarred;
2065 my $borrower_debar_dt = dt_from_string
( $patron->debarred );
2066 $borrower_debar_dt->truncate(to
=> 'day');
2067 my $today_dt = $return_date->clone()->truncate(to
=> 'day');
2068 if ( DateTime
->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2069 $messages->{'PrevDebarred'} = $patron->debarred;
2075 # find reserves.....
2076 # launch the Checkreserves routine to find any holds
2077 my ($resfound, $resrec);
2078 my $lookahead= C4
::Context
->preference('ConfirmFutureHolds'); #number of days to look for future holds
2079 ($resfound, $resrec, undef) = C4
::Reserves
::CheckReserves
( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2080 # if a hold is found and is waiting at another branch, change the priority back to 1 and trigger the hold (this will trigger a transfer and update the hold status properly)
2081 if ( $resfound eq "Waiting" and $branch ne $resrec->{branchcode
} ) {
2082 my $hold = C4
::Reserves
::RevertWaitingStatus
( { itemnumber
=> $item->itemnumber } );
2083 $resfound = 'Reserved';
2084 $resrec = $hold->unblessed;
2087 $resrec->{'ResFound'} = $resfound;
2088 $messages->{'ResFound'} = $resrec;
2091 # Record the fact that this book was returned.
2095 itemnumber
=> $itemnumber,
2096 itemtype
=> $itemtype,
2097 borrowernumber
=> $borrowernumber,
2098 ccode
=> $item->ccode,
2101 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2103 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2105 branchcode
=> $branch,
2106 categorycode
=> $patron->categorycode,
2107 item_type
=> $itemtype,
2108 notification
=> 'CHECKIN',
2110 if ($doreturn && $circulation_alert->is_enabled_for(\
%conditions)) {
2111 SendCirculationAlert
({
2113 item
=> $item_unblessed,
2114 borrower
=> $patron->unblessed,
2119 logaction
("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2120 if C4
::Context
->preference("ReturnLog");
2123 # Remove any OVERDUES related debarment if the borrower has no overdues
2124 if ( $borrowernumber
2125 && $patron->debarred
2126 && C4
::Context
->preference('AutoRemoveOverduesRestrictions')
2127 && !Koha
::Patrons
->find( $borrowernumber )->has_overdues
2128 && @
{ GetDebarments
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' }) }
2130 DelUniqueDebarment
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' });
2133 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2134 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2135 my $BranchTransferLimitsType = C4
::Context
->preference("BranchTransferLimitsType") eq 'itemtype' ?
'effective_itemtype' : 'ccode';
2136 if (C4
::Context
->preference("AutomaticItemReturn" ) or
2137 (C4
::Context
->preference("UseBranchTransferLimits") and
2138 ! IsBranchTransferAllowed
($branch, $returnbranch, $item->$BranchTransferLimitsType )
2140 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2141 $debug and warn "item: " . Dumper
($item_unblessed);
2142 ModItemTransfer
($item->itemnumber, $branch, $returnbranch);
2143 $messages->{'WasTransfered'} = 1;
2145 $messages->{'NeedsTransfer'} = $returnbranch;
2149 if ( C4
::Context
->preference('ClaimReturnedLostValue') ) {
2150 my $claims = Koha
::Checkouts
::ReturnClaims
->search(
2152 itemnumber
=> $item->id,
2153 resolution
=> undef,
2157 if ( $claims->count ) {
2158 $messages->{ReturnClaims
} = $claims;
2162 return ( $doreturn, $messages, $issue, ( $patron ?
$patron->unblessed : {} ));
2165 =head2 MarkIssueReturned
2167 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2169 Unconditionally marks an issue as being returned by
2170 moving the C<issues> row to C<old_issues> and
2171 setting C<returndate> to the current date.
2173 if C<$returndate> is specified (in iso format), it is used as the date
2176 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2177 the old_issue is immediately anonymised
2179 Ideally, this function would be internal to C<C4::Circulation>,
2180 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2181 and offline_circ/process_koc.pl.
2185 sub MarkIssueReturned
{
2186 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2188 # Retrieve the issue
2189 my $issue = Koha
::Checkouts
->find( { itemnumber
=> $itemnumber } ) or return;
2191 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2193 my $issue_id = $issue->issue_id;
2195 my $anonymouspatron;
2196 if ( $privacy && $privacy == 2 ) {
2197 # The default of 0 will not work due to foreign key constraints
2198 # The anonymisation will fail if AnonymousPatron is not a valid entry
2199 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2200 # Note that a warning should appear on the about page (System information tab).
2201 $anonymouspatron = C4
::Context
->preference('AnonymousPatron');
2202 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."
2203 unless Koha
::Patrons
->find( $anonymouspatron );
2206 my $schema = Koha
::Database
->schema;
2208 # FIXME Improve the return value and handle it from callers
2209 $schema->txn_do(sub {
2211 # Update the returndate value
2212 if ( $returndate ) {
2213 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2216 $issue->returndate( \'NOW
()' )->store->discard_changes; # update and refetch
2219 # Create the old_issues entry
2220 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2222 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2223 if ( $privacy && $privacy == 2) {
2224 $old_checkout->borrowernumber($anonymouspatron)->store;
2227 # And finally delete the issue
2230 ModItem( { 'onloan
' => undef }, undef, $itemnumber, { log_action => 0 } );
2232 if ( C4::Context->preference('StoreLastBorrower
') ) {
2233 my $item = Koha::Items->find( $itemnumber );
2234 my $patron = Koha::Patrons->find( $borrowernumber );
2235 $item->last_returned_by( $patron );
2242 =head2 _debar_user_on_return
2244 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2246 C<$borrower> borrower hashref
2248 C<$item> item hashref
2250 C<$datedue> date due DateTime object
2252 C<$returndate> DateTime object representing the return time
2254 Internal function, called only by AddReturn that calculates and updates
2255 the user fine days, and debars them if necessary.
2257 Should only be called for overdue returns
2259 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2264 sub _calculate_new_debar_dt {
2265 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2267 my $branchcode = _GetCircControlBranch( $item, $borrower );
2268 my $circcontrol = C4::Context->preference('CircControl
');
2269 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2270 { categorycode => $borrower->{categorycode},
2271 itemtype => $item->{itype},
2272 branchcode => $branchcode,
2277 'maxsuspensiondays
',
2278 'suspension_chargeperiod
',
2282 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2283 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2284 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2286 return unless $finedays;
2288 # finedays is in days, so hourly loans must multiply by 24
2289 # thus 1 hour late equals 1 day suspension * finedays rate
2290 $finedays = $finedays * 24 if ( $unit eq 'hours
' );
2292 # grace period is measured in the same units as the loan
2294 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2296 my $deltadays = DateTime::Duration->new(
2297 days => $chargeable_units
2300 if ( $deltadays->subtract($grace)->is_positive() ) {
2301 my $suspension_days = $deltadays * $finedays;
2303 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2304 # No need to / 1 and do not consider / 0
2305 $suspension_days = DateTime::Duration->new(
2306 days => floor( $suspension_days->in_units('days
') / $issuing_rule->{suspension_chargeperiod} )
2310 # If the max suspension days is < than the suspension days
2311 # the suspension days is limited to this maximum period.
2312 my $max_sd = $issuing_rule->{maxsuspensiondays};
2313 if ( defined $max_sd && $max_sd ne '' ) {
2314 $max_sd = DateTime::Duration->new( days => $max_sd );
2315 $suspension_days = $max_sd
2316 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2319 my ( $has_been_extended );
2320 if ( C4::Context->preference('CumulativeRestrictionPeriods
') and $borrower->{debarred} ) {
2321 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION
' } ) }[0];
2323 $return_date = dt_from_string( $debarment->{expiration}, 'sql
' );
2324 $has_been_extended = 1;
2329 # Use the calendar or not to calculate the debarment date
2330 if ( C4::Context->preference('SuspensionsCalendar
') eq 'noSuspensionsWhenClosed
' ) {
2331 my $calendar = Koha::Calendar->new(
2332 branchcode => $branchcode,
2333 days_mode => 'Calendar
'
2335 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2338 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2340 return $new_debar_dt;
2345 sub _debar_user_on_return {
2346 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2348 $return_date //= dt_from_string();
2350 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2352 return unless $new_debar_dt;
2354 Koha::Patron::Debarments::AddUniqueDebarment({
2355 borrowernumber => $borrower->{borrowernumber},
2356 expiration => $new_debar_dt->ymd(),
2357 type => 'SUSPENSION
',
2359 # if borrower was already debarred but does not get an extra debarment
2360 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2361 my ($new_debarment_str, $is_a_reminder);
2362 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2364 $new_debarment_str = $borrower->{debarred};
2366 $new_debarment_str = $new_debar_dt->ymd();
2368 # FIXME Should return a DateTime object
2369 return $new_debarment_str, $is_a_reminder;
2372 =head2 _FixOverduesOnReturn
2374 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2376 C<$borrowernumber> borrowernumber
2378 C<$itemnumber> itemnumber
2380 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2382 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2388 sub _FixOverduesOnReturn {
2389 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2390 unless( $borrowernumber ) {
2391 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2395 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2399 warn "_FixOverduesOnReturn() not supplied valid status";
2403 my $schema = Koha::Database->schema;
2405 my $result = $schema->txn_do(
2407 # check for overdue fine
2408 my $accountlines = Koha::Account::Lines->search(
2410 borrowernumber => $borrowernumber,
2411 itemnumber => $item,
2412 debit_type_code => 'OVERDUE
',
2413 status => 'UNRETURNED
'
2416 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2418 my $accountline = $accountlines->next;
2420 my $amountoutstanding = $accountline->amountoutstanding;
2422 my $account = Koha
::Account
->new({patron_id
=> $borrowernumber});
2423 my $credit = $account->add_credit(
2425 amount
=> $amountoutstanding,
2426 user_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'number'} : undef,
2427 library_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'branch'} : undef,
2428 interface
=> C4
::Context
->interface,
2434 $credit->apply({ debits
=> [ $accountline ], offset_type
=> 'Forgiven' });
2436 $accountline->status('FORGIVEN');
2438 if (C4
::Context
->preference("FinesLog")) {
2439 &logaction
("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2442 $accountline->status($status);
2445 return $accountline->store();
2452 =head2 _FixAccountForLostAndFound
2454 &_FixAccountForLostAndFound($itemnumber, [$borrowernumber, $barcode]);
2456 Finds the most recent lost item charge for this item and refunds the borrower
2457 appropriatly, taking into account any payments or writeoffs already applied
2460 Internal function, not exported, called only by AddReturn.
2464 sub _FixAccountForLostAndFound
{
2465 my $itemnumber = shift or return;
2466 my $borrowernumber = @_ ?
shift : undef;
2467 my $item_id = @_ ?
shift : $itemnumber; # Send the barcode if you want that logged in the description
2471 # check for charge made for lost book
2472 my $accountlines = Koha
::Account
::Lines
->search(
2474 itemnumber
=> $itemnumber,
2475 debit_type_code
=> 'LOST',
2476 status
=> [ undef, { '<>' => 'FOUND' } ]
2479 order_by
=> { -desc
=> [ 'date', 'accountlines_id' ] }
2483 return unless $accountlines->count > 0;
2484 my $accountline = $accountlines->next;
2485 my $total_to_refund = 0;
2487 return unless $accountline->borrowernumber;
2488 my $patron = Koha
::Patrons
->find( $accountline->borrowernumber );
2489 return unless $patron; # Patron has been deleted, nobody to credit the return to
2491 my $account = $patron->account;
2494 if ( $accountline->amount > $accountline->amountoutstanding ) {
2495 # some amount has been cancelled. collect the offsets that are not writeoffs
2496 # this works because the only way to subtract from this kind of a debt is
2497 # using the UI buttons 'Pay' and 'Write off'
2498 my $credits_offsets = Koha
::Account
::Offsets
->search({
2499 debit_id
=> $accountline->id,
2500 credit_id
=> { '!=' => undef }, # it is not the debit itself
2501 type
=> { '!=' => 'Writeoff' },
2502 amount
=> { '<' => 0 } # credits are negative on the DB
2505 $total_to_refund = ( $credits_offsets->count > 0 )
2506 ?
$credits_offsets->total * -1 # credits are negative on the DB
2510 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2512 if ( $credit_total > 0 ) {
2513 my $branchcode = C4
::Context
->userenv ? C4
::Context
->userenv->{'branch'} : undef;
2514 $credit = $account->add_credit(
2516 amount
=> $credit_total,
2517 description
=> 'Item found ' . $item_id,
2518 type
=> 'LOST_FOUND',
2519 interface
=> C4
::Context
->interface,
2520 library_id
=> $branchcode,
2521 item_id
=> $itemnumber
2525 $credit->apply( { debits
=> [ $accountline ] } );
2528 # Update the account status
2529 $accountline->discard_changes->status('FOUND');
2530 $accountline->store;
2532 if ( defined $account and C4
::Context
->preference('AccountAutoReconcile') ) {
2533 $account->reconcile_balance;
2536 return ($credit) ?
$credit->id : undef;
2539 =head2 _GetCircControlBranch
2541 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2545 Return the library code to be used to determine which circulation
2546 policy applies to a transaction. Looks up the CircControl and
2547 HomeOrHoldingBranch system preferences.
2549 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2551 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2555 sub _GetCircControlBranch
{
2556 my ($item, $borrower) = @_;
2557 my $circcontrol = C4
::Context
->preference('CircControl');
2560 if ($circcontrol eq 'PickupLibrary' and (C4
::Context
->userenv and C4
::Context
->userenv->{'branch'}) ) {
2561 $branch= C4
::Context
->userenv->{'branch'};
2562 } elsif ($circcontrol eq 'PatronLibrary') {
2563 $branch=$borrower->{branchcode
};
2565 my $branchfield = C4
::Context
->preference('HomeOrHoldingBranch') || 'homebranch';
2566 $branch = $item->{$branchfield};
2567 # default to item home branch if holdingbranch is used
2568 # and is not defined
2569 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2570 $branch = $item->{homebranch
};
2578 $issue = GetOpenIssue( $itemnumber );
2580 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2582 C<$itemnumber> is the item's itemnumber
2589 my ( $itemnumber ) = @_;
2590 return unless $itemnumber;
2591 my $dbh = C4
::Context
->dbh;
2592 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2593 $sth->execute( $itemnumber );
2594 return $sth->fetchrow_hashref();
2598 =head2 GetBiblioIssues
2600 $issues = GetBiblioIssues($biblionumber);
2602 this function get all issues from a biblionumber.
2605 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2606 tables issues and the firstname,surname & cardnumber from borrowers.
2610 sub GetBiblioIssues
{
2611 my $biblionumber = shift;
2612 return unless $biblionumber;
2613 my $dbh = C4
::Context
->dbh;
2615 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2617 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2618 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2619 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2620 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2621 WHERE biblio.biblionumber = ?
2623 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2625 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2626 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2627 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2628 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2629 WHERE biblio.biblionumber = ?
2632 my $sth = $dbh->prepare($query);
2633 $sth->execute($biblionumber, $biblionumber);
2636 while ( my $data = $sth->fetchrow_hashref ) {
2637 push @issues, $data;
2642 =head2 GetUpcomingDueIssues
2644 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2648 sub GetUpcomingDueIssues
{
2651 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2652 my $dbh = C4
::Context
->dbh;
2654 my $statement = <<END_SQL;
2657 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2659 LEFT JOIN items USING (itemnumber)
2660 LEFT OUTER JOIN branches USING (branchcode)
2661 WHERE returndate is NULL
2663 WHERE days_until_due >= 0 AND days_until_due <= ?
2666 my @bind_parameters = ( $params->{'days_in_advance'} );
2668 my $sth = $dbh->prepare( $statement );
2669 $sth->execute( @bind_parameters );
2670 my $upcoming_dues = $sth->fetchall_arrayref({});
2672 return $upcoming_dues;
2675 =head2 CanBookBeRenewed
2677 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2679 Find out whether a borrowed item may be renewed.
2681 C<$borrowernumber> is the borrower number of the patron who currently
2682 has the item on loan.
2684 C<$itemnumber> is the number of the item to renew.
2686 C<$override_limit>, if supplied with a true value, causes
2687 the limit on the number of times that the loan can be renewed
2688 (as controlled by the item type) to be ignored. Overriding also allows
2689 to renew sooner than "No renewal before" and to manually renew loans
2690 that are automatically renewed.
2692 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2693 item must currently be on loan to the specified borrower; renewals
2694 must be allowed for the item's type; and the borrower must not have
2695 already renewed the loan. $error will contain the reason the renewal can not proceed
2699 sub CanBookBeRenewed {
2700 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2702 my $dbh = C4::Context->dbh;
2706 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2707 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2708 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2709 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2711 my $patron = $issue->patron or return;
2713 # override_limit will override anything else except on_reserve
2714 unless ( $override_limit ){
2715 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2716 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2718 categorycode => $patron->categorycode,
2719 itemtype => $item->effective_itemtype,
2720 branchcode => $branchcode,
2723 'no_auto_renewal_after',
2724 'no_auto_renewal_after_hard_limit',
2731 return ( 0, "too_many" )
2732 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2734 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2735 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2736 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2737 my $restricted = $patron->is_debarred;
2738 my $hasoverdues = $patron->has_overdues;
2740 if ( $restricted and $restrictionblockrenewing ) {
2741 return ( 0, 'restriction');
2742 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2743 return ( 0, 'overdue');
2746 if ( $issue->auto_renew ) {
2748 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2749 return ( 0, 'auto_account_expired' );
2752 if ( defined $issuing_rule->{no_auto_renewal_after}
2753 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2754 # Get issue_date and add no_auto_renewal_after
2755 # If this is greater than today, it's too late for renewal.
2756 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2757 $maximum_renewal_date->add(
2758 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2760 my $now = dt_from_string;
2761 if ( $now >= $maximum_renewal_date ) {
2762 return ( 0, "auto_too_late" );
2765 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2766 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2767 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2768 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2769 return ( 0, "auto_too_late" );
2773 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2774 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2775 my $amountoutstanding =
2776 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2777 ? $patron->account->balance
2778 : $patron->account->outstanding_debits->total_outstanding;
2779 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2780 return ( 0, "auto_too_much_oweing" );
2785 if ( defined $issuing_rule->{norenewalbefore}
2786 and $issuing_rule->{norenewalbefore} ne "" )
2789 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2790 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2791 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2793 # Depending on syspref reset the exact time, only check the date
2794 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2795 and $issuing_rule->{lengthunit} eq 'days' )
2797 $soonestrenewal->truncate( to => 'day' );
2800 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2802 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2803 return ( 0, "too_soon" );
2805 elsif ( $issue->auto_renew ) {
2810 # Fallback for automatic renewals:
2811 # If norenewalbefore is undef, don't renew before due date.
2812 if ( $issue->auto_renew && !$auto_renew ) {
2813 my $now = dt_from_string;
2814 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2817 return ( 0, "auto_too_soon" );
2822 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2824 # This item can fill one or more unfilled reserve, can those unfilled reserves
2825 # all be filled by other available items?
2827 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2829 my $schema = Koha::Database->new()->schema();
2831 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2833 # There is an item level hold on this item, no other item can fill the hold
2838 # Get all other items that could possibly fill reserves
2839 my @itemnumbers = $schema->resultset('Item')->search(
2841 biblionumber => $resrec->{biblionumber},
2844 -not => { itemnumber => $itemnumber }
2846 { columns => 'itemnumber' }
2847 )->get_column('itemnumber')->all();
2849 # Get all other reserves that could have been filled by this item
2850 my @borrowernumbers;
2852 my ( $reserve_found, $reserve, undef ) =
2853 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2855 if ($reserve_found) {
2856 push( @borrowernumbers, $reserve->{borrowernumber} );
2863 # If the count of the union of the lists of reservable items for each borrower
2864 # is equal or greater than the number of borrowers, we know that all reserves
2865 # can be filled with available items. We can get the union of the sets simply
2866 # by pushing all the elements onto an array and removing the duplicates.
2869 ITEM: foreach my $itemnumber (@itemnumbers) {
2870 my $item = Koha::Items->find( $itemnumber );
2871 next if IsItemOnHoldAndFound( $itemnumber );
2872 for my $borrowernumber (@borrowernumbers) {
2873 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2874 next unless IsAvailableForItemLevelRequest($item, $patron);
2875 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2877 push @reservable, $itemnumber;
2878 if (@reservable >= @borrowernumbers) {
2887 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2888 return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
2890 return ( 1, undef );
2895 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2899 C<$borrowernumber> is the borrower number of the patron who currently
2902 C<$itemnumber> is the number of the item to renew.
2904 C<$branch> is the library where the renewal took place (if any).
2905 The library that controls the circ policies for the renewal is retrieved from the issues record.
2907 C<$datedue> can be a DateTime object used to set the due date.
2909 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2910 this parameter is not supplied, lastreneweddate is set to the current date.
2912 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2913 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2914 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2917 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2918 from the book's item type.
2923 my $borrowernumber = shift;
2924 my $itemnumber = shift or return;
2926 my $datedue = shift;
2927 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2928 my $skipfinecalc = shift;
2930 my $item_object = Koha::Items->find($itemnumber) or return;
2931 my $biblio = $item_object->biblio;
2932 my $issue = $item_object->checkout;
2933 my $item_unblessed = $item_object->unblessed;
2935 my $dbh = C4::Context->dbh;
2937 return unless $issue;
2939 $borrowernumber ||= $issue->borrowernumber;
2941 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2942 carp 'Invalid date passed to AddRenewal.';
2946 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2947 my $patron_unblessed = $patron->unblessed;
2949 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2951 my $schema = Koha::Database->schema;
2952 $schema->txn_do(sub{
2954 if ( !skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
2955 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2957 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2959 # If the due date wasn't specified, calculate it by adding the
2960 # book's loan length to today's date or the current due date
2961 # based on the value of the RenewalPeriodBase syspref.
2962 my $itemtype = $item_object->effective_itemtype;
2965 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2966 dt_from_string( $issue->date_due, 'sql' ) :
2967 DateTime->now( time_zone => C4::Context->tz());
2968 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2971 my $fees = Koha::Charges::Fees->new(
2974 library => $circ_library,
2975 item => $item_object,
2976 from_date => dt_from_string( $issue->date_due, 'sql' ),
2977 to_date => dt_from_string($datedue),
2981 # Update the issues record to have the new due date, and a new count
2982 # of how many times it has been renewed.
2983 my $renews = ( $issue->renewals || 0 ) + 1;
2984 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2985 WHERE borrowernumber=?
2989 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2991 # Update the renewal count on the item, and tell zebra to reindex
2992 $renews = ( $item_object->renewals || 0 ) + 1;
2993 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2995 # Charge a new rental fee, if applicable
2996 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2997 if ( $charge > 0 ) {
2998 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3001 # Charge a new accumulate rental fee, if applicable
3002 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3003 if ( $itemtype_object ) {
3004 my $accumulate_charge = $fees->accumulate_rentalcharge();
3005 if ( $accumulate_charge > 0 ) {
3006 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3008 $charge += $accumulate_charge;
3011 # Send a renewal slip according to checkout alert preferencei
3012 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3013 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3015 branchcode => $branch,
3016 categorycode => $patron->categorycode,
3017 item_type => $itemtype,
3018 notification => 'CHECKOUT',
3020 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3021 SendCirculationAlert(
3024 item => $item_unblessed,
3025 borrower => $patron->unblessed,
3032 # Remove any OVERDUES related debarment if the borrower has no overdues
3034 && $patron->is_debarred
3035 && ! $patron->has_overdues
3036 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3038 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3041 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
3042 $branch = ( C4::Context->userenv && defined C4::Context->userenv->{branch} ) ? C4::Context->userenv->{branch} : $branch;
3045 # Add the renewal to stats
3051 itemnumber => $itemnumber,
3052 itemtype => $itemtype,
3053 location => $item_object->location,
3054 borrowernumber => $borrowernumber,
3055 ccode => $item_object->ccode,
3060 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3067 # check renewal status
3068 my ( $bornum, $itemno ) = @_;
3069 my $dbh = C4::Context->dbh;
3071 my $renewsallowed = 0;
3074 my $patron = Koha::Patrons->find( $bornum );
3075 my $item = Koha::Items->find($itemno);
3077 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3079 # Look in the issues table for this item, lent to this borrower,
3080 # and not yet returned.
3082 # FIXME - I think this function could be redone to use only one SQL call.
3083 my $sth = $dbh->prepare(
3084 "select * from issues
3085 where (borrowernumber = ?)
3086 and (itemnumber = ?)"
3088 $sth->execute( $bornum, $itemno );
3089 my $data = $sth->fetchrow_hashref;
3090 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3091 # $item and $borrower should be calculated
3092 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3094 my $rule = Koha::CirculationRules->get_effective_rule(
3096 categorycode => $patron->categorycode,
3097 itemtype => $item->effective_itemtype,
3098 branchcode => $branchcode,
3099 rule_name => 'renewalsallowed',
3103 $renewsallowed = $rule ? $rule->rule_value : 0;
3104 $renewsleft = $renewsallowed - $renewcount;
3105 if($renewsleft < 0){ $renewsleft = 0; }
3106 return ( $renewcount, $renewsallowed, $renewsleft );
3109 =head2 GetSoonestRenewDate
3111 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3113 Find out the soonest possible renew date of a borrowed item.
3115 C<$borrowernumber> is the borrower number of the patron who currently
3116 has the item on loan.
3118 C<$itemnumber> is the number of the item to renew.
3120 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3121 renew date, based on the value "No renewal before" of the applicable
3122 issuing rule. Returns the current date if the item can already be
3123 renewed, and returns undefined if the borrower, loan, or item
3128 sub GetSoonestRenewDate {
3129 my ( $borrowernumber, $itemnumber ) = @_;
3131 my $dbh = C4::Context->dbh;
3133 my $item = Koha::Items->find($itemnumber) or return;
3134 my $itemissue = $item->checkout or return;
3136 $borrowernumber ||= $itemissue->borrowernumber;
3137 my $patron = Koha::Patrons->find( $borrowernumber )
3140 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3141 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3142 { categorycode => $patron->categorycode,
3143 itemtype => $item->effective_itemtype,
3144 branchcode => $branchcode,
3152 my $now = dt_from_string;
3153 return $now unless $issuing_rule;
3155 if ( defined $issuing_rule->{norenewalbefore}
3156 and $issuing_rule->{norenewalbefore} ne "" )
3158 my $soonestrenewal =
3159 dt_from_string( $itemissue->date_due )->subtract(
3160 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3162 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3163 and $issuing_rule->{lengthunit} eq 'days' )
3165 $soonestrenewal->truncate( to => 'day' );
3167 return $soonestrenewal if $now < $soonestrenewal;
3172 =head2 GetLatestAutoRenewDate
3174 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3176 Find out the latest possible auto renew date of a borrowed item.
3178 C<$borrowernumber> is the borrower number of the patron who currently
3179 has the item on loan.
3181 C<$itemnumber> is the number of the item to renew.
3183 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3184 auto renew date, based on the value "No auto renewal after" and the "No auto
3185 renewal after (hard limit) of the applicable issuing rule.
3186 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3187 or item cannot be found.
3191 sub GetLatestAutoRenewDate {
3192 my ( $borrowernumber, $itemnumber ) = @_;
3194 my $dbh = C4::Context->dbh;
3196 my $item = Koha::Items->find($itemnumber) or return;
3197 my $itemissue = $item->checkout or return;
3199 $borrowernumber ||= $itemissue->borrowernumber;
3200 my $patron = Koha::Patrons->find( $borrowernumber )
3203 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3204 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3206 categorycode => $patron->categorycode,
3207 itemtype => $item->effective_itemtype,
3208 branchcode => $branchcode,
3210 'no_auto_renewal_after',
3211 'no_auto_renewal_after_hard_limit',
3217 return unless $circulation_rules;
3219 if ( not $circulation_rules->{no_auto_renewal_after}
3220 or $circulation_rules->{no_auto_renewal_after} eq '' )
3221 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3222 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3224 my $maximum_renewal_date;
3225 if ( $circulation_rules->{no_auto_renewal_after} ) {
3226 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3227 $maximum_renewal_date->add(
3228 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3232 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3233 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3234 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3236 return $maximum_renewal_date;
3240 =head2 GetIssuingCharges
3242 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3244 Calculate how much it would cost for a given patron to borrow a given
3245 item, including any applicable discounts.
3247 C<$itemnumber> is the item number of item the patron wishes to borrow.
3249 C<$borrowernumber> is the patron's borrower number.
3251 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3252 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3257 sub GetIssuingCharges {
3259 # calculate charges due
3260 my ( $itemnumber, $borrowernumber ) = @_;
3262 my $dbh = C4::Context->dbh;
3265 # Get the book's item type and rental charge (via its biblioitem).
3266 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3267 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3268 $charge_query .= (C4::Context->preference('item-level_itypes'))
3269 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3270 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3272 $charge_query .= ' WHERE items.itemnumber =?';
3274 my $sth = $dbh->prepare($charge_query);
3275 $sth->execute($itemnumber);
3276 if ( my $item_data = $sth->fetchrow_hashref ) {
3277 $item_type = $item_data->{itemtype};
3278 $charge = $item_data->{rentalcharge};
3279 my $branch = C4::Context::mybranch();
3280 my $patron = Koha::Patrons->find( $borrowernumber );
3281 my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3283 # We may have multiple rules so get the most specific
3284 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3287 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3291 return ( $charge, $item_type );
3294 # Select most appropriate discount rule from those returned
3295 sub _get_discount_from_rule {
3296 my ($categorycode, $branchcode, $itemtype) = @_;
3298 # Set search precedences
3301 branchcode => $branchcode,
3302 itemtype => $itemtype,
3303 categorycode => $categorycode,
3306 branchcode => undef,
3307 categorycode => $categorycode,
3308 itemtype => $itemtype,
3311 branchcode => $branchcode,
3312 categorycode => $categorycode,
3316 branchcode => undef,
3317 categorycode => $categorycode,
3322 foreach my $params (@params) {
3323 my $rule = Koha::CirculationRules->search(
3325 rule_name => 'rentaldiscount',
3330 return $rule->rule_value if $rule;
3337 =head2 AddIssuingCharge
3339 &AddIssuingCharge( $checkout, $charge, $type )
3343 sub AddIssuingCharge {
3344 my ( $checkout, $charge, $type ) = @_;
3346 # FIXME What if checkout does not exist?
3348 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3349 my $accountline = $account->add_debit(
3353 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3354 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3355 interface => C4::Context->interface,
3357 item_id => $checkout->itemnumber,
3358 issue_id => $checkout->issue_id,
3365 GetTransfers($itemnumber);
3370 my ($itemnumber) = @_;
3372 my $dbh = C4::Context->dbh;
3379 FROM branchtransfers
3380 WHERE itemnumber = ?
3381 AND datearrived IS NULL
3383 my $sth = $dbh->prepare($query);
3384 $sth->execute($itemnumber);
3385 my @row = $sth->fetchrow_array();
3389 =head2 GetTransfersFromTo
3391 @results = GetTransfersFromTo($frombranch,$tobranch);
3393 Returns the list of pending transfers between $from and $to branch
3397 sub GetTransfersFromTo {
3398 my ( $frombranch, $tobranch ) = @_;
3399 return unless ( $frombranch && $tobranch );
3400 my $dbh = C4::Context->dbh;
3402 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3403 FROM branchtransfers
3406 AND datearrived IS NULL
3408 my $sth = $dbh->prepare($query);
3409 $sth->execute( $frombranch, $tobranch );
3412 while ( my $data = $sth->fetchrow_hashref ) {
3413 push @gettransfers, $data;
3415 return (@gettransfers);
3418 =head2 DeleteTransfer
3420 &DeleteTransfer($itemnumber);
3424 sub DeleteTransfer {
3425 my ($itemnumber) = @_;
3426 return unless $itemnumber;
3427 my $dbh = C4::Context->dbh;
3428 my $sth = $dbh->prepare(
3429 "DELETE FROM branchtransfers
3431 AND datearrived IS NULL "
3433 return $sth->execute($itemnumber);
3436 =head2 SendCirculationAlert
3438 Send out a C<check-in> or C<checkout> alert using the messaging system.
3446 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3450 Hashref of information about the item being checked in or out.
3454 Hashref of information about the borrower of the item.
3458 The branchcode from where the checkout or check-in took place.
3464 SendCirculationAlert({
3467 borrower => $borrower,
3473 sub SendCirculationAlert {
3475 my ($type, $item, $borrower, $branch) =
3476 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3477 my %message_name = (
3478 CHECKIN => 'Item_Check_in',
3479 CHECKOUT => 'Item_Checkout',
3480 RENEWAL => 'Item_Checkout',
3482 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3483 borrowernumber => $borrower->{borrowernumber},
3484 message_name => $message_name{$type},
3486 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3488 my $schema = Koha::Database->new->schema;
3489 my @transports = keys %{ $borrower_preferences->{transports} };
3491 # From the MySQL doc:
3492 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3493 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3494 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3495 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3497 for my $mtt (@transports) {
3498 my $letter = C4::Letters::GetPreparedLetter (
3499 module => 'circulation',
3500 letter_code => $type,
3501 branchcode => $branch,
3502 message_transport_type => $mtt,
3503 lang => $borrower->{lang},
3505 $issues_table => $item->{itemnumber},
3506 'items' => $item->{itemnumber},
3507 'biblio' => $item->{biblionumber},
3508 'biblioitems' => $item->{biblionumber},
3509 'borrowers' => $borrower,
3510 'branches' => $branch,
3514 $schema->storage->txn_begin;
3515 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3516 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3517 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3518 unless ( $message ) {
3519 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3520 C4::Message->enqueue($letter, $borrower, $mtt);
3522 $message->append($letter);
3525 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3526 $schema->storage->txn_commit;
3532 =head2 updateWrongTransfer
3534 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3536 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
3540 sub updateWrongTransfer {
3541 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3542 my $dbh = C4::Context->dbh;
3543 # first step validate the actual line of transfert .
3546 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3548 $sth->execute($FromLibrary,$itemNumber);
3550 # second step create a new line of branchtransfer to the right location .
3551 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3553 #third step changing holdingbranch of item
3554 UpdateHoldingbranch($FromLibrary,$itemNumber);
3557 =head2 UpdateHoldingbranch
3559 $items = UpdateHoldingbranch($branch,$itmenumber);
3561 Simple methode for updating hodlingbranch in items BDD line
3565 sub UpdateHoldingbranch {
3566 my ( $branch,$itemnumber ) = @_;
3567 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3572 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3574 this function calculates the due date given the start date and configured circulation rules,
3575 checking against the holidays calendar as per the 'useDaysMode' syspref.
3576 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3577 C<$itemtype> = itemtype code of item in question
3578 C<$branch> = location whose calendar to use
3579 C<$borrower> = Borrower object
3580 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3585 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3589 # loanlength now a href
3591 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3593 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3599 if (ref $startdate ne 'DateTime' ) {
3600 $datedue = dt_from_string($datedue);
3602 $datedue = $startdate->clone;
3606 DateTime->now( time_zone => C4::Context->tz() )
3607 ->truncate( to => 'minute' );
3611 # calculate the datedue as normal
3612 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3613 { # ignoring calendar
3614 if ( $loanlength->{lengthunit} eq 'hours' ) {
3615 $datedue->add( hours => $loanlength->{$length_key} );
3617 $datedue->add( days => $loanlength->{$length_key} );
3618 $datedue->set_hour(23);
3619 $datedue->set_minute(59);
3623 if ($loanlength->{lengthunit} eq 'hours') {
3624 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3627 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3629 my $calendar = Koha::Calendar->new( branchcode => $branch );
3630 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3631 if ($loanlength->{lengthunit} eq 'days') {
3632 $datedue->set_hour(23);
3633 $datedue->set_minute(59);
3637 # if Hard Due Dates are used, retrieve them and apply as necessary
3638 my ( $hardduedate, $hardduedatecompare ) =
3639 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3640 if ($hardduedate) { # hardduedates are currently dates
3641 $hardduedate->truncate( to => 'minute' );
3642 $hardduedate->set_hour(23);
3643 $hardduedate->set_minute(59);
3644 my $cmp = DateTime->compare( $hardduedate, $datedue );
3646 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3647 # if the calculated date is before the 'after' Hard Due Date (floor), override
3648 # if the hard due date is set to 'exactly', overrride
3649 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3650 $datedue = $hardduedate->clone;
3653 # in all other cases, keep the date due as it is
3657 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3658 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3659 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3660 if( $expiry_dt ) { #skip empty expiry date..
3661 $expiry_dt->set( hour => 23, minute => 59);
3662 my $d1= $datedue->clone->set_time_zone('floating');
3663 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3664 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3667 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3668 my $calendar = Koha::Calendar->new( branchcode => $branch );
3669 if ( $calendar->is_holiday($datedue) ) {
3670 # Don't return on a closed day
3671 $datedue = $calendar->prev_open_days( $datedue, 1 );
3680 sub CheckValidBarcode{
3682 my $dbh = C4::Context->dbh;
3683 my $query=qq|SELECT count(*)
3687 my $sth = $dbh->prepare($query);
3688 $sth->execute($barcode);
3689 my $exist=$sth->fetchrow ;
3693 =head2 IsBranchTransferAllowed
3695 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3697 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3699 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3700 Koha::Item->can_be_transferred.
3704 sub IsBranchTransferAllowed {
3705 my ( $toBranch, $fromBranch, $code ) = @_;
3707 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3709 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3710 my $dbh = C4::Context->dbh;
3712 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3713 $sth->execute( $toBranch, $fromBranch, $code );
3714 my $limit = $sth->fetchrow_hashref();
3716 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3717 if ( $limit->{'limitId'} ) {
3724 =head2 CreateBranchTransferLimit
3726 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3728 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3730 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3734 sub CreateBranchTransferLimit {
3735 my ( $toBranch, $fromBranch, $code ) = @_;
3736 return unless defined($toBranch) && defined($fromBranch);
3737 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3739 my $dbh = C4::Context->dbh;
3741 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3742 return $sth->execute( $code, $toBranch, $fromBranch );
3745 =head2 DeleteBranchTransferLimits
3747 my $result = DeleteBranchTransferLimits($frombranch);
3749 Deletes all the library transfer limits for one library. Returns the
3750 number of limits deleted, 0e0 if no limits were deleted, or undef if
3751 no arguments are supplied.
3753 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3754 fromBranch => $fromBranch
3759 sub DeleteBranchTransferLimits {
3761 return unless defined $branch;
3762 my $dbh = C4::Context->dbh;
3763 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3764 return $sth->execute($branch);
3768 my ( $borrowernumber, $itemnum ) = @_;
3769 MarkIssueReturned( $borrowernumber, $itemnum );
3774 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3776 unless ( $mark_lost_from ) {
3777 # Temporary check to avoid regressions
3778 die q|LostItem called without $mark_lost_from, check the API.|;
3782 if ( $force_mark_returned ) {
3785 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3786 $mark_returned = ( $pref =~ m
|$mark_lost_from| );
3789 my $dbh = C4
::Context
->dbh();
3790 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3792 JOIN items USING (itemnumber)
3793 JOIN biblio USING (biblionumber)
3794 WHERE issues.itemnumber=?");
3795 $sth->execute($itemnumber);
3796 my $issues=$sth->fetchrow_hashref();
3798 # If a borrower lost the item, add a replacement cost to the their record
3799 if ( my $borrowernumber = $issues->{borrowernumber
} ){
3800 my $patron = Koha
::Patrons
->find( $borrowernumber );
3802 my $fix = _FixOverduesOnReturn
($borrowernumber, $itemnumber, C4
::Context
->preference('WhenLostForgiveFine'), 'LOST');
3803 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3805 if (C4
::Context
->preference('WhenLostChargeReplacementFee')){
3806 C4
::Accounts
::chargelostitem
(
3809 $issues->{'replacementprice'},
3810 sprintf( "%s %s %s",
3811 $issues->{'title'} || q{},
3812 $issues->{'barcode'} || q{},
3813 $issues->{'itemcallnumber'} || q{},
3816 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3817 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3820 MarkIssueReturned
($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3823 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3824 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers
($itemnumber)) {
3825 ModItem
({holdingbranch
=> $frombranch}, undef, $itemnumber);
3827 my $transferdeleted = DeleteTransfer
($itemnumber);
3830 sub GetOfflineOperations
{
3831 my $dbh = C4
::Context
->dbh;
3832 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3833 $sth->execute(C4
::Context
->userenv->{'branch'});
3834 my $results = $sth->fetchall_arrayref({});
3838 sub GetOfflineOperation
{
3839 my $operationid = shift;
3840 return unless $operationid;
3841 my $dbh = C4
::Context
->dbh;
3842 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3843 $sth->execute( $operationid );
3844 return $sth->fetchrow_hashref;
3847 sub AddOfflineOperation
{
3848 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3849 my $dbh = C4
::Context
->dbh;
3850 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3851 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3855 sub DeleteOfflineOperation
{
3856 my $dbh = C4
::Context
->dbh;
3857 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3858 $sth->execute( shift );
3862 sub ProcessOfflineOperation
{
3863 my $operation = shift;
3866 if ( $operation->{action
} eq 'return' ) {
3867 $report = ProcessOfflineReturn
( $operation );
3868 } elsif ( $operation->{action
} eq 'issue' ) {
3869 $report = ProcessOfflineIssue
( $operation );
3870 } elsif ( $operation->{action
} eq 'payment' ) {
3871 $report = ProcessOfflinePayment
( $operation );
3874 DeleteOfflineOperation
( $operation->{operationid
} ) if $operation->{operationid
};
3879 sub ProcessOfflineReturn
{
3880 my $operation = shift;
3882 my $item = Koha
::Items
->find({barcode
=> $operation->{barcode
}});
3885 my $itemnumber = $item->itemnumber;
3886 my $issue = GetOpenIssue
( $itemnumber );
3889 $issue->{borrowernumber
},
3891 $operation->{timestamp
},
3894 { renewals
=> 0, onloan
=> undef },
3895 $issue->{'biblionumber'},
3901 return "Item not issued.";
3904 return "Item not found.";
3908 sub ProcessOfflineIssue
{
3909 my $operation = shift;
3911 my $patron = Koha
::Patrons
->find( { cardnumber
=> $operation->{cardnumber
} } );
3914 my $item = Koha
::Items
->find({ barcode
=> $operation->{barcode
} });
3916 return "Barcode not found.";
3918 my $itemnumber = $item->itemnumber;
3919 my $issue = GetOpenIssue
( $itemnumber );
3921 if ( $issue and ( $issue->{borrowernumber
} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3923 $issue->{borrowernumber
},
3925 $operation->{timestamp
},
3930 $operation->{'barcode'},
3933 $operation->{timestamp
},
3938 return "Borrower not found.";
3942 sub ProcessOfflinePayment
{
3943 my $operation = shift;
3945 my $patron = Koha
::Patrons
->find({ cardnumber
=> $operation->{cardnumber
} });
3947 $patron->account->pay(
3949 amount
=> $operation->{amount
},
3950 library_id
=> $operation->{branchcode
},
3960 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3962 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3967 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3971 ? Koha
::Items
->find($itemnumber)
3972 : Koha
::Items
->find( { barcode
=> $barcode } );
3976 return C4
::Letters
::GetPreparedLetter
(
3977 module
=> 'circulation',
3978 letter_code
=> 'TRANSFERSLIP',
3979 branchcode
=> $branch,
3981 'branches' => $to_branch,
3982 'biblio' => $item->biblionumber,
3983 'items' => $item->unblessed,
3988 =head2 CheckIfIssuedToPatron
3990 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3992 Return 1 if any record item is issued to patron, otherwise return 0
3996 sub CheckIfIssuedToPatron
{
3997 my ($borrowernumber, $biblionumber) = @_;
3999 my $dbh = C4
::Context
->dbh;
4001 SELECT COUNT
(*) FROM issues
4002 LEFT JOIN items ON items
.itemnumber
= issues
.itemnumber
4003 WHERE items
.biblionumber
= ?
4004 AND issues
.borrowernumber
= ?
4006 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4007 return 1 if $is_issued;
4013 IsItemIssued( $itemnumber )
4015 Return 1 if the item is on loan, otherwise return 0
4020 my $itemnumber = shift;
4021 my $dbh = C4
::Context
->dbh;
4022 my $sth = $dbh->prepare(q{
4025 WHERE itemnumber = ?
4027 $sth->execute($itemnumber);
4028 return $sth->fetchrow;
4031 =head2 GetAgeRestriction
4033 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4034 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4036 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4037 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4039 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4040 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4041 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4042 Negative days mean the borrower has gone past the age restriction age.
4046 sub GetAgeRestriction
{
4047 my ($record_restrictions, $borrower) = @_;
4048 my $markers = C4
::Context
->preference('AgeRestrictionMarker');
4050 return unless $record_restrictions;
4051 # Split $record_restrictions to something like FSK 16 or PEGI 6
4052 my @values = split ' ', uc($record_restrictions);
4053 return unless @values;
4055 # Search first occurrence of one of the markers
4056 my @markers = split /\|/, uc($markers);
4057 return unless @markers;
4060 my $restriction_year = 0;
4061 for my $value (@values) {
4063 for my $marker (@markers) {
4064 $marker =~ s/^\s+//; #remove leading spaces
4065 $marker =~ s/\s+$//; #remove trailing spaces
4066 if ( $marker eq $value ) {
4067 if ( $index <= $#values ) {
4068 $restriction_year += $values[$index];
4072 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4074 # Perhaps it is something like "K16" (as in Finland)
4075 $restriction_year += $1;
4079 last if ( $restriction_year > 0 );
4082 #Check if the borrower is age restricted for this material and for how long.
4083 if ($restriction_year && $borrower) {
4084 if ( $borrower->{'dateofbirth'} ) {
4085 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4086 $alloweddate[0] += $restriction_year;
4088 #Prevent runime eror on leap year (invalid date)
4089 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4090 $alloweddate[2] = 28;
4093 #Get how many days the borrower has to reach the age restriction
4094 my @Today = split /-/, DateTime
->today->ymd();
4095 my $daysToAgeRestriction = Date_to_Days
(@alloweddate) - Date_to_Days
(@Today);
4096 #Negative days means the borrower went past the age restriction age
4097 return ($restriction_year, $daysToAgeRestriction);
4101 return ($restriction_year);
4105 =head2 GetPendingOnSiteCheckouts
4109 sub GetPendingOnSiteCheckouts
{
4110 my $dbh = C4
::Context
->dbh;
4111 return $dbh->selectall_arrayref(q
|
4117 items
.itemcallnumber
,
4121 issues
.date_due
< NOW
() AS is_overdue
,
4124 borrowers
.firstname
,
4126 borrowers
.cardnumber
,
4127 borrowers
.borrowernumber
4129 LEFT JOIN issues ON items
.itemnumber
= issues
.itemnumber
4130 LEFT JOIN biblio ON items
.biblionumber
= biblio
.biblionumber
4131 LEFT JOIN borrowers ON issues
.borrowernumber
= borrowers
.borrowernumber
4132 WHERE issues
.onsite_checkout
= 1
4133 |, { Slice
=> {} } );
4139 my ($count, $branch, $itemtype, $ccode, $newness)
4140 = @
$params{qw(count branch itemtype ccode newness)};
4142 my $dbh = C4
::Context
->dbh;
4145 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4146 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4147 i.ccode, SUM(i.issues) AS count
4149 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4150 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4153 my (@where_strs, @where_args);
4156 push @where_strs, 'i.homebranch = ?';
4157 push @where_args, $branch;
4160 if (C4
::Context
->preference('item-level_itypes')){
4161 push @where_strs, 'i.itype = ?';
4162 push @where_args, $itemtype;
4164 push @where_strs, 'bi.itemtype = ?';
4165 push @where_args, $itemtype;
4169 push @where_strs, 'i.ccode = ?';
4170 push @where_args, $ccode;
4173 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4174 push @where_args, $newness;
4178 $query .= 'WHERE ' . join(' AND ', @where_strs);
4182 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4183 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4188 $query .= q{ ) xxx WHERE count > 0 };
4189 $count = int($count);
4191 $query .= "LIMIT $count";
4194 my $rows = $dbh->selectall_arrayref($query, { Slice
=> {} }, @where_args);
4199 sub _CalculateAndUpdateFine
{
4202 my $borrower = $params->{borrower
};
4203 my $item = $params->{item
};
4204 my $issue = $params->{issue
};
4205 my $return_date = $params->{return_date
};
4207 unless ($borrower) { carp
"No borrower passed in!" && return; }
4208 unless ($item) { carp
"No item passed in!" && return; }
4209 unless ($issue) { carp
"No issue passed in!" && return; }
4211 my $datedue = dt_from_string
( $issue->date_due );
4213 # we only need to calculate and change the fines if we want to do that on return
4214 # Should be on for hourly loans
4215 my $control = C4
::Context
->preference('CircControl');
4216 my $control_branchcode =
4217 ( $control eq 'ItemHomeLibrary' ) ?
$item->{homebranch
}
4218 : ( $control eq 'PatronLibrary' ) ?
$borrower->{branchcode
}
4219 : $issue->branchcode;
4221 my $date_returned = $return_date ?
$return_date : dt_from_string
();
4223 my ( $amount, $unitcounttotal, $unitcount ) =
4224 C4
::Overdues
::CalcFine
( $item, $borrower->{categorycode
}, $control_branchcode, $datedue, $date_returned );
4226 if ( C4
::Context
->preference('finesMode') eq 'production' ) {
4227 if ( $amount > 0 ) {
4228 C4
::Overdues
::UpdateFine
({
4229 issue_id
=> $issue->issue_id,
4230 itemnumber
=> $issue->itemnumber,
4231 borrowernumber
=> $issue->borrowernumber,
4233 due
=> output_pref
($datedue),
4236 elsif ($return_date) {
4238 # Backdated returns may have fines that shouldn't exist,
4239 # so in this case, we need to drop those fines to 0
4241 C4
::Overdues
::UpdateFine
({
4242 issue_id
=> $issue->issue_id,
4243 itemnumber
=> $issue->itemnumber,
4244 borrowernumber
=> $issue->borrowernumber,
4246 due
=> output_pref
($datedue),
4252 sub _item_denied_renewal
{
4255 my $item = $params->{item
};
4256 return unless $item;
4258 my $denyingrules = Koha
::Config
::SysPrefs
->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4259 return unless $denyingrules;
4260 foreach my $field (keys %$denyingrules) {
4261 my $val = $item->$field;
4262 if( !defined $val) {
4263 if ( any
{ !defined $_ } @
{$denyingrules->{$field}} ){
4266 } elsif (any
{ defined($_) && $val eq $_ } @
{$denyingrules->{$field}}) {
4267 # If the results matches the values in the syspref
4268 # We return true if match found
4282 Koha Development Team <http://koha-community.org/>