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::RefundLostItemFeeRule;
58 use Koha::RefundLostItemFeeRules;
59 use Koha::Account::Lines;
60 use Koha::Account::Offsets;
61 use Koha::Config::SysPrefs;
63 use List::MoreUtils qw( uniq any );
64 use Scalar::Util qw( looks_like_number );
74 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
80 # FIXME subs that should probably be elsewhere
85 &GetPendingOnSiteCheckouts
88 # subs to deal with issuing a book
96 &GetLatestAutoRenewDate
98 &GetBranchBorrowerCircRule
102 &CheckIfIssuedToPatron
107 # subs to deal with returns
113 # subs to deal with transfers
120 &IsBranchTransferAllowed
121 &CreateBranchTransferLimit
122 &DeleteBranchTransferLimits
126 # subs to deal with offline circulation
128 &GetOfflineOperations
131 &DeleteOfflineOperation
132 &ProcessOfflineOperation
138 C4::Circulation - Koha circulation module
146 The functions in this module deal with circulation, issues, and
147 returns, as well as general information about the library.
148 Also deals with inventory.
154 $str = &barcodedecode($barcode, [$filter]);
156 Generic filter function for barcode string.
157 Called on every circ if the System Pref itemBarcodeInputFilter is set.
158 Will do some manipulation of the barcode for systems that deliver a barcode
159 to circulation.pl that differs from the barcode stored for the item.
160 For proper functioning of this filter, calling the function on the
161 correct barcode string (items.barcode) should return an unaltered barcode.
163 The optional $filter argument is to allow for testing or explicit
164 behavior that ignores the System Pref. Valid values are the same as the
169 # FIXME -- the &decode fcn below should be wrapped into this one.
170 # FIXME -- these plugins should be moved out of Circulation.pm
173 my ($barcode, $filter) = @_;
174 my $branch = C4::Context::mybranch();
175 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
176 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
177 if ($filter eq 'whitespace') {
179 } elsif ($filter eq 'cuecat') {
181 my @fields = split( /\./, $barcode );
182 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
183 ($#results == 2) and return $results[2];
184 } elsif ($filter eq 'T-prefix') {
185 if ($barcode =~ /^[Tt](\d)/) {
186 (defined($1) and $1 eq '0') and return $barcode;
187 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
189 return sprintf("T%07d", $barcode);
190 # FIXME: $barcode could be "T1", causing warning: substr outside of string
191 # Why drop the nonzero digit after the T?
192 # Why pass non-digits (or empty string) to "T%07d"?
193 } elsif ($filter eq 'libsuite8') {
194 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
195 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
196 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
198 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
201 } elsif ($filter eq 'EAN13') {
202 my $ean = CheckDigits('ean');
203 if ( $ean->is_valid($barcode) ) {
204 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
205 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
207 warn "# [$barcode] not valid EAN-13/UPC-A\n";
210 return $barcode; # return barcode, modified or not
215 $str = &decode($chunk);
217 Decodes a segment of a string emitted by a CueCat barcode scanner and
220 FIXME: Should be replaced with Barcode::Cuecat from CPAN
221 or Javascript based decoding on the client side.
228 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
229 my @s = map { index( $seq, $_ ); } split( //, $encoded );
230 my $l = ( $#s + 1 ) % 4;
233 # warn "Error: Cuecat decode parsing failed!";
241 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
243 chr( ( $n >> 16 ) ^ 67 )
244 .chr( ( $n >> 8 & 255 ) ^ 67 )
245 .chr( ( $n & 255 ) ^ 67 );
248 $r = substr( $r, 0, length($r) - $l );
254 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
255 $barcode, $ignore_reserves);
257 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
259 C<$newbranch> is the code for the branch to which the item should be transferred.
261 C<$barcode> is the barcode of the item to be transferred.
263 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
264 Otherwise, if an item is reserved, the transfer fails.
266 Returns three values:
272 is true if the transfer was successful.
276 is a reference-to-hash which may have any of the following keys:
282 There is no item in the catalog with the given barcode. The value is C<$barcode>.
284 =item C<DestinationEqualsHolding>
286 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.
290 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.
294 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>.
296 =item C<WasTransferred>
298 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
307 my ( $tbr, $barcode, $ignoreRs ) = @_;
310 my $item = Koha::Items->find( { barcode => $barcode } );
314 $messages->{'BadBarcode'} = $barcode;
318 my $itemnumber = $item->itemnumber;
319 my $issue = GetOpenIssue($itemnumber);
320 # get branches of book...
321 my $hbr = $item->homebranch;
322 my $fbr = $item->holdingbranch;
324 # if using Branch Transfer Limits
325 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
326 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
327 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
328 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
329 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
332 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
333 $messages->{'NotAllowed'} = $tbr . "::" . $code;
338 # can't transfer book if is already there....
339 if ( $fbr eq $tbr ) {
340 $messages->{'DestinationEqualsHolding'} = 1;
344 # check if it is still issued to someone, return it...
346 AddReturn( $barcode, $fbr );
347 $messages->{'WasReturned'} = $issue->borrowernumber;
351 # That'll save a database query.
352 my ( $resfound, $resrec, undef ) =
353 CheckReserves( $itemnumber );
354 if ( $resfound and not $ignoreRs ) {
355 $resrec->{'ResFound'} = $resfound;
357 # $messages->{'ResFound'} = $resrec;
361 #actually do the transfer....
363 ModItemTransfer( $itemnumber, $fbr, $tbr );
365 # don't need to update MARC anymore, we do it in batch now
366 $messages->{'WasTransfered'} = 1;
369 ModDateLastSeen( $itemnumber );
370 return ( $dotransfer, $messages );
375 my $borrower = shift;
376 my $biblionumber = shift;
379 my $onsite_checkout = $params->{onsite_checkout} || 0;
380 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
381 my $cat_borrower = $borrower->{'categorycode'};
382 my $dbh = C4::Context->dbh;
384 # Get which branchcode we need
385 $branch = _GetCircControlBranch($item,$borrower);
386 my $type = (C4::Context->preference('item-level_itypes'))
387 ? $item->{'itype'} # item-level
388 : $item->{'itemtype'}; # biblio-level
390 # given branch, patron category, and item type, determine
391 # applicable issuing rule
392 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
394 categorycode => $cat_borrower,
396 branchcode => $branch,
397 rule_name => 'maxissueqty',
400 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
402 categorycode => $cat_borrower,
404 branchcode => $branch,
405 rule_name => 'maxonsiteissueqty',
410 # if a rule is found and has a loan limit set, count
411 # how many loans the patron already has that meet that
413 if (defined($maxissueqty_rule) and defined($maxissueqty_rule->rule_value)) {
416 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
418 JOIN items USING (itemnumber)
421 my $rule_itemtype = $maxissueqty_rule->itemtype;
422 if ($rule_itemtype eq "*") {
423 # matching rule has the default item type, so count only
424 # those existing loans that don't fall under a more
426 if (C4::Context->preference('item-level_itypes')) {
427 $count_query .= " WHERE items.itype NOT IN (
428 SELECT itemtype FROM issuingrules
430 AND (categorycode = ? OR categorycode = ?)
434 $count_query .= " JOIN biblioitems USING (biblionumber)
435 WHERE biblioitems.itemtype NOT IN (
436 SELECT itemtype FROM issuingrules
438 AND (categorycode = ? OR categorycode = ?)
442 push @bind_params, $maxissueqty_rule->branchcode;
443 push @bind_params, $maxissueqty_rule->categorycode;
444 push @bind_params, $cat_borrower;
446 # rule has specific item type, so count loans of that
448 if (C4::Context->preference('item-level_itypes')) {
449 $count_query .= " WHERE items.itype = ? ";
451 $count_query .= " JOIN biblioitems USING (biblionumber)
452 WHERE biblioitems.itemtype= ? ";
454 push @bind_params, $type;
457 $count_query .= " AND borrowernumber = ? ";
458 push @bind_params, $borrower->{'borrowernumber'};
459 my $rule_branch = $maxissueqty_rule->branchcode;
460 if ($rule_branch ne "*") {
461 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
462 $count_query .= " AND issues.branchcode = ? ";
463 push @bind_params, $branch;
464 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
465 ; # if branch is the patron's home branch, then count all loans by patron
467 $count_query .= " AND items.homebranch = ? ";
468 push @bind_params, $branch;
472 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
474 my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : 0;
475 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : 0;
477 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
478 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
480 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
481 count => $onsite_checkout_count,
482 max_allowed => $max_onsite_checkouts_allowed,
486 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
487 my $delta = $switch_onsite_checkout ? 1 : 0;
488 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
490 reason => 'TOO_MANY_CHECKOUTS',
491 count => $checkout_count,
492 max_allowed => $max_checkouts_allowed,
495 } elsif ( not $onsite_checkout ) {
496 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
498 reason => 'TOO_MANY_CHECKOUTS',
499 count => $checkout_count - $onsite_checkout_count,
500 max_allowed => $max_checkouts_allowed,
506 # Now count total loans against the limit for the branch
507 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
508 if (defined($branch_borrower_circ_rule->{patron_maxissueqty})) {
509 my @bind_params = ();
510 my $branch_count_query = q|
511 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
513 JOIN items USING (itemnumber)
514 WHERE borrowernumber = ?
516 push @bind_params, $borrower->{borrowernumber};
518 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
519 $branch_count_query .= " AND issues.branchcode = ? ";
520 push @bind_params, $branch;
521 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
522 ; # if branch is the patron's home branch, then count all loans by patron
524 $branch_count_query .= " AND items.homebranch = ? ";
525 push @bind_params, $branch;
527 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
528 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
529 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
531 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
532 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
534 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
535 count => $onsite_checkout_count,
536 max_allowed => $max_onsite_checkouts_allowed,
540 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
541 my $delta = $switch_onsite_checkout ? 1 : 0;
542 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
544 reason => 'TOO_MANY_CHECKOUTS',
545 count => $checkout_count,
546 max_allowed => $max_checkouts_allowed,
549 } elsif ( not $onsite_checkout ) {
550 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
552 reason => 'TOO_MANY_CHECKOUTS',
553 count => $checkout_count - $onsite_checkout_count,
554 max_allowed => $max_checkouts_allowed,
560 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
561 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
564 # OK, the patron can issue !!!
568 =head2 CanBookBeIssued
570 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
571 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
573 Check if a book can be issued.
575 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
577 IMPORTANT: The assumption by users of this routine is that causes blocking
578 the issue are keyed by uppercase labels and other returned
579 data is keyed in lower case!
583 =item C<$patron> is a Koha::Patron
585 =item C<$barcode> is the bar code of the book being issued.
587 =item C<$duedates> is a DateTime object.
589 =item C<$inprocess> boolean switch
591 =item C<$ignore_reserves> boolean switch
593 =item C<$params> Hashref of additional parameters
596 override_high_holds - Ignore high holds
597 onsite_checkout - Checkout is an onsite checkout that will not leave the library
605 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
606 Possible values are :
612 sticky due date is invalid
616 borrower gone with no address
620 borrower declared it's card lost
626 =head3 UNKNOWN_BARCODE
640 item is restricted (set by ??)
642 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
643 could be prevented, but ones that can be overriden by the operator.
645 Possible values are :
653 renewing, not issuing
655 =head3 ISSUED_TO_ANOTHER
657 issued to someone else.
661 reserved for someone else.
665 sticky due date is invalid or due date in the past
669 if the borrower borrows to much things
673 sub CanBookBeIssued {
674 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
675 my %needsconfirmation; # filled with problems that needs confirmations
676 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
677 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
678 my %messages; # filled with information messages that should be displayed.
680 my $onsite_checkout = $params->{onsite_checkout} || 0;
681 my $override_high_holds = $params->{override_high_holds} || 0;
683 my $item = Koha::Items->find({barcode => $barcode });
684 # MANDATORY CHECKS - unless item exists, nothing else matters
686 $issuingimpossible{UNKNOWN_BARCODE} = 1;
688 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
690 my $item_unblessed = $item->unblessed; # Transition...
691 my $issue = $item->checkout;
692 my $biblio = $item->biblio;
693 my $biblioitem = $biblio->biblioitem;
694 my $effective_itemtype = $item->effective_itemtype;
695 my $dbh = C4::Context->dbh;
696 my $patron_unblessed = $patron->unblessed;
699 # DUE DATE is OK ? -- should already have checked.
701 if ($duedate && ref $duedate ne 'DateTime') {
702 $duedate = dt_from_string($duedate);
704 my $now = DateTime->now( time_zone => C4::Context->tz() );
705 unless ( $duedate ) {
706 my $issuedate = $now->clone();
708 my $branch = _GetCircControlBranch($item_unblessed, $patron_unblessed);
709 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $branch, $patron_unblessed );
711 # Offline circ calls AddIssue directly, doesn't run through here
712 # So issuingimpossible should be ok.
715 my $today = $now->clone();
716 $today->truncate( to => 'minute');
717 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
718 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
721 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
727 if ( $patron->category->category_type eq 'X' && ( $item->barcode )) {
728 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
730 branch => C4::Context->userenv->{'branch'},
732 itemnumber => $item->itemnumber,
733 itemtype => $effective_itemtype,
734 borrowernumber => $patron->borrowernumber,
735 ccode => $item->ccode}
737 ModDateLastSeen( $item->itemnumber ); # FIXME Move to Koha::Item
738 return( { STATS => 1 }, {});
741 if ( $patron->gonenoaddress == 1 ) {
742 $issuingimpossible{GNA} = 1;
745 if ( $patron->lost == 1 ) {
746 $issuingimpossible{CARD_LOST} = 1;
748 if ( $patron->is_debarred ) {
749 $issuingimpossible{DEBARRED} = 1;
752 if ( $patron->is_expired ) {
753 $issuingimpossible{EXPIRED} = 1;
761 my $account = $patron->account;
762 my $balance = $account->balance;
763 my $non_issues_charges = $account->non_issues_charges;
764 my $other_charges = $balance - $non_issues_charges;
766 my $amountlimit = C4::Context->preference("noissuescharge");
767 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
768 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
770 # Check the debt of this patrons guarantees
771 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
772 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
773 if ( defined $no_issues_charge_guarantees ) {
774 my @guarantees = $patron->guarantees();
775 my $guarantees_non_issues_charges;
776 foreach my $g ( @guarantees ) {
777 $guarantees_non_issues_charges += $g->account->non_issues_charges;
780 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
781 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
782 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
783 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
784 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
785 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
789 if ( C4::Context->preference("IssuingInProcess") ) {
790 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
791 $issuingimpossible{DEBT} = $non_issues_charges;
792 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
793 $needsconfirmation{DEBT} = $non_issues_charges;
794 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
795 $needsconfirmation{DEBT} = $non_issues_charges;
799 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
800 $needsconfirmation{DEBT} = $non_issues_charges;
801 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
802 $issuingimpossible{DEBT} = $non_issues_charges;
803 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
804 $needsconfirmation{DEBT} = $non_issues_charges;
808 if ($balance > 0 && $other_charges > 0) {
809 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
812 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
813 $patron_unblessed = $patron->unblessed;
815 if ( my $debarred_date = $patron->is_debarred ) {
816 # patron has accrued fine days or has a restriction. $count is a date
817 if ($debarred_date eq '9999-12-31') {
818 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
821 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
823 } elsif ( my $num_overdues = $patron->has_overdues ) {
824 ## patron has outstanding overdue loans
825 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
826 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
828 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
829 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
834 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
836 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
838 # Already issued to current borrower.
839 # If it is an on-site checkout if it can be switched to a normal checkout
840 # or ask whether the loan should be renewed
842 if ( $issue->onsite_checkout
843 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
844 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
846 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
847 $patron->borrowernumber,
850 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
851 if ( $renewerror eq 'onsite_checkout' ) {
852 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
855 $issuingimpossible{NO_MORE_RENEWALS} = 1;
859 $needsconfirmation{RENEW_ISSUE} = 1;
865 # issued to someone else
867 my $patron = Koha::Patrons->find( $issue->borrowernumber );
869 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
871 unless ( $can_be_returned ) {
872 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
873 $issuingimpossible{branch_to_return} = $message;
875 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
876 $needsconfirmation{issued_firstname} = $patron->firstname;
877 $needsconfirmation{issued_surname} = $patron->surname;
878 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
879 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
883 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
885 my $switch_onsite_checkout = (
886 C4::Context->preference('SwitchOnSiteCheckouts')
888 and $issue->onsite_checkout
889 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
890 my $toomany = TooMany( $patron_unblessed, $item->biblionumber, $item_unblessed, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
891 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
892 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
893 if ( $toomany->{max_allowed} == 0 ) {
894 $needsconfirmation{PATRON_CANT} = 1;
896 if ( C4::Context->preference("AllowTooManyOverride") ) {
897 $needsconfirmation{TOO_MANY} = $toomany->{reason};
898 $needsconfirmation{current_loan_count} = $toomany->{count};
899 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
901 $issuingimpossible{TOO_MANY} = $toomany->{reason};
902 $issuingimpossible{current_loan_count} = $toomany->{count};
903 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
908 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
910 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
911 my $wants_check = $patron->wants_check_for_previous_checkout;
912 $needsconfirmation{PREVISSUE} = 1
913 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
918 if ( $item->notforloan )
920 if(!C4::Context->preference("AllowNotForLoanOverride")){
921 $issuingimpossible{NOT_FOR_LOAN} = 1;
922 $issuingimpossible{item_notforloan} = $item->notforloan;
924 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
925 $needsconfirmation{item_notforloan} = $item->notforloan;
929 # we have to check itemtypes.notforloan also
930 if (C4::Context->preference('item-level_itypes')){
931 # this should probably be a subroutine
932 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
933 $sth->execute($effective_itemtype);
934 my $notforloan=$sth->fetchrow_hashref();
935 if ($notforloan->{'notforloan'}) {
936 if (!C4::Context->preference("AllowNotForLoanOverride")) {
937 $issuingimpossible{NOT_FOR_LOAN} = 1;
938 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
940 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
941 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
946 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
947 if ( $itemtype and $itemtype->notforloan == 1){
948 if (!C4::Context->preference("AllowNotForLoanOverride")) {
949 $issuingimpossible{NOT_FOR_LOAN} = 1;
950 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
952 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
953 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
958 if ( $item->withdrawn && $item->withdrawn > 0 )
960 $issuingimpossible{WTHDRAWN} = 1;
962 if ( $item->restricted
963 && $item->restricted == 1 )
965 $issuingimpossible{RESTRICTED} = 1;
967 if ( $item->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
968 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->itemlost });
969 my $code = $av->count ? $av->next->lib : '';
970 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
971 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
973 if ( C4::Context->preference("IndependentBranches") ) {
974 my $userenv = C4::Context->userenv;
975 unless ( C4::Context->IsSuperLibrarian() ) {
976 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
977 if ( $item->$HomeOrHoldingBranch ne $userenv->{branch} ){
978 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
979 $issuingimpossible{'itemhomebranch'} = $item->$HomeOrHoldingBranch;
981 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
982 if ( $patron->branchcode ne $userenv->{branch} );
986 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
988 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
990 if ( $rentalConfirmation ){
991 my ($rentalCharge) = GetIssuingCharges( $item->itemnumber, $patron->borrowernumber );
992 if ( $rentalCharge > 0 ){
993 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
997 unless ( $ignore_reserves ) {
998 # See if the item is on reserve.
999 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->itemnumber );
1001 my $resbor = $res->{'borrowernumber'};
1002 if ( $resbor ne $patron->borrowernumber ) {
1003 my $patron = Koha::Patrons->find( $resbor );
1004 if ( $restype eq "Waiting" )
1006 # The item is on reserve and waiting, but has been
1007 # reserved by some other patron.
1008 $needsconfirmation{RESERVE_WAITING} = 1;
1009 $needsconfirmation{'resfirstname'} = $patron->firstname;
1010 $needsconfirmation{'ressurname'} = $patron->surname;
1011 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1012 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1013 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1014 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1016 elsif ( $restype eq "Reserved" ) {
1017 # The item is on reserve for someone else.
1018 $needsconfirmation{RESERVED} = 1;
1019 $needsconfirmation{'resfirstname'} = $patron->firstname;
1020 $needsconfirmation{'ressurname'} = $patron->surname;
1021 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1022 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1023 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1024 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1030 ## CHECK AGE RESTRICTION
1031 my $agerestriction = $biblioitem->agerestriction;
1032 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1033 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1034 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1035 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1038 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1042 ## check for high holds decreasing loan period
1043 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1044 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1046 if ( $check->{exceeded} ) {
1047 if ($override_high_holds) {
1048 $alerts{HIGHHOLDS} = {
1049 num_holds => $check->{outstanding},
1050 duration => $check->{duration},
1051 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1055 $needsconfirmation{HIGHHOLDS} = {
1056 num_holds => $check->{outstanding},
1057 duration => $check->{duration},
1058 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1065 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1066 # don't do the multiple loans per bib check if we've
1067 # already determined that we've got a loan on the same item
1068 !$issuingimpossible{NO_MORE_RENEWALS} &&
1069 !$needsconfirmation{RENEW_ISSUE}
1071 # Check if borrower has already issued an item from the same biblio
1072 # Only if it's not a subscription
1073 my $biblionumber = $item->biblionumber;
1074 require C4::Serials;
1075 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1076 unless ($is_a_subscription) {
1077 # FIXME Should be $patron->checkouts($args);
1078 my $checkouts = Koha::Checkouts->search(
1080 borrowernumber => $patron->borrowernumber,
1081 biblionumber => $biblionumber,
1087 # if we get here, we don't already have a loan on this item,
1088 # so if there are any loans on this bib, ask for confirmation
1089 if ( $checkouts->count ) {
1090 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1095 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1098 =head2 CanBookBeReturned
1100 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1102 Check whether the item can be returned to the provided branch
1106 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1108 =item C<$branch> is the branchcode where the return is taking place
1116 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1118 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1124 sub CanBookBeReturned {
1125 my ($item, $branch) = @_;
1126 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1128 # assume return is allowed to start
1132 # identify all cases where return is forbidden
1133 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1135 $message = $item->{'homebranch'};
1136 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1138 $message = $item->{'holdingbranch'};
1139 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1141 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1144 return ($allowed, $message);
1147 =head2 CheckHighHolds
1149 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1150 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1151 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1155 sub checkHighHolds {
1156 my ( $item, $borrower ) = @_;
1157 my $branch = _GetCircControlBranch( $item, $borrower );
1158 my $item_object = Koha::Items->find( $item->{itemnumber} );
1167 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1169 if ( $holds->count() ) {
1170 $return_data->{outstanding} = $holds->count();
1172 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1173 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1174 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1176 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1178 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1180 # static means just more than a given number of holds on the record
1182 # If the number of holds is less than the threshold, we can stop here
1183 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1184 return $return_data;
1187 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1189 # dynamic means X more than the number of holdable items on the record
1191 # let's get the items
1192 my @items = $holds->next()->biblio()->items();
1194 # Remove any items with status defined to be ignored even if the would not make item unholdable
1195 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1196 @items = grep { !$_->$status } @items;
1199 # Remove any items that are not holdable for this patron
1200 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber )->{status} eq 'OK' } @items;
1202 my $items_count = scalar @items;
1204 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1206 # If the number of holds is less than the count of items we have
1207 # plus the number of holds allowed above that count, we can stop here
1208 if ( $holds->count() <= $threshold ) {
1209 return $return_data;
1213 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1215 my $calendar = Koha::Calendar->new( branchcode => $branch );
1217 my $itype = $item_object->effective_itemtype;
1218 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1220 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1222 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1223 $reduced_datedue->set_hour($orig_due->hour);
1224 $reduced_datedue->set_minute($orig_due->minute);
1225 $reduced_datedue->truncate( to => 'minute' );
1227 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1228 $return_data->{exceeded} = 1;
1229 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1230 $return_data->{due_date} = $reduced_datedue;
1234 return $return_data;
1239 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1241 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1245 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1247 =item C<$barcode> is the barcode of the item being issued.
1249 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1250 Calculated if empty.
1252 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1254 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1255 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1257 AddIssue does the following things :
1259 - step 01: check that there is a borrowernumber & a barcode provided
1260 - check for RENEWAL (book issued & being issued to the same patron)
1261 - renewal YES = Calculate Charge & renew
1263 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1265 - fill reserve if reserve to this patron
1266 - cancel reserve or not, otherwise
1267 * TRANSFERT PENDING ?
1268 - complete the transfert
1276 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1278 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1279 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1280 my $auto_renew = $params && $params->{auto_renew};
1281 my $dbh = C4::Context->dbh;
1282 my $barcodecheck = CheckValidBarcode($barcode);
1286 if ( $datedue && ref $datedue ne 'DateTime' ) {
1287 $datedue = dt_from_string($datedue);
1290 # $issuedate defaults to today.
1291 if ( !defined $issuedate ) {
1292 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1295 if ( ref $issuedate ne 'DateTime' ) {
1296 $issuedate = dt_from_string($issuedate);
1301 # Stop here if the patron or barcode doesn't exist
1302 if ( $borrower && $barcode && $barcodecheck ) {
1303 # find which item we issue
1304 my $item = Koha::Items->find({ barcode => $barcode })
1305 or return; # if we don't get an Item, abort.
1306 my $item_unblessed = $item->unblessed;
1308 my $branch = _GetCircControlBranch( $item_unblessed, $borrower );
1310 # get actual issuing if there is one
1311 my $actualissue = $item->checkout;
1313 # check if we just renew the issue.
1314 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1315 and not $switch_onsite_checkout ) {
1316 $datedue = AddRenewal(
1317 $borrower->{'borrowernumber'},
1321 $issuedate, # here interpreted as the renewal date
1325 # it's NOT a renewal
1326 if ( $actualissue and not $switch_onsite_checkout ) {
1327 # This book is currently on loan, but not to the person
1328 # who wants to borrow it now. mark it returned before issuing to the new borrower
1329 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1330 return unless $allowed;
1331 AddReturn( $item->barcode, C4::Context->userenv->{'branch'} );
1334 C4::Reserves::MoveReserve( $item->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1336 # Starting process for transfer job (checking transfert and validate it if we have one)
1337 my ($datesent) = GetTransfers( $item->itemnumber );
1339 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1340 my $sth = $dbh->prepare(
1341 "UPDATE branchtransfers
1342 SET datearrived = now(),
1344 comments = 'Forced branchtransfer'
1345 WHERE itemnumber= ? AND datearrived IS NULL"
1347 $sth->execute( C4::Context->userenv->{'branch'},
1348 $item->itemnumber );
1351 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1352 unless ($auto_renew) {
1353 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1354 { categorycode => $borrower->{categorycode},
1355 itemtype => $item->effective_itemtype,
1356 branchcode => $branch
1360 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1363 # Record in the database the fact that the book was issued.
1365 my $itype = $item->effective_itemtype;
1366 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1369 $datedue->truncate( to => 'minute' );
1371 my $issue_attributes = {
1372 borrowernumber => $borrower->{'borrowernumber'},
1373 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1374 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1375 branchcode => C4::Context->userenv->{'branch'},
1376 onsite_checkout => $onsite_checkout,
1377 auto_renew => $auto_renew ? 1 : 0,
1380 $issue = Koha::Checkouts->find( { itemnumber => $item->itemnumber } );
1382 $issue->set($issue_attributes)->store;
1385 $issue = Koha::Checkout->new(
1387 itemnumber => $item->itemnumber,
1393 if ( C4::Context->preference('ReturnToShelvingCart') ) {
1394 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1395 CartToShelf( $item->itemnumber );
1398 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1399 UpdateTotalIssues( $item->biblionumber, 1 );
1402 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1403 if ( $item->itemlost ) {
1405 Koha::RefundLostItemFeeRules->should_refund(
1407 current_branch => C4::Context->userenv->{branch},
1408 item_home_branch => $item->homebranch,
1409 item_holding_branch => $item->holdingbranch,
1414 _FixAccountForLostAndReturned( $item->itemnumber, undef,
1421 issues => $item->issues + 1,
1422 holdingbranch => C4::Context->userenv->{'branch'},
1424 onloan => $datedue->ymd(),
1425 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1427 $item->biblionumber,
1431 ModDateLastSeen( $item->itemnumber );
1433 # If it costs to borrow this book, charge it to the patron's account.
1434 my ( $charge, $itemtype ) = GetIssuingCharges( $item->itemnumber, $borrower->{'borrowernumber'} );
1435 if ( $charge > 0 ) {
1436 AddIssuingCharge( $issue, $charge );
1439 # Record the fact that this book was issued.
1442 branch => C4::Context->userenv->{'branch'},
1443 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1445 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1446 itemnumber => $item->itemnumber,
1447 itemtype => $item->effective_itemtype,
1448 location => $item->location,
1449 borrowernumber => $borrower->{'borrowernumber'},
1450 ccode => $item->ccode,
1454 # Send a checkout slip.
1455 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1457 branchcode => $branch,
1458 categorycode => $borrower->{categorycode},
1459 item_type => $item->effective_itemtype,
1460 notification => 'CHECKOUT',
1462 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1463 SendCirculationAlert(
1466 item => $item->unblessed,
1467 borrower => $borrower,
1473 "CIRCULATION", "ISSUE",
1474 $borrower->{'borrowernumber'},
1476 ) if C4::Context->preference("IssueLog");
1482 =head2 GetLoanLength
1484 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1486 Get loan length for an itemtype, a borrower type and a branch
1491 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1492 my $dbh = C4::Context->dbh;
1493 my $sth = $dbh->prepare(qq{
1494 SELECT issuelength, lengthunit, renewalperiod
1496 WHERE categorycode=?
1499 AND issuelength IS NOT NULL
1502 # try to find issuelength & return the 1st available.
1503 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1504 $sth->execute( $borrowertype, $itemtype, $branchcode );
1505 my $loanlength = $sth->fetchrow_hashref;
1508 if defined($loanlength) && defined $loanlength->{issuelength};
1510 $sth->execute( $borrowertype, '*', $branchcode );
1511 $loanlength = $sth->fetchrow_hashref;
1513 if defined($loanlength) && defined $loanlength->{issuelength};
1515 $sth->execute( '*', $itemtype, $branchcode );
1516 $loanlength = $sth->fetchrow_hashref;
1518 if defined($loanlength) && defined $loanlength->{issuelength};
1520 $sth->execute( '*', '*', $branchcode );
1521 $loanlength = $sth->fetchrow_hashref;
1523 if defined($loanlength) && defined $loanlength->{issuelength};
1525 $sth->execute( $borrowertype, $itemtype, '*' );
1526 $loanlength = $sth->fetchrow_hashref;
1528 if defined($loanlength) && defined $loanlength->{issuelength};
1530 $sth->execute( $borrowertype, '*', '*' );
1531 $loanlength = $sth->fetchrow_hashref;
1533 if defined($loanlength) && defined $loanlength->{issuelength};
1535 $sth->execute( '*', $itemtype, '*' );
1536 $loanlength = $sth->fetchrow_hashref;
1538 if defined($loanlength) && defined $loanlength->{issuelength};
1540 $sth->execute( '*', '*', '*' );
1541 $loanlength = $sth->fetchrow_hashref;
1543 if defined($loanlength) && defined $loanlength->{issuelength};
1545 # if no rule is set => 0 day (hardcoded)
1549 lengthunit => 'days',
1555 =head2 GetHardDueDate
1557 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1559 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1563 sub GetHardDueDate {
1564 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1566 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1567 { categorycode => $borrowertype,
1568 itemtype => $itemtype,
1569 branchcode => $branchcode
1574 if ( defined( $issuing_rule ) ) {
1575 if ( $issuing_rule->hardduedate ) {
1576 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1578 return (undef, undef);
1583 =head2 GetBranchBorrowerCircRule
1585 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1587 Retrieves circulation rule attributes that apply to the given
1588 branch and patron category, regardless of item type.
1589 The return value is a hashref containing the following key:
1591 patron_maxissueqty - maximum number of loans that a
1592 patron of the given category can have at the given
1593 branch. If the value is undef, no limit.
1595 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1596 patron of the given category can have at the given
1597 branch. If the value is undef, no limit.
1599 This will check for different branch/category combinations in the following order:
1603 default branch and category
1605 If no rule has been found in the database, it will default to
1608 patron_maxissueqty - undef
1609 patron_maxonsiteissueqty - undef
1611 C<$branchcode> and C<$categorycode> should contain the
1612 literal branch code and patron category code, respectively - no
1617 sub GetBranchBorrowerCircRule {
1618 my ( $branchcode, $categorycode ) = @_;
1620 # Set search prededences
1623 branchcode => $branchcode,
1624 categorycode => $categorycode,
1628 branchcode => $branchcode,
1629 categorycode => undef,
1633 branchcode => undef,
1634 categorycode => $categorycode,
1638 branchcode => undef,
1639 categorycode => undef,
1644 # Initialize default values
1646 patron_maxissueqty => undef,
1647 patron_maxonsiteissueqty => undef,
1651 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1652 foreach my $params (@params) {
1653 my $rule = Koha::CirculationRules->search(
1655 rule_name => $rule_name,
1661 $rules->{$rule_name} = $rule->rule_value;
1670 =head2 GetBranchItemRule
1672 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1674 Retrieves circulation rule attributes that apply to the given
1675 branch and item type, regardless of patron category.
1677 The return value is a hashref containing the following keys:
1679 holdallowed => Hold policy for this branch and itemtype. Possible values:
1680 0: No holds allowed.
1681 1: Holds allowed only by patrons that have the same homebranch as the item.
1682 2: Holds allowed from any patron.
1684 returnbranch => branch to which to return item. Possible values:
1685 noreturn: do not return, let item remain where checked in (floating collections)
1686 homebranch: return to item's home branch
1687 holdingbranch: return to issuer branch
1689 This searches branchitemrules in the following order:
1691 * Same branchcode and itemtype
1692 * Same branchcode, itemtype '*'
1693 * branchcode '*', same itemtype
1694 * branchcode and itemtype '*'
1696 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1700 sub GetBranchItemRule {
1701 my ( $branchcode, $itemtype ) = @_;
1702 my $dbh = C4::Context->dbh();
1706 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1707 FROM branch_item_rules
1708 WHERE branchcode = ?
1709 AND itemtype = ?', $branchcode, $itemtype],
1710 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1711 FROM default_branch_circ_rules
1712 WHERE branchcode = ?', $branchcode],
1713 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1714 FROM default_branch_item_rules
1715 WHERE itemtype = ?', $itemtype],
1716 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1717 FROM default_circ_rules'],
1720 foreach my $attempt (@attempts) {
1721 my ($query, @bind_params) = @{$attempt};
1722 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1725 # Since branch/category and branch/itemtype use the same per-branch
1726 # defaults tables, we have to check that the key we want is set, not
1727 # just that a row was returned
1728 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1729 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1730 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1733 # built-in default circulation rule
1734 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1735 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1736 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1743 ($doreturn, $messages, $iteminformation, $borrower) =
1744 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1750 =item C<$barcode> is the bar code of the book being returned.
1752 =item C<$branch> is the code of the branch where the book is being returned.
1754 =item C<$exemptfine> indicates that overdue charges for the item will be
1757 =item C<$dropbox> indicates that the check-in date is assumed to be
1758 yesterday, or the last non-holiday as defined in C4::Calendar . If
1759 overdue charges are applied and C<$dropbox> is true, the last charge
1760 will be removed. This assumes that the fines accrual script has run
1761 for _today_. Optional.
1763 =item C<$return_date> allows the default return date to be overridden
1764 by the given return date. Optional.
1768 C<&AddReturn> returns a list of four items:
1770 C<$doreturn> is true iff the return succeeded.
1772 C<$messages> is a reference-to-hash giving feedback on the operation.
1773 The keys of the hash are:
1779 No item with this barcode exists. The value is C<$barcode>.
1783 The book is not currently on loan. The value is C<$barcode>.
1787 This book has been withdrawn/cancelled. The value should be ignored.
1789 =item C<Wrongbranch>
1791 This book has was returned to the wrong branch. The value is a hashref
1792 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1793 contain the branchcode of the incorrect and correct return library, respectively.
1797 The item was reserved. The value is a reference-to-hash whose keys are
1798 fields from the reserves table of the Koha database, and
1799 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1800 either C<Waiting>, C<Reserved>, or 0.
1802 =item C<WasReturned>
1804 Value 1 if return is successful.
1806 =item C<NeedsTransfer>
1808 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1812 C<$iteminformation> is a reference-to-hash, giving information about the
1813 returned item from the issues table.
1815 C<$borrower> is a reference-to-hash, giving information about the
1816 patron who last borrowed the book.
1821 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1823 if ($branch and not Koha::Libraries->find($branch)) {
1824 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1827 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1831 my $validTransfert = 0;
1832 my $stat_type = 'return';
1834 # get information on item
1835 my $item = Koha::Items->find({ barcode => $barcode });
1837 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1840 my $itemnumber = $item->itemnumber;
1841 my $itemtype = $item->effective_itemtype;
1843 my $issue = $item->checkout;
1845 $patron = $issue->patron
1846 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1847 . Dumper($issue->unblessed) . "\n";
1849 $messages->{'NotIssued'} = $barcode;
1850 ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1851 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1853 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1854 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1855 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1856 $messages->{'LocalUse'} = 1;
1857 $stat_type = 'localuse';
1861 my $item_unblessed = $item->unblessed;
1862 if ( $item->location eq 'PROC' ) {
1863 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1864 $item_unblessed->{location} = 'CART';
1867 $item_unblessed->{location} = $item->permanent_location;
1870 ModItem( $item_unblessed, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1873 # full item data, but no borrowernumber or checkout info (no issue)
1874 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1875 # get the proper branch to which to return the item
1876 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1877 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1879 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1880 my $patron_unblessed = $patron ? $patron->unblessed : {};
1882 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1884 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1886 eval { $rules = YAML::Load($yaml); };
1888 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1891 foreach my $key ( keys %$rules ) {
1892 if ( $item->notforloan eq $key ) {
1893 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1894 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1901 # check if the return is allowed at this branch
1902 my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1903 unless ($returnallowed){
1904 $messages->{'Wrongbranch'} = {
1905 Wrongbranch => $branch,
1906 Rightbranch => $message
1909 return ( $doreturn, $messages, $issue, $patron_unblessed);
1912 if ( $item->withdrawn ) { # book has been cancelled
1913 $messages->{'withdrawn'} = 1;
1914 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1917 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1921 # case of a return of document (deal with issues and holdingbranch)
1922 my $today = DateTime->now( time_zone => C4::Context->tz() );
1926 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1927 $patron or warn "AddReturn without current borrower";
1929 $is_overdue = $issue->is_overdue( $dropboxdate );
1931 $is_overdue = $issue->is_overdue;
1937 MarkIssueReturned( $borrowernumber, $item->itemnumber,
1938 $dropboxdate, $patron->privacy );
1941 MarkIssueReturned( $borrowernumber, $item->itemnumber,
1942 $return_date, $patron->privacy );
1946 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1947 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1950 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 );
1952 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1955 # FIXME is the "= 1" right? This could be the borrower hash.
1956 $messages->{'WasReturned'} = 1;
1960 ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1963 # the holdingbranch is updated if the document is returned to another location.
1964 # this is always done regardless of whether the item was on loan or not
1965 my $item_holding_branch = $item->holdingbranch;
1966 if ($item->holdingbranch ne $branch) {
1967 UpdateHoldingbranch($branch, $item->itemnumber);
1968 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1971 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1972 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
1974 # check if we have a transfer for this document
1975 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
1977 # if we have a transfer to do, we update the line of transfers with the datearrived
1978 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
1980 if ( $tobranch eq $branch ) {
1981 my $sth = C4::Context->dbh->prepare(
1982 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1984 $sth->execute( $item->itemnumber );
1985 # if we have a reservation with valid transfer, we can set it's status to 'W'
1986 ShelfToCart( $item->itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
1987 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
1989 $messages->{'WrongTransfer'} = $tobranch;
1990 $messages->{'WrongTransferItem'} = $item->itemnumber;
1992 $validTransfert = 1;
1994 ShelfToCart( $item->itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
1997 # fix up the accounts.....
1998 if ( $item->itemlost ) {
1999 $messages->{'WasLost'} = 1;
2000 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2002 Koha::RefundLostItemFeeRules->should_refund(
2004 current_branch => C4::Context->userenv->{branch},
2005 item_home_branch => $item->homebranch,
2006 item_holding_branch => $item_holding_branch
2011 _FixAccountForLostAndReturned( $item->itemnumber,
2012 $borrowernumber, $barcode );
2013 $messages->{'LostItemFeeRefunded'} = 1;
2018 # fix up the overdues in accounts...
2019 if ($borrowernumber) {
2020 my $fix = _FixOverduesOnReturn($borrowernumber, $item->itemnumber, $exemptfine, $dropbox);
2021 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2023 if ( $issue and $issue->is_overdue ) {
2025 $today = dt_from_string($return_date) if $return_date;
2026 $today = $dropboxdate if $dropbox;
2027 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $today );
2029 $messages->{'PrevDebarred'} = $debardate;
2031 $messages->{'Debarred'} = $debardate if $debardate;
2033 # there's no overdue on the item but borrower had been previously debarred
2034 } elsif ( $issue->date_due and $patron->debarred ) {
2035 if ( $patron->debarred eq "9999-12-31") {
2036 $messages->{'ForeverDebarred'} = $patron->debarred;
2038 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2039 $borrower_debar_dt->truncate(to => 'day');
2040 my $today_dt = $today->clone()->truncate(to => 'day');
2041 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2042 $messages->{'PrevDebarred'} = $patron->debarred;
2048 # find reserves.....
2049 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2050 my ($resfound, $resrec);
2051 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2052 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2054 $resrec->{'ResFound'} = $resfound;
2055 $messages->{'ResFound'} = $resrec;
2058 # Record the fact that this book was returned.
2062 itemnumber => $itemnumber,
2063 itemtype => $itemtype,
2064 borrowernumber => $borrowernumber,
2065 ccode => $item->ccode,
2068 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2070 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2072 branchcode => $branch,
2073 categorycode => $patron->categorycode,
2074 item_type => $itemtype,
2075 notification => 'CHECKIN',
2077 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2078 SendCirculationAlert({
2080 item => $item_unblessed,
2081 borrower => $patron->unblessed,
2086 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2087 if C4::Context->preference("ReturnLog");
2090 # Remove any OVERDUES related debarment if the borrower has no overdues
2091 if ( $borrowernumber
2092 && $patron->debarred
2093 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2094 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2095 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2097 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2100 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2101 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2102 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType");
2103 if (C4::Context->preference("AutomaticItemReturn" ) or
2104 (C4::Context->preference("UseBranchTransferLimits") and
2105 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2107 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2108 $debug and warn "item: " . Dumper($item_unblessed);
2109 ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2110 $messages->{'WasTransfered'} = 1;
2112 $messages->{'NeedsTransfer'} = $returnbranch;
2116 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2119 =head2 MarkIssueReturned
2121 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2123 Unconditionally marks an issue as being returned by
2124 moving the C<issues> row to C<old_issues> and
2125 setting C<returndate> to the current date.
2127 if C<$returndate> is specified (in iso format), it is used as the date
2130 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2131 the old_issue is immediately anonymised
2133 Ideally, this function would be internal to C<C4::Circulation>,
2134 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2135 and offline_circ/process_koc.pl.
2139 sub MarkIssueReturned {
2140 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2142 # Retrieve the issue
2143 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2144 my $issue_id = $issue->issue_id;
2146 my $anonymouspatron;
2147 if ( $privacy == 2 ) {
2148 # The default of 0 will not work due to foreign key constraints
2149 # The anonymisation will fail if AnonymousPatron is not a valid entry
2150 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2151 # Note that a warning should appear on the about page (System information tab).
2152 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2153 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."
2154 unless Koha::Patrons->find( $anonymouspatron );
2157 my $schema = Koha::Database->schema;
2159 # FIXME Improve the return value and handle it from callers
2160 $schema->txn_do(sub {
2162 # Update the returndate value
2163 if ( $returndate ) {
2164 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2167 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2170 # Create the old_issues entry
2171 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2173 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2174 if ( $privacy == 2) {
2175 $old_checkout->borrowernumber($anonymouspatron)->store;
2178 # And finally delete the issue
2181 ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2183 if ( C4::Context->preference('StoreLastBorrower') ) {
2184 my $item = Koha::Items->find( $itemnumber );
2185 my $patron = Koha::Patrons->find( $borrowernumber );
2186 $item->last_returned_by( $patron );
2193 =head2 _debar_user_on_return
2195 _debar_user_on_return($borrower, $item, $datedue, today);
2197 C<$borrower> borrower hashref
2199 C<$item> item hashref
2201 C<$datedue> date due DateTime object
2203 C<$return_date> DateTime object representing the return time
2205 Internal function, called only by AddReturn that calculates and updates
2206 the user fine days, and debars them if necessary.
2208 Should only be called for overdue returns
2212 sub _debar_user_on_return {
2213 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2215 my $branchcode = _GetCircControlBranch( $item, $borrower );
2217 my $circcontrol = C4::Context->preference('CircControl');
2218 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2219 { categorycode => $borrower->{categorycode},
2220 itemtype => $item->{itype},
2221 branchcode => $branchcode
2224 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2225 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2226 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2230 # finedays is in days, so hourly loans must multiply by 24
2231 # thus 1 hour late equals 1 day suspension * finedays rate
2232 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2234 # grace period is measured in the same units as the loan
2236 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2238 my $deltadays = DateTime::Duration->new(
2239 days => $chargeable_units
2241 if ( $deltadays->subtract($grace)->is_positive() ) {
2242 my $suspension_days = $deltadays * $finedays;
2244 # If the max suspension days is < than the suspension days
2245 # the suspension days is limited to this maximum period.
2246 my $max_sd = $issuing_rule->maxsuspensiondays;
2247 if ( defined $max_sd ) {
2248 $max_sd = DateTime::Duration->new( days => $max_sd );
2249 $suspension_days = $max_sd
2250 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2253 my ( $has_been_extended, $is_a_reminder );
2254 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2255 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2257 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2258 $has_been_extended = 1;
2262 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2263 # No need to / 1 and do not consider / 0
2264 $suspension_days = DateTime::Duration->new(
2265 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2270 # Use the calendar or not to calculate the debarment date
2271 if ( C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed' ) {
2272 my $calendar = Koha::Calendar->new(
2273 branchcode => $branchcode,
2274 days_mode => 'Calendar'
2276 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2279 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2282 Koha::Patron::Debarments::AddUniqueDebarment({
2283 borrowernumber => $borrower->{borrowernumber},
2284 expiration => $new_debar_dt->ymd(),
2285 type => 'SUSPENSION',
2287 # if borrower was already debarred but does not get an extra debarment
2288 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2289 my $new_debarment_str;
2290 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2292 $new_debarment_str = $borrower->{debarred};
2294 $new_debarment_str = $new_debar_dt->ymd();
2296 # FIXME Should return a DateTime object
2297 return $new_debarment_str, $is_a_reminder;
2303 =head2 _FixOverduesOnReturn
2305 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2307 C<$brn> borrowernumber
2311 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2312 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2318 sub _FixOverduesOnReturn {
2319 my ($borrowernumber, $item, $exemptfine, $dropbox ) = @_;
2320 unless( $borrowernumber ) {
2321 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2325 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2329 # check for overdue fine
2330 my $accountline = Koha::Account::Lines->search(
2332 borrowernumber => $borrowernumber,
2333 itemnumber => $item,
2335 accounttype => 'FU',
2340 return 0 unless $accountline; # no warning, there's just nothing to fix
2343 my $amountoutstanding = $accountline->amountoutstanding;
2345 $accountline->accounttype('FFOR');
2346 $accountline->amountoutstanding(0);
2348 Koha::Account::Offset->new(
2350 debit_id => $accountline->id,
2352 amount => $amountoutstanding * -1,
2356 if (C4::Context->preference("FinesLog")) {
2357 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2359 } elsif ($dropbox && $accountline->lastincrement) {
2360 my $outstanding = $accountline->amountoutstanding - $accountline->lastincrement;
2361 my $amt = $accountline->amount - $accountline->lastincrement;
2363 Koha::Account::Offset->new(
2365 debit_id => $accountline->id,
2367 amount => $accountline->lastincrement * -1,
2371 if ( C4::Context->preference("FinesLog") ) {
2372 &logaction( "FINES", 'MODIFY', $borrowernumber,
2373 "Dropbox adjustment $amt, item $item" );
2376 $accountline->accounttype('F');
2378 if ( $outstanding >= 0 && $amt >= 0 ) {
2379 $accountline->amount($amt);
2380 $accountline->amountoutstanding($outstanding);
2384 $accountline->accounttype('F');
2387 return $accountline->store();
2390 =head2 _FixAccountForLostAndReturned
2392 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2394 Calculates the charge for a book lost and returned.
2396 Internal function, not exported, called only by AddReturn.
2400 sub _FixAccountForLostAndReturned {
2401 my $itemnumber = shift or return;
2402 my $borrowernumber = @_ ? shift : undef;
2403 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2407 # check for charge made for lost book
2408 my $accountlines = Koha::Account::Lines->search(
2410 itemnumber => $itemnumber,
2411 accounttype => { -in => [ 'L', 'Rep', 'W' ] },
2414 order_by => { -desc => [ 'date', 'accountno' ] }
2418 return unless $accountlines->count > 0;
2419 my $accountline = $accountlines->next;
2420 my $total_to_refund = 0;
2421 my $account = Koha::Patrons->find( $accountline->borrowernumber )->account;
2424 if ( $accountline->amount > $accountline->amountoutstanding ) {
2425 # some amount has been cancelled. collect the offsets that are not writeoffs
2426 # this works because the only way to subtract from this kind of a debt is
2427 # using the UI buttons 'Pay' and 'Write off'
2428 my $credits_offsets = Koha::Account::Offsets->search({
2429 debit_id => $accountline->id,
2430 credit_id => { '!=' => undef }, # it is not the debit itself
2431 type => { '!=' => 'Writeoff' },
2432 amount => { '<' => 0 } # credits are negative on the DB
2435 $total_to_refund = ( $credits_offsets->count > 0 )
2436 ? $credits_offsets->total * -1 # credits are negative on the DB
2440 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2442 if ( $credit_total > 0 ) {
2443 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2444 $credit = $account->add_credit(
2445 { amount => $credit_total,
2446 description => 'Item Returned ' . $item_id,
2447 type => 'lost_item_return',
2448 library_id => $branchcode
2452 # TODO: ->apply should just accept the accountline
2453 $credit->apply( { debits => $accountlines->reset } );
2456 # Manually set the accounttype
2457 $accountline->discard_changes->accounttype('LR');
2458 $accountline->store;
2460 ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2462 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2463 $account->reconcile_balance;
2466 return ($credit) ? $credit->id : undef;
2469 =head2 _GetCircControlBranch
2471 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2475 Return the library code to be used to determine which circulation
2476 policy applies to a transaction. Looks up the CircControl and
2477 HomeOrHoldingBranch system preferences.
2479 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2481 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2485 sub _GetCircControlBranch {
2486 my ($item, $borrower) = @_;
2487 my $circcontrol = C4::Context->preference('CircControl');
2490 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2491 $branch= C4::Context->userenv->{'branch'};
2492 } elsif ($circcontrol eq 'PatronLibrary') {
2493 $branch=$borrower->{branchcode};
2495 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2496 $branch = $item->{$branchfield};
2497 # default to item home branch if holdingbranch is used
2498 # and is not defined
2499 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2500 $branch = $item->{homebranch};
2508 $issue = GetOpenIssue( $itemnumber );
2510 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2512 C<$itemnumber> is the item's itemnumber
2519 my ( $itemnumber ) = @_;
2520 return unless $itemnumber;
2521 my $dbh = C4::Context->dbh;
2522 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2523 $sth->execute( $itemnumber );
2524 return $sth->fetchrow_hashref();
2528 =head2 GetBiblioIssues
2530 $issues = GetBiblioIssues($biblionumber);
2532 this function get all issues from a biblionumber.
2535 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2536 tables issues and the firstname,surname & cardnumber from borrowers.
2540 sub GetBiblioIssues {
2541 my $biblionumber = shift;
2542 return unless $biblionumber;
2543 my $dbh = C4::Context->dbh;
2545 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2547 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2548 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2549 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2550 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2551 WHERE biblio.biblionumber = ?
2553 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2555 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2556 LEFT JOIN items ON old_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 = ?
2562 my $sth = $dbh->prepare($query);
2563 $sth->execute($biblionumber, $biblionumber);
2566 while ( my $data = $sth->fetchrow_hashref ) {
2567 push @issues, $data;
2572 =head2 GetUpcomingDueIssues
2574 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2578 sub GetUpcomingDueIssues {
2581 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2582 my $dbh = C4::Context->dbh;
2584 my $statement = <<END_SQL;
2587 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2589 LEFT JOIN items USING (itemnumber)
2590 LEFT OUTER JOIN branches USING (branchcode)
2591 WHERE returndate is NULL
2593 WHERE days_until_due >= 0 AND days_until_due <= ?
2596 my @bind_parameters = ( $params->{'days_in_advance'} );
2598 my $sth = $dbh->prepare( $statement );
2599 $sth->execute( @bind_parameters );
2600 my $upcoming_dues = $sth->fetchall_arrayref({});
2602 return $upcoming_dues;
2605 =head2 CanBookBeRenewed
2607 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2609 Find out whether a borrowed item may be renewed.
2611 C<$borrowernumber> is the borrower number of the patron who currently
2612 has the item on loan.
2614 C<$itemnumber> is the number of the item to renew.
2616 C<$override_limit>, if supplied with a true value, causes
2617 the limit on the number of times that the loan can be renewed
2618 (as controlled by the item type) to be ignored. Overriding also allows
2619 to renew sooner than "No renewal before" and to manually renew loans
2620 that are automatically renewed.
2622 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2623 item must currently be on loan to the specified borrower; renewals
2624 must be allowed for the item's type; and the borrower must not have
2625 already renewed the loan. $error will contain the reason the renewal can not proceed
2629 sub CanBookBeRenewed {
2630 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2632 my $dbh = C4::Context->dbh;
2635 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2636 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2637 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2638 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2640 my $patron = $issue->patron or return;
2642 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2644 # This item can fill one or more unfilled reserve, can those unfilled reserves
2645 # all be filled by other available items?
2647 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2649 my $schema = Koha::Database->new()->schema();
2651 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2653 # There is an item level hold on this item, no other item can fill the hold
2658 # Get all other items that could possibly fill reserves
2659 my @itemnumbers = $schema->resultset('Item')->search(
2661 biblionumber => $resrec->{biblionumber},
2664 -not => { itemnumber => $itemnumber }
2666 { columns => 'itemnumber' }
2667 )->get_column('itemnumber')->all();
2669 # Get all other reserves that could have been filled by this item
2670 my @borrowernumbers;
2672 my ( $reserve_found, $reserve, undef ) =
2673 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2675 if ($reserve_found) {
2676 push( @borrowernumbers, $reserve->{borrowernumber} );
2683 # If the count of the union of the lists of reservable items for each borrower
2684 # is equal or greater than the number of borrowers, we know that all reserves
2685 # can be filled with available items. We can get the union of the sets simply
2686 # by pushing all the elements onto an array and removing the duplicates.
2689 ITEM: foreach my $i (@itemnumbers) {
2690 my $item = Koha::Items->find($i)->unblessed;
2691 next if IsItemOnHoldAndFound($i);
2692 for my $b (@borrowernumbers) {
2693 my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2694 next unless IsAvailableForItemLevelRequest($item, $borr);
2695 next unless CanItemBeReserved($b,$i);
2697 push @reservable, $i;
2698 if (@reservable >= @borrowernumbers) {
2707 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2709 return ( 1, undef ) if $override_limit;
2711 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2712 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2713 { categorycode => $patron->categorycode,
2714 itemtype => $item->effective_itemtype,
2715 branchcode => $branchcode
2719 return ( 0, "too_many" )
2720 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2722 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2723 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2724 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2725 my $restricted = $patron->is_debarred;
2726 my $hasoverdues = $patron->has_overdues;
2728 if ( $restricted and $restrictionblockrenewing ) {
2729 return ( 0, 'restriction');
2730 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2731 return ( 0, 'overdue');
2734 if ( $issue->auto_renew ) {
2736 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2737 return ( 0, 'auto_account_expired' );
2740 if ( defined $issuing_rule->no_auto_renewal_after
2741 and $issuing_rule->no_auto_renewal_after ne "" ) {
2742 # Get issue_date and add no_auto_renewal_after
2743 # If this is greater than today, it's too late for renewal.
2744 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2745 $maximum_renewal_date->add(
2746 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2748 my $now = dt_from_string;
2749 if ( $now >= $maximum_renewal_date ) {
2750 return ( 0, "auto_too_late" );
2753 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2754 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2755 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2756 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2757 return ( 0, "auto_too_late" );
2761 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2762 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2763 my $amountoutstanding = $patron->account->balance;
2764 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2765 return ( 0, "auto_too_much_oweing" );
2770 if ( defined $issuing_rule->norenewalbefore
2771 and $issuing_rule->norenewalbefore ne "" )
2774 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2775 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2776 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2778 # Depending on syspref reset the exact time, only check the date
2779 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2780 and $issuing_rule->lengthunit eq 'days' )
2782 $soonestrenewal->truncate( to => 'day' );
2785 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2787 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2788 return ( 0, "too_soon" );
2790 elsif ( $issue->auto_renew ) {
2791 return ( 0, "auto_renew" );
2795 # Fallback for automatic renewals:
2796 # If norenewalbefore is undef, don't renew before due date.
2797 if ( $issue->auto_renew ) {
2798 my $now = dt_from_string;
2799 return ( 0, "auto_renew" )
2800 if $now >= dt_from_string( $issue->date_due, 'sql' );
2801 return ( 0, "auto_too_soon" );
2804 return ( 1, undef );
2809 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2813 C<$borrowernumber> is the borrower number of the patron who currently
2816 C<$itemnumber> is the number of the item to renew.
2818 C<$branch> is the library where the renewal took place (if any).
2819 The library that controls the circ policies for the renewal is retrieved from the issues record.
2821 C<$datedue> can be a DateTime object used to set the due date.
2823 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2824 this parameter is not supplied, lastreneweddate is set to the current date.
2826 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2827 from the book's item type.
2832 my $borrowernumber = shift;
2833 my $itemnumber = shift or return;
2835 my $datedue = shift;
2836 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2838 my $item = Koha::Items->find($itemnumber) or return;
2839 my $biblio = $item->biblio;
2840 my $issue = $item->checkout;
2841 my $item_unblessed = $item->unblessed;
2843 my $dbh = C4::Context->dbh;
2845 return unless $issue;
2847 $borrowernumber ||= $issue->borrowernumber;
2849 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2850 carp 'Invalid date passed to AddRenewal.';
2854 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2855 my $patron_unblessed = $patron->unblessed;
2857 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2858 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2860 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2862 # If the due date wasn't specified, calculate it by adding the
2863 # book's loan length to today's date or the current due date
2864 # based on the value of the RenewalPeriodBase syspref.
2867 my $itemtype = $item->effective_itemtype;
2868 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2869 dt_from_string( $issue->date_due, 'sql' ) :
2870 DateTime->now( time_zone => C4::Context->tz());
2871 $datedue = CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item_unblessed, $patron_unblessed), $patron_unblessed, 'is a renewal');
2874 # Update the issues record to have the new due date, and a new count
2875 # of how many times it has been renewed.
2876 my $renews = $issue->renewals + 1;
2877 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2878 WHERE borrowernumber=?
2882 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2884 # Update the renewal count on the item, and tell zebra to reindex
2885 $renews = $item->renewals + 1;
2886 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item->biblionumber, $itemnumber, { log_action => 0 } );
2888 # Charge a new rental fee, if applicable?
2889 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2890 if ( $charge > 0 ) {
2891 my $accountno = C4::Accounts::getnextacctno( $borrowernumber );
2893 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2894 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2895 Koha::Account::Line->new(
2897 date => dt_from_string(),
2898 borrowernumber => $borrowernumber,
2899 accountno => $accountno,
2901 manager_id => $manager_id,
2902 accounttype => 'Rent',
2903 amountoutstanding => $charge,
2904 itemnumber => $itemnumber,
2905 branchcode => $branchcode,
2906 description => 'Renewal of Rental Item '
2908 . " " . $item->barcode,
2913 # Send a renewal slip according to checkout alert preferencei
2914 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2915 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2917 branchcode => $branch,
2918 categorycode => $patron->categorycode,
2919 item_type => $item->effective_itemtype,
2920 notification => 'CHECKOUT',
2922 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2923 SendCirculationAlert(
2926 item => $item_unblessed,
2927 borrower => $patron->unblessed,
2934 # Remove any OVERDUES related debarment if the borrower has no overdues
2936 && $patron->is_debarred
2937 && ! $patron->has_overdues
2938 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2940 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2943 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2944 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2947 # Add the renewal to stats
2953 itemnumber => $itemnumber,
2954 itemtype => $item->effective_itemtype,
2955 location => $item->location,
2956 borrowernumber => $borrowernumber,
2957 ccode => $item->ccode,
2962 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2967 # check renewal status
2968 my ( $bornum, $itemno ) = @_;
2969 my $dbh = C4::Context->dbh;
2971 my $renewsallowed = 0;
2974 my $patron = Koha::Patrons->find( $bornum );
2975 my $item = Koha::Items->find($itemno);
2977 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2979 # Look in the issues table for this item, lent to this borrower,
2980 # and not yet returned.
2982 # FIXME - I think this function could be redone to use only one SQL call.
2983 my $sth = $dbh->prepare(
2984 "select * from issues
2985 where (borrowernumber = ?)
2986 and (itemnumber = ?)"
2988 $sth->execute( $bornum, $itemno );
2989 my $data = $sth->fetchrow_hashref;
2990 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2991 # $item and $borrower should be calculated
2992 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
2994 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2995 { categorycode => $patron->categorycode,
2996 itemtype => $item->effective_itemtype,
2997 branchcode => $branchcode
3001 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3002 $renewsleft = $renewsallowed - $renewcount;
3003 if($renewsleft < 0){ $renewsleft = 0; }
3004 return ( $renewcount, $renewsallowed, $renewsleft );
3007 =head2 GetSoonestRenewDate
3009 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3011 Find out the soonest possible renew date of a borrowed item.
3013 C<$borrowernumber> is the borrower number of the patron who currently
3014 has the item on loan.
3016 C<$itemnumber> is the number of the item to renew.
3018 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3019 renew date, based on the value "No renewal before" of the applicable
3020 issuing rule. Returns the current date if the item can already be
3021 renewed, and returns undefined if the borrower, loan, or item
3026 sub GetSoonestRenewDate {
3027 my ( $borrowernumber, $itemnumber ) = @_;
3029 my $dbh = C4::Context->dbh;
3031 my $item = Koha::Items->find($itemnumber) or return;
3032 my $itemissue = $item->checkout or return;
3034 $borrowernumber ||= $itemissue->borrowernumber;
3035 my $patron = Koha::Patrons->find( $borrowernumber )
3038 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3039 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3040 { categorycode => $patron->categorycode,
3041 itemtype => $item->effective_itemtype,
3042 branchcode => $branchcode
3046 my $now = dt_from_string;
3047 return $now unless $issuing_rule;
3049 if ( defined $issuing_rule->norenewalbefore
3050 and $issuing_rule->norenewalbefore ne "" )
3052 my $soonestrenewal =
3053 dt_from_string( $itemissue->date_due )->subtract(
3054 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3056 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3057 and $issuing_rule->lengthunit eq 'days' )
3059 $soonestrenewal->truncate( to => 'day' );
3061 return $soonestrenewal if $now < $soonestrenewal;
3066 =head2 GetLatestAutoRenewDate
3068 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3070 Find out the latest possible auto renew date of a borrowed item.
3072 C<$borrowernumber> is the borrower number of the patron who currently
3073 has the item on loan.
3075 C<$itemnumber> is the number of the item to renew.
3077 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3078 auto renew date, based on the value "No auto renewal after" and the "No auto
3079 renewal after (hard limit) of the applicable issuing rule.
3080 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3081 or item cannot be found.
3085 sub GetLatestAutoRenewDate {
3086 my ( $borrowernumber, $itemnumber ) = @_;
3088 my $dbh = C4::Context->dbh;
3090 my $item = Koha::Items->find($itemnumber) or return;
3091 my $itemissue = $item->checkout or return;
3093 $borrowernumber ||= $itemissue->borrowernumber;
3094 my $patron = Koha::Patrons->find( $borrowernumber )
3097 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3098 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3099 { categorycode => $patron->categorycode,
3100 itemtype => $item->effective_itemtype,
3101 branchcode => $branchcode
3105 return unless $issuing_rule;
3107 if ( not $issuing_rule->no_auto_renewal_after
3108 or $issuing_rule->no_auto_renewal_after eq '' )
3109 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3110 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3112 my $maximum_renewal_date;
3113 if ( $issuing_rule->no_auto_renewal_after ) {
3114 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3115 $maximum_renewal_date->add(
3116 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3120 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3121 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3122 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3124 return $maximum_renewal_date;
3128 =head2 GetIssuingCharges
3130 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3132 Calculate how much it would cost for a given patron to borrow a given
3133 item, including any applicable discounts.
3135 C<$itemnumber> is the item number of item the patron wishes to borrow.
3137 C<$borrowernumber> is the patron's borrower number.
3139 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3140 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3145 sub GetIssuingCharges {
3147 # calculate charges due
3148 my ( $itemnumber, $borrowernumber ) = @_;
3150 my $dbh = C4::Context->dbh;
3153 # Get the book's item type and rental charge (via its biblioitem).
3154 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3155 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3156 $charge_query .= (C4::Context->preference('item-level_itypes'))
3157 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3158 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3160 $charge_query .= ' WHERE items.itemnumber =?';
3162 my $sth = $dbh->prepare($charge_query);
3163 $sth->execute($itemnumber);
3164 if ( my $item_data = $sth->fetchrow_hashref ) {
3165 $item_type = $item_data->{itemtype};
3166 $charge = $item_data->{rentalcharge};
3167 my $branch = C4::Context::mybranch();
3168 my $discount_query = q|SELECT rentaldiscount,
3169 issuingrules.itemtype, issuingrules.branchcode
3171 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3172 WHERE borrowers.borrowernumber = ?
3173 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3174 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3175 my $discount_sth = $dbh->prepare($discount_query);
3176 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3177 my $discount_rules = $discount_sth->fetchall_arrayref({});
3178 if (@{$discount_rules}) {
3179 # We may have multiple rules so get the most specific
3180 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3181 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3184 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3188 return ( $charge, $item_type );
3191 # Select most appropriate discount rule from those returned
3192 sub _get_discount_from_rule {
3193 my ($rules_ref, $branch, $itemtype) = @_;
3196 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3197 $discount = $rules_ref->[0]->{rentaldiscount};
3198 return (defined $discount) ? $discount : 0;
3200 # could have up to 4 does one match $branch and $itemtype
3201 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3203 $discount = $d[0]->{rentaldiscount};
3204 return (defined $discount) ? $discount : 0;
3206 # do we have item type + all branches
3207 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3209 $discount = $d[0]->{rentaldiscount};
3210 return (defined $discount) ? $discount : 0;
3212 # do we all item types + this branch
3213 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3215 $discount = $d[0]->{rentaldiscount};
3216 return (defined $discount) ? $discount : 0;
3218 # so all and all (surely we wont get here)
3219 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3221 $discount = $d[0]->{rentaldiscount};
3222 return (defined $discount) ? $discount : 0;
3228 =head2 AddIssuingCharge
3230 &AddIssuingCharge( $checkout, $charge )
3234 sub AddIssuingCharge {
3235 my ( $checkout, $charge ) = @_;
3237 # FIXME What if checkout does not exist?
3239 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3240 my $accountline = $account->add_debit(
3243 description => 'Rental',
3245 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
3246 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3248 item_id => $checkout->itemnumber,
3249 issue_id => $checkout->issue_id,
3256 GetTransfers($itemnumber);
3261 my ($itemnumber) = @_;
3263 my $dbh = C4::Context->dbh;
3270 FROM branchtransfers
3271 WHERE itemnumber = ?
3272 AND datearrived IS NULL
3274 my $sth = $dbh->prepare($query);
3275 $sth->execute($itemnumber);
3276 my @row = $sth->fetchrow_array();
3280 =head2 GetTransfersFromTo
3282 @results = GetTransfersFromTo($frombranch,$tobranch);
3284 Returns the list of pending transfers between $from and $to branch
3288 sub GetTransfersFromTo {
3289 my ( $frombranch, $tobranch ) = @_;
3290 return unless ( $frombranch && $tobranch );
3291 my $dbh = C4::Context->dbh;
3293 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3294 FROM branchtransfers
3297 AND datearrived IS NULL
3299 my $sth = $dbh->prepare($query);
3300 $sth->execute( $frombranch, $tobranch );
3303 while ( my $data = $sth->fetchrow_hashref ) {
3304 push @gettransfers, $data;
3306 return (@gettransfers);
3309 =head2 DeleteTransfer
3311 &DeleteTransfer($itemnumber);
3315 sub DeleteTransfer {
3316 my ($itemnumber) = @_;
3317 return unless $itemnumber;
3318 my $dbh = C4::Context->dbh;
3319 my $sth = $dbh->prepare(
3320 "DELETE FROM branchtransfers
3322 AND datearrived IS NULL "
3324 return $sth->execute($itemnumber);
3327 =head2 SendCirculationAlert
3329 Send out a C<check-in> or C<checkout> alert using the messaging system.
3337 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3341 Hashref of information about the item being checked in or out.
3345 Hashref of information about the borrower of the item.
3349 The branchcode from where the checkout or check-in took place.
3355 SendCirculationAlert({
3358 borrower => $borrower,
3364 sub SendCirculationAlert {
3366 my ($type, $item, $borrower, $branch) =
3367 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3368 my %message_name = (
3369 CHECKIN => 'Item_Check_in',
3370 CHECKOUT => 'Item_Checkout',
3371 RENEWAL => 'Item_Checkout',
3373 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3374 borrowernumber => $borrower->{borrowernumber},
3375 message_name => $message_name{$type},
3377 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3379 my $schema = Koha::Database->new->schema;
3380 my @transports = keys %{ $borrower_preferences->{transports} };
3382 # From the MySQL doc:
3383 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3384 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3385 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3386 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3388 for my $mtt (@transports) {
3389 my $letter = C4::Letters::GetPreparedLetter (
3390 module => 'circulation',
3391 letter_code => $type,
3392 branchcode => $branch,
3393 message_transport_type => $mtt,
3394 lang => $borrower->{lang},
3396 $issues_table => $item->{itemnumber},
3397 'items' => $item->{itemnumber},
3398 'biblio' => $item->{biblionumber},
3399 'biblioitems' => $item->{biblionumber},
3400 'borrowers' => $borrower,
3401 'branches' => $branch,
3405 $schema->storage->txn_begin;
3406 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3407 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3408 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3409 unless ( $message ) {
3410 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3411 C4::Message->enqueue($letter, $borrower, $mtt);
3413 $message->append($letter);
3416 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3417 $schema->storage->txn_commit;
3423 =head2 updateWrongTransfer
3425 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3427 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
3431 sub updateWrongTransfer {
3432 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3433 my $dbh = C4::Context->dbh;
3434 # first step validate the actual line of transfert .
3437 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3439 $sth->execute($FromLibrary,$itemNumber);
3441 # second step create a new line of branchtransfer to the right location .
3442 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3444 #third step changing holdingbranch of item
3445 UpdateHoldingbranch($FromLibrary,$itemNumber);
3448 =head2 UpdateHoldingbranch
3450 $items = UpdateHoldingbranch($branch,$itmenumber);
3452 Simple methode for updating hodlingbranch in items BDD line
3456 sub UpdateHoldingbranch {
3457 my ( $branch,$itemnumber ) = @_;
3458 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3463 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3465 this function calculates the due date given the start date and configured circulation rules,
3466 checking against the holidays calendar as per the 'useDaysMode' syspref.
3467 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3468 C<$itemtype> = itemtype code of item in question
3469 C<$branch> = location whose calendar to use
3470 C<$borrower> = Borrower object
3471 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3476 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3480 # loanlength now a href
3482 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3484 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3490 if (ref $startdate ne 'DateTime' ) {
3491 $datedue = dt_from_string($datedue);
3493 $datedue = $startdate->clone;
3497 DateTime->now( time_zone => C4::Context->tz() )
3498 ->truncate( to => 'minute' );
3502 # calculate the datedue as normal
3503 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3504 { # ignoring calendar
3505 if ( $loanlength->{lengthunit} eq 'hours' ) {
3506 $datedue->add( hours => $loanlength->{$length_key} );
3508 $datedue->add( days => $loanlength->{$length_key} );
3509 $datedue->set_hour(23);
3510 $datedue->set_minute(59);
3514 if ($loanlength->{lengthunit} eq 'hours') {
3515 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3518 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3520 my $calendar = Koha::Calendar->new( branchcode => $branch );
3521 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3522 if ($loanlength->{lengthunit} eq 'days') {
3523 $datedue->set_hour(23);
3524 $datedue->set_minute(59);
3528 # if Hard Due Dates are used, retrieve them and apply as necessary
3529 my ( $hardduedate, $hardduedatecompare ) =
3530 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3531 if ($hardduedate) { # hardduedates are currently dates
3532 $hardduedate->truncate( to => 'minute' );
3533 $hardduedate->set_hour(23);
3534 $hardduedate->set_minute(59);
3535 my $cmp = DateTime->compare( $hardduedate, $datedue );
3537 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3538 # if the calculated date is before the 'after' Hard Due Date (floor), override
3539 # if the hard due date is set to 'exactly', overrride
3540 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3541 $datedue = $hardduedate->clone;
3544 # in all other cases, keep the date due as it is
3548 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3549 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3550 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3551 if( $expiry_dt ) { #skip empty expiry date..
3552 $expiry_dt->set( hour => 23, minute => 59);
3553 my $d1= $datedue->clone->set_time_zone('floating');
3554 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3555 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3558 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3559 my $calendar = Koha::Calendar->new( branchcode => $branch );
3560 if ( $calendar->is_holiday($datedue) ) {
3561 # Don't return on a closed day
3562 $datedue = $calendar->prev_open_day( $datedue );
3571 sub CheckValidBarcode{
3573 my $dbh = C4::Context->dbh;
3574 my $query=qq|SELECT count(*)
3578 my $sth = $dbh->prepare($query);
3579 $sth->execute($barcode);
3580 my $exist=$sth->fetchrow ;
3584 =head2 IsBranchTransferAllowed
3586 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3588 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3590 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3591 Koha::Item->can_be_transferred.
3595 sub IsBranchTransferAllowed {
3596 my ( $toBranch, $fromBranch, $code ) = @_;
3598 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3600 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3601 my $dbh = C4::Context->dbh;
3603 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3604 $sth->execute( $toBranch, $fromBranch, $code );
3605 my $limit = $sth->fetchrow_hashref();
3607 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3608 if ( $limit->{'limitId'} ) {
3615 =head2 CreateBranchTransferLimit
3617 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3619 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3621 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3625 sub CreateBranchTransferLimit {
3626 my ( $toBranch, $fromBranch, $code ) = @_;
3627 return unless defined($toBranch) && defined($fromBranch);
3628 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3630 my $dbh = C4::Context->dbh;
3632 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3633 return $sth->execute( $code, $toBranch, $fromBranch );
3636 =head2 DeleteBranchTransferLimits
3638 my $result = DeleteBranchTransferLimits($frombranch);
3640 Deletes all the library transfer limits for one library. Returns the
3641 number of limits deleted, 0e0 if no limits were deleted, or undef if
3642 no arguments are supplied.
3644 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3645 fromBranch => $fromBranch
3650 sub DeleteBranchTransferLimits {
3652 return unless defined $branch;
3653 my $dbh = C4::Context->dbh;
3654 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3655 return $sth->execute($branch);
3659 my ( $borrowernumber, $itemnum ) = @_;
3661 MarkIssueReturned( $borrowernumber, $itemnum );
3662 my $patron = Koha::Patrons->find( $borrowernumber );
3663 my $item = Koha::Items->find($itemnum);
3664 my $old_note = ($item->paidfor && ($item->paidfor ne q{})) ? $item->paidfor.' / ' : q{};
3665 my @datearr = localtime(time);
3666 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3667 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3668 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3673 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3675 unless ( $mark_lost_from ) {
3676 # Temporary check to avoid regressions
3677 die q|LostItem called without $mark_lost_from, check the API.|;
3681 if ( $force_mark_returned ) {
3684 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3685 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3688 my $dbh = C4::Context->dbh();
3689 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3691 JOIN items USING (itemnumber)
3692 JOIN biblio USING (biblionumber)
3693 WHERE issues.itemnumber=?");
3694 $sth->execute($itemnumber);
3695 my $issues=$sth->fetchrow_hashref();
3697 # If a borrower lost the item, add a replacement cost to the their record
3698 if ( my $borrowernumber = $issues->{borrowernumber} ){
3699 my $patron = Koha::Patrons->find( $borrowernumber );
3701 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 0); # 1, 0 = exemptfine, no-dropbox
3702 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3704 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3705 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3706 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3707 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3710 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3713 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3714 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3715 ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3717 my $transferdeleted = DeleteTransfer($itemnumber);
3720 sub GetOfflineOperations {
3721 my $dbh = C4::Context->dbh;
3722 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3723 $sth->execute(C4::Context->userenv->{'branch'});
3724 my $results = $sth->fetchall_arrayref({});
3728 sub GetOfflineOperation {
3729 my $operationid = shift;
3730 return unless $operationid;
3731 my $dbh = C4::Context->dbh;
3732 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3733 $sth->execute( $operationid );
3734 return $sth->fetchrow_hashref;
3737 sub AddOfflineOperation {
3738 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3739 my $dbh = C4::Context->dbh;
3740 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3741 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3745 sub DeleteOfflineOperation {
3746 my $dbh = C4::Context->dbh;
3747 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3748 $sth->execute( shift );
3752 sub ProcessOfflineOperation {
3753 my $operation = shift;
3756 if ( $operation->{action} eq 'return' ) {
3757 $report = ProcessOfflineReturn( $operation );
3758 } elsif ( $operation->{action} eq 'issue' ) {
3759 $report = ProcessOfflineIssue( $operation );
3760 } elsif ( $operation->{action} eq 'payment' ) {
3761 $report = ProcessOfflinePayment( $operation );
3764 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3769 sub ProcessOfflineReturn {
3770 my $operation = shift;
3772 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3775 my $itemnumber = $item->itemnumber;
3776 my $issue = GetOpenIssue( $itemnumber );
3779 $issue->{borrowernumber},
3781 $operation->{timestamp},
3784 { renewals => 0, onloan => undef },
3785 $issue->{'biblionumber'},
3791 return "Item not issued.";
3794 return "Item not found.";
3798 sub ProcessOfflineIssue {
3799 my $operation = shift;
3801 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3804 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3806 return "Barcode not found.";
3808 my $itemnumber = $item->itemnumber;
3809 my $issue = GetOpenIssue( $itemnumber );
3811 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3813 $issue->{borrowernumber},
3815 $operation->{timestamp},
3820 $operation->{'barcode'},
3823 $operation->{timestamp},
3828 return "Borrower not found.";
3832 sub ProcessOfflinePayment {
3833 my $operation = shift;
3835 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3837 $patron->account->pay({ amount => $operation->{amount}, library_id => $operation->{branchcode} });
3844 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3846 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3851 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3855 ? Koha::Items->find($itemnumber)
3856 : Koha::Items->find( { barcode => $barcode } );
3860 return C4::Letters::GetPreparedLetter (
3861 module => 'circulation',
3862 letter_code => 'TRANSFERSLIP',
3863 branchcode => $branch,
3865 'branches' => $to_branch,
3866 'biblio' => $item->biblionumber,
3867 'items' => $item->unblessed,
3872 =head2 CheckIfIssuedToPatron
3874 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3876 Return 1 if any record item is issued to patron, otherwise return 0
3880 sub CheckIfIssuedToPatron {
3881 my ($borrowernumber, $biblionumber) = @_;
3883 my $dbh = C4::Context->dbh;
3885 SELECT COUNT(*) FROM issues
3886 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3887 WHERE items.biblionumber = ?
3888 AND issues.borrowernumber = ?
3890 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3891 return 1 if $is_issued;
3897 IsItemIssued( $itemnumber )
3899 Return 1 if the item is on loan, otherwise return 0
3904 my $itemnumber = shift;
3905 my $dbh = C4::Context->dbh;
3906 my $sth = $dbh->prepare(q{
3909 WHERE itemnumber = ?
3911 $sth->execute($itemnumber);
3912 return $sth->fetchrow;
3915 =head2 GetAgeRestriction
3917 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3918 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3920 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3921 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3923 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3924 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3925 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3926 Negative days mean the borrower has gone past the age restriction age.
3930 sub GetAgeRestriction {
3931 my ($record_restrictions, $borrower) = @_;
3932 my $markers = C4::Context->preference('AgeRestrictionMarker');
3934 # Split $record_restrictions to something like FSK 16 or PEGI 6
3935 my @values = split ' ', uc($record_restrictions);
3936 return unless @values;
3938 # Search first occurrence of one of the markers
3939 my @markers = split /\|/, uc($markers);
3940 return unless @markers;
3943 my $restriction_year = 0;
3944 for my $value (@values) {
3946 for my $marker (@markers) {
3947 $marker =~ s/^\s+//; #remove leading spaces
3948 $marker =~ s/\s+$//; #remove trailing spaces
3949 if ( $marker eq $value ) {
3950 if ( $index <= $#values ) {
3951 $restriction_year += $values[$index];
3955 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3957 # Perhaps it is something like "K16" (as in Finland)
3958 $restriction_year += $1;
3962 last if ( $restriction_year > 0 );
3965 #Check if the borrower is age restricted for this material and for how long.
3966 if ($restriction_year && $borrower) {
3967 if ( $borrower->{'dateofbirth'} ) {
3968 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3969 $alloweddate[0] += $restriction_year;
3971 #Prevent runime eror on leap year (invalid date)
3972 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3973 $alloweddate[2] = 28;
3976 #Get how many days the borrower has to reach the age restriction
3977 my @Today = split /-/, DateTime->today->ymd();
3978 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3979 #Negative days means the borrower went past the age restriction age
3980 return ($restriction_year, $daysToAgeRestriction);
3984 return ($restriction_year);
3988 =head2 GetPendingOnSiteCheckouts
3992 sub GetPendingOnSiteCheckouts {
3993 my $dbh = C4::Context->dbh;
3994 return $dbh->selectall_arrayref(q|
4000 items.itemcallnumber,
4004 issues.date_due < NOW() AS is_overdue,
4007 borrowers.firstname,
4009 borrowers.cardnumber,
4010 borrowers.borrowernumber
4012 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4013 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4014 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4015 WHERE issues.onsite_checkout = 1
4016 |, { Slice => {} } );
4022 my ($count, $branch, $itemtype, $ccode, $newness)
4023 = @$params{qw(count branch itemtype ccode newness)};
4025 my $dbh = C4::Context->dbh;
4028 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4029 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4030 i.ccode, SUM(i.issues) AS count
4032 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4033 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4036 my (@where_strs, @where_args);
4039 push @where_strs, 'i.homebranch = ?';
4040 push @where_args, $branch;
4043 if (C4::Context->preference('item-level_itypes')){
4044 push @where_strs, 'i.itype = ?';
4045 push @where_args, $itemtype;
4047 push @where_strs, 'bi.itemtype = ?';
4048 push @where_args, $itemtype;
4052 push @where_strs, 'i.ccode = ?';
4053 push @where_args, $ccode;
4056 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4057 push @where_args, $newness;
4061 $query .= 'WHERE ' . join(' AND ', @where_strs);
4065 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4066 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4071 $query .= q{ ) xxx WHERE count > 0 };
4072 $count = int($count);
4074 $query .= "LIMIT $count";
4077 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4082 sub _CalculateAndUpdateFine {
4085 my $borrower = $params->{borrower};
4086 my $item = $params->{item};
4087 my $issue = $params->{issue};
4088 my $return_date = $params->{return_date};
4090 unless ($borrower) { carp "No borrower passed in!" && return; }
4091 unless ($item) { carp "No item passed in!" && return; }
4092 unless ($issue) { carp "No issue passed in!" && return; }
4094 my $datedue = dt_from_string( $issue->date_due );
4096 # we only need to calculate and change the fines if we want to do that on return
4097 # Should be on for hourly loans
4098 my $control = C4::Context->preference('CircControl');
4099 my $control_branchcode =
4100 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4101 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4102 : $issue->branchcode;
4104 my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4106 my ( $amount, $unitcounttotal, $unitcount ) =
4107 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4109 if ( C4::Context->preference('finesMode') eq 'production' ) {
4110 if ( $amount > 0 ) {
4111 C4::Overdues::UpdateFine({
4112 issue_id => $issue->issue_id,
4113 itemnumber => $issue->itemnumber,
4114 borrowernumber => $issue->borrowernumber,
4116 due => output_pref($datedue),
4119 elsif ($return_date) {
4121 # Backdated returns may have fines that shouldn't exist,
4122 # so in this case, we need to drop those fines to 0
4124 C4::Overdues::UpdateFine({
4125 issue_id => $issue->issue_id,
4126 itemnumber => $issue->itemnumber,
4127 borrowernumber => $issue->borrowernumber,
4129 due => output_pref($datedue),
4135 sub _item_denied_renewal {
4138 my $item = $params->{item};
4139 return unless $item;
4141 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4142 return unless $denyingrules;
4143 foreach my $field (keys %$denyingrules) {
4144 my $val = $item->$field;
4145 if( !defined $val) {
4146 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4149 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4150 # If the results matches the values in the syspref
4151 # We return true if match found
4165 Koha Development Team <http://koha-community.org/>