1 package C4
::Circulation
;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 #use warnings; FIXME - Bug 2505
25 use POSIX
qw( floor );
34 use C4
::ItemCirculationAlertPreference
;
37 use C4
::Log
; # logaction
38 use C4
::Overdues
qw(CalcFine UpdateFine get_chargeable_units);
39 use C4
::RotatingCollections
qw(GetCollectionItemBranches);
40 use Algorithm
::CheckDigits
;
44 use Koha
::AuthorisedValues
;
45 use Koha
::Biblioitems
;
49 use Koha
::IssuingRules
;
52 use Koha
::Patron
::Debarments
;
55 use Koha
::Account
::Lines
;
57 use Koha
::RefundLostItemFeeRules
;
58 use Koha
::Account
::Lines
;
59 use Koha
::Account
::Offsets
;
60 use Koha
::Config
::SysPrefs
;
61 use Koha
::Charges
::Fees
;
62 use Koha
::Util
::SystemPreferences
;
64 use List
::MoreUtils
qw( uniq any );
65 use Scalar
::Util
qw( looks_like_number );
75 use vars
qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
81 # FIXME subs that should probably be elsewhere
86 &GetPendingOnSiteCheckouts
89 # subs to deal with issuing a book
97 &GetLatestAutoRenewDate
99 &GetBranchBorrowerCircRule
103 &CheckIfIssuedToPatron
108 # subs to deal with returns
114 # subs to deal with transfers
121 &IsBranchTransferAllowed
122 &CreateBranchTransferLimit
123 &DeleteBranchTransferLimits
127 # subs to deal with offline circulation
129 &GetOfflineOperations
132 &DeleteOfflineOperation
133 &ProcessOfflineOperation
139 C4::Circulation - Koha circulation module
147 The functions in this module deal with circulation, issues, and
148 returns, as well as general information about the library.
149 Also deals with inventory.
155 $str = &barcodedecode($barcode, [$filter]);
157 Generic filter function for barcode string.
158 Called on every circ if the System Pref itemBarcodeInputFilter is set.
159 Will do some manipulation of the barcode for systems that deliver a barcode
160 to circulation.pl that differs from the barcode stored for the item.
161 For proper functioning of this filter, calling the function on the
162 correct barcode string (items.barcode) should return an unaltered barcode.
164 The optional $filter argument is to allow for testing or explicit
165 behavior that ignores the System Pref. Valid values are the same as the
170 # FIXME -- the &decode fcn below should be wrapped into this one.
171 # FIXME -- these plugins should be moved out of Circulation.pm
174 my ($barcode, $filter) = @_;
175 my $branch = C4
::Context
::mybranch
();
176 $filter = C4
::Context
->preference('itemBarcodeInputFilter') unless $filter;
177 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
178 if ($filter eq 'whitespace') {
180 } elsif ($filter eq 'cuecat') {
182 my @fields = split( /\./, $barcode );
183 my @results = map( decode
($_), @fields[ 1 .. $#fields ] );
184 ($#results == 2) and return $results[2];
185 } elsif ($filter eq 'T-prefix') {
186 if ($barcode =~ /^[Tt](\d)/) {
187 (defined($1) and $1 eq '0') and return $barcode;
188 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
190 return sprintf("T%07d", $barcode);
191 # FIXME: $barcode could be "T1", causing warning: substr outside of string
192 # Why drop the nonzero digit after the T?
193 # Why pass non-digits (or empty string) to "T%07d"?
194 } elsif ($filter eq 'libsuite8') {
195 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
196 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
197 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
199 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
202 } elsif ($filter eq 'EAN13') {
203 my $ean = CheckDigits
('ean');
204 if ( $ean->is_valid($barcode) ) {
205 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
206 $barcode = '0' x
( 13 - length($barcode) ) . $barcode;
208 warn "# [$barcode] not valid EAN-13/UPC-A\n";
211 return $barcode; # return barcode, modified or not
216 $str = &decode($chunk);
218 Decodes a segment of a string emitted by a CueCat barcode scanner and
221 FIXME: Should be replaced with Barcode::Cuecat from CPAN
222 or Javascript based decoding on the client side.
229 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
230 my @s = map { index( $seq, $_ ); } split( //, $encoded );
231 my $l = ( $#s + 1 ) % 4;
234 # warn "Error: Cuecat decode parsing failed!";
242 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
244 chr( ( $n >> 16 ) ^ 67 )
245 .chr( ( $n >> 8 & 255 ) ^ 67 )
246 .chr( ( $n & 255 ) ^ 67 );
249 $r = substr( $r, 0, length($r) - $l );
255 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
256 $barcode, $ignore_reserves);
258 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
260 C<$newbranch> is the code for the branch to which the item should be transferred.
262 C<$barcode> is the barcode of the item to be transferred.
264 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
265 Otherwise, if an item is reserved, the transfer fails.
267 Returns three values:
273 is true if the transfer was successful.
277 is a reference-to-hash which may have any of the following keys:
283 There is no item in the catalog with the given barcode. The value is C<$barcode>.
285 =item C<DestinationEqualsHolding>
287 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.
291 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.
295 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>.
297 =item C<WasTransferred>
299 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
308 my ( $tbr, $barcode, $ignoreRs ) = @_;
311 my $item = Koha
::Items
->find( { barcode
=> $barcode } );
315 $messages->{'BadBarcode'} = $barcode;
317 return ( $dotransfer, $messages );
320 my $itemnumber = $item->itemnumber;
321 my $issue = GetOpenIssue
($itemnumber);
322 # get branches of book...
323 my $hbr = $item->homebranch;
324 my $fbr = $item->holdingbranch;
326 # if using Branch Transfer Limits
327 if ( C4
::Context
->preference("UseBranchTransferLimits") == 1 ) {
328 my $code = C4
::Context
->preference("BranchTransferLimitsType") eq 'ccode' ?
$item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
329 if ( C4
::Context
->preference("item-level_itypes") && C4
::Context
->preference("BranchTransferLimitsType") eq 'itemtype' ) {
330 if ( ! IsBranchTransferAllowed
( $tbr, $fbr, $item->itype ) ) {
331 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
334 } elsif ( ! IsBranchTransferAllowed
( $tbr, $fbr, $code ) ) {
335 $messages->{'NotAllowed'} = $tbr . "::" . $code;
340 # can't transfer book if is already there....
341 if ( $fbr eq $tbr ) {
342 $messages->{'DestinationEqualsHolding'} = 1;
346 # check if it is still issued to someone, return it...
348 AddReturn
( $barcode, $fbr );
349 $messages->{'WasReturned'} = $issue->borrowernumber;
353 # That'll save a database query.
354 my ( $resfound, $resrec, undef ) =
355 CheckReserves
( $itemnumber );
356 if ( $resfound and not $ignoreRs ) {
357 $resrec->{'ResFound'} = $resfound;
359 # $messages->{'ResFound'} = $resrec;
363 #actually do the transfer....
365 ModItemTransfer
( $itemnumber, $fbr, $tbr );
367 # don't need to update MARC anymore, we do it in batch now
368 $messages->{'WasTransfered'} = 1;
371 ModDateLastSeen
( $itemnumber );
372 return ( $dotransfer, $messages );
377 my $borrower = shift;
378 my $item_object = shift;
380 my $onsite_checkout = $params->{onsite_checkout
} || 0;
381 my $switch_onsite_checkout = $params->{switch_onsite_checkout
} || 0;
382 my $cat_borrower = $borrower->{'categorycode'};
383 my $dbh = C4
::Context
->dbh;
385 # Get which branchcode we need
386 $branch = _GetCircControlBranch
($item_object->unblessed,$borrower);
387 my $type = $item_object->effective_itemtype;
389 # given branch, patron category, and item type, determine
390 # applicable issuing rule
391 my $maxissueqty_rule = Koha
::CirculationRules
->get_effective_rule(
393 categorycode
=> $cat_borrower,
395 branchcode
=> $branch,
396 rule_name
=> 'maxissueqty',
399 my $maxonsiteissueqty_rule = Koha
::CirculationRules
->get_effective_rule(
401 categorycode
=> $cat_borrower,
403 branchcode
=> $branch,
404 rule_name
=> 'maxonsiteissueqty',
409 # if a rule is found and has a loan limit set, count
410 # how many loans the patron already has that meet that
412 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne '') {
415 SELECT COUNT
(*) AS total
, COALESCE
(SUM
(onsite_checkout
), 0) AS onsite_checkouts
417 JOIN items USING
(itemnumber
)
420 my $rule_itemtype = $maxissueqty_rule->itemtype;
421 unless ($rule_itemtype) {
422 # matching rule has the default item type, so count only
423 # those existing loans that don't fall under a more
425 if (C4
::Context
->preference('item-level_itypes')) {
426 $count_query .= " WHERE items.itype NOT IN (
427 SELECT itemtype FROM issuingrules
429 AND (categorycode = ? OR categorycode = ?)
433 $count_query .= " JOIN biblioitems USING (biblionumber)
434 WHERE biblioitems.itemtype NOT IN (
435 SELECT itemtype FROM issuingrules
437 AND (categorycode = ? OR categorycode = ?)
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 defined $max_onsite_checkouts_allowed ) {
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 my $branch = $circ_library;
711 $duedate = CalcDateDue
( $issuedate, $effective_itemtype, $branch, $patron_unblessed );
713 # Offline circ calls AddIssue directly, doesn't run through here
714 # So issuingimpossible should be ok.
717 my $fees = Koha
::Charges
::Fees
->new(
720 library
=> $circ_library,
721 item
=> $item_object,
727 my $today = $now->clone();
728 $today->truncate( to
=> 'minute');
729 if (DateTime
->compare($duedate,$today) == -1 ) { # duedate cannot be before now
730 $needsconfirmation{INVALID_DATE
} = output_pref
($duedate);
733 $issuingimpossible{INVALID_DATE
} = output_pref
($duedate);
739 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
740 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
742 branch
=> C4
::Context
->userenv->{'branch'},
744 itemnumber
=> $item_object->itemnumber,
745 itemtype
=> $effective_itemtype,
746 borrowernumber
=> $patron->borrowernumber,
747 ccode
=> $item_object->ccode}
749 ModDateLastSeen
( $item_object->itemnumber ); # FIXME Move to Koha::Item
750 return( { STATS
=> 1 }, {});
753 if ( $patron->gonenoaddress == 1 ) {
754 $issuingimpossible{GNA
} = 1;
757 if ( $patron->lost == 1 ) {
758 $issuingimpossible{CARD_LOST
} = 1;
760 if ( $patron->is_debarred ) {
761 $issuingimpossible{DEBARRED
} = 1;
764 if ( $patron->is_expired ) {
765 $issuingimpossible{EXPIRED
} = 1;
773 my $account = $patron->account;
774 my $balance = $account->balance;
775 my $non_issues_charges = $account->non_issues_charges;
776 my $other_charges = $balance - $non_issues_charges;
778 my $amountlimit = C4
::Context
->preference("noissuescharge");
779 my $allowfineoverride = C4
::Context
->preference("AllowFineOverride");
780 my $allfinesneedoverride = C4
::Context
->preference("AllFinesNeedOverride");
782 # Check the debt of this patrons guarantees
783 my $no_issues_charge_guarantees = C4
::Context
->preference("NoIssuesChargeGuarantees");
784 $no_issues_charge_guarantees = undef unless looks_like_number
( $no_issues_charge_guarantees );
785 if ( defined $no_issues_charge_guarantees ) {
786 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
787 my $guarantees_non_issues_charges;
788 foreach my $g ( @guarantees ) {
789 $guarantees_non_issues_charges += $g->account->non_issues_charges;
792 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
793 $issuingimpossible{DEBT_GUARANTEES
} = $guarantees_non_issues_charges;
794 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
795 $needsconfirmation{DEBT_GUARANTEES
} = $guarantees_non_issues_charges;
796 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
797 $needsconfirmation{DEBT_GUARANTEES
} = $guarantees_non_issues_charges;
801 if ( C4
::Context
->preference("IssuingInProcess") ) {
802 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
803 $issuingimpossible{DEBT
} = $non_issues_charges;
804 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
805 $needsconfirmation{DEBT
} = $non_issues_charges;
806 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
807 $needsconfirmation{DEBT
} = $non_issues_charges;
811 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
812 $needsconfirmation{DEBT
} = $non_issues_charges;
813 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
814 $issuingimpossible{DEBT
} = $non_issues_charges;
815 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
816 $needsconfirmation{DEBT
} = $non_issues_charges;
820 if ($balance > 0 && $other_charges > 0) {
821 $alerts{OTHER_CHARGES
} = sprintf( "%.2f", $other_charges );
824 $patron = Koha
::Patrons
->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
825 $patron_unblessed = $patron->unblessed;
827 if ( my $debarred_date = $patron->is_debarred ) {
828 # patron has accrued fine days or has a restriction. $count is a date
829 if ($debarred_date eq '9999-12-31') {
830 $issuingimpossible{USERBLOCKEDNOENDDATE
} = $debarred_date;
833 $issuingimpossible{USERBLOCKEDWITHENDDATE
} = $debarred_date;
835 } elsif ( my $num_overdues = $patron->has_overdues ) {
836 ## patron has outstanding overdue loans
837 if ( C4
::Context
->preference("OverduesBlockCirc") eq 'block'){
838 $issuingimpossible{USERBLOCKEDOVERDUE
} = $num_overdues;
840 elsif ( C4
::Context
->preference("OverduesBlockCirc") eq 'confirmation'){
841 $needsconfirmation{USERBLOCKEDOVERDUE
} = $num_overdues;
846 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
848 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
850 # Already issued to current borrower.
851 # If it is an on-site checkout if it can be switched to a normal checkout
852 # or ask whether the loan should be renewed
854 if ( $issue->onsite_checkout
855 and C4
::Context
->preference('SwitchOnSiteCheckouts') ) {
856 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED
} = 1;
858 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed
(
859 $patron->borrowernumber,
860 $item_object->itemnumber,
862 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
863 if ( $renewerror eq 'onsite_checkout' ) {
864 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS
} = 1;
867 $issuingimpossible{NO_MORE_RENEWALS
} = 1;
871 $needsconfirmation{RENEW_ISSUE
} = 1;
877 # issued to someone else
879 my $patron = Koha
::Patrons
->find( $issue->borrowernumber );
881 my ( $can_be_returned, $message ) = CanBookBeReturned
( $item_unblessed, C4
::Context
->userenv->{branch
} );
883 unless ( $can_be_returned ) {
884 $issuingimpossible{RETURN_IMPOSSIBLE
} = 1;
885 $issuingimpossible{branch_to_return
} = $message;
887 if ( C4
::Context
->preference('AutoReturnCheckedOutItems') ) {
888 $alerts{RETURNED_FROM_ANOTHER
} = { patron
=> $patron };
890 $needsconfirmation{ISSUED_TO_ANOTHER
} = 1;
891 $needsconfirmation{issued_firstname
} = $patron->firstname;
892 $needsconfirmation{issued_surname
} = $patron->surname;
893 $needsconfirmation{issued_cardnumber
} = $patron->cardnumber;
894 $needsconfirmation{issued_borrowernumber
} = $patron->borrowernumber;
899 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
901 my $switch_onsite_checkout = (
902 C4
::Context
->preference('SwitchOnSiteCheckouts')
904 and $issue->onsite_checkout
905 and $issue->borrowernumber == $patron->borrowernumber ?
1 : 0 );
906 my $toomany = TooMany
( $patron_unblessed, $item_object, { onsite_checkout
=> $onsite_checkout, switch_onsite_checkout
=> $switch_onsite_checkout, } );
907 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
908 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE
} ) {
909 if ( $toomany->{max_allowed
} == 0 ) {
910 $needsconfirmation{PATRON_CANT
} = 1;
912 if ( C4
::Context
->preference("AllowTooManyOverride") ) {
913 $needsconfirmation{TOO_MANY
} = $toomany->{reason
};
914 $needsconfirmation{current_loan_count
} = $toomany->{count
};
915 $needsconfirmation{max_loans_allowed
} = $toomany->{max_allowed
};
917 $issuingimpossible{TOO_MANY
} = $toomany->{reason
};
918 $issuingimpossible{current_loan_count
} = $toomany->{count
};
919 $issuingimpossible{max_loans_allowed
} = $toomany->{max_allowed
};
924 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
926 $patron = Koha
::Patrons
->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
927 my $wants_check = $patron->wants_check_for_previous_checkout;
928 $needsconfirmation{PREVISSUE
} = 1
929 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
934 if ( $item_object->notforloan )
936 if(!C4
::Context
->preference("AllowNotForLoanOverride")){
937 $issuingimpossible{NOT_FOR_LOAN
} = 1;
938 $issuingimpossible{item_notforloan
} = $item_object->notforloan;
940 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
941 $needsconfirmation{item_notforloan
} = $item_object->notforloan;
945 # we have to check itemtypes.notforloan also
946 if (C4
::Context
->preference('item-level_itypes')){
947 # this should probably be a subroutine
948 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
949 $sth->execute($effective_itemtype);
950 my $notforloan=$sth->fetchrow_hashref();
951 if ($notforloan->{'notforloan'}) {
952 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
953 $issuingimpossible{NOT_FOR_LOAN
} = 1;
954 $issuingimpossible{itemtype_notforloan
} = $effective_itemtype;
956 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
957 $needsconfirmation{itemtype_notforloan
} = $effective_itemtype;
962 my $itemtype = Koha
::ItemTypes
->find($biblioitem->itemtype);
963 if ( $itemtype and $itemtype->notforloan == 1){
964 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
965 $issuingimpossible{NOT_FOR_LOAN
} = 1;
966 $issuingimpossible{itemtype_notforloan
} = $effective_itemtype;
968 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
969 $needsconfirmation{itemtype_notforloan
} = $effective_itemtype;
974 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
976 $issuingimpossible{WTHDRAWN
} = 1;
978 if ( $item_object->restricted
979 && $item_object->restricted == 1 )
981 $issuingimpossible{RESTRICTED
} = 1;
983 if ( $item_object->itemlost && C4
::Context
->preference("IssueLostItem") ne 'nothing' ) {
984 my $av = Koha
::AuthorisedValues
->search({ category
=> 'LOST', authorised_value
=> $item_object->itemlost });
985 my $code = $av->count ?
$av->next->lib : '';
986 $needsconfirmation{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'confirm' );
987 $alerts{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'alert' );
989 if ( C4
::Context
->preference("IndependentBranches") ) {
990 my $userenv = C4
::Context
->userenv;
991 unless ( C4
::Context
->IsSuperLibrarian() ) {
992 my $HomeOrHoldingBranch = C4
::Context
->preference("HomeOrHoldingBranch");
993 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch
} ){
994 $issuingimpossible{ITEMNOTSAMEBRANCH
} = 1;
995 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
997 $needsconfirmation{BORRNOTSAMEBRANCH
} = $patron->branchcode
998 if ( $patron->branchcode ne $userenv->{branch
} );
1002 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1004 my $rentalConfirmation = C4
::Context
->preference("RentalFeesCheckoutConfirmation");
1006 if ( $rentalConfirmation ){
1007 my ($rentalCharge) = GetIssuingCharges
( $item_object->itemnumber, $patron->borrowernumber );
1008 my $itemtype = Koha
::ItemTypes
->find( $item_object->itype ); # GetItem sets effective itemtype
1009 $rentalCharge += $fees->accumulate_rentalcharge({ from
=> dt_from_string
(), to
=> $duedate });
1010 if ( $rentalCharge > 0 ){
1011 $needsconfirmation{RENTALCHARGE
} = $rentalCharge;
1015 unless ( $ignore_reserves ) {
1016 # See if the item is on reserve.
1017 my ( $restype, $res ) = C4
::Reserves
::CheckReserves
( $item_object->itemnumber );
1019 my $resbor = $res->{'borrowernumber'};
1020 if ( $resbor ne $patron->borrowernumber ) {
1021 my $patron = Koha
::Patrons
->find( $resbor );
1022 if ( $restype eq "Waiting" )
1024 # The item is on reserve and waiting, but has been
1025 # reserved by some other patron.
1026 $needsconfirmation{RESERVE_WAITING
} = 1;
1027 $needsconfirmation{'resfirstname'} = $patron->firstname;
1028 $needsconfirmation{'ressurname'} = $patron->surname;
1029 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1030 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1031 $needsconfirmation{'resbranchcode'} = $res->{branchcode
};
1032 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1034 elsif ( $restype eq "Reserved" ) {
1035 # The item is on reserve for someone else.
1036 $needsconfirmation{RESERVED
} = 1;
1037 $needsconfirmation{'resfirstname'} = $patron->firstname;
1038 $needsconfirmation{'ressurname'} = $patron->surname;
1039 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1040 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1041 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1042 $needsconfirmation{'resreservedate'} = $res->{reservedate
};
1048 ## CHECK AGE RESTRICTION
1049 my $agerestriction = $biblioitem->agerestriction;
1050 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction
( $agerestriction, $patron->unblessed );
1051 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1052 if ( C4
::Context
->preference('AgeRestrictionOverride') ) {
1053 $needsconfirmation{AGE_RESTRICTION
} = "$agerestriction";
1056 $issuingimpossible{AGE_RESTRICTION
} = "$agerestriction";
1060 ## check for high holds decreasing loan period
1061 if ( C4
::Context
->preference('decreaseLoanHighHolds') ) {
1062 my $check = checkHighHolds
( $item_unblessed, $patron_unblessed );
1064 if ( $check->{exceeded
} ) {
1065 if ($override_high_holds) {
1066 $alerts{HIGHHOLDS
} = {
1067 num_holds
=> $check->{outstanding
},
1068 duration
=> $check->{duration
},
1069 returndate
=> output_pref
( { dt
=> dt_from_string
($check->{due_date
}), dateformat
=> 'iso', timeformat
=> '24hr' }),
1073 $needsconfirmation{HIGHHOLDS
} = {
1074 num_holds
=> $check->{outstanding
},
1075 duration
=> $check->{duration
},
1076 returndate
=> output_pref
( { dt
=> dt_from_string
($check->{due_date
}), dateformat
=> 'iso', timeformat
=> '24hr' }),
1083 !C4
::Context
->preference('AllowMultipleIssuesOnABiblio') &&
1084 # don't do the multiple loans per bib check if we've
1085 # already determined that we've got a loan on the same item
1086 !$issuingimpossible{NO_MORE_RENEWALS
} &&
1087 !$needsconfirmation{RENEW_ISSUE
}
1089 # Check if borrower has already issued an item from the same biblio
1090 # Only if it's not a subscription
1091 my $biblionumber = $item_object->biblionumber;
1092 require C4
::Serials
;
1093 my $is_a_subscription = C4
::Serials
::CountSubscriptionFromBiblionumber
($biblionumber);
1094 unless ($is_a_subscription) {
1095 # FIXME Should be $patron->checkouts($args);
1096 my $checkouts = Koha
::Checkouts
->search(
1098 borrowernumber
=> $patron->borrowernumber,
1099 biblionumber
=> $biblionumber,
1105 # if we get here, we don't already have a loan on this item,
1106 # so if there are any loans on this bib, ask for confirmation
1107 if ( $checkouts->count ) {
1108 $needsconfirmation{BIBLIO_ALREADY_ISSUED
} = 1;
1113 return ( \
%issuingimpossible, \
%needsconfirmation, \
%alerts, \
%messages, );
1116 =head2 CanBookBeReturned
1118 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1120 Check whether the item can be returned to the provided branch
1124 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1126 =item C<$branch> is the branchcode where the return is taking place
1134 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1136 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1142 sub CanBookBeReturned
{
1143 my ($item, $branch) = @_;
1144 my $allowreturntobranch = C4
::Context
->preference("AllowReturnToBranch") || 'anywhere';
1146 # assume return is allowed to start
1150 # identify all cases where return is forbidden
1151 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1153 $message = $item->{'homebranch'};
1154 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1156 $message = $item->{'holdingbranch'};
1157 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1159 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1162 return ($allowed, $message);
1165 =head2 CheckHighHolds
1167 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1168 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1169 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1173 sub checkHighHolds
{
1174 my ( $item, $borrower ) = @_;
1175 my $branch = _GetCircControlBranch
( $item, $borrower );
1176 my $item_object = Koha
::Items
->find( $item->{itemnumber
} );
1185 my $holds = Koha
::Holds
->search( { biblionumber
=> $item->{'biblionumber'} } );
1187 if ( $holds->count() ) {
1188 $return_data->{outstanding
} = $holds->count();
1190 my $decreaseLoanHighHoldsControl = C4
::Context
->preference('decreaseLoanHighHoldsControl');
1191 my $decreaseLoanHighHoldsValue = C4
::Context
->preference('decreaseLoanHighHoldsValue');
1192 my $decreaseLoanHighHoldsIgnoreStatuses = C4
::Context
->preference('decreaseLoanHighHoldsIgnoreStatuses');
1194 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1196 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1198 # static means just more than a given number of holds on the record
1200 # If the number of holds is less than the threshold, we can stop here
1201 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1202 return $return_data;
1205 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1207 # dynamic means X more than the number of holdable items on the record
1209 # let's get the items
1210 my @items = $holds->next()->biblio()->items()->as_list;
1212 # Remove any items with status defined to be ignored even if the would not make item unholdable
1213 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1214 @items = grep { !$_->$status } @items;
1217 # Remove any items that are not holdable for this patron
1218 @items = grep { CanItemBeReserved
( $borrower->{borrowernumber
}, $_->itemnumber )->{status
} eq 'OK' } @items;
1220 my $items_count = scalar @items;
1222 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1224 # If the number of holds is less than the count of items we have
1225 # plus the number of holds allowed above that count, we can stop here
1226 if ( $holds->count() <= $threshold ) {
1227 return $return_data;
1231 my $issuedate = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1233 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
1235 my $itype = $item_object->effective_itemtype;
1236 my $orig_due = C4
::Circulation
::CalcDateDue
( $issuedate, $itype, $branch, $borrower );
1238 my $decreaseLoanHighHoldsDuration = C4
::Context
->preference('decreaseLoanHighHoldsDuration');
1240 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1241 $reduced_datedue->set_hour($orig_due->hour);
1242 $reduced_datedue->set_minute($orig_due->minute);
1243 $reduced_datedue->truncate( to
=> 'minute' );
1245 if ( DateTime
->compare( $reduced_datedue, $orig_due ) == -1 ) {
1246 $return_data->{exceeded
} = 1;
1247 $return_data->{duration
} = $decreaseLoanHighHoldsDuration;
1248 $return_data->{due_date
} = $reduced_datedue;
1252 return $return_data;
1257 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1259 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1263 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1265 =item C<$barcode> is the barcode of the item being issued.
1267 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1268 Calculated if empty.
1270 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1272 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1273 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1275 AddIssue does the following things :
1277 - step 01: check that there is a borrowernumber & a barcode provided
1278 - check for RENEWAL (book issued & being issued to the same patron)
1279 - renewal YES = Calculate Charge & renew
1281 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1283 - fill reserve if reserve to this patron
1284 - cancel reserve or not, otherwise
1285 * TRANSFERT PENDING ?
1286 - complete the transfert
1294 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1296 my $onsite_checkout = $params && $params->{onsite_checkout
} ?
1 : 0;
1297 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout
};
1298 my $auto_renew = $params && $params->{auto_renew
};
1299 my $dbh = C4
::Context
->dbh;
1300 my $barcodecheck = CheckValidBarcode
($barcode);
1304 if ( $datedue && ref $datedue ne 'DateTime' ) {
1305 $datedue = dt_from_string
($datedue);
1308 # $issuedate defaults to today.
1309 if ( !defined $issuedate ) {
1310 $issuedate = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1313 if ( ref $issuedate ne 'DateTime' ) {
1314 $issuedate = dt_from_string
($issuedate);
1319 # Stop here if the patron or barcode doesn't exist
1320 if ( $borrower && $barcode && $barcodecheck ) {
1321 # find which item we issue
1322 my $item_object = Koha
::Items
->find({ barcode
=> $barcode })
1323 or return; # if we don't get an Item, abort.
1324 my $item_unblessed = $item_object->unblessed;
1326 my $branch = _GetCircControlBranch
( $item_unblessed, $borrower );
1328 # get actual issuing if there is one
1329 my $actualissue = $item_object->checkout;
1331 # check if we just renew the issue.
1332 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1333 and not $switch_onsite_checkout ) {
1334 $datedue = AddRenewal
(
1335 $borrower->{'borrowernumber'},
1336 $item_object->itemnumber,
1339 $issuedate, # here interpreted as the renewal date
1344 my $itype = $item_object->effective_itemtype;
1345 $datedue = CalcDateDue
( $issuedate, $itype, $branch, $borrower );
1348 $datedue->truncate( to
=> 'minute' );
1350 my $patron = Koha
::Patrons
->find( $borrower );
1351 my $library = Koha
::Libraries
->find( $branch );
1352 my $fees = Koha
::Charges
::Fees
->new(
1355 library
=> $library,
1356 item
=> $item_object,
1357 to_date
=> $datedue,
1361 # it's NOT a renewal
1362 if ( $actualissue and not $switch_onsite_checkout ) {
1363 # This book is currently on loan, but not to the person
1364 # who wants to borrow it now. mark it returned before issuing to the new borrower
1365 my ( $allowed, $message ) = CanBookBeReturned
( $item_unblessed, C4
::Context
->userenv->{branch
} );
1366 return unless $allowed;
1367 AddReturn
( $item_object->barcode, C4
::Context
->userenv->{'branch'} );
1370 C4
::Reserves
::MoveReserve
( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1372 # Starting process for transfer job (checking transfert and validate it if we have one)
1373 my ($datesent) = GetTransfers
( $item_object->itemnumber );
1375 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1376 my $sth = $dbh->prepare(
1377 "UPDATE branchtransfers
1378 SET datearrived = now(),
1380 comments = 'Forced branchtransfer'
1381 WHERE itemnumber= ? AND datearrived IS NULL"
1383 $sth->execute( C4
::Context
->userenv->{'branch'},
1384 $item_object->itemnumber );
1387 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1388 unless ($auto_renew) {
1389 my $issuing_rule = Koha
::IssuingRules
->get_effective_issuing_rule(
1390 { categorycode
=> $borrower->{categorycode
},
1391 itemtype
=> $item_object->effective_itemtype,
1392 branchcode
=> $branch
1396 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1399 # Record in the database the fact that the book was issued.
1401 my $itype = $item_object->effective_itemtype;
1402 $datedue = CalcDateDue
( $issuedate, $itype, $branch, $borrower );
1405 $datedue->truncate( to
=> 'minute' );
1407 my $issue_attributes = {
1408 borrowernumber
=> $borrower->{'borrowernumber'},
1409 issuedate
=> $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1410 date_due
=> $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1411 branchcode
=> C4
::Context
->userenv->{'branch'},
1412 onsite_checkout
=> $onsite_checkout,
1413 auto_renew
=> $auto_renew ?
1 : 0,
1416 $issue = Koha
::Checkouts
->find( { itemnumber
=> $item_object->itemnumber } );
1418 $issue->set($issue_attributes)->store;
1421 $issue = Koha
::Checkout
->new(
1423 itemnumber
=> $item_object->itemnumber,
1428 if ( $item_object->location eq 'CART' && $item_object->permanent_location ne 'CART' ) {
1429 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1430 CartToShelf
( $item_object->itemnumber );
1433 if ( C4
::Context
->preference('UpdateTotalIssuesOnCirc') ) {
1434 UpdateTotalIssues
( $item_object->biblionumber, 1 );
1437 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1438 if ( $item_object->itemlost ) {
1440 Koha
::RefundLostItemFeeRules
->should_refund(
1442 current_branch
=> C4
::Context
->userenv->{branch
},
1443 item_home_branch
=> $item_object->homebranch,
1444 item_holding_branch
=> $item_object->holdingbranch,
1449 _FixAccountForLostAndReturned
( $item_object->itemnumber, undef,
1450 $item_object->barcode );
1456 issues
=> $item_object->issues + 1,
1457 holdingbranch
=> C4
::Context
->userenv->{'branch'},
1459 onloan
=> $datedue->ymd(),
1460 datelastborrowed
=> DateTime
->now( time_zone
=> C4
::Context
->tz() )->ymd(),
1462 $item_object->biblionumber,
1463 $item_object->itemnumber,
1466 ModDateLastSeen
( $item_object->itemnumber );
1468 # If it costs to borrow this book, charge it to the patron's account.
1469 my ( $charge, $itemtype ) = GetIssuingCharges
( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1470 if ( $charge > 0 ) {
1471 AddIssuingCharge
( $issue, $charge, 'RENT' );
1474 my $itemtype_object = Koha
::ItemTypes
->find( $item_object->effective_itemtype );
1475 if ( $itemtype_object ) {
1476 my $accumulate_charge = $fees->accumulate_rentalcharge();
1477 if ( $accumulate_charge > 0 ) {
1478 AddIssuingCharge
( $issue, $accumulate_charge, 'RENT_DAILY' ) if $accumulate_charge > 0;
1479 $charge += $accumulate_charge;
1480 $item_unblessed->{charge
} = $charge;
1484 # Record the fact that this book was issued.
1487 branch
=> C4
::Context
->userenv->{'branch'},
1488 type
=> ( $onsite_checkout ?
'onsite_checkout' : 'issue' ),
1490 other
=> ( $sipmode ?
"SIP-$sipmode" : '' ),
1491 itemnumber
=> $item_object->itemnumber,
1492 itemtype
=> $item_object->effective_itemtype,
1493 location
=> $item_object->location,
1494 borrowernumber
=> $borrower->{'borrowernumber'},
1495 ccode
=> $item_object->ccode,
1499 # Send a checkout slip.
1500 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1502 branchcode
=> $branch,
1503 categorycode
=> $borrower->{categorycode
},
1504 item_type
=> $item_object->effective_itemtype,
1505 notification
=> 'CHECKOUT',
1507 if ( $circulation_alert->is_enabled_for( \
%conditions ) ) {
1508 SendCirculationAlert
(
1511 item
=> $item_object->unblessed,
1512 borrower
=> $borrower,
1518 "CIRCULATION", "ISSUE",
1519 $borrower->{'borrowernumber'},
1520 $item_object->itemnumber,
1521 ) if C4
::Context
->preference("IssueLog");
1527 =head2 GetLoanLength
1529 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1531 Get loan length for an itemtype, a borrower type and a branch
1536 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1537 my $dbh = C4
::Context
->dbh;
1538 my $sth = $dbh->prepare(qq{
1539 SELECT issuelength
, lengthunit
, renewalperiod
1541 WHERE categorycode
=?
1544 AND issuelength IS NOT NULL
1547 # try to find issuelength & return the 1st available.
1548 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1549 $sth->execute( $borrowertype, $itemtype, $branchcode );
1550 my $loanlength = $sth->fetchrow_hashref;
1553 if defined($loanlength) && defined $loanlength->{issuelength
};
1555 $sth->execute( $borrowertype, '*', $branchcode );
1556 $loanlength = $sth->fetchrow_hashref;
1558 if defined($loanlength) && defined $loanlength->{issuelength
};
1560 $sth->execute( '*', $itemtype, $branchcode );
1561 $loanlength = $sth->fetchrow_hashref;
1563 if defined($loanlength) && defined $loanlength->{issuelength
};
1565 $sth->execute( '*', '*', $branchcode );
1566 $loanlength = $sth->fetchrow_hashref;
1568 if defined($loanlength) && defined $loanlength->{issuelength
};
1570 $sth->execute( $borrowertype, $itemtype, '*' );
1571 $loanlength = $sth->fetchrow_hashref;
1573 if defined($loanlength) && defined $loanlength->{issuelength
};
1575 $sth->execute( $borrowertype, '*', '*' );
1576 $loanlength = $sth->fetchrow_hashref;
1578 if defined($loanlength) && defined $loanlength->{issuelength
};
1580 $sth->execute( '*', $itemtype, '*' );
1581 $loanlength = $sth->fetchrow_hashref;
1583 if defined($loanlength) && defined $loanlength->{issuelength
};
1585 $sth->execute( '*', '*', '*' );
1586 $loanlength = $sth->fetchrow_hashref;
1588 if defined($loanlength) && defined $loanlength->{issuelength
};
1590 # if no rule is set => 0 day (hardcoded)
1594 lengthunit
=> 'days',
1600 =head2 GetHardDueDate
1602 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1604 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1608 sub GetHardDueDate
{
1609 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1611 my $issuing_rule = Koha
::IssuingRules
->get_effective_issuing_rule(
1612 { categorycode
=> $borrowertype,
1613 itemtype
=> $itemtype,
1614 branchcode
=> $branchcode
1619 if ( defined( $issuing_rule ) ) {
1620 if ( $issuing_rule->hardduedate ) {
1621 return (dt_from_string
($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1623 return (undef, undef);
1628 =head2 GetBranchBorrowerCircRule
1630 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1632 Retrieves circulation rule attributes that apply to the given
1633 branch and patron category, regardless of item type.
1634 The return value is a hashref containing the following key:
1636 patron_maxissueqty - maximum number of loans that a
1637 patron of the given category can have at the given
1638 branch. If the value is undef, no limit.
1640 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1641 patron of the given category can have at the given
1642 branch. If the value is undef, no limit.
1644 This will check for different branch/category combinations in the following order:
1648 default branch and category
1650 If no rule has been found in the database, it will default to
1653 patron_maxissueqty - undef
1654 patron_maxonsiteissueqty - undef
1656 C<$branchcode> and C<$categorycode> should contain the
1657 literal branch code and patron category code, respectively - no
1662 sub GetBranchBorrowerCircRule
{
1663 my ( $branchcode, $categorycode ) = @_;
1665 # Initialize default values
1667 patron_maxissueqty
=> undef,
1668 patron_maxonsiteissueqty
=> undef,
1672 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1673 my $rule = Koha
::CirculationRules
->get_effective_rule(
1675 categorycode
=> $categorycode,
1677 branchcode
=> $branchcode,
1678 rule_name
=> $rule_name,
1682 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1688 =head2 GetBranchItemRule
1690 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1692 Retrieves circulation rule attributes that apply to the given
1693 branch and item type, regardless of patron category.
1695 The return value is a hashref containing the following keys:
1697 holdallowed => Hold policy for this branch and itemtype. Possible values:
1698 0: No holds allowed.
1699 1: Holds allowed only by patrons that have the same homebranch as the item.
1700 2: Holds allowed from any patron.
1702 returnbranch => branch to which to return item. Possible values:
1703 noreturn: do not return, let item remain where checked in (floating collections)
1704 homebranch: return to item's home branch
1705 holdingbranch: return to issuer branch
1707 This searches branchitemrules in the following order:
1709 * Same branchcode and itemtype
1710 * Same branchcode, itemtype '*'
1711 * branchcode '*', same itemtype
1712 * branchcode and itemtype '*'
1714 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1718 sub GetBranchItemRule
{
1719 my ( $branchcode, $itemtype ) = @_;
1722 my $holdallowed_rule = Koha
::CirculationRules
->get_effective_rule(
1724 branchcode
=> $branchcode,
1725 itemtype
=> $itemtype,
1726 rule_name
=> 'holdallowed',
1729 my $hold_fulfillment_policy_rule = Koha
::CirculationRules
->get_effective_rule(
1731 branchcode
=> $branchcode,
1732 itemtype
=> $itemtype,
1733 rule_name
=> 'hold_fulfillment_policy',
1736 my $returnbranch_rule = Koha
::CirculationRules
->get_effective_rule(
1738 branchcode
=> $branchcode,
1739 itemtype
=> $itemtype,
1740 rule_name
=> 'returnbranch',
1744 # built-in default circulation rule
1746 $rules->{holdallowed
} = defined $holdallowed_rule
1747 ?
$holdallowed_rule->rule_value
1749 $rules->{hold_fulfillment_policy
} = defined $hold_fulfillment_policy_rule
1750 ?
$hold_fulfillment_policy_rule->rule_value
1752 $rules->{returnbranch
} = defined $returnbranch_rule
1753 ?
$returnbranch_rule->rule_value
1761 ($doreturn, $messages, $iteminformation, $borrower) =
1762 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1768 =item C<$barcode> is the bar code of the book being returned.
1770 =item C<$branch> is the code of the branch where the book is being returned.
1772 =item C<$exemptfine> indicates that overdue charges for the item will be
1775 =item C<$return_date> allows the default return date to be overridden
1776 by the given return date. Optional.
1780 C<&AddReturn> returns a list of four items:
1782 C<$doreturn> is true iff the return succeeded.
1784 C<$messages> is a reference-to-hash giving feedback on the operation.
1785 The keys of the hash are:
1791 No item with this barcode exists. The value is C<$barcode>.
1795 The book is not currently on loan. The value is C<$barcode>.
1799 This book has been withdrawn/cancelled. The value should be ignored.
1801 =item C<Wrongbranch>
1803 This book has was returned to the wrong branch. The value is a hashref
1804 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1805 contain the branchcode of the incorrect and correct return library, respectively.
1809 The item was reserved. The value is a reference-to-hash whose keys are
1810 fields from the reserves table of the Koha database, and
1811 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1812 either C<Waiting>, C<Reserved>, or 0.
1814 =item C<WasReturned>
1816 Value 1 if return is successful.
1818 =item C<NeedsTransfer>
1820 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1824 C<$iteminformation> is a reference-to-hash, giving information about the
1825 returned item from the issues table.
1827 C<$borrower> is a reference-to-hash, giving information about the
1828 patron who last borrowed the book.
1833 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1835 if ($branch and not Koha
::Libraries
->find($branch)) {
1836 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4
::Context
->userenv->{'branch'};
1839 $branch = C4
::Context
->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1840 $return_date //= dt_from_string
();
1844 my $validTransfert = 0;
1845 my $stat_type = 'return';
1847 # get information on item
1848 my $item = Koha
::Items
->find({ barcode
=> $barcode });
1850 return ( 0, { BadBarcode
=> $barcode } ); # no barcode means no item or borrower. bail out.
1853 my $itemnumber = $item->itemnumber;
1854 my $itemtype = $item->effective_itemtype;
1856 my $issue = $item->checkout;
1858 $patron = $issue->patron
1859 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1860 . Dumper
($issue->unblessed) . "\n";
1862 $messages->{'NotIssued'} = $barcode;
1863 ModItem
({ onloan
=> undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1864 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1866 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1867 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1868 if (C4
::Context
->preference("RecordLocalUseOnReturn")) {
1869 $messages->{'LocalUse'} = 1;
1870 $stat_type = 'localuse';
1874 my $item_unblessed = $item->unblessed;
1875 # full item data, but no borrowernumber or checkout info (no issue)
1876 my $hbr = GetBranchItemRule
($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1877 # get the proper branch to which to return the item
1878 my $returnbranch = $hbr ne 'noreturn' ?
$item->$hbr : $branch;
1879 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1881 my $borrowernumber = $patron ?
$patron->borrowernumber : undef; # we don't know if we had a borrower or not
1882 my $patron_unblessed = $patron ?
$patron->unblessed : {};
1884 my $update_loc_rules = get_yaml_pref_hash
('UpdateItemLocationOnCheckin');
1885 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1886 if ($update_loc_rules) {
1887 if (defined $update_loc_rules->{_ALL_
}) {
1888 if ($update_loc_rules->{_ALL_
} eq '_PERM_') { $update_loc_rules->{_ALL_
} = $item->permanent_location; }
1889 if ($update_loc_rules->{_ALL_
} eq '_BLANK_') { $update_loc_rules->{_ALL_
} = ''; }
1890 if ( $item->location ne $update_loc_rules->{_ALL_
}) {
1891 $messages->{'ItemLocationUpdated'} = { from
=> $item->location, to
=> $update_loc_rules->{_ALL_
} };
1892 ModItem
( { location
=> $update_loc_rules->{_ALL_
} }, undef, $itemnumber );
1896 foreach my $key ( keys %$update_loc_rules ) {
1897 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1898 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1899 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1900 $messages->{'ItemLocationUpdated'} = { from
=> $item->location, to
=> $update_loc_rules->{$key} };
1901 ModItem
( { location
=> $update_loc_rules->{$key} }, undef, $itemnumber );
1908 my $yaml = C4
::Context
->preference('UpdateNotForLoanStatusOnCheckin');
1910 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1912 eval { $rules = YAML
::Load
($yaml); };
1914 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1917 foreach my $key ( keys %$rules ) {
1918 if ( $item->notforloan eq $key ) {
1919 $messages->{'NotForLoanStatusUpdated'} = { from
=> $item->notforloan, to
=> $rules->{$key} };
1920 ModItem
( { notforloan
=> $rules->{$key} }, undef, $itemnumber, { log_action
=> 0 } );
1927 # check if the return is allowed at this branch
1928 my ($returnallowed, $message) = CanBookBeReturned
($item_unblessed, $branch);
1929 unless ($returnallowed){
1930 $messages->{'Wrongbranch'} = {
1931 Wrongbranch
=> $branch,
1932 Rightbranch
=> $message
1935 return ( $doreturn, $messages, $issue, $patron_unblessed);
1938 if ( $item->withdrawn ) { # book has been cancelled
1939 $messages->{'withdrawn'} = 1;
1940 $doreturn = 0 if C4
::Context
->preference("BlockReturnOfWithdrawnItems");
1943 if ( $item->itemlost and C4
::Context
->preference("BlockReturnOfLostItems") ) {
1947 # case of a return of document (deal with issues and holdingbranch)
1950 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1951 $patron or warn "AddReturn without current borrower";
1952 $is_overdue = $issue->is_overdue( $return_date );
1956 MarkIssueReturned
( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1959 if ( C4
::Context
->preference('CalculateFinesOnReturn') && $is_overdue && !$item->itemlost ) {
1960 _CalculateAndUpdateFine
( { issue
=> $issue, item
=> $item_unblessed, borrower
=> $patron_unblessed, return_date
=> $return_date } );
1963 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 );
1965 return ( 0, { WasReturned
=> 0, DataCorrupted
=> 1 }, $issue, $patron_unblessed );
1968 # FIXME is the "= 1" right? This could be the borrower hash.
1969 $messages->{'WasReturned'} = 1;
1973 ModItem
( { onloan
=> undef }, $item->biblionumber, $item->itemnumber, { log_action
=> 0 } );
1976 # the holdingbranch is updated if the document is returned to another location.
1977 # this is always done regardless of whether the item was on loan or not
1978 my $item_holding_branch = $item->holdingbranch;
1979 if ($item->holdingbranch ne $branch) {
1980 UpdateHoldingbranch
($branch, $item->itemnumber);
1981 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1984 my $leave_item_lost = C4
::Context
->preference("BlockReturnOfLostItems") ?
1 : 0;
1985 ModDateLastSeen
( $item->itemnumber, $leave_item_lost );
1987 # check if we have a transfer for this document
1988 my ($datesent,$frombranch,$tobranch) = GetTransfers
( $item->itemnumber );
1990 # if we have a transfer to do, we update the line of transfers with the datearrived
1991 my $is_in_rotating_collection = C4
::RotatingCollections
::isItemInAnyCollection
( $item->itemnumber );
1993 if ( $tobranch eq $branch ) {
1994 my $sth = C4
::Context
->dbh->prepare(
1995 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1997 $sth->execute( $item->itemnumber );
1998 # if we have a reservation with valid transfer, we can set it's status to 'W'
1999 C4
::Reserves
::ModReserveStatus
($item->itemnumber, 'W');
2001 $messages->{'WrongTransfer'} = $tobranch;
2002 $messages->{'WrongTransferItem'} = $item->itemnumber;
2004 $validTransfert = 1;
2007 # fix up the accounts.....
2008 if ( $item->itemlost ) {
2009 $messages->{'WasLost'} = 1;
2010 unless ( C4
::Context
->preference("BlockReturnOfLostItems") ) {
2012 Koha
::RefundLostItemFeeRules
->should_refund(
2014 current_branch
=> C4
::Context
->userenv->{branch
},
2015 item_home_branch
=> $item->homebranch,
2016 item_holding_branch
=> $item_holding_branch
2021 _FixAccountForLostAndReturned
( $item->itemnumber,
2022 $borrowernumber, $barcode );
2023 $messages->{'LostItemFeeRefunded'} = 1;
2028 # fix up the overdues in accounts...
2029 if ($borrowernumber) {
2030 my $fix = _FixOverduesOnReturn
( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2031 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2033 if ( $issue and $issue->is_overdue ) {
2035 my ($debardate,$reminder) = _debar_user_on_return
( $patron_unblessed, $item_unblessed, dt_from_string
($issue->date_due), $return_date );
2037 $messages->{'PrevDebarred'} = $debardate;
2039 $messages->{'Debarred'} = $debardate if $debardate;
2041 # there's no overdue on the item but borrower had been previously debarred
2042 } elsif ( $issue->date_due and $patron->debarred ) {
2043 if ( $patron->debarred eq "9999-12-31") {
2044 $messages->{'ForeverDebarred'} = $patron->debarred;
2046 my $borrower_debar_dt = dt_from_string
( $patron->debarred );
2047 $borrower_debar_dt->truncate(to
=> 'day');
2048 my $today_dt = $return_date->clone()->truncate(to
=> 'day');
2049 if ( DateTime
->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2050 $messages->{'PrevDebarred'} = $patron->debarred;
2056 # find reserves.....
2057 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2058 my ($resfound, $resrec);
2059 my $lookahead= C4
::Context
->preference('ConfirmFutureHolds'); #number of days to look for future holds
2060 ($resfound, $resrec, undef) = C4
::Reserves
::CheckReserves
( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2062 $resrec->{'ResFound'} = $resfound;
2063 $messages->{'ResFound'} = $resrec;
2066 # Record the fact that this book was returned.
2070 itemnumber
=> $itemnumber,
2071 itemtype
=> $itemtype,
2072 borrowernumber
=> $borrowernumber,
2073 ccode
=> $item->ccode,
2076 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2078 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2080 branchcode
=> $branch,
2081 categorycode
=> $patron->categorycode,
2082 item_type
=> $itemtype,
2083 notification
=> 'CHECKIN',
2085 if ($doreturn && $circulation_alert->is_enabled_for(\
%conditions)) {
2086 SendCirculationAlert
({
2088 item
=> $item_unblessed,
2089 borrower
=> $patron->unblessed,
2094 logaction
("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2095 if C4
::Context
->preference("ReturnLog");
2098 # Remove any OVERDUES related debarment if the borrower has no overdues
2099 if ( $borrowernumber
2100 && $patron->debarred
2101 && C4
::Context
->preference('AutoRemoveOverduesRestrictions')
2102 && !Koha
::Patrons
->find( $borrowernumber )->has_overdues
2103 && @
{ GetDebarments
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' }) }
2105 DelUniqueDebarment
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' });
2108 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2109 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2110 my $BranchTransferLimitsType = C4
::Context
->preference("BranchTransferLimitsType");
2111 if (C4
::Context
->preference("AutomaticItemReturn" ) or
2112 (C4
::Context
->preference("UseBranchTransferLimits") and
2113 ! IsBranchTransferAllowed
($branch, $returnbranch, $item->$BranchTransferLimitsType )
2115 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2116 $debug and warn "item: " . Dumper
($item_unblessed);
2117 ModItemTransfer
($item->itemnumber, $branch, $returnbranch);
2118 $messages->{'WasTransfered'} = 1;
2120 $messages->{'NeedsTransfer'} = $returnbranch;
2124 return ( $doreturn, $messages, $issue, ( $patron ?
$patron->unblessed : {} ));
2127 =head2 MarkIssueReturned
2129 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2131 Unconditionally marks an issue as being returned by
2132 moving the C<issues> row to C<old_issues> and
2133 setting C<returndate> to the current date.
2135 if C<$returndate> is specified (in iso format), it is used as the date
2138 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2139 the old_issue is immediately anonymised
2141 Ideally, this function would be internal to C<C4::Circulation>,
2142 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2143 and offline_circ/process_koc.pl.
2147 sub MarkIssueReturned
{
2148 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2150 # Retrieve the issue
2151 my $issue = Koha
::Checkouts
->find( { itemnumber
=> $itemnumber } ) or return;
2152 my $issue_id = $issue->issue_id;
2154 my $anonymouspatron;
2155 if ( $privacy == 2 ) {
2156 # The default of 0 will not work due to foreign key constraints
2157 # The anonymisation will fail if AnonymousPatron is not a valid entry
2158 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2159 # Note that a warning should appear on the about page (System information tab).
2160 $anonymouspatron = C4
::Context
->preference('AnonymousPatron');
2161 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."
2162 unless Koha
::Patrons
->find( $anonymouspatron );
2165 my $schema = Koha
::Database
->schema;
2167 # FIXME Improve the return value and handle it from callers
2168 $schema->txn_do(sub {
2170 # Update the returndate value
2171 if ( $returndate ) {
2172 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2175 $issue->returndate( \'NOW
()' )->store->discard_changes; # update and refetch
2178 # Create the old_issues entry
2179 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2181 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2182 if ( $privacy == 2) {
2183 $old_checkout->borrowernumber($anonymouspatron)->store;
2186 # And finally delete the issue
2189 ModItem( { 'onloan
' => undef }, undef, $itemnumber, { log_action => 0 } );
2191 if ( C4::Context->preference('StoreLastBorrower
') ) {
2192 my $item = Koha::Items->find( $itemnumber );
2193 my $patron = Koha::Patrons->find( $borrowernumber );
2194 $item->last_returned_by( $patron );
2201 =head2 _debar_user_on_return
2203 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2205 C<$borrower> borrower hashref
2207 C<$item> item hashref
2209 C<$datedue> date due DateTime object
2211 C<$returndate> DateTime object representing the return time
2213 Internal function, called only by AddReturn that calculates and updates
2214 the user fine days, and debars them if necessary.
2216 Should only be called for overdue returns
2220 sub _debar_user_on_return {
2221 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2223 my $branchcode = _GetCircControlBranch( $item, $borrower );
2224 $return_date //= dt_from_string();
2226 my $circcontrol = C4::Context->preference('CircControl
');
2227 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2228 { categorycode => $borrower->{categorycode},
2229 itemtype => $item->{itype},
2230 branchcode => $branchcode
2233 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2234 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2235 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2239 # finedays is in days, so hourly loans must multiply by 24
2240 # thus 1 hour late equals 1 day suspension * finedays rate
2241 $finedays = $finedays * 24 if ( $unit eq 'hours
' );
2243 # grace period is measured in the same units as the loan
2245 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2247 my $deltadays = DateTime::Duration->new(
2248 days => $chargeable_units
2250 if ( $deltadays->subtract($grace)->is_positive() ) {
2251 my $suspension_days = $deltadays * $finedays;
2253 # If the max suspension days is < than the suspension days
2254 # the suspension days is limited to this maximum period.
2255 my $max_sd = $issuing_rule->maxsuspensiondays;
2256 if ( defined $max_sd ) {
2257 $max_sd = DateTime::Duration->new( days => $max_sd );
2258 $suspension_days = $max_sd
2259 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2262 my ( $has_been_extended, $is_a_reminder );
2263 if ( C4::Context->preference('CumulativeRestrictionPeriods
') and $borrower->{debarred} ) {
2264 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION
' } ) }[0];
2266 $return_date = dt_from_string( $debarment->{expiration}, 'sql
' );
2267 $has_been_extended = 1;
2271 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2272 # No need to / 1 and do not consider / 0
2273 $suspension_days = DateTime::Duration->new(
2274 days => floor( $suspension_days->in_units('days
') / $issuing_rule->suspension_chargeperiod )
2279 # Use the calendar or not to calculate the debarment date
2280 if ( C4::Context->preference('finesCalendar
') eq 'noFinesWhenClosed
' ) {
2281 my $calendar = Koha::Calendar->new(
2282 branchcode => $branchcode,
2283 days_mode => 'Calendar
'
2285 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2288 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2291 Koha::Patron::Debarments::AddUniqueDebarment({
2292 borrowernumber => $borrower->{borrowernumber},
2293 expiration => $new_debar_dt->ymd(),
2294 type => 'SUSPENSION
',
2296 # if borrower was already debarred but does not get an extra debarment
2297 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2298 my $new_debarment_str;
2299 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2301 $new_debarment_str = $borrower->{debarred};
2303 $new_debarment_str = $new_debar_dt->ymd();
2305 # FIXME Should return a DateTime object
2306 return $new_debarment_str, $is_a_reminder;
2312 =head2 _FixOverduesOnReturn
2314 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2316 C<$borrowernumber> borrowernumber
2318 C<$itemnumber> itemnumber
2320 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2322 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2328 sub _FixOverduesOnReturn {
2329 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2330 unless( $borrowernumber ) {
2331 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2335 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2339 warn "_FixOverduesOnReturn() not supplied valid status";
2343 my $schema = Koha::Database->schema;
2345 my $result = $schema->txn_do(
2347 # check for overdue fine
2348 my $accountlines = Koha::Account::Lines->search(
2350 borrowernumber => $borrowernumber,
2351 itemnumber => $item,
2352 debit_type_code => 'OVERDUE
',
2353 status => 'UNRETURNED
'
2356 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2358 my $accountline = $accountlines->next;
2360 my $amountoutstanding = $accountline->amountoutstanding;
2362 my $account = Koha
::Account
->new({patron_id
=> $borrowernumber});
2363 my $credit = $account->add_credit(
2365 amount
=> $amountoutstanding,
2366 user_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'number'} : undef,
2367 library_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'branch'} : undef,
2368 interface
=> C4
::Context
->interface,
2374 $credit->apply({ debits
=> [ $accountline ], offset_type
=> 'Forgiven' });
2376 $accountline->status('FORGIVEN');
2378 if (C4
::Context
->preference("FinesLog")) {
2379 &logaction
("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2382 $accountline->status($status);
2385 return $accountline->store();
2392 =head2 _FixAccountForLostAndReturned
2394 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2396 Finds the most recent lost item charge for this item and refunds the borrower
2397 appropriatly, taking into account any payments or writeoffs already applied
2400 Internal function, not exported, called only by AddReturn.
2404 sub _FixAccountForLostAndReturned
{
2405 my $itemnumber = shift or return;
2406 my $borrowernumber = @_ ?
shift : undef;
2407 my $item_id = @_ ?
shift : $itemnumber; # Send the barcode if you want that logged in the description
2411 # check for charge made for lost book
2412 my $accountlines = Koha
::Account
::Lines
->search(
2414 itemnumber
=> $itemnumber,
2415 debit_type_code
=> 'LOST',
2416 status
=> [ undef, { '<>' => 'RETURNED' } ]
2419 order_by
=> { -desc
=> [ 'date', 'accountlines_id' ] }
2423 return unless $accountlines->count > 0;
2424 my $accountline = $accountlines->next;
2425 my $total_to_refund = 0;
2427 return unless $accountline->borrowernumber;
2428 my $patron = Koha
::Patrons
->find( $accountline->borrowernumber );
2429 return unless $patron; # Patron has been deleted, nobody to credit the return to
2431 my $account = $patron->account;
2434 if ( $accountline->amount > $accountline->amountoutstanding ) {
2435 # some amount has been cancelled. collect the offsets that are not writeoffs
2436 # this works because the only way to subtract from this kind of a debt is
2437 # using the UI buttons 'Pay' and 'Write off'
2438 my $credits_offsets = Koha
::Account
::Offsets
->search({
2439 debit_id
=> $accountline->id,
2440 credit_id
=> { '!=' => undef }, # it is not the debit itself
2441 type
=> { '!=' => 'Writeoff' },
2442 amount
=> { '<' => 0 } # credits are negative on the DB
2445 $total_to_refund = ( $credits_offsets->count > 0 )
2446 ?
$credits_offsets->total * -1 # credits are negative on the DB
2450 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2452 if ( $credit_total > 0 ) {
2453 my $branchcode = C4
::Context
->userenv ? C4
::Context
->userenv->{'branch'} : undef;
2454 $credit = $account->add_credit(
2455 { amount
=> $credit_total,
2456 description
=> 'Item Returned ' . $item_id,
2457 type
=> 'LOST_RETURN',
2458 interface
=> C4
::Context
->interface,
2459 library_id
=> $branchcode
2463 $credit->apply( { debits
=> [ $accountline ] } );
2466 # Update the account status
2467 $accountline->discard_changes->status('RETURNED');
2468 $accountline->store;
2470 if ( defined $account and C4
::Context
->preference('AccountAutoReconcile') ) {
2471 $account->reconcile_balance;
2474 return ($credit) ?
$credit->id : undef;
2477 =head2 _GetCircControlBranch
2479 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2483 Return the library code to be used to determine which circulation
2484 policy applies to a transaction. Looks up the CircControl and
2485 HomeOrHoldingBranch system preferences.
2487 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2489 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2493 sub _GetCircControlBranch
{
2494 my ($item, $borrower) = @_;
2495 my $circcontrol = C4
::Context
->preference('CircControl');
2498 if ($circcontrol eq 'PickupLibrary' and (C4
::Context
->userenv and C4
::Context
->userenv->{'branch'}) ) {
2499 $branch= C4
::Context
->userenv->{'branch'};
2500 } elsif ($circcontrol eq 'PatronLibrary') {
2501 $branch=$borrower->{branchcode
};
2503 my $branchfield = C4
::Context
->preference('HomeOrHoldingBranch') || 'homebranch';
2504 $branch = $item->{$branchfield};
2505 # default to item home branch if holdingbranch is used
2506 # and is not defined
2507 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2508 $branch = $item->{homebranch
};
2516 $issue = GetOpenIssue( $itemnumber );
2518 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2520 C<$itemnumber> is the item's itemnumber
2527 my ( $itemnumber ) = @_;
2528 return unless $itemnumber;
2529 my $dbh = C4
::Context
->dbh;
2530 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2531 $sth->execute( $itemnumber );
2532 return $sth->fetchrow_hashref();
2536 =head2 GetBiblioIssues
2538 $issues = GetBiblioIssues($biblionumber);
2540 this function get all issues from a biblionumber.
2543 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2544 tables issues and the firstname,surname & cardnumber from borrowers.
2548 sub GetBiblioIssues
{
2549 my $biblionumber = shift;
2550 return unless $biblionumber;
2551 my $dbh = C4
::Context
->dbh;
2553 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2555 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2556 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2557 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2558 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2559 WHERE biblio.biblionumber = ?
2561 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2563 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2564 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2565 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2566 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2567 WHERE biblio.biblionumber = ?
2570 my $sth = $dbh->prepare($query);
2571 $sth->execute($biblionumber, $biblionumber);
2574 while ( my $data = $sth->fetchrow_hashref ) {
2575 push @issues, $data;
2580 =head2 GetUpcomingDueIssues
2582 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2586 sub GetUpcomingDueIssues
{
2589 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2590 my $dbh = C4
::Context
->dbh;
2592 my $statement = <<END_SQL;
2595 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2597 LEFT JOIN items USING (itemnumber)
2598 LEFT OUTER JOIN branches USING (branchcode)
2599 WHERE returndate is NULL
2601 WHERE days_until_due >= 0 AND days_until_due <= ?
2604 my @bind_parameters = ( $params->{'days_in_advance'} );
2606 my $sth = $dbh->prepare( $statement );
2607 $sth->execute( @bind_parameters );
2608 my $upcoming_dues = $sth->fetchall_arrayref({});
2610 return $upcoming_dues;
2613 =head2 CanBookBeRenewed
2615 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2617 Find out whether a borrowed item may be renewed.
2619 C<$borrowernumber> is the borrower number of the patron who currently
2620 has the item on loan.
2622 C<$itemnumber> is the number of the item to renew.
2624 C<$override_limit>, if supplied with a true value, causes
2625 the limit on the number of times that the loan can be renewed
2626 (as controlled by the item type) to be ignored. Overriding also allows
2627 to renew sooner than "No renewal before" and to manually renew loans
2628 that are automatically renewed.
2630 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2631 item must currently be on loan to the specified borrower; renewals
2632 must be allowed for the item's type; and the borrower must not have
2633 already renewed the loan. $error will contain the reason the renewal can not proceed
2637 sub CanBookBeRenewed {
2638 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2640 my $dbh = C4::Context->dbh;
2643 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2644 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2645 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2646 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2648 my $patron = $issue->patron or return;
2650 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2652 # This item can fill one or more unfilled reserve, can those unfilled reserves
2653 # all be filled by other available items?
2655 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2657 my $schema = Koha::Database->new()->schema();
2659 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2661 # There is an item level hold on this item, no other item can fill the hold
2666 # Get all other items that could possibly fill reserves
2667 my @itemnumbers = $schema->resultset('Item')->search(
2669 biblionumber => $resrec->{biblionumber},
2672 -not => { itemnumber => $itemnumber }
2674 { columns => 'itemnumber' }
2675 )->get_column('itemnumber')->all();
2677 # Get all other reserves that could have been filled by this item
2678 my @borrowernumbers;
2680 my ( $reserve_found, $reserve, undef ) =
2681 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2683 if ($reserve_found) {
2684 push( @borrowernumbers, $reserve->{borrowernumber} );
2691 # If the count of the union of the lists of reservable items for each borrower
2692 # is equal or greater than the number of borrowers, we know that all reserves
2693 # can be filled with available items. We can get the union of the sets simply
2694 # by pushing all the elements onto an array and removing the duplicates.
2697 ITEM: foreach my $itemnumber (@itemnumbers) {
2698 my $item = Koha::Items->find( $itemnumber );
2699 next if IsItemOnHoldAndFound( $itemnumber );
2700 for my $borrowernumber (@borrowernumbers) {
2701 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2702 next unless IsAvailableForItemLevelRequest($item, $patron);
2703 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2705 push @reservable, $itemnumber;
2706 if (@reservable >= @borrowernumbers) {
2715 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2717 return ( 1, undef ) if $override_limit;
2719 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2720 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2721 { categorycode => $patron->categorycode,
2722 itemtype => $item->effective_itemtype,
2723 branchcode => $branchcode
2727 return ( 0, "too_many" )
2728 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2730 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2731 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2732 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2733 my $restricted = $patron->is_debarred;
2734 my $hasoverdues = $patron->has_overdues;
2736 if ( $restricted and $restrictionblockrenewing ) {
2737 return ( 0, 'restriction');
2738 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2739 return ( 0, 'overdue');
2742 if ( $issue->auto_renew ) {
2744 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2745 return ( 0, 'auto_account_expired' );
2748 if ( defined $issuing_rule->no_auto_renewal_after
2749 and $issuing_rule->no_auto_renewal_after ne "" ) {
2750 # Get issue_date and add no_auto_renewal_after
2751 # If this is greater than today, it's too late for renewal.
2752 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2753 $maximum_renewal_date->add(
2754 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2756 my $now = dt_from_string;
2757 if ( $now >= $maximum_renewal_date ) {
2758 return ( 0, "auto_too_late" );
2761 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2762 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2763 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2764 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2765 return ( 0, "auto_too_late" );
2769 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2770 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2771 my $amountoutstanding = $patron->account->balance;
2772 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2773 return ( 0, "auto_too_much_oweing" );
2778 if ( defined $issuing_rule->norenewalbefore
2779 and $issuing_rule->norenewalbefore ne "" )
2782 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2783 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2784 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2786 # Depending on syspref reset the exact time, only check the date
2787 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2788 and $issuing_rule->lengthunit eq 'days' )
2790 $soonestrenewal->truncate( to => 'day' );
2793 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2795 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2796 return ( 0, "too_soon" );
2798 elsif ( $issue->auto_renew ) {
2799 return ( 0, "auto_renew" );
2803 # Fallback for automatic renewals:
2804 # If norenewalbefore is undef, don't renew before due date.
2805 if ( $issue->auto_renew ) {
2806 my $now = dt_from_string;
2807 return ( 0, "auto_renew" )
2808 if $now >= dt_from_string( $issue->date_due, 'sql' );
2809 return ( 0, "auto_too_soon" );
2812 return ( 1, undef );
2817 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2821 C<$borrowernumber> is the borrower number of the patron who currently
2824 C<$itemnumber> is the number of the item to renew.
2826 C<$branch> is the library where the renewal took place (if any).
2827 The library that controls the circ policies for the renewal is retrieved from the issues record.
2829 C<$datedue> can be a DateTime object used to set the due date.
2831 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2832 this parameter is not supplied, lastreneweddate is set to the current date.
2834 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2835 from the book's item type.
2840 my $borrowernumber = shift;
2841 my $itemnumber = shift or return;
2843 my $datedue = shift;
2844 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2846 my $item_object = Koha::Items->find($itemnumber) or return;
2847 my $biblio = $item_object->biblio;
2848 my $issue = $item_object->checkout;
2849 my $item_unblessed = $item_object->unblessed;
2851 my $dbh = C4::Context->dbh;
2853 return unless $issue;
2855 $borrowernumber ||= $issue->borrowernumber;
2857 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2858 carp 'Invalid date passed to AddRenewal.';
2862 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2863 my $patron_unblessed = $patron->unblessed;
2865 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2867 my $schema = Koha::Database->schema;
2868 $schema->txn_do(sub{
2870 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2871 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2873 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2875 # If the due date wasn't specified, calculate it by adding the
2876 # book's loan length to today's date or the current due date
2877 # based on the value of the RenewalPeriodBase syspref.
2878 my $itemtype = $item_object->effective_itemtype;
2881 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2882 dt_from_string( $issue->date_due, 'sql' ) :
2883 DateTime->now( time_zone => C4::Context->tz());
2884 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2887 my $fees = Koha::Charges::Fees->new(
2890 library => $circ_library,
2891 item => $item_object,
2892 from_date => dt_from_string( $issue->date_due, 'sql' ),
2893 to_date => dt_from_string($datedue),
2897 # Update the issues record to have the new due date, and a new count
2898 # of how many times it has been renewed.
2899 my $renews = $issue->renewals + 1;
2900 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2901 WHERE borrowernumber=?
2905 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2907 # Update the renewal count on the item, and tell zebra to reindex
2908 $renews = $item_object->renewals + 1;
2909 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2911 # Charge a new rental fee, if applicable
2912 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2913 if ( $charge > 0 ) {
2914 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
2917 # Charge a new accumulate rental fee, if applicable
2918 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2919 if ( $itemtype_object ) {
2920 my $accumulate_charge = $fees->accumulate_rentalcharge();
2921 if ( $accumulate_charge > 0 ) {
2922 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
2924 $charge += $accumulate_charge;
2927 # Send a renewal slip according to checkout alert preferencei
2928 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2929 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2931 branchcode => $branch,
2932 categorycode => $patron->categorycode,
2933 item_type => $itemtype,
2934 notification => 'CHECKOUT',
2936 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2937 SendCirculationAlert(
2940 item => $item_unblessed,
2941 borrower => $patron->unblessed,
2948 # Remove any OVERDUES related debarment if the borrower has no overdues
2950 && $patron->is_debarred
2951 && ! $patron->has_overdues
2952 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2954 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2957 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2958 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2961 # Add the renewal to stats
2967 itemnumber => $itemnumber,
2968 itemtype => $itemtype,
2969 location => $item_object->location,
2970 borrowernumber => $borrowernumber,
2971 ccode => $item_object->ccode,
2976 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2983 # check renewal status
2984 my ( $bornum, $itemno ) = @_;
2985 my $dbh = C4::Context->dbh;
2987 my $renewsallowed = 0;
2990 my $patron = Koha::Patrons->find( $bornum );
2991 my $item = Koha::Items->find($itemno);
2993 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2995 # Look in the issues table for this item, lent to this borrower,
2996 # and not yet returned.
2998 # FIXME - I think this function could be redone to use only one SQL call.
2999 my $sth = $dbh->prepare(
3000 "select * from issues
3001 where (borrowernumber = ?)
3002 and (itemnumber = ?)"
3004 $sth->execute( $bornum, $itemno );
3005 my $data = $sth->fetchrow_hashref;
3006 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3007 # $item and $borrower should be calculated
3008 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3010 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3011 { categorycode => $patron->categorycode,
3012 itemtype => $item->effective_itemtype,
3013 branchcode => $branchcode
3017 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3018 $renewsleft = $renewsallowed - $renewcount;
3019 if($renewsleft < 0){ $renewsleft = 0; }
3020 return ( $renewcount, $renewsallowed, $renewsleft );
3023 =head2 GetSoonestRenewDate
3025 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3027 Find out the soonest possible renew date of a borrowed item.
3029 C<$borrowernumber> is the borrower number of the patron who currently
3030 has the item on loan.
3032 C<$itemnumber> is the number of the item to renew.
3034 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3035 renew date, based on the value "No renewal before" of the applicable
3036 issuing rule. Returns the current date if the item can already be
3037 renewed, and returns undefined if the borrower, loan, or item
3042 sub GetSoonestRenewDate {
3043 my ( $borrowernumber, $itemnumber ) = @_;
3045 my $dbh = C4::Context->dbh;
3047 my $item = Koha::Items->find($itemnumber) or return;
3048 my $itemissue = $item->checkout or return;
3050 $borrowernumber ||= $itemissue->borrowernumber;
3051 my $patron = Koha::Patrons->find( $borrowernumber )
3054 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3055 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3056 { categorycode => $patron->categorycode,
3057 itemtype => $item->effective_itemtype,
3058 branchcode => $branchcode
3062 my $now = dt_from_string;
3063 return $now unless $issuing_rule;
3065 if ( defined $issuing_rule->norenewalbefore
3066 and $issuing_rule->norenewalbefore ne "" )
3068 my $soonestrenewal =
3069 dt_from_string( $itemissue->date_due )->subtract(
3070 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3072 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3073 and $issuing_rule->lengthunit eq 'days' )
3075 $soonestrenewal->truncate( to => 'day' );
3077 return $soonestrenewal if $now < $soonestrenewal;
3082 =head2 GetLatestAutoRenewDate
3084 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3086 Find out the latest possible auto renew date of a borrowed item.
3088 C<$borrowernumber> is the borrower number of the patron who currently
3089 has the item on loan.
3091 C<$itemnumber> is the number of the item to renew.
3093 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3094 auto renew date, based on the value "No auto renewal after" and the "No auto
3095 renewal after (hard limit) of the applicable issuing rule.
3096 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3097 or item cannot be found.
3101 sub GetLatestAutoRenewDate {
3102 my ( $borrowernumber, $itemnumber ) = @_;
3104 my $dbh = C4::Context->dbh;
3106 my $item = Koha::Items->find($itemnumber) or return;
3107 my $itemissue = $item->checkout or return;
3109 $borrowernumber ||= $itemissue->borrowernumber;
3110 my $patron = Koha::Patrons->find( $borrowernumber )
3113 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3114 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3115 { categorycode => $patron->categorycode,
3116 itemtype => $item->effective_itemtype,
3117 branchcode => $branchcode
3121 return unless $issuing_rule;
3123 if ( not $issuing_rule->no_auto_renewal_after
3124 or $issuing_rule->no_auto_renewal_after eq '' )
3125 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3126 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3128 my $maximum_renewal_date;
3129 if ( $issuing_rule->no_auto_renewal_after ) {
3130 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3131 $maximum_renewal_date->add(
3132 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3136 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3137 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3138 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3140 return $maximum_renewal_date;
3144 =head2 GetIssuingCharges
3146 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3148 Calculate how much it would cost for a given patron to borrow a given
3149 item, including any applicable discounts.
3151 C<$itemnumber> is the item number of item the patron wishes to borrow.
3153 C<$borrowernumber> is the patron's borrower number.
3155 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3156 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3161 sub GetIssuingCharges {
3163 # calculate charges due
3164 my ( $itemnumber, $borrowernumber ) = @_;
3166 my $dbh = C4::Context->dbh;
3169 # Get the book's item type and rental charge (via its biblioitem).
3170 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3171 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3172 $charge_query .= (C4::Context->preference('item-level_itypes'))
3173 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3174 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3176 $charge_query .= ' WHERE items.itemnumber =?';
3178 my $sth = $dbh->prepare($charge_query);
3179 $sth->execute($itemnumber);
3180 if ( my $item_data = $sth->fetchrow_hashref ) {
3181 $item_type = $item_data->{itemtype};
3182 $charge = $item_data->{rentalcharge};
3183 my $branch = C4::Context::mybranch();
3184 my $discount_query = q|SELECT rentaldiscount,
3185 issuingrules.itemtype, issuingrules.branchcode
3187 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3188 WHERE borrowers.borrowernumber = ?
3189 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3190 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3191 my $discount_sth = $dbh->prepare($discount_query);
3192 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3193 my $discount_rules = $discount_sth->fetchall_arrayref({});
3194 if (@{$discount_rules}) {
3195 # We may have multiple rules so get the most specific
3196 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3197 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3200 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3204 return ( $charge, $item_type );
3207 # Select most appropriate discount rule from those returned
3208 sub _get_discount_from_rule {
3209 my ($rules_ref, $branch, $itemtype) = @_;
3212 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3213 $discount = $rules_ref->[0]->{rentaldiscount};
3214 return (defined $discount) ? $discount : 0;
3216 # could have up to 4 does one match $branch and $itemtype
3217 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3219 $discount = $d[0]->{rentaldiscount};
3220 return (defined $discount) ? $discount : 0;
3222 # do we have item type + all branches
3223 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype
} eq $itemtype } @
{$rules_ref};
3225 $discount = $d[0]->{rentaldiscount
};
3226 return (defined $discount) ?
$discount : 0;
3228 # do we all item types + this branch
3229 @d = grep { $_->{branchcode
} eq $branch && $_->{itemtype
} eq q{*} } @
{$rules_ref};
3231 $discount = $d[0]->{rentaldiscount
};
3232 return (defined $discount) ?
$discount : 0;
3234 # so all and all (surely we wont get here)
3235 @d = grep { $_->{branchcode
} eq q{*} && $_->{itemtype
} eq q{*} } @
{$rules_ref};
3237 $discount = $d[0]->{rentaldiscount
};
3238 return (defined $discount) ?
$discount : 0;
3244 =head2 AddIssuingCharge
3246 &AddIssuingCharge( $checkout, $charge, $type )
3250 sub AddIssuingCharge
{
3251 my ( $checkout, $charge, $type ) = @_;
3253 # FIXME What if checkout does not exist?
3255 my $account = Koha
::Account
->new({ patron_id
=> $checkout->borrowernumber });
3256 my $accountline = $account->add_debit(
3260 user_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'number'} : undef,
3261 library_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'branch'} : undef,
3262 interface
=> C4
::Context
->interface,
3264 item_id
=> $checkout->itemnumber,
3265 issue_id
=> $checkout->issue_id,
3272 GetTransfers($itemnumber);
3277 my ($itemnumber) = @_;
3279 my $dbh = C4
::Context
->dbh;
3286 FROM branchtransfers
3287 WHERE itemnumber = ?
3288 AND datearrived IS NULL
3290 my $sth = $dbh->prepare($query);
3291 $sth->execute($itemnumber);
3292 my @row = $sth->fetchrow_array();
3296 =head2 GetTransfersFromTo
3298 @results = GetTransfersFromTo($frombranch,$tobranch);
3300 Returns the list of pending transfers between $from and $to branch
3304 sub GetTransfersFromTo
{
3305 my ( $frombranch, $tobranch ) = @_;
3306 return unless ( $frombranch && $tobranch );
3307 my $dbh = C4
::Context
->dbh;
3309 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3310 FROM branchtransfers
3313 AND datearrived IS NULL
3315 my $sth = $dbh->prepare($query);
3316 $sth->execute( $frombranch, $tobranch );
3319 while ( my $data = $sth->fetchrow_hashref ) {
3320 push @gettransfers, $data;
3322 return (@gettransfers);
3325 =head2 DeleteTransfer
3327 &DeleteTransfer($itemnumber);
3331 sub DeleteTransfer
{
3332 my ($itemnumber) = @_;
3333 return unless $itemnumber;
3334 my $dbh = C4
::Context
->dbh;
3335 my $sth = $dbh->prepare(
3336 "DELETE FROM branchtransfers
3338 AND datearrived IS NULL "
3340 return $sth->execute($itemnumber);
3343 =head2 SendCirculationAlert
3345 Send out a C<check-in> or C<checkout> alert using the messaging system.
3353 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3357 Hashref of information about the item being checked in or out.
3361 Hashref of information about the borrower of the item.
3365 The branchcode from where the checkout or check-in took place.
3371 SendCirculationAlert({
3374 borrower => $borrower,
3380 sub SendCirculationAlert
{
3382 my ($type, $item, $borrower, $branch) =
3383 ($opts->{type
}, $opts->{item
}, $opts->{borrower
}, $opts->{branch
});
3384 my %message_name = (
3385 CHECKIN
=> 'Item_Check_in',
3386 CHECKOUT
=> 'Item_Checkout',
3387 RENEWAL
=> 'Item_Checkout',
3389 my $borrower_preferences = C4
::Members
::Messaging
::GetMessagingPreferences
({
3390 borrowernumber
=> $borrower->{borrowernumber
},
3391 message_name
=> $message_name{$type},
3393 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ?
'issues' : 'old_issues';
3395 my $schema = Koha
::Database
->new->schema;
3396 my @transports = keys %{ $borrower_preferences->{transports
} };
3398 # From the MySQL doc:
3399 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3400 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3401 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3402 my $do_not_lock = ( exists $ENV{_
} && $ENV{_
} =~ m
|prove
| ) || $ENV{KOHA_NO_TABLE_LOCKS
};
3404 for my $mtt (@transports) {
3405 my $letter = C4
::Letters
::GetPreparedLetter
(
3406 module
=> 'circulation',
3407 letter_code
=> $type,
3408 branchcode
=> $branch,
3409 message_transport_type
=> $mtt,
3410 lang
=> $borrower->{lang
},
3412 $issues_table => $item->{itemnumber
},
3413 'items' => $item->{itemnumber
},
3414 'biblio' => $item->{biblionumber
},
3415 'biblioitems' => $item->{biblionumber
},
3416 'borrowers' => $borrower,
3417 'branches' => $branch,
3421 $schema->storage->txn_begin;
3422 C4
::Context
->dbh->do(q
|LOCK TABLE message_queue READ
|) unless $do_not_lock;
3423 C4
::Context
->dbh->do(q
|LOCK TABLE message_queue WRITE
|) unless $do_not_lock;
3424 my $message = C4
::Message
->find_last_message($borrower, $type, $mtt);
3425 unless ( $message ) {
3426 C4
::Context
->dbh->do(q
|UNLOCK TABLES
|) unless $do_not_lock;
3427 C4
::Message
->enqueue($letter, $borrower, $mtt);
3429 $message->append($letter);
3432 C4
::Context
->dbh->do(q
|UNLOCK TABLES
|) unless $do_not_lock;
3433 $schema->storage->txn_commit;
3439 =head2 updateWrongTransfer
3441 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3443 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
3447 sub updateWrongTransfer
{
3448 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3449 my $dbh = C4
::Context
->dbh;
3450 # first step validate the actual line of transfert .
3453 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3455 $sth->execute($FromLibrary,$itemNumber);
3457 # second step create a new line of branchtransfer to the right location .
3458 ModItemTransfer
($itemNumber, $FromLibrary, $waitingAtLibrary);
3460 #third step changing holdingbranch of item
3461 UpdateHoldingbranch
($FromLibrary,$itemNumber);
3464 =head2 UpdateHoldingbranch
3466 $items = UpdateHoldingbranch($branch,$itmenumber);
3468 Simple methode for updating hodlingbranch in items BDD line
3472 sub UpdateHoldingbranch
{
3473 my ( $branch,$itemnumber ) = @_;
3474 ModItem
({ holdingbranch
=> $branch }, undef, $itemnumber);
3479 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3481 this function calculates the due date given the start date and configured circulation rules,
3482 checking against the holidays calendar as per the 'useDaysMode' syspref.
3483 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3484 C<$itemtype> = itemtype code of item in question
3485 C<$branch> = location whose calendar to use
3486 C<$borrower> = Borrower object
3487 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3492 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3496 # loanlength now a href
3498 GetLoanLength
( $borrower->{'categorycode'}, $itemtype, $branch );
3500 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod
} )
3506 if (ref $startdate ne 'DateTime' ) {
3507 $datedue = dt_from_string
($datedue);
3509 $datedue = $startdate->clone;
3513 DateTime
->now( time_zone
=> C4
::Context
->tz() )
3514 ->truncate( to
=> 'minute' );
3518 # calculate the datedue as normal
3519 if ( C4
::Context
->preference('useDaysMode') eq 'Days' )
3520 { # ignoring calendar
3521 if ( $loanlength->{lengthunit
} eq 'hours' ) {
3522 $datedue->add( hours
=> $loanlength->{$length_key} );
3524 $datedue->add( days
=> $loanlength->{$length_key} );
3525 $datedue->set_hour(23);
3526 $datedue->set_minute(59);
3530 if ($loanlength->{lengthunit
} eq 'hours') {
3531 $dur = DateTime
::Duration
->new( hours
=> $loanlength->{$length_key});
3534 $dur = DateTime
::Duration
->new( days
=> $loanlength->{$length_key});
3536 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
3537 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit
} );
3538 if ($loanlength->{lengthunit
} eq 'days') {
3539 $datedue->set_hour(23);
3540 $datedue->set_minute(59);
3544 # if Hard Due Dates are used, retrieve them and apply as necessary
3545 my ( $hardduedate, $hardduedatecompare ) =
3546 GetHardDueDate
( $borrower->{'categorycode'}, $itemtype, $branch );
3547 if ($hardduedate) { # hardduedates are currently dates
3548 $hardduedate->truncate( to
=> 'minute' );
3549 $hardduedate->set_hour(23);
3550 $hardduedate->set_minute(59);
3551 my $cmp = DateTime
->compare( $hardduedate, $datedue );
3553 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3554 # if the calculated date is before the 'after' Hard Due Date (floor), override
3555 # if the hard due date is set to 'exactly', overrride
3556 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3557 $datedue = $hardduedate->clone;
3560 # in all other cases, keep the date due as it is
3564 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3565 if ( C4
::Context
->preference('ReturnBeforeExpiry') ) {
3566 my $expiry_dt = dt_from_string
( $borrower->{dateexpiry
}, 'iso', 'floating');
3567 if( $expiry_dt ) { #skip empty expiry date..
3568 $expiry_dt->set( hour
=> 23, minute
=> 59);
3569 my $d1= $datedue->clone->set_time_zone('floating');
3570 if ( DateTime
->compare( $d1, $expiry_dt ) == 1 ) {
3571 $datedue = $expiry_dt->clone->set_time_zone( C4
::Context
->tz );
3574 if ( C4
::Context
->preference('useDaysMode') ne 'Days' ) {
3575 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
3576 if ( $calendar->is_holiday($datedue) ) {
3577 # Don't return on a closed day
3578 $datedue = $calendar->prev_open_day( $datedue );
3587 sub CheckValidBarcode
{
3589 my $dbh = C4
::Context
->dbh;
3590 my $query=qq|SELECT count
(*)
3594 my $sth = $dbh->prepare($query);
3595 $sth->execute($barcode);
3596 my $exist=$sth->fetchrow ;
3600 =head2 IsBranchTransferAllowed
3602 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3604 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3606 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3607 Koha::Item->can_be_transferred.
3611 sub IsBranchTransferAllowed
{
3612 my ( $toBranch, $fromBranch, $code ) = @_;
3614 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3616 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3617 my $dbh = C4
::Context
->dbh;
3619 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3620 $sth->execute( $toBranch, $fromBranch, $code );
3621 my $limit = $sth->fetchrow_hashref();
3623 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3624 if ( $limit->{'limitId'} ) {
3631 =head2 CreateBranchTransferLimit
3633 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3635 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3637 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3641 sub CreateBranchTransferLimit
{
3642 my ( $toBranch, $fromBranch, $code ) = @_;
3643 return unless defined($toBranch) && defined($fromBranch);
3644 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3646 my $dbh = C4
::Context
->dbh;
3648 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3649 return $sth->execute( $code, $toBranch, $fromBranch );
3652 =head2 DeleteBranchTransferLimits
3654 my $result = DeleteBranchTransferLimits($frombranch);
3656 Deletes all the library transfer limits for one library. Returns the
3657 number of limits deleted, 0e0 if no limits were deleted, or undef if
3658 no arguments are supplied.
3660 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3661 fromBranch => $fromBranch
3666 sub DeleteBranchTransferLimits
{
3668 return unless defined $branch;
3669 my $dbh = C4
::Context
->dbh;
3670 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3671 return $sth->execute($branch);
3675 my ( $borrowernumber, $itemnum ) = @_;
3676 MarkIssueReturned
( $borrowernumber, $itemnum );
3681 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3683 unless ( $mark_lost_from ) {
3684 # Temporary check to avoid regressions
3685 die q
|LostItem called without
$mark_lost_from, check the API
.|;
3689 if ( $force_mark_returned ) {
3692 my $pref = C4
::Context
->preference('MarkLostItemsAsReturned') // q{};
3693 $mark_returned = ( $pref =~ m
|$mark_lost_from| );
3696 my $dbh = C4
::Context
->dbh();
3697 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3699 JOIN items USING (itemnumber)
3700 JOIN biblio USING (biblionumber)
3701 WHERE issues.itemnumber=?");
3702 $sth->execute($itemnumber);
3703 my $issues=$sth->fetchrow_hashref();
3705 # If a borrower lost the item, add a replacement cost to the their record
3706 if ( my $borrowernumber = $issues->{borrowernumber
} ){
3707 my $patron = Koha
::Patrons
->find( $borrowernumber );
3709 my $fix = _FixOverduesOnReturn
($borrowernumber, $itemnumber, C4
::Context
->preference('WhenLostForgiveFine'), 'LOST');
3710 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3712 if (C4
::Context
->preference('WhenLostChargeReplacementFee')){
3713 C4
::Accounts
::chargelostitem
($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "$issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3714 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3715 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3718 MarkIssueReturned
($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3721 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3722 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers
($itemnumber)) {
3723 ModItem
({holdingbranch
=> $frombranch}, undef, $itemnumber);
3725 my $transferdeleted = DeleteTransfer
($itemnumber);
3728 sub GetOfflineOperations
{
3729 my $dbh = C4
::Context
->dbh;
3730 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3731 $sth->execute(C4
::Context
->userenv->{'branch'});
3732 my $results = $sth->fetchall_arrayref({});
3736 sub GetOfflineOperation
{
3737 my $operationid = shift;
3738 return unless $operationid;
3739 my $dbh = C4
::Context
->dbh;
3740 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3741 $sth->execute( $operationid );
3742 return $sth->fetchrow_hashref;
3745 sub AddOfflineOperation
{
3746 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3747 my $dbh = C4
::Context
->dbh;
3748 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3749 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3753 sub DeleteOfflineOperation
{
3754 my $dbh = C4
::Context
->dbh;
3755 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3756 $sth->execute( shift );
3760 sub ProcessOfflineOperation
{
3761 my $operation = shift;
3764 if ( $operation->{action
} eq 'return' ) {
3765 $report = ProcessOfflineReturn
( $operation );
3766 } elsif ( $operation->{action
} eq 'issue' ) {
3767 $report = ProcessOfflineIssue
( $operation );
3768 } elsif ( $operation->{action
} eq 'payment' ) {
3769 $report = ProcessOfflinePayment
( $operation );
3772 DeleteOfflineOperation
( $operation->{operationid
} ) if $operation->{operationid
};
3777 sub ProcessOfflineReturn
{
3778 my $operation = shift;
3780 my $item = Koha
::Items
->find({barcode
=> $operation->{barcode
}});
3783 my $itemnumber = $item->itemnumber;
3784 my $issue = GetOpenIssue
( $itemnumber );
3787 $issue->{borrowernumber
},
3789 $operation->{timestamp
},
3792 { renewals
=> 0, onloan
=> undef },
3793 $issue->{'biblionumber'},
3799 return "Item not issued.";
3802 return "Item not found.";
3806 sub ProcessOfflineIssue
{
3807 my $operation = shift;
3809 my $patron = Koha
::Patrons
->find( { cardnumber
=> $operation->{cardnumber
} } );
3812 my $item = Koha
::Items
->find({ barcode
=> $operation->{barcode
} });
3814 return "Barcode not found.";
3816 my $itemnumber = $item->itemnumber;
3817 my $issue = GetOpenIssue
( $itemnumber );
3819 if ( $issue and ( $issue->{borrowernumber
} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3821 $issue->{borrowernumber
},
3823 $operation->{timestamp
},
3828 $operation->{'barcode'},
3831 $operation->{timestamp
},
3836 return "Borrower not found.";
3840 sub ProcessOfflinePayment
{
3841 my $operation = shift;
3843 my $patron = Koha
::Patrons
->find({ cardnumber
=> $operation->{cardnumber
} });
3845 $patron->account->pay(
3847 amount
=> $operation->{amount
},
3848 library_id
=> $operation->{branchcode
},
3858 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3860 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3865 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3869 ? Koha
::Items
->find($itemnumber)
3870 : Koha
::Items
->find( { barcode
=> $barcode } );
3874 return C4
::Letters
::GetPreparedLetter
(
3875 module
=> 'circulation',
3876 letter_code
=> 'TRANSFERSLIP',
3877 branchcode
=> $branch,
3879 'branches' => $to_branch,
3880 'biblio' => $item->biblionumber,
3881 'items' => $item->unblessed,
3886 =head2 CheckIfIssuedToPatron
3888 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3890 Return 1 if any record item is issued to patron, otherwise return 0
3894 sub CheckIfIssuedToPatron
{
3895 my ($borrowernumber, $biblionumber) = @_;
3897 my $dbh = C4
::Context
->dbh;
3899 SELECT COUNT
(*) FROM issues
3900 LEFT JOIN items ON items
.itemnumber
= issues
.itemnumber
3901 WHERE items
.biblionumber
= ?
3902 AND issues
.borrowernumber
= ?
3904 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3905 return 1 if $is_issued;
3911 IsItemIssued( $itemnumber )
3913 Return 1 if the item is on loan, otherwise return 0
3918 my $itemnumber = shift;
3919 my $dbh = C4
::Context
->dbh;
3920 my $sth = $dbh->prepare(q{
3923 WHERE itemnumber = ?
3925 $sth->execute($itemnumber);
3926 return $sth->fetchrow;
3929 =head2 GetAgeRestriction
3931 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3932 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3934 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3935 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3937 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3938 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3939 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3940 Negative days mean the borrower has gone past the age restriction age.
3944 sub GetAgeRestriction
{
3945 my ($record_restrictions, $borrower) = @_;
3946 my $markers = C4
::Context
->preference('AgeRestrictionMarker');
3948 # Split $record_restrictions to something like FSK 16 or PEGI 6
3949 my @values = split ' ', uc($record_restrictions);
3950 return unless @values;
3952 # Search first occurrence of one of the markers
3953 my @markers = split /\|/, uc($markers);
3954 return unless @markers;
3957 my $restriction_year = 0;
3958 for my $value (@values) {
3960 for my $marker (@markers) {
3961 $marker =~ s/^\s+//; #remove leading spaces
3962 $marker =~ s/\s+$//; #remove trailing spaces
3963 if ( $marker eq $value ) {
3964 if ( $index <= $#values ) {
3965 $restriction_year += $values[$index];
3969 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3971 # Perhaps it is something like "K16" (as in Finland)
3972 $restriction_year += $1;
3976 last if ( $restriction_year > 0 );
3979 #Check if the borrower is age restricted for this material and for how long.
3980 if ($restriction_year && $borrower) {
3981 if ( $borrower->{'dateofbirth'} ) {
3982 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3983 $alloweddate[0] += $restriction_year;
3985 #Prevent runime eror on leap year (invalid date)
3986 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3987 $alloweddate[2] = 28;
3990 #Get how many days the borrower has to reach the age restriction
3991 my @Today = split /-/, DateTime
->today->ymd();
3992 my $daysToAgeRestriction = Date_to_Days
(@alloweddate) - Date_to_Days
(@Today);
3993 #Negative days means the borrower went past the age restriction age
3994 return ($restriction_year, $daysToAgeRestriction);
3998 return ($restriction_year);
4002 =head2 GetPendingOnSiteCheckouts
4006 sub GetPendingOnSiteCheckouts
{
4007 my $dbh = C4
::Context
->dbh;
4008 return $dbh->selectall_arrayref(q
|
4014 items
.itemcallnumber
,
4018 issues
.date_due
< NOW
() AS is_overdue
,
4021 borrowers
.firstname
,
4023 borrowers
.cardnumber
,
4024 borrowers
.borrowernumber
4026 LEFT JOIN issues ON items
.itemnumber
= issues
.itemnumber
4027 LEFT JOIN biblio ON items
.biblionumber
= biblio
.biblionumber
4028 LEFT JOIN borrowers ON issues
.borrowernumber
= borrowers
.borrowernumber
4029 WHERE issues
.onsite_checkout
= 1
4030 |, { Slice
=> {} } );
4036 my ($count, $branch, $itemtype, $ccode, $newness)
4037 = @
$params{qw(count branch itemtype ccode newness)};
4039 my $dbh = C4
::Context
->dbh;
4042 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4043 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4044 i.ccode, SUM(i.issues) AS count
4046 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4047 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4050 my (@where_strs, @where_args);
4053 push @where_strs, 'i.homebranch = ?';
4054 push @where_args, $branch;
4057 if (C4
::Context
->preference('item-level_itypes')){
4058 push @where_strs, 'i.itype = ?';
4059 push @where_args, $itemtype;
4061 push @where_strs, 'bi.itemtype = ?';
4062 push @where_args, $itemtype;
4066 push @where_strs, 'i.ccode = ?';
4067 push @where_args, $ccode;
4070 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4071 push @where_args, $newness;
4075 $query .= 'WHERE ' . join(' AND ', @where_strs);
4079 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4080 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4085 $query .= q{ ) xxx WHERE count > 0 };
4086 $count = int($count);
4088 $query .= "LIMIT $count";
4091 my $rows = $dbh->selectall_arrayref($query, { Slice
=> {} }, @where_args);
4096 sub _CalculateAndUpdateFine
{
4099 my $borrower = $params->{borrower
};
4100 my $item = $params->{item
};
4101 my $issue = $params->{issue
};
4102 my $return_date = $params->{return_date
};
4104 unless ($borrower) { carp
"No borrower passed in!" && return; }
4105 unless ($item) { carp
"No item passed in!" && return; }
4106 unless ($issue) { carp
"No issue passed in!" && return; }
4108 my $datedue = dt_from_string
( $issue->date_due );
4110 # we only need to calculate and change the fines if we want to do that on return
4111 # Should be on for hourly loans
4112 my $control = C4
::Context
->preference('CircControl');
4113 my $control_branchcode =
4114 ( $control eq 'ItemHomeLibrary' ) ?
$item->{homebranch
}
4115 : ( $control eq 'PatronLibrary' ) ?
$borrower->{branchcode
}
4116 : $issue->branchcode;
4118 my $date_returned = $return_date ?
$return_date : dt_from_string
();
4120 my ( $amount, $unitcounttotal, $unitcount ) =
4121 C4
::Overdues
::CalcFine
( $item, $borrower->{categorycode
}, $control_branchcode, $datedue, $date_returned );
4123 if ( C4
::Context
->preference('finesMode') eq 'production' ) {
4124 if ( $amount > 0 ) {
4125 C4
::Overdues
::UpdateFine
({
4126 issue_id
=> $issue->issue_id,
4127 itemnumber
=> $issue->itemnumber,
4128 borrowernumber
=> $issue->borrowernumber,
4130 due
=> output_pref
($datedue),
4133 elsif ($return_date) {
4135 # Backdated returns may have fines that shouldn't exist,
4136 # so in this case, we need to drop those fines to 0
4138 C4
::Overdues
::UpdateFine
({
4139 issue_id
=> $issue->issue_id,
4140 itemnumber
=> $issue->itemnumber,
4141 borrowernumber
=> $issue->borrowernumber,
4143 due
=> output_pref
($datedue),
4149 sub _item_denied_renewal
{
4152 my $item = $params->{item
};
4153 return unless $item;
4155 my $denyingrules = Koha
::Config
::SysPrefs
->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4156 return unless $denyingrules;
4157 foreach my $field (keys %$denyingrules) {
4158 my $val = $item->$field;
4159 if( !defined $val) {
4160 if ( any
{ !defined $_ } @
{$denyingrules->{$field}} ){
4163 } elsif (any
{ defined($_) && $val eq $_ } @
{$denyingrules->{$field}}) {
4164 # If the results matches the values in the syspref
4165 # We return true if match found
4179 Koha Development Team <http://koha-community.org/>