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
33 use C4::ItemCirculationAlertPreference;
36 use C4::Log; # logaction
37 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
38 use C4::RotatingCollections qw(GetCollectionItemBranches);
39 use Algorithm::CheckDigits;
43 use Koha::AuthorisedValues;
44 use Koha::Biblioitems;
48 use Koha::IssuingRules;
51 use Koha::Patron::Debarments;
55 use Koha::RefundLostItemFeeRule;
56 use Koha::RefundLostItemFeeRules;
58 use List::MoreUtils qw( uniq );
59 use Scalar::Util qw( looks_like_number );
69 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
75 # FIXME subs that should probably be elsewhere
80 &GetPendingOnSiteCheckouts
83 # subs to deal with issuing a book
91 &GetLatestAutoRenewDate
93 &GetBranchBorrowerCircRule
97 &CheckIfIssuedToPatron
102 # subs to deal with returns
108 # subs to deal with transfers
115 &IsBranchTransferAllowed
116 &CreateBranchTransferLimit
117 &DeleteBranchTransferLimits
121 # subs to deal with offline circulation
123 &GetOfflineOperations
126 &DeleteOfflineOperation
127 &ProcessOfflineOperation
133 C4::Circulation - Koha circulation module
141 The functions in this module deal with circulation, issues, and
142 returns, as well as general information about the library.
143 Also deals with inventory.
149 $str = &barcodedecode($barcode, [$filter]);
151 Generic filter function for barcode string.
152 Called on every circ if the System Pref itemBarcodeInputFilter is set.
153 Will do some manipulation of the barcode for systems that deliver a barcode
154 to circulation.pl that differs from the barcode stored for the item.
155 For proper functioning of this filter, calling the function on the
156 correct barcode string (items.barcode) should return an unaltered barcode.
158 The optional $filter argument is to allow for testing or explicit
159 behavior that ignores the System Pref. Valid values are the same as the
164 # FIXME -- the &decode fcn below should be wrapped into this one.
165 # FIXME -- these plugins should be moved out of Circulation.pm
168 my ($barcode, $filter) = @_;
169 my $branch = C4::Context::mybranch();
170 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
171 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
172 if ($filter eq 'whitespace') {
174 } elsif ($filter eq 'cuecat') {
176 my @fields = split( /\./, $barcode );
177 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
178 ($#results == 2) and return $results[2];
179 } elsif ($filter eq 'T-prefix') {
180 if ($barcode =~ /^[Tt](\d)/) {
181 (defined($1) and $1 eq '0') and return $barcode;
182 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
184 return sprintf("T%07d", $barcode);
185 # FIXME: $barcode could be "T1", causing warning: substr outside of string
186 # Why drop the nonzero digit after the T?
187 # Why pass non-digits (or empty string) to "T%07d"?
188 } elsif ($filter eq 'libsuite8') {
189 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
190 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
191 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
193 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
196 } elsif ($filter eq 'EAN13') {
197 my $ean = CheckDigits('ean');
198 if ( $ean->is_valid($barcode) ) {
199 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
200 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
202 warn "# [$barcode] not valid EAN-13/UPC-A\n";
205 return $barcode; # return barcode, modified or not
210 $str = &decode($chunk);
212 Decodes a segment of a string emitted by a CueCat barcode scanner and
215 FIXME: Should be replaced with Barcode::Cuecat from CPAN
216 or Javascript based decoding on the client side.
223 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
224 my @s = map { index( $seq, $_ ); } split( //, $encoded );
225 my $l = ( $#s + 1 ) % 4;
228 # warn "Error: Cuecat decode parsing failed!";
236 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
238 chr( ( $n >> 16 ) ^ 67 )
239 .chr( ( $n >> 8 & 255 ) ^ 67 )
240 .chr( ( $n & 255 ) ^ 67 );
243 $r = substr( $r, 0, length($r) - $l );
249 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
250 $barcode, $ignore_reserves);
252 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
254 C<$newbranch> is the code for the branch to which the item should be transferred.
256 C<$barcode> is the barcode of the item to be transferred.
258 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
259 Otherwise, if an item is reserved, the transfer fails.
261 Returns three values:
267 is true if the transfer was successful.
271 is a reference-to-hash which may have any of the following keys:
277 There is no item in the catalog with the given barcode. The value is C<$barcode>.
281 The item's home branch is permanent. This doesn't prevent the item from being transferred, though. The value is the code of the item's home branch.
283 =item C<DestinationEqualsHolding>
285 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
289 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
293 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
295 =item C<WasTransferred>
297 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
306 my ( $tbr, $barcode, $ignoreRs ) = @_;
309 my $item = Koha::Items->find( { barcode => $barcode } );
313 $messages->{'BadBarcode'} = $barcode;
317 my $itemnumber = $item->itemnumber;
318 my $issue = GetOpenIssue($itemnumber);
319 # get branches of book...
320 my $hbr = $item->homebranch;
321 my $fbr = $item->holdingbranch;
323 # if using Branch Transfer Limits
324 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
325 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
326 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
327 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
328 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
331 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
332 $messages->{'NotAllowed'} = $tbr . "::" . $code;
338 # FIXME Is this still used by someone?
339 # See other FIXME in AddReturn
340 my $library = Koha::Libraries->find($hbr);
341 if ( $library and $library->get_categories->search({'me.categorycode' => 'PE'})->count ) {
342 $messages->{'IsPermanent'} = $hbr;
346 # can't transfer book if is already there....
347 if ( $fbr eq $tbr ) {
348 $messages->{'DestinationEqualsHolding'} = 1;
352 # check if it is still issued to someone, return it...
354 AddReturn( $barcode, $fbr );
355 $messages->{'WasReturned'} = $issue->borrowernumber;
359 # That'll save a database query.
360 my ( $resfound, $resrec, undef ) =
361 CheckReserves( $itemnumber );
362 if ( $resfound and not $ignoreRs ) {
363 $resrec->{'ResFound'} = $resfound;
365 # $messages->{'ResFound'} = $resrec;
369 #actually do the transfer....
371 ModItemTransfer( $itemnumber, $fbr, $tbr );
373 # don't need to update MARC anymore, we do it in batch now
374 $messages->{'WasTransfered'} = 1;
377 ModDateLastSeen( $itemnumber );
378 return ( $dotransfer, $messages );
383 my $borrower = shift;
384 my $biblionumber = shift;
387 my $onsite_checkout = $params->{onsite_checkout} || 0;
388 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
389 my $cat_borrower = $borrower->{'categorycode'};
390 my $dbh = C4::Context->dbh;
392 # Get which branchcode we need
393 $branch = _GetCircControlBranch($item,$borrower);
394 my $type = (C4::Context->preference('item-level_itypes'))
395 ? $item->{'itype'} # item-level
396 : $item->{'itemtype'}; # biblio-level
398 # given branch, patron category, and item type, determine
399 # applicable issuing rule
400 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
401 { categorycode => $cat_borrower,
403 branchcode => $branch
408 # if a rule is found and has a loan limit set, count
409 # how many loans the patron already has that meet that
411 if (defined($issuing_rule) and defined($issuing_rule->maxissueqty)) {
414 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
416 JOIN items USING (itemnumber)
419 my $rule_itemtype = $issuing_rule->itemtype;
420 if ($rule_itemtype eq "*") {
421 # matching rule has the default item type, so count only
422 # those existing loans that don't fall under a more
424 if (C4::Context->preference('item-level_itypes')) {
425 $count_query .= " WHERE items.itype NOT IN (
426 SELECT itemtype FROM issuingrules
428 AND (categorycode = ? OR categorycode = ?)
432 $count_query .= " JOIN biblioitems USING (biblionumber)
433 WHERE biblioitems.itemtype NOT IN (
434 SELECT itemtype FROM issuingrules
436 AND (categorycode = ? OR categorycode = ?)
440 push @bind_params, $issuing_rule->branchcode;
441 push @bind_params, $issuing_rule->categorycode;
442 push @bind_params, $cat_borrower;
444 # rule has specific item type, so count loans of that
446 if (C4::Context->preference('item-level_itypes')) {
447 $count_query .= " WHERE items.itype = ? ";
449 $count_query .= " JOIN biblioitems USING (biblionumber)
450 WHERE biblioitems.itemtype= ? ";
452 push @bind_params, $type;
455 $count_query .= " AND borrowernumber = ? ";
456 push @bind_params, $borrower->{'borrowernumber'};
457 my $rule_branch = $issuing_rule->branchcode;
458 if ($rule_branch ne "*") {
459 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
460 $count_query .= " AND issues.branchcode = ? ";
461 push @bind_params, $branch;
462 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
463 ; # if branch is the patron's home branch, then count all loans by patron
465 $count_query .= " AND items.homebranch = ? ";
466 push @bind_params, $branch;
470 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
472 my $max_checkouts_allowed = $issuing_rule->maxissueqty;
473 my $max_onsite_checkouts_allowed = $issuing_rule->maxonsiteissueqty;
475 if ( $onsite_checkout ) {
476 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
478 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
479 count => $onsite_checkout_count,
480 max_allowed => $max_onsite_checkouts_allowed,
484 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
485 my $delta = $switch_onsite_checkout ? 1 : 0;
486 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
488 reason => 'TOO_MANY_CHECKOUTS',
489 count => $checkout_count,
490 max_allowed => $max_checkouts_allowed,
493 } elsif ( not $onsite_checkout ) {
494 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
496 reason => 'TOO_MANY_CHECKOUTS',
497 count => $checkout_count - $onsite_checkout_count,
498 max_allowed => $max_checkouts_allowed,
504 # Now count total loans against the limit for the branch
505 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
506 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
507 my @bind_params = ();
508 my $branch_count_query = q|
509 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
511 JOIN items USING (itemnumber)
512 WHERE borrowernumber = ?
514 push @bind_params, $borrower->{borrowernumber};
516 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
517 $branch_count_query .= " AND issues.branchcode = ? ";
518 push @bind_params, $branch;
519 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
520 ; # if branch is the patron's home branch, then count all loans by patron
522 $branch_count_query .= " AND items.homebranch = ? ";
523 push @bind_params, $branch;
525 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
526 my $max_checkouts_allowed = $branch_borrower_circ_rule->{maxissueqty};
527 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{maxonsiteissueqty};
529 if ( $onsite_checkout ) {
530 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
532 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
533 count => $onsite_checkout_count,
534 max_allowed => $max_onsite_checkouts_allowed,
538 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
539 my $delta = $switch_onsite_checkout ? 1 : 0;
540 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
542 reason => 'TOO_MANY_CHECKOUTS',
543 count => $checkout_count,
544 max_allowed => $max_checkouts_allowed,
547 } elsif ( not $onsite_checkout ) {
548 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
550 reason => 'TOO_MANY_CHECKOUTS',
551 count => $checkout_count - $onsite_checkout_count,
552 max_allowed => $max_checkouts_allowed,
558 if ( not defined( $issuing_rule ) and not defined($branch_borrower_circ_rule->{maxissueqty}) ) {
559 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
562 # OK, the patron can issue !!!
566 =head2 CanBookBeIssued
568 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
569 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
571 Check if a book can be issued.
573 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
577 =item C<$borrower> hash with borrower informations (from Koha::Patron->unblessed)
579 =item C<$barcode> is the bar code of the book being issued.
581 =item C<$duedates> is a DateTime object.
583 =item C<$inprocess> boolean switch
585 =item C<$ignore_reserves> boolean switch
587 =item C<$params> Hashref of additional parameters
590 override_high_holds - Ignore high holds
591 onsite_checkout - Checkout is an onsite checkout that will not leave the library
599 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
600 Possible values are :
606 sticky due date is invalid
610 borrower gone with no address
614 borrower declared it's card lost
620 =head3 UNKNOWN_BARCODE
634 item is restricted (set by ??)
636 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
637 could be prevented, but ones that can be overriden by the operator.
639 Possible values are :
647 renewing, not issuing
649 =head3 ISSUED_TO_ANOTHER
651 issued to someone else.
655 reserved for someone else.
659 sticky due date is invalid or due date in the past
663 if the borrower borrows to much things
667 sub CanBookBeIssued {
668 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
669 my %needsconfirmation; # filled with problems that needs confirmations
670 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
671 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
672 my %messages; # filled with information messages that should be displayed.
674 my $onsite_checkout = $params->{onsite_checkout} || 0;
675 my $override_high_holds = $params->{override_high_holds} || 0;
677 my $item = GetItem(undef, $barcode );
678 my $issue = Koha::Checkouts->find( { itemnumber => $item->{itemnumber} } );
679 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
680 $item->{'itemtype'}=$item->{'itype'};
681 my $dbh = C4::Context->dbh;
683 # MANDATORY CHECKS - unless item exists, nothing else matters
684 unless ( $item->{barcode} ) {
685 $issuingimpossible{UNKNOWN_BARCODE} = 1;
687 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
690 # DUE DATE is OK ? -- should already have checked.
692 if ($duedate && ref $duedate ne 'DateTime') {
693 $duedate = dt_from_string($duedate);
695 my $now = DateTime->now( time_zone => C4::Context->tz() );
696 unless ( $duedate ) {
697 my $issuedate = $now->clone();
699 my $branch = _GetCircControlBranch($item,$borrower);
700 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
701 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
703 # Offline circ calls AddIssue directly, doesn't run through here
704 # So issuingimpossible should be ok.
707 my $today = $now->clone();
708 $today->truncate( to => 'minute');
709 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
710 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
713 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
719 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
720 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
722 branch => C4::Context->userenv->{'branch'},
724 itemnumber => $item->{'itemnumber'},
725 itemtype => $item->{'itype'},
726 borrowernumber => $borrower->{'borrowernumber'},
727 ccode => $item->{'ccode'}}
729 ModDateLastSeen( $item->{'itemnumber'} );
730 return( { STATS => 1 }, {});
733 my $flags = C4::Members::patronflags( $borrower );
735 if ( $flags->{GNA} ) {
736 $issuingimpossible{GNA} = 1;
738 if ( $flags->{'LOST'} ) {
739 $issuingimpossible{CARD_LOST} = 1;
741 if ( $flags->{'DBARRED'} ) {
742 $issuingimpossible{DEBARRED} = 1;
745 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
746 $issuingimpossible{EXPIRED} = 1;
748 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'sql', 'floating' );
749 $expiry_dt->truncate( to => 'day');
750 my $today = $now->clone()->truncate(to => 'day');
751 $today->set_time_zone( 'floating' );
752 if ( DateTime->compare($today, $expiry_dt) == 1 ) {
753 $issuingimpossible{EXPIRED} = 1;
762 my ($balance, $non_issue_charges, $other_charges) =
763 C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
765 my $amountlimit = C4::Context->preference("noissuescharge");
766 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
767 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
769 # Check the debt of this patrons guarantees
770 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
771 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
772 if ( defined $no_issues_charge_guarantees ) {
773 my $p = Koha::Patrons->find( $borrower->{borrowernumber} );
774 my @guarantees = $p->guarantees();
775 my $guarantees_non_issues_charges;
776 foreach my $g ( @guarantees ) {
777 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
778 $guarantees_non_issues_charges += $n;
781 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
782 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
783 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
784 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
785 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
786 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
790 if ( C4::Context->preference("IssuingInProcess") ) {
791 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
792 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
793 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
794 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
795 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
796 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
800 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
801 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
802 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
803 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
804 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
805 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
809 if ($balance > 0 && $other_charges > 0) {
810 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
813 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
814 if ( my $debarred_date = $patron->is_debarred ) {
815 # patron has accrued fine days or has a restriction. $count is a date
816 if ($debarred_date eq '9999-12-31') {
817 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
820 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
822 } elsif ( my $num_overdues = $patron->has_overdues ) {
823 ## patron has outstanding overdue loans
824 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
825 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
827 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
828 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
832 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
834 my $switch_onsite_checkout = (
835 C4::Context->preference('SwitchOnSiteCheckouts')
837 and $issue->onsite_checkout
838 and $issue->borrowernumber == $borrower->{'borrowernumber'} ? 1 : 0 );
839 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
840 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
842 if ( $toomany->{max_allowed} == 0 ) {
843 $needsconfirmation{PATRON_CANT} = 1;
845 if ( C4::Context->preference("AllowTooManyOverride") ) {
846 $needsconfirmation{TOO_MANY} = $toomany->{reason};
847 $needsconfirmation{current_loan_count} = $toomany->{count};
848 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
850 $issuingimpossible{TOO_MANY} = $toomany->{reason};
851 $issuingimpossible{current_loan_count} = $toomany->{count};
852 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
857 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
859 $patron = Koha::Patrons->find($borrower->{borrowernumber});
860 my $wants_check = $patron->wants_check_for_previous_checkout;
861 $needsconfirmation{PREVISSUE} = 1
862 if ($wants_check and $patron->do_check_for_previous_checkout($item));
867 if ( $item->{'notforloan'} )
869 if(!C4::Context->preference("AllowNotForLoanOverride")){
870 $issuingimpossible{NOT_FOR_LOAN} = 1;
871 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
873 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
874 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
878 # we have to check itemtypes.notforloan also
879 if (C4::Context->preference('item-level_itypes')){
880 # this should probably be a subroutine
881 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
882 $sth->execute($item->{'itemtype'});
883 my $notforloan=$sth->fetchrow_hashref();
884 if ($notforloan->{'notforloan'}) {
885 if (!C4::Context->preference("AllowNotForLoanOverride")) {
886 $issuingimpossible{NOT_FOR_LOAN} = 1;
887 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
889 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
890 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
894 elsif ($biblioitem->{'notforloan'} == 1){
895 if (!C4::Context->preference("AllowNotForLoanOverride")) {
896 $issuingimpossible{NOT_FOR_LOAN} = 1;
897 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
899 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
900 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
904 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
906 $issuingimpossible{WTHDRAWN} = 1;
908 if ( $item->{'restricted'}
909 && $item->{'restricted'} == 1 )
911 $issuingimpossible{RESTRICTED} = 1;
913 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
914 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->{itemlost} });
915 my $code = $av->count ? $av->next->lib : '';
916 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
917 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
919 if ( C4::Context->preference("IndependentBranches") ) {
920 my $userenv = C4::Context->userenv;
921 unless ( C4::Context->IsSuperLibrarian() ) {
922 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
923 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
924 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
926 $needsconfirmation{BORRNOTSAMEBRANCH} = $borrower->{'branchcode'}
927 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
931 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
933 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
935 if ( $rentalConfirmation ){
936 my ($rentalCharge) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
937 if ( $rentalCharge > 0 ){
938 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
943 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
945 if ( $issue && $issue->borrowernumber eq $borrower->{'borrowernumber'} ){
947 # Already issued to current borrower.
948 # If it is an on-site checkout if it can be switched to a normal checkout
949 # or ask whether the loan should be renewed
951 if ( $issue->onsite_checkout
952 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
953 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
955 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
956 $borrower->{'borrowernumber'},
957 $item->{'itemnumber'},
959 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
960 if ( $renewerror eq 'onsite_checkout' ) {
961 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
964 $issuingimpossible{NO_MORE_RENEWALS} = 1;
968 $needsconfirmation{RENEW_ISSUE} = 1;
974 # issued to someone else
976 my $patron = Koha::Patrons->find( $issue->borrowernumber );
978 my ( $can_be_returned, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
980 unless ( $can_be_returned ) {
981 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
982 $issuingimpossible{branch_to_return} = $message;
984 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
985 $needsconfirmation{issued_firstname} = $patron->firstname;
986 $needsconfirmation{issued_surname} = $patron->surname;
987 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
988 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
992 unless ( $ignore_reserves ) {
993 # See if the item is on reserve.
994 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
996 my $resbor = $res->{'borrowernumber'};
997 if ( $resbor ne $borrower->{'borrowernumber'} ) {
998 my $patron = Koha::Patrons->find( $resbor );
999 if ( $restype eq "Waiting" )
1001 # The item is on reserve and waiting, but has been
1002 # reserved by some other patron.
1003 $needsconfirmation{RESERVE_WAITING} = 1;
1004 $needsconfirmation{'resfirstname'} = $patron->firstname;
1005 $needsconfirmation{'ressurname'} = $patron->surname;
1006 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1007 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1008 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1009 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1011 elsif ( $restype eq "Reserved" ) {
1012 # The item is on reserve for someone else.
1013 $needsconfirmation{RESERVED} = 1;
1014 $needsconfirmation{'resfirstname'} = $patron->firstname;
1015 $needsconfirmation{'ressurname'} = $patron->surname;
1016 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1017 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1018 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1019 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1025 ## CHECK AGE RESTRICTION
1026 my $agerestriction = $biblioitem->{'agerestriction'};
1027 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $borrower );
1028 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1029 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1030 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1033 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1037 ## check for high holds decreasing loan period
1038 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1039 my $check = checkHighHolds( $item, $borrower );
1041 if ( $check->{exceeded} ) {
1042 if ($override_high_holds) {
1043 $alerts{HIGHHOLDS} = {
1044 num_holds => $check->{outstanding},
1045 duration => $check->{duration},
1046 returndate => output_pref( $check->{due_date} ),
1050 $needsconfirmation{HIGHHOLDS} = {
1051 num_holds => $check->{outstanding},
1052 duration => $check->{duration},
1053 returndate => output_pref( $check->{due_date} ),
1060 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1061 # don't do the multiple loans per bib check if we've
1062 # already determined that we've got a loan on the same item
1063 !$issuingimpossible{NO_MORE_RENEWALS} &&
1064 !$needsconfirmation{RENEW_ISSUE}
1066 # Check if borrower has already issued an item from the same biblio
1067 # Only if it's not a subscription
1068 my $biblionumber = $item->{biblionumber};
1069 require C4::Serials;
1070 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1071 unless ($is_a_subscription) {
1072 my $checkouts = Koha::Checkouts->search(
1074 borrowernumber => $borrower->{borrowernumber},
1075 biblionumber => $biblionumber,
1081 # if we get here, we don't already have a loan on this item,
1082 # so if there are any loans on this bib, ask for confirmation
1083 if ( $checkouts->count ) {
1084 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1089 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1092 =head2 CanBookBeReturned
1094 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1096 Check whether the item can be returned to the provided branch
1100 =item C<$item> is a hash of item information as returned from GetItem
1102 =item C<$branch> is the branchcode where the return is taking place
1110 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1112 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1118 sub CanBookBeReturned {
1119 my ($item, $branch) = @_;
1120 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1122 # assume return is allowed to start
1126 # identify all cases where return is forbidden
1127 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1129 $message = $item->{'homebranch'};
1130 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1132 $message = $item->{'holdingbranch'};
1133 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1135 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1138 return ($allowed, $message);
1141 =head2 CheckHighHolds
1143 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1144 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1145 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1149 sub checkHighHolds {
1150 my ( $item, $borrower ) = @_;
1151 my $branch = _GetCircControlBranch( $item, $borrower );
1152 my $item_object = Koha::Items->find( $item->{itemnumber} );
1161 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1163 if ( $holds->count() ) {
1164 $return_data->{outstanding} = $holds->count();
1166 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1167 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1168 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1170 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1172 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1174 # static means just more than a given number of holds on the record
1176 # If the number of holds is less than the threshold, we can stop here
1177 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1178 return $return_data;
1181 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1183 # dynamic means X more than the number of holdable items on the record
1185 # let's get the items
1186 my @items = $holds->next()->biblio()->items();
1188 # Remove any items with status defined to be ignored even if the would not make item unholdable
1189 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1190 @items = grep { !$_->$status } @items;
1193 # Remove any items that are not holdable for this patron
1194 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber ) eq 'OK' } @items;
1196 my $items_count = scalar @items;
1198 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1200 # If the number of holds is less than the count of items we have
1201 # plus the number of holds allowed above that count, we can stop here
1202 if ( $holds->count() <= $threshold ) {
1203 return $return_data;
1207 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1209 my $calendar = Koha::Calendar->new( branchcode => $branch );
1211 my $itype = $item_object->effective_itemtype;
1212 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1214 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1216 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1217 $reduced_datedue->set_hour($orig_due->hour);
1218 $reduced_datedue->set_minute($orig_due->minute);
1219 $reduced_datedue->truncate( to => 'minute' );
1221 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1222 $return_data->{exceeded} = 1;
1223 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1224 $return_data->{due_date} = $reduced_datedue;
1228 return $return_data;
1233 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1235 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1239 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1241 =item C<$barcode> is the barcode of the item being issued.
1243 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1244 Calculated if empty.
1246 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1248 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1249 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1251 AddIssue does the following things :
1253 - step 01: check that there is a borrowernumber & a barcode provided
1254 - check for RENEWAL (book issued & being issued to the same patron)
1255 - renewal YES = Calculate Charge & renew
1257 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1259 - fill reserve if reserve to this patron
1260 - cancel reserve or not, otherwise
1261 * TRANSFERT PENDING ?
1262 - complete the transfert
1270 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1272 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1273 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1274 my $auto_renew = $params && $params->{auto_renew};
1275 my $dbh = C4::Context->dbh;
1276 my $barcodecheck = CheckValidBarcode($barcode);
1280 if ( $datedue && ref $datedue ne 'DateTime' ) {
1281 $datedue = dt_from_string($datedue);
1284 # $issuedate defaults to today.
1285 if ( !defined $issuedate ) {
1286 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1289 if ( ref $issuedate ne 'DateTime' ) {
1290 $issuedate = dt_from_string($issuedate);
1295 # Stop here if the patron or barcode doesn't exist
1296 if ( $borrower && $barcode && $barcodecheck ) {
1297 # find which item we issue
1298 my $item = GetItem( '', $barcode )
1299 or return; # if we don't get an Item, abort.
1300 my $item_object = Koha::Items->find( { barcode => $barcode } );
1302 my $branch = _GetCircControlBranch( $item, $borrower );
1304 # get actual issuing if there is one
1305 my $actualissue = Koha::Checkouts->find( { itemnumber => $item->{itemnumber} } );
1307 # check if we just renew the issue.
1308 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1309 and not $switch_onsite_checkout ) {
1310 $datedue = AddRenewal(
1311 $borrower->{'borrowernumber'},
1312 $item->{'itemnumber'},
1315 $issuedate, # here interpreted as the renewal date
1319 # it's NOT a renewal
1320 if ( $actualissue and not $switch_onsite_checkout ) {
1321 # This book is currently on loan, but not to the person
1322 # who wants to borrow it now. mark it returned before issuing to the new borrower
1323 my ( $allowed, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
1324 return unless $allowed;
1325 AddReturn( $item->{'barcode'}, C4::Context->userenv->{'branch'} );
1328 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1330 # Starting process for transfer job (checking transfert and validate it if we have one)
1331 my ($datesent) = GetTransfers( $item->{'itemnumber'} );
1333 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1334 my $sth = $dbh->prepare(
1335 "UPDATE branchtransfers
1336 SET datearrived = now(),
1338 comments = 'Forced branchtransfer'
1339 WHERE itemnumber= ? AND datearrived IS NULL"
1341 $sth->execute( C4::Context->userenv->{'branch'},
1342 $item->{'itemnumber'} );
1345 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1346 unless ($auto_renew) {
1347 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1348 { categorycode => $borrower->{categorycode},
1349 itemtype => $item->{itype},
1350 branchcode => $branch
1354 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1357 # Record in the database the fact that the book was issued.
1359 my $itype = $item_object->effective_itemtype;
1360 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1363 $datedue->truncate( to => 'minute' );
1365 $issue = Koha::Database->new()->schema()->resultset('Issue')->update_or_create(
1367 borrowernumber => $borrower->{'borrowernumber'},
1368 itemnumber => $item->{'itemnumber'},
1369 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1370 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1371 branchcode => C4::Context->userenv->{'branch'},
1372 onsite_checkout => $onsite_checkout,
1373 auto_renew => $auto_renew ? 1 : 0
1377 if ( C4::Context->preference('ReturnToShelvingCart') ) {
1378 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1379 CartToShelf( $item->{'itemnumber'} );
1381 $item->{'issues'}++;
1382 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1383 UpdateTotalIssues( $item->{'biblionumber'}, 1 );
1386 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1387 if ( $item->{'itemlost'} ) {
1389 Koha::RefundLostItemFeeRules->should_refund(
1391 current_branch => C4::Context->userenv->{branch},
1392 item_home_branch => $item->{homebranch},
1393 item_holding_branch => $item->{holdingbranch}
1398 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef,
1399 $item->{'barcode'} );
1405 issues => $item->{'issues'},
1406 holdingbranch => C4::Context->userenv->{'branch'},
1408 onloan => $datedue->ymd(),
1409 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1411 $item->{'biblionumber'},
1412 $item->{'itemnumber'}
1414 ModDateLastSeen( $item->{'itemnumber'} );
1416 # If it costs to borrow this book, charge it to the patron's account.
1417 my ( $charge, $itemtype ) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1418 if ( $charge > 0 ) {
1419 AddIssuingCharge( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $charge );
1420 $item->{'charge'} = $charge;
1423 # Record the fact that this book was issued.
1426 branch => C4::Context->userenv->{'branch'},
1427 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1429 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1430 itemnumber => $item->{'itemnumber'},
1431 itemtype => $item->{'itype'},
1432 borrowernumber => $borrower->{'borrowernumber'},
1433 ccode => $item->{'ccode'}
1437 # Send a checkout slip.
1438 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1440 branchcode => $branch,
1441 categorycode => $borrower->{categorycode},
1442 item_type => $item->{itype},
1443 notification => 'CHECKOUT',
1445 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1446 SendCirculationAlert(
1450 borrower => $borrower,
1458 "CIRCULATION", "ISSUE",
1459 $borrower->{'borrowernumber'},
1460 $item->{'itemnumber'}
1461 ) if C4::Context->preference("IssueLog");
1466 =head2 GetLoanLength
1468 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1470 Get loan length for an itemtype, a borrower type and a branch
1475 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1476 my $dbh = C4::Context->dbh;
1477 my $sth = $dbh->prepare(qq{
1478 SELECT issuelength, lengthunit, renewalperiod
1480 WHERE categorycode=?
1483 AND issuelength IS NOT NULL
1486 # try to find issuelength & return the 1st available.
1487 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1488 $sth->execute( $borrowertype, $itemtype, $branchcode );
1489 my $loanlength = $sth->fetchrow_hashref;
1492 if defined($loanlength) && defined $loanlength->{issuelength};
1494 $sth->execute( $borrowertype, '*', $branchcode );
1495 $loanlength = $sth->fetchrow_hashref;
1497 if defined($loanlength) && defined $loanlength->{issuelength};
1499 $sth->execute( '*', $itemtype, $branchcode );
1500 $loanlength = $sth->fetchrow_hashref;
1502 if defined($loanlength) && defined $loanlength->{issuelength};
1504 $sth->execute( '*', '*', $branchcode );
1505 $loanlength = $sth->fetchrow_hashref;
1507 if defined($loanlength) && defined $loanlength->{issuelength};
1509 $sth->execute( $borrowertype, $itemtype, '*' );
1510 $loanlength = $sth->fetchrow_hashref;
1512 if defined($loanlength) && defined $loanlength->{issuelength};
1514 $sth->execute( $borrowertype, '*', '*' );
1515 $loanlength = $sth->fetchrow_hashref;
1517 if defined($loanlength) && defined $loanlength->{issuelength};
1519 $sth->execute( '*', $itemtype, '*' );
1520 $loanlength = $sth->fetchrow_hashref;
1522 if defined($loanlength) && defined $loanlength->{issuelength};
1524 $sth->execute( '*', '*', '*' );
1525 $loanlength = $sth->fetchrow_hashref;
1527 if defined($loanlength) && defined $loanlength->{issuelength};
1529 # if no rule is set => 0 day (hardcoded)
1533 lengthunit => 'days',
1539 =head2 GetHardDueDate
1541 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1543 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1547 sub GetHardDueDate {
1548 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1550 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1551 { categorycode => $borrowertype,
1552 itemtype => $itemtype,
1553 branchcode => $branchcode
1558 if ( defined( $issuing_rule ) ) {
1559 if ( $issuing_rule->hardduedate ) {
1560 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1562 return (undef, undef);
1567 =head2 GetBranchBorrowerCircRule
1569 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1571 Retrieves circulation rule attributes that apply to the given
1572 branch and patron category, regardless of item type.
1573 The return value is a hashref containing the following key:
1575 maxissueqty - maximum number of loans that a
1576 patron of the given category can have at the given
1577 branch. If the value is undef, no limit.
1579 maxonsiteissueqty - maximum of on-site checkouts that a
1580 patron of the given category can have at the given
1581 branch. If the value is undef, no limit.
1583 This will first check for a specific branch and
1584 category match from branch_borrower_circ_rules.
1586 If no rule is found, it will then check default_branch_circ_rules
1587 (same branch, default category). If no rule is found,
1588 it will then check default_borrower_circ_rules (default
1589 branch, same category), then failing that, default_circ_rules
1590 (default branch, default category).
1592 If no rule has been found in the database, it will default to
1596 maxonsiteissueqty - undef
1598 C<$branchcode> and C<$categorycode> should contain the
1599 literal branch code and patron category code, respectively - no
1604 sub GetBranchBorrowerCircRule {
1605 my ( $branchcode, $categorycode ) = @_;
1608 my $dbh = C4::Context->dbh();
1609 $rules = $dbh->selectrow_hashref( q|
1610 SELECT maxissueqty, maxonsiteissueqty
1611 FROM branch_borrower_circ_rules
1612 WHERE branchcode = ?
1613 AND categorycode = ?
1614 |, {}, $branchcode, $categorycode ) ;
1615 return $rules if $rules;
1617 # try same branch, default borrower category
1618 $rules = $dbh->selectrow_hashref( q|
1619 SELECT maxissueqty, maxonsiteissueqty
1620 FROM default_branch_circ_rules
1621 WHERE branchcode = ?
1622 |, {}, $branchcode ) ;
1623 return $rules if $rules;
1625 # try default branch, same borrower category
1626 $rules = $dbh->selectrow_hashref( q|
1627 SELECT maxissueqty, maxonsiteissueqty
1628 FROM default_borrower_circ_rules
1629 WHERE categorycode = ?
1630 |, {}, $categorycode ) ;
1631 return $rules if $rules;
1633 # try default branch, default borrower category
1634 $rules = $dbh->selectrow_hashref( q|
1635 SELECT maxissueqty, maxonsiteissueqty
1636 FROM default_circ_rules
1638 return $rules if $rules;
1640 # built-in default circulation rule
1642 maxissueqty => undef,
1643 maxonsiteissueqty => undef,
1647 =head2 GetBranchItemRule
1649 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1651 Retrieves circulation rule attributes that apply to the given
1652 branch and item type, regardless of patron category.
1654 The return value is a hashref containing the following keys:
1656 holdallowed => Hold policy for this branch and itemtype. Possible values:
1657 0: No holds allowed.
1658 1: Holds allowed only by patrons that have the same homebranch as the item.
1659 2: Holds allowed from any patron.
1661 returnbranch => branch to which to return item. Possible values:
1662 noreturn: do not return, let item remain where checked in (floating collections)
1663 homebranch: return to item's home branch
1664 holdingbranch: return to issuer branch
1666 This searches branchitemrules in the following order:
1668 * Same branchcode and itemtype
1669 * Same branchcode, itemtype '*'
1670 * branchcode '*', same itemtype
1671 * branchcode and itemtype '*'
1673 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1677 sub GetBranchItemRule {
1678 my ( $branchcode, $itemtype ) = @_;
1679 my $dbh = C4::Context->dbh();
1683 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1684 FROM branch_item_rules
1685 WHERE branchcode = ?
1686 AND itemtype = ?', $branchcode, $itemtype],
1687 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1688 FROM default_branch_circ_rules
1689 WHERE branchcode = ?', $branchcode],
1690 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1691 FROM default_branch_item_rules
1692 WHERE itemtype = ?', $itemtype],
1693 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1694 FROM default_circ_rules'],
1697 foreach my $attempt (@attempts) {
1698 my ($query, @bind_params) = @{$attempt};
1699 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1702 # Since branch/category and branch/itemtype use the same per-branch
1703 # defaults tables, we have to check that the key we want is set, not
1704 # just that a row was returned
1705 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1706 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1707 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1710 # built-in default circulation rule
1711 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1712 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1713 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1720 ($doreturn, $messages, $iteminformation, $borrower) =
1721 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1727 =item C<$barcode> is the bar code of the book being returned.
1729 =item C<$branch> is the code of the branch where the book is being returned.
1731 =item C<$exemptfine> indicates that overdue charges for the item will be
1734 =item C<$dropbox> indicates that the check-in date is assumed to be
1735 yesterday, or the last non-holiday as defined in C4::Calendar . If
1736 overdue charges are applied and C<$dropbox> is true, the last charge
1737 will be removed. This assumes that the fines accrual script has run
1738 for _today_. Optional.
1740 =item C<$return_date> allows the default return date to be overridden
1741 by the given return date. Optional.
1745 C<&AddReturn> returns a list of four items:
1747 C<$doreturn> is true iff the return succeeded.
1749 C<$messages> is a reference-to-hash giving feedback on the operation.
1750 The keys of the hash are:
1756 No item with this barcode exists. The value is C<$barcode>.
1760 The book is not currently on loan. The value is C<$barcode>.
1762 =item C<IsPermanent>
1764 The book's home branch is a permanent collection. If you have borrowed
1765 this book, you are not allowed to return it. The value is the code for
1766 the book's home branch.
1770 This book has been withdrawn/cancelled. The value should be ignored.
1772 =item C<Wrongbranch>
1774 This book has was returned to the wrong branch. The value is a hashref
1775 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1776 contain the branchcode of the incorrect and correct return library, respectively.
1780 The item was reserved. The value is a reference-to-hash whose keys are
1781 fields from the reserves table of the Koha database, and
1782 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1783 either C<Waiting>, C<Reserved>, or 0.
1785 =item C<WasReturned>
1787 Value 1 if return is successful.
1789 =item C<NeedsTransfer>
1791 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1795 C<$iteminformation> is a reference-to-hash, giving information about the
1796 returned item from the issues table.
1798 C<$borrower> is a reference-to-hash, giving information about the
1799 patron who last borrowed the book.
1804 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1806 if ($branch and not Koha::Libraries->find($branch)) {
1807 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1810 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1814 my $validTransfert = 0;
1815 my $stat_type = 'return';
1817 # get information on item
1818 my $item = GetItem( undef, $barcode );
1820 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1823 my $itemnumber = $item->{ itemnumber };
1824 my $itemtype = C4::Context->preference("item-level_itypes")
1826 : Koha::Biblioitems->find( $item->{biblioitemnumber} )->itemtype;
1828 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
1830 $patron = Koha::Patrons->find( $issue->borrowernumber )
1831 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1832 . Dumper($issue->unblessed) . "\n";
1834 $messages->{'NotIssued'} = $barcode;
1835 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1837 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1838 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1839 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1840 $messages->{'LocalUse'} = 1;
1841 $stat_type = 'localuse';
1845 if ( $item->{'location'} eq 'PROC' ) {
1846 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1847 $item->{'location'} = 'CART';
1850 $item->{location} = $item->{permanent_location};
1853 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
1856 # full item data, but no borrowernumber or checkout info (no issue)
1857 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1858 # get the proper branch to which to return the item
1859 my $returnbranch = $item->{$hbr} || $branch ;
1860 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1862 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1863 my $patron_unblessed = $patron ? $patron->unblessed : {};
1865 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1867 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1869 eval { $rules = YAML::Load($yaml); };
1871 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1874 foreach my $key ( keys %$rules ) {
1875 if ( $item->{notforloan} eq $key ) {
1876 $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1877 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1885 # check if the book is in a permanent collection....
1886 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1887 if ( $returnbranch ) {
1888 my $library = Koha::Libraries->find($returnbranch);
1889 if ( $library and $library->get_categories->search({'me.categorycode' => 'PE'})->count ) {
1890 $messages->{'IsPermanent'} = $returnbranch;
1894 # check if the return is allowed at this branch
1895 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1896 unless ($returnallowed){
1897 $messages->{'Wrongbranch'} = {
1898 Wrongbranch => $branch,
1899 Rightbranch => $message
1902 return ( $doreturn, $messages, $issue, $patron_unblessed);
1905 if ( $item->{'withdrawn'} ) { # book has been cancelled
1906 $messages->{'withdrawn'} = 1;
1907 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1910 # case of a return of document (deal with issues and holdingbranch)
1911 my $today = DateTime->now( time_zone => C4::Context->tz() );
1915 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1916 $patron or warn "AddReturn without current borrower";
1917 my $circControlBranch;
1919 # define circControlBranch only if dropbox mode is set
1920 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1921 # FIXME: check issuedate > returndate, factoring in holidays
1923 $circControlBranch = _GetCircControlBranch($item,$patron_unblessed);
1924 $is_overdue = $issue->is_overdue( $dropboxdate );
1926 $is_overdue = $issue->is_overdue;
1931 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1932 $circControlBranch, $return_date, $patron->privacy );
1935 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1936 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed, return_date => $return_date } );
1939 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 );
1941 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1944 # FIXME is the "= 1" right? This could be the borrower hash.
1945 $messages->{'WasReturned'} = 1;
1949 ModItem({ onloan => undef }, $item->{biblionumber}, $item->{'itemnumber'});
1952 # the holdingbranch is updated if the document is returned to another location.
1953 # this is always done regardless of whether the item was on loan or not
1954 my $item_holding_branch = $item->{ holdingbranch };
1955 if ($item->{'holdingbranch'} ne $branch) {
1956 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1957 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1959 ModDateLastSeen( $item->{'itemnumber'} );
1961 # check if we have a transfer for this document
1962 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1964 # if we have a transfer to do, we update the line of transfers with the datearrived
1965 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1967 if ( $tobranch eq $branch ) {
1968 my $sth = C4::Context->dbh->prepare(
1969 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1971 $sth->execute( $item->{'itemnumber'} );
1972 # if we have a reservation with valid transfer, we can set it's status to 'W'
1973 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1974 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1976 $messages->{'WrongTransfer'} = $tobranch;
1977 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1979 $validTransfert = 1;
1981 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1984 # fix up the accounts.....
1985 if ( $item->{'itemlost'} ) {
1986 $messages->{'WasLost'} = 1;
1988 if ( $item->{'itemlost'} ) {
1990 Koha::RefundLostItemFeeRules->should_refund(
1992 current_branch => C4::Context->userenv->{branch},
1993 item_home_branch => $item->{homebranch},
1994 item_holding_branch => $item_holding_branch
1999 _FixAccountForLostAndReturned( $item->{'itemnumber'}, $borrowernumber, $barcode );
2000 $messages->{'LostItemFeeRefunded'} = 1;
2005 # fix up the overdues in accounts...
2006 if ($borrowernumber) {
2007 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
2008 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
2010 if ( $issue and $issue->is_overdue ) {
2012 $today = $dropboxdate if $dropbox;
2013 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item, dt_from_string($issue->date_due), $today );
2015 $messages->{'PrevDebarred'} = $debardate;
2017 $messages->{'Debarred'} = $debardate if $debardate;
2019 # there's no overdue on the item but borrower had been previously debarred
2020 } elsif ( $issue->date_due and $patron->debarred ) {
2021 if ( $patron->debarred eq "9999-12-31") {
2022 $messages->{'ForeverDebarred'} = $patron->debarred;
2024 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2025 $borrower_debar_dt->truncate(to => 'day');
2026 my $today_dt = $today->clone()->truncate(to => 'day');
2027 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2028 $messages->{'PrevDebarred'} = $patron->debarred;
2034 # find reserves.....
2035 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2036 my ($resfound, $resrec);
2037 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2038 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2040 $resrec->{'ResFound'} = $resfound;
2041 $messages->{'ResFound'} = $resrec;
2044 # Record the fact that this book was returned.
2048 itemnumber => $itemnumber,
2049 itemtype => $itemtype,
2050 borrowernumber => $borrowernumber,
2051 ccode => $item->{ ccode }
2054 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2056 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2058 branchcode => $branch,
2059 categorycode => $patron->categorycode,
2060 item_type => $item->{itype},
2061 notification => 'CHECKIN',
2063 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2064 SendCirculationAlert({
2067 borrower => $patron->unblessed,
2072 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2073 if C4::Context->preference("ReturnLog");
2076 # Remove any OVERDUES related debarment if the borrower has no overdues
2077 if ( $borrowernumber
2078 && $patron->debarred
2079 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2080 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2081 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2083 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2086 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2087 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2088 if (C4::Context->preference("AutomaticItemReturn" ) or
2089 (C4::Context->preference("UseBranchTransferLimits") and
2090 ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2092 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2093 $debug and warn "item: " . Dumper($item);
2094 ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2095 $messages->{'WasTransfered'} = 1;
2097 $messages->{'NeedsTransfer'} = $returnbranch;
2101 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2104 =head2 MarkIssueReturned
2106 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2108 Unconditionally marks an issue as being returned by
2109 moving the C<issues> row to C<old_issues> and
2110 setting C<returndate> to the current date, or
2111 the last non-holiday date of the branccode specified in
2112 C<dropbox_branch> . Assumes you've already checked that
2113 it's safe to do this, i.e. last non-holiday > issuedate.
2115 if C<$returndate> is specified (in iso format), it is used as the date
2116 of the return. It is ignored when a dropbox_branch is passed in.
2118 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2119 the old_issue is immediately anonymised
2121 Ideally, this function would be internal to C<C4::Circulation>,
2122 not exported, but it is currently needed by one
2123 routine in C<C4::Accounts>.
2127 sub MarkIssueReturned {
2128 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2130 my $anonymouspatron;
2131 if ( $privacy == 2 ) {
2132 # The default of 0 will not work due to foreign key constraints
2133 # The anonymisation will fail if AnonymousPatron is not a valid entry
2134 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2135 # Note that a warning should appear on the about page (System information tab).
2136 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2137 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."
2138 unless Koha::Patrons->find( $anonymouspatron );
2140 my $database = Koha::Database->new();
2141 my $schema = $database->schema;
2142 my $dbh = C4::Context->dbh;
2144 my $issue_id = $dbh->selectrow_array(
2145 q|SELECT issue_id FROM issues WHERE itemnumber = ?|,
2149 my $query = 'UPDATE issues SET returndate=';
2151 if ($dropbox_branch) {
2152 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2153 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2155 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2156 } elsif ($returndate) {
2158 push @bind, $returndate;
2160 $query .= ' now() ';
2162 $query .= ' WHERE issue_id = ?';
2163 push @bind, $issue_id;
2165 # FIXME Improve the return value and handle it from callers
2166 $schema->txn_do(sub {
2168 # Update the returndate
2169 $dbh->do( $query, undef, @bind );
2171 # Retrieve the issue
2172 my $issue = Koha::Checkouts->find( $issue_id ); # FIXME should be fetched earlier
2174 # Create the old_issues entry
2175 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2178 $dbh->do(q|UPDATE accountlines SET issue_id = ? WHERE issue_id = ?|, undef, $old_checkout->issue_id, $issue->issue_id);
2180 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2181 if ( $privacy == 2) {
2182 $dbh->do(q|UPDATE old_issues SET borrowernumber=? WHERE issue_id = ?|, undef, $anonymouspatron, $old_checkout->issue_id);
2185 # And finally delete the issue
2188 ModItem( { 'onloan' => undef }, undef, $itemnumber );
2190 if ( C4::Context->preference('StoreLastBorrower') ) {
2191 my $item = Koha::Items->find( $itemnumber );
2192 my $patron = Koha::Patrons->find( $borrowernumber );
2193 $item->last_returned_by( $patron );
2200 =head2 _debar_user_on_return
2202 _debar_user_on_return($borrower, $item, $datedue, today);
2204 C<$borrower> borrower hashref
2206 C<$item> item hashref
2208 C<$datedue> date due DateTime object
2210 C<$return_date> DateTime object representing the return time
2212 Internal function, called only by AddReturn that calculates and updates
2213 the user fine days, and debars them if necessary.
2215 Should only be called for overdue returns
2219 sub _debar_user_on_return {
2220 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2222 my $branchcode = _GetCircControlBranch( $item, $borrower );
2224 my $circcontrol = C4::Context->preference('CircControl');
2225 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2226 { categorycode => $borrower->{categorycode},
2227 itemtype => $item->{itype},
2228 branchcode => $branchcode
2231 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2232 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2233 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2237 # finedays is in days, so hourly loans must multiply by 24
2238 # thus 1 hour late equals 1 day suspension * finedays rate
2239 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2241 # grace period is measured in the same units as the loan
2243 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2245 my $deltadays = DateTime::Duration->new(
2246 days => $chargeable_units
2248 if ( $deltadays->subtract($grace)->is_positive() ) {
2249 my $suspension_days = $deltadays * $finedays;
2251 # If the max suspension days is < than the suspension days
2252 # the suspension days is limited to this maximum period.
2253 my $max_sd = $issuing_rule->maxsuspensiondays;
2254 if ( defined $max_sd ) {
2255 $max_sd = DateTime::Duration->new( days => $max_sd );
2256 $suspension_days = $max_sd
2257 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2260 my ( $has_been_extended, $is_a_reminder );
2261 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2262 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2264 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2265 $has_been_extended = 1;
2270 $return_date->clone()->add_duration( $suspension_days );
2272 Koha::Patron::Debarments::AddUniqueDebarment({
2273 borrowernumber => $borrower->{borrowernumber},
2274 expiration => $new_debar_dt->ymd(),
2275 type => 'SUSPENSION',
2277 # if borrower was already debarred but does not get an extra debarment
2278 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2279 my $new_debarment_str;
2280 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2282 $new_debarment_str = $borrower->{debarred};
2284 $new_debarment_str = $new_debar_dt->ymd();
2286 # FIXME Should return a DateTime object
2287 return $new_debarment_str, $is_a_reminder;
2293 =head2 _FixOverduesOnReturn
2295 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2297 C<$brn> borrowernumber
2301 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2302 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2304 Internal function, called only by AddReturn
2308 sub _FixOverduesOnReturn {
2309 my ($borrowernumber, $item);
2310 unless ($borrowernumber = shift) {
2311 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2314 unless ($item = shift) {
2315 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2318 my ($exemptfine, $dropbox) = @_;
2319 my $dbh = C4::Context->dbh;
2321 # check for overdue fine
2322 my $sth = $dbh->prepare(
2323 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2325 $sth->execute( $borrowernumber, $item );
2327 # alter fine to show that the book has been returned
2328 my $data = $sth->fetchrow_hashref;
2329 return 0 unless $data; # no warning, there's just nothing to fix
2332 my @bind = ($data->{'accountlines_id'});
2334 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2335 if (C4::Context->preference("FinesLog")) {
2336 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2338 } elsif ($dropbox && $data->{lastincrement}) {
2339 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2340 my $amt = $data->{amount} - $data->{lastincrement} ;
2341 if (C4::Context->preference("FinesLog")) {
2342 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2344 $uquery = "update accountlines set accounttype='F' ";
2345 if($outstanding >= 0 && $amt >=0) {
2346 $uquery .= ", amount = ? , amountoutstanding=? ";
2347 unshift @bind, ($amt, $outstanding) ;
2350 $uquery = "update accountlines set accounttype='F' ";
2352 $uquery .= " where (accountlines_id = ?)";
2353 my $usth = $dbh->prepare($uquery);
2354 return $usth->execute(@bind);
2357 =head2 _FixAccountForLostAndReturned
2359 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2361 Calculates the charge for a book lost and returned.
2363 Internal function, not exported, called only by AddReturn.
2365 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2366 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2370 sub _FixAccountForLostAndReturned {
2371 my $itemnumber = shift or return;
2372 my $borrowernumber = @_ ? shift : undef;
2373 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2374 my $dbh = C4::Context->dbh;
2375 # check for charge made for lost book
2376 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2377 $sth->execute($itemnumber);
2378 my $data = $sth->fetchrow_hashref;
2379 $data or return; # bail if there is nothing to do
2380 $data->{accounttype} eq 'W' and return; # Written off
2382 # writeoff this amount
2384 my $amount = $data->{'amount'};
2385 my $acctno = $data->{'accountno'};
2386 my $amountleft; # Starts off undef/zero.
2387 if ($data->{'amountoutstanding'} == $amount) {
2388 $offset = $data->{'amount'};
2389 $amountleft = 0; # Hey, it's zero here, too.
2391 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2392 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2394 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2395 WHERE (accountlines_id = ?)");
2396 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2397 #check if any credit is left if so writeoff other accounts
2398 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2399 $amountleft *= -1 if ($amountleft < 0);
2400 if ($amountleft > 0) {
2401 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2402 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2403 $msth->execute($data->{'borrowernumber'});
2404 # offset transactions
2407 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2408 if ($accdata->{'amountoutstanding'} < $amountleft) {
2410 $amountleft -= $accdata->{'amountoutstanding'};
2412 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2415 my $thisacct = $accdata->{'accountlines_id'};
2416 # FIXME: move prepares outside while loop!
2417 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2418 WHERE (accountlines_id = ?)");
2419 $usth->execute($newamtos,$thisacct);
2420 $usth = $dbh->prepare("INSERT INTO accountoffsets
2421 (borrowernumber, accountno, offsetaccount, offsetamount)
2424 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2427 $amountleft *= -1 if ($amountleft > 0);
2428 my $desc = "Item Returned " . $item_id;
2429 $usth = $dbh->prepare("INSERT INTO accountlines
2430 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2431 VALUES (?,?,now(),?,?,'CR',?)");
2432 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2433 if ($borrowernumber) {
2434 # FIXME: same as query above. use 1 sth for both
2435 $usth = $dbh->prepare("INSERT INTO accountoffsets
2436 (borrowernumber, accountno, offsetaccount, offsetamount)
2438 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2440 ModItem({ paidfor => '' }, undef, $itemnumber);
2444 =head2 _GetCircControlBranch
2446 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2450 Return the library code to be used to determine which circulation
2451 policy applies to a transaction. Looks up the CircControl and
2452 HomeOrHoldingBranch system preferences.
2454 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2456 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2460 sub _GetCircControlBranch {
2461 my ($item, $borrower) = @_;
2462 my $circcontrol = C4::Context->preference('CircControl');
2465 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2466 $branch= C4::Context->userenv->{'branch'};
2467 } elsif ($circcontrol eq 'PatronLibrary') {
2468 $branch=$borrower->{branchcode};
2470 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2471 $branch = $item->{$branchfield};
2472 # default to item home branch if holdingbranch is used
2473 # and is not defined
2474 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2475 $branch = $item->{homebranch};
2483 $issue = GetOpenIssue( $itemnumber );
2485 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2487 C<$itemnumber> is the item's itemnumber
2494 my ( $itemnumber ) = @_;
2495 return unless $itemnumber;
2496 my $dbh = C4::Context->dbh;
2497 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2498 $sth->execute( $itemnumber );
2499 return $sth->fetchrow_hashref();
2503 =head2 GetBiblioIssues
2505 $issues = GetBiblioIssues($biblionumber);
2507 this function get all issues from a biblionumber.
2510 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2511 tables issues and the firstname,surname & cardnumber from borrowers.
2515 sub GetBiblioIssues {
2516 my $biblionumber = shift;
2517 return unless $biblionumber;
2518 my $dbh = C4::Context->dbh;
2520 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2522 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2523 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2524 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2525 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2526 WHERE biblio.biblionumber = ?
2528 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2530 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2531 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2532 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2533 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2534 WHERE biblio.biblionumber = ?
2537 my $sth = $dbh->prepare($query);
2538 $sth->execute($biblionumber, $biblionumber);
2541 while ( my $data = $sth->fetchrow_hashref ) {
2542 push @issues, $data;
2547 =head2 GetUpcomingDueIssues
2549 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2553 sub GetUpcomingDueIssues {
2556 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2557 my $dbh = C4::Context->dbh;
2559 my $statement = <<END_SQL;
2560 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2562 LEFT JOIN items USING (itemnumber)
2563 LEFT OUTER JOIN branches USING (branchcode)
2564 WHERE returndate is NULL
2565 HAVING days_until_due >= 0 AND days_until_due <= ?
2568 my @bind_parameters = ( $params->{'days_in_advance'} );
2570 my $sth = $dbh->prepare( $statement );
2571 $sth->execute( @bind_parameters );
2572 my $upcoming_dues = $sth->fetchall_arrayref({});
2574 return $upcoming_dues;
2577 =head2 CanBookBeRenewed
2579 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2581 Find out whether a borrowed item may be renewed.
2583 C<$borrowernumber> is the borrower number of the patron who currently
2584 has the item on loan.
2586 C<$itemnumber> is the number of the item to renew.
2588 C<$override_limit>, if supplied with a true value, causes
2589 the limit on the number of times that the loan can be renewed
2590 (as controlled by the item type) to be ignored. Overriding also allows
2591 to renew sooner than "No renewal before" and to manually renew loans
2592 that are automatically renewed.
2594 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2595 item must currently be on loan to the specified borrower; renewals
2596 must be allowed for the item's type; and the borrower must not have
2597 already renewed the loan. $error will contain the reason the renewal can not proceed
2601 sub CanBookBeRenewed {
2602 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2604 my $dbh = C4::Context->dbh;
2607 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2608 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return ( 0, 'no_checkout' );
2609 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2611 $borrowernumber ||= $issue->borrowernumber;
2612 my $patron = Koha::Patrons->find( $borrowernumber )
2615 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2617 # This item can fill one or more unfilled reserve, can those unfilled reserves
2618 # all be filled by other available items?
2620 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2622 my $schema = Koha::Database->new()->schema();
2624 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2626 # There is an item level hold on this item, no other item can fill the hold
2631 # Get all other items that could possibly fill reserves
2632 my @itemnumbers = $schema->resultset('Item')->search(
2634 biblionumber => $resrec->{biblionumber},
2637 -not => { itemnumber => $itemnumber }
2639 { columns => 'itemnumber' }
2640 )->get_column('itemnumber')->all();
2642 # Get all other reserves that could have been filled by this item
2643 my @borrowernumbers;
2645 my ( $reserve_found, $reserve, undef ) =
2646 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2648 if ($reserve_found) {
2649 push( @borrowernumbers, $reserve->{borrowernumber} );
2656 # If the count of the union of the lists of reservable items for each borrower
2657 # is equal or greater than the number of borrowers, we know that all reserves
2658 # can be filled with available items. We can get the union of the sets simply
2659 # by pushing all the elements onto an array and removing the duplicates.
2662 ITEM: foreach my $i (@itemnumbers) {
2663 my $item = GetItem($i);
2664 next if IsItemOnHoldAndFound($i);
2665 for my $b (@borrowernumbers) {
2666 my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2667 next unless IsAvailableForItemLevelRequest($item, $borr);
2668 next unless CanItemBeReserved($b,$i);
2670 push @reservable, $i;
2671 if (@reservable >= @borrowernumbers) {
2680 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2682 return ( 1, undef ) if $override_limit;
2684 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2685 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2686 { categorycode => $patron->categorycode,
2687 itemtype => $item->{itype},
2688 branchcode => $branchcode
2692 return ( 0, "too_many" )
2693 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2695 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2696 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2697 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2698 my $restricted = $patron->is_debarred;
2699 my $hasoverdues = $patron->has_overdues;
2701 if ( $restricted and $restrictionblockrenewing ) {
2702 return ( 0, 'restriction');
2703 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2704 return ( 0, 'overdue');
2707 if ( $issue->auto_renew ) {
2708 if ( defined $issuing_rule->no_auto_renewal_after
2709 and $issuing_rule->no_auto_renewal_after ne "" ) {
2710 # Get issue_date and add no_auto_renewal_after
2711 # If this is greater than today, it's too late for renewal.
2712 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2713 $maximum_renewal_date->add(
2714 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2716 my $now = dt_from_string;
2717 if ( $now >= $maximum_renewal_date ) {
2718 return ( 0, "auto_too_late" );
2721 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2722 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2723 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2724 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2725 return ( 0, "auto_too_late" );
2729 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2730 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2731 my ( $amountoutstanding ) = C4::Members::GetMemberAccountRecords($patron->borrowernumber);
2732 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2733 return ( 0, "auto_too_much_oweing" );
2738 if ( defined $issuing_rule->norenewalbefore
2739 and $issuing_rule->norenewalbefore ne "" )
2742 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2743 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2744 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2746 # Depending on syspref reset the exact time, only check the date
2747 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2748 and $issuing_rule->lengthunit eq 'days' )
2750 $soonestrenewal->truncate( to => 'day' );
2753 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2755 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2756 return ( 0, "too_soon" );
2758 elsif ( $issue->auto_renew ) {
2759 return ( 0, "auto_renew" );
2763 # Fallback for automatic renewals:
2764 # If norenewalbefore is undef, don't renew before due date.
2765 if ( $issue->auto_renew ) {
2766 my $now = dt_from_string;
2767 return ( 0, "auto_renew" )
2768 if $now >= dt_from_string( $issue->date_due, 'sql' );
2769 return ( 0, "auto_too_soon" );
2772 return ( 1, undef );
2777 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2781 C<$borrowernumber> is the borrower number of the patron who currently
2784 C<$itemnumber> is the number of the item to renew.
2786 C<$branch> is the library where the renewal took place (if any).
2787 The library that controls the circ policies for the renewal is retrieved from the issues record.
2789 C<$datedue> can be a DateTime object used to set the due date.
2791 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2792 this parameter is not supplied, lastreneweddate is set to the current date.
2794 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2795 from the book's item type.
2800 my $borrowernumber = shift;
2801 my $itemnumber = shift or return;
2803 my $datedue = shift;
2804 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2806 my $item = GetItem($itemnumber) or return;
2807 my $item_object = Koha::Items->find( $itemnumber ); # Should replace $item
2808 my $biblio = $item_object->biblio;
2810 my $dbh = C4::Context->dbh;
2812 # Find the issues record for this book
2813 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
2815 return unless $issue;
2817 $borrowernumber ||= $issue->borrowernumber;
2819 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2820 carp 'Invalid date passed to AddRenewal.';
2824 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2825 my $patron_unblessed = $patron->unblessed;
2827 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2828 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed } );
2830 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2832 # If the due date wasn't specified, calculate it by adding the
2833 # book's loan length to today's date or the current due date
2834 # based on the value of the RenewalPeriodBase syspref.
2837 my $itemtype = $item_object->effective_itemtype;
2838 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2839 dt_from_string( $issue->date_due, 'sql' ) :
2840 DateTime->now( time_zone => C4::Context->tz());
2841 $datedue = CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $patron_unblessed), $patron_unblessed, 'is a renewal');
2844 # Update the issues record to have the new due date, and a new count
2845 # of how many times it has been renewed.
2846 my $renews = $issue->renewals + 1;
2847 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2848 WHERE borrowernumber=?
2852 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2854 # Update the renewal count on the item, and tell zebra to reindex
2855 $renews = $item->{renewals} + 1;
2856 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item->{biblionumber}, $itemnumber);
2858 # Charge a new rental fee, if applicable?
2859 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2860 if ( $charge > 0 ) {
2861 my $accountno = getnextacctno( $borrowernumber );
2863 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2864 $sth = $dbh->prepare(
2865 "INSERT INTO accountlines
2866 (date, borrowernumber, accountno, amount, manager_id,
2867 description,accounttype, amountoutstanding, itemnumber)
2868 VALUES (now(),?,?,?,?,?,?,?,?)"
2870 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2871 "Renewal of Rental Item " . $biblio->title . " $item->{'barcode'}",
2872 'Rent', $charge, $itemnumber );
2875 # Send a renewal slip according to checkout alert preferencei
2876 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2877 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2879 branchcode => $branch,
2880 categorycode => $patron->categorycode,
2881 item_type => $item->{itype},
2882 notification => 'CHECKOUT',
2884 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2885 SendCirculationAlert(
2889 borrower => $patron->unblessed,
2896 # Remove any OVERDUES related debarment if the borrower has no overdues
2898 && $patron->is_debarred
2899 && ! $patron->has_overdues
2900 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2902 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2905 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2906 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2909 # Add the renewal to stats
2915 itemnumber => $itemnumber,
2916 itemtype => $item->{itype},
2917 borrowernumber => $borrowernumber,
2918 ccode => $item->{'ccode'}
2923 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2928 # check renewal status
2929 my ( $bornum, $itemno ) = @_;
2930 my $dbh = C4::Context->dbh;
2932 my $renewsallowed = 0;
2935 my $patron = Koha::Patrons->find( $bornum );
2936 my $item = GetItem($itemno);
2938 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2940 # Look in the issues table for this item, lent to this borrower,
2941 # and not yet returned.
2943 # FIXME - I think this function could be redone to use only one SQL call.
2944 my $sth = $dbh->prepare(
2945 "select * from issues
2946 where (borrowernumber = ?)
2947 and (itemnumber = ?)"
2949 $sth->execute( $bornum, $itemno );
2950 my $data = $sth->fetchrow_hashref;
2951 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2952 # $item and $borrower should be calculated
2953 my $branchcode = _GetCircControlBranch($item, $patron->unblessed);
2955 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2956 { categorycode => $patron->categorycode,
2957 itemtype => $item->{itype},
2958 branchcode => $branchcode
2962 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
2963 $renewsleft = $renewsallowed - $renewcount;
2964 if($renewsleft < 0){ $renewsleft = 0; }
2965 return ( $renewcount, $renewsallowed, $renewsleft );
2968 =head2 GetSoonestRenewDate
2970 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2972 Find out the soonest possible renew date of a borrowed item.
2974 C<$borrowernumber> is the borrower number of the patron who currently
2975 has the item on loan.
2977 C<$itemnumber> is the number of the item to renew.
2979 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2980 renew date, based on the value "No renewal before" of the applicable
2981 issuing rule. Returns the current date if the item can already be
2982 renewed, and returns undefined if the borrower, loan, or item
2987 sub GetSoonestRenewDate {
2988 my ( $borrowernumber, $itemnumber ) = @_;
2990 my $dbh = C4::Context->dbh;
2992 my $item = GetItem($itemnumber) or return;
2993 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2995 $borrowernumber ||= $itemissue->borrowernumber;
2996 my $patron = Koha::Patrons->find( $borrowernumber )
2999 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3000 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3001 { categorycode => $patron->categorycode,
3002 itemtype => $item->{itype},
3003 branchcode => $branchcode
3007 my $now = dt_from_string;
3008 return $now unless $issuing_rule;
3010 if ( defined $issuing_rule->norenewalbefore
3011 and $issuing_rule->norenewalbefore ne "" )
3013 my $soonestrenewal =
3014 dt_from_string( $itemissue->date_due )->subtract(
3015 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3017 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3018 and $issuing_rule->lengthunit eq 'days' )
3020 $soonestrenewal->truncate( to => 'day' );
3022 return $soonestrenewal if $now < $soonestrenewal;
3027 =head2 GetLatestAutoRenewDate
3029 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3031 Find out the latest possible auto renew date of a borrowed item.
3033 C<$borrowernumber> is the borrower number of the patron who currently
3034 has the item on loan.
3036 C<$itemnumber> is the number of the item to renew.
3038 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3039 auto renew date, based on the value "No auto renewal after" and the "No auto
3040 renewal after (hard limit) of the applicable issuing rule.
3041 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3042 or item cannot be found.
3046 sub GetLatestAutoRenewDate {
3047 my ( $borrowernumber, $itemnumber ) = @_;
3049 my $dbh = C4::Context->dbh;
3051 my $item = GetItem($itemnumber) or return;
3052 my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3054 $borrowernumber ||= $itemissue->borrowernumber;
3055 my $patron = Koha::Patrons->find( $borrowernumber )
3058 my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3059 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3060 { categorycode => $patron->categorycode,
3061 itemtype => $item->{itype},
3062 branchcode => $branchcode
3066 return unless $issuing_rule;
3068 if ( not $issuing_rule->no_auto_renewal_after
3069 or $issuing_rule->no_auto_renewal_after eq '' )
3070 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3071 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3073 my $maximum_renewal_date;
3074 if ( $issuing_rule->no_auto_renewal_after ) {
3075 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3076 $maximum_renewal_date->add(
3077 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3081 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3082 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3083 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3085 return $maximum_renewal_date;
3089 =head2 GetIssuingCharges
3091 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3093 Calculate how much it would cost for a given patron to borrow a given
3094 item, including any applicable discounts.
3096 C<$itemnumber> is the item number of item the patron wishes to borrow.
3098 C<$borrowernumber> is the patron's borrower number.
3100 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3101 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3106 sub GetIssuingCharges {
3108 # calculate charges due
3109 my ( $itemnumber, $borrowernumber ) = @_;
3111 my $dbh = C4::Context->dbh;
3114 # Get the book's item type and rental charge (via its biblioitem).
3115 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3116 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3117 $charge_query .= (C4::Context->preference('item-level_itypes'))
3118 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3119 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3121 $charge_query .= ' WHERE items.itemnumber =?';
3123 my $sth = $dbh->prepare($charge_query);
3124 $sth->execute($itemnumber);
3125 if ( my $item_data = $sth->fetchrow_hashref ) {
3126 $item_type = $item_data->{itemtype};
3127 $charge = $item_data->{rentalcharge};
3128 my $branch = C4::Context::mybranch();
3129 my $discount_query = q|SELECT rentaldiscount,
3130 issuingrules.itemtype, issuingrules.branchcode
3132 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3133 WHERE borrowers.borrowernumber = ?
3134 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3135 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3136 my $discount_sth = $dbh->prepare($discount_query);
3137 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3138 my $discount_rules = $discount_sth->fetchall_arrayref({});
3139 if (@{$discount_rules}) {
3140 # We may have multiple rules so get the most specific
3141 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3142 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3145 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3149 return ( $charge, $item_type );
3152 # Select most appropriate discount rule from those returned
3153 sub _get_discount_from_rule {
3154 my ($rules_ref, $branch, $itemtype) = @_;
3157 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3158 $discount = $rules_ref->[0]->{rentaldiscount};
3159 return (defined $discount) ? $discount : 0;
3161 # could have up to 4 does one match $branch and $itemtype
3162 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3164 $discount = $d[0]->{rentaldiscount};
3165 return (defined $discount) ? $discount : 0;
3167 # do we have item type + all branches
3168 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3170 $discount = $d[0]->{rentaldiscount};
3171 return (defined $discount) ? $discount : 0;
3173 # do we all item types + this branch
3174 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3176 $discount = $d[0]->{rentaldiscount};
3177 return (defined $discount) ? $discount : 0;
3179 # so all and all (surely we wont get here)
3180 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3182 $discount = $d[0]->{rentaldiscount};
3183 return (defined $discount) ? $discount : 0;
3189 =head2 AddIssuingCharge
3191 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3195 sub AddIssuingCharge {
3196 my ( $itemnumber, $borrowernumber, $charge ) = @_;
3197 my $dbh = C4::Context->dbh;
3198 my $nextaccntno = getnextacctno( $borrowernumber );
3200 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3202 INSERT INTO accountlines
3203 (borrowernumber, itemnumber, accountno,
3204 date, amount, description, accounttype,
3205 amountoutstanding, manager_id)
3206 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3208 my $sth = $dbh->prepare($query);
3209 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3214 GetTransfers($itemnumber);
3219 my ($itemnumber) = @_;
3221 my $dbh = C4::Context->dbh;
3228 FROM branchtransfers
3229 WHERE itemnumber = ?
3230 AND datearrived IS NULL
3232 my $sth = $dbh->prepare($query);
3233 $sth->execute($itemnumber);
3234 my @row = $sth->fetchrow_array();
3238 =head2 GetTransfersFromTo
3240 @results = GetTransfersFromTo($frombranch,$tobranch);
3242 Returns the list of pending transfers between $from and $to branch
3246 sub GetTransfersFromTo {
3247 my ( $frombranch, $tobranch ) = @_;
3248 return unless ( $frombranch && $tobranch );
3249 my $dbh = C4::Context->dbh;
3251 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3252 FROM branchtransfers
3255 AND datearrived IS NULL
3257 my $sth = $dbh->prepare($query);
3258 $sth->execute( $frombranch, $tobranch );
3261 while ( my $data = $sth->fetchrow_hashref ) {
3262 push @gettransfers, $data;
3264 return (@gettransfers);
3267 =head2 DeleteTransfer
3269 &DeleteTransfer($itemnumber);
3273 sub DeleteTransfer {
3274 my ($itemnumber) = @_;
3275 return unless $itemnumber;
3276 my $dbh = C4::Context->dbh;
3277 my $sth = $dbh->prepare(
3278 "DELETE FROM branchtransfers
3280 AND datearrived IS NULL "
3282 return $sth->execute($itemnumber);
3285 =head2 SendCirculationAlert
3287 Send out a C<check-in> or C<checkout> alert using the messaging system.
3295 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3299 Hashref of information about the item being checked in or out.
3303 Hashref of information about the borrower of the item.
3307 The branchcode from where the checkout or check-in took place.
3313 SendCirculationAlert({
3316 borrower => $borrower,
3322 sub SendCirculationAlert {
3324 my ($type, $item, $borrower, $branch) =
3325 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3326 my %message_name = (
3327 CHECKIN => 'Item_Check_in',
3328 CHECKOUT => 'Item_Checkout',
3329 RENEWAL => 'Item_Checkout',
3331 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3332 borrowernumber => $borrower->{borrowernumber},
3333 message_name => $message_name{$type},
3335 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3337 my $schema = Koha::Database->new->schema;
3338 my @transports = keys %{ $borrower_preferences->{transports} };
3340 # From the MySQL doc:
3341 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3342 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3343 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3344 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3346 for my $mtt (@transports) {
3347 my $letter = C4::Letters::GetPreparedLetter (
3348 module => 'circulation',
3349 letter_code => $type,
3350 branchcode => $branch,
3351 message_transport_type => $mtt,
3352 lang => $borrower->{lang},
3354 $issues_table => $item->{itemnumber},
3355 'items' => $item->{itemnumber},
3356 'biblio' => $item->{biblionumber},
3357 'biblioitems' => $item->{biblionumber},
3358 'borrowers' => $borrower,
3359 'branches' => $branch,
3363 $schema->storage->txn_begin;
3364 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3365 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3366 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3367 unless ( $message ) {
3368 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3369 C4::Message->enqueue($letter, $borrower, $mtt);
3371 $message->append($letter);
3374 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3375 $schema->storage->txn_commit;
3381 =head2 updateWrongTransfer
3383 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3385 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
3389 sub updateWrongTransfer {
3390 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3391 my $dbh = C4::Context->dbh;
3392 # first step validate the actual line of transfert .
3395 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3397 $sth->execute($FromLibrary,$itemNumber);
3399 # second step create a new line of branchtransfer to the right location .
3400 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3402 #third step changing holdingbranch of item
3403 UpdateHoldingbranch($FromLibrary,$itemNumber);
3406 =head2 UpdateHoldingbranch
3408 $items = UpdateHoldingbranch($branch,$itmenumber);
3410 Simple methode for updating hodlingbranch in items BDD line
3414 sub UpdateHoldingbranch {
3415 my ( $branch,$itemnumber ) = @_;
3416 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3421 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3423 this function calculates the due date given the start date and configured circulation rules,
3424 checking against the holidays calendar as per the 'useDaysMode' syspref.
3425 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3426 C<$itemtype> = itemtype code of item in question
3427 C<$branch> = location whose calendar to use
3428 C<$borrower> = Borrower object
3429 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3434 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3438 # loanlength now a href
3440 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3442 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3448 if (ref $startdate ne 'DateTime' ) {
3449 $datedue = dt_from_string($datedue);
3451 $datedue = $startdate->clone;
3455 DateTime->now( time_zone => C4::Context->tz() )
3456 ->truncate( to => 'minute' );
3460 # calculate the datedue as normal
3461 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3462 { # ignoring calendar
3463 if ( $loanlength->{lengthunit} eq 'hours' ) {
3464 $datedue->add( hours => $loanlength->{$length_key} );
3466 $datedue->add( days => $loanlength->{$length_key} );
3467 $datedue->set_hour(23);
3468 $datedue->set_minute(59);
3472 if ($loanlength->{lengthunit} eq 'hours') {
3473 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3476 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3478 my $calendar = Koha::Calendar->new( branchcode => $branch );
3479 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3480 if ($loanlength->{lengthunit} eq 'days') {
3481 $datedue->set_hour(23);
3482 $datedue->set_minute(59);
3486 # if Hard Due Dates are used, retrieve them and apply as necessary
3487 my ( $hardduedate, $hardduedatecompare ) =
3488 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3489 if ($hardduedate) { # hardduedates are currently dates
3490 $hardduedate->truncate( to => 'minute' );
3491 $hardduedate->set_hour(23);
3492 $hardduedate->set_minute(59);
3493 my $cmp = DateTime->compare( $hardduedate, $datedue );
3495 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3496 # if the calculated date is before the 'after' Hard Due Date (floor), override
3497 # if the hard due date is set to 'exactly', overrride
3498 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3499 $datedue = $hardduedate->clone;
3502 # in all other cases, keep the date due as it is
3506 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3507 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3508 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3509 if( $expiry_dt ) { #skip empty expiry date..
3510 $expiry_dt->set( hour => 23, minute => 59);
3511 my $d1= $datedue->clone->set_time_zone('floating');
3512 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3513 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3516 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3517 # Don't return on a closed day
3518 my $calendar = Koha::Calendar->new( branchcode => $branch );
3519 $datedue = $calendar->prev_open_day( $datedue );
3527 sub CheckValidBarcode{
3529 my $dbh = C4::Context->dbh;
3530 my $query=qq|SELECT count(*)
3534 my $sth = $dbh->prepare($query);
3535 $sth->execute($barcode);
3536 my $exist=$sth->fetchrow ;
3540 =head2 IsBranchTransferAllowed
3542 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3544 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3548 sub IsBranchTransferAllowed {
3549 my ( $toBranch, $fromBranch, $code ) = @_;
3551 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3553 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3554 my $dbh = C4::Context->dbh;
3556 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3557 $sth->execute( $toBranch, $fromBranch, $code );
3558 my $limit = $sth->fetchrow_hashref();
3560 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3561 if ( $limit->{'limitId'} ) {
3568 =head2 CreateBranchTransferLimit
3570 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3572 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3576 sub CreateBranchTransferLimit {
3577 my ( $toBranch, $fromBranch, $code ) = @_;
3578 return unless defined($toBranch) && defined($fromBranch);
3579 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3581 my $dbh = C4::Context->dbh;
3583 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3584 return $sth->execute( $code, $toBranch, $fromBranch );
3587 =head2 DeleteBranchTransferLimits
3589 my $result = DeleteBranchTransferLimits($frombranch);
3591 Deletes all the library transfer limits for one library. Returns the
3592 number of limits deleted, 0e0 if no limits were deleted, or undef if
3593 no arguments are supplied.
3597 sub DeleteBranchTransferLimits {
3599 return unless defined $branch;
3600 my $dbh = C4::Context->dbh;
3601 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3602 return $sth->execute($branch);
3606 my ( $borrowernumber, $itemnum ) = @_;
3608 MarkIssueReturned( $borrowernumber, $itemnum );
3609 my $patron = Koha::Patrons->find( $borrowernumber );
3610 my $item = C4::Items::GetItem( $itemnum );
3611 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3612 my @datearr = localtime(time);
3613 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3614 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3615 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3620 my ($itemnumber, $mark_returned) = @_;
3622 my $dbh = C4::Context->dbh();
3623 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3625 JOIN items USING (itemnumber)
3626 JOIN biblio USING (biblionumber)
3627 WHERE issues.itemnumber=?");
3628 $sth->execute($itemnumber);
3629 my $issues=$sth->fetchrow_hashref();
3631 # If a borrower lost the item, add a replacement cost to the their record
3632 if ( my $borrowernumber = $issues->{borrowernumber} ){
3633 my $patron = Koha::Patrons->find( $borrowernumber );
3635 if (C4::Context->preference('WhenLostForgiveFine')){
3636 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3637 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3639 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3640 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3641 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3642 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3645 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$patron->privacy) if $mark_returned;
3649 sub GetOfflineOperations {
3650 my $dbh = C4::Context->dbh;
3651 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3652 $sth->execute(C4::Context->userenv->{'branch'});
3653 my $results = $sth->fetchall_arrayref({});
3657 sub GetOfflineOperation {
3658 my $operationid = shift;
3659 return unless $operationid;
3660 my $dbh = C4::Context->dbh;
3661 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3662 $sth->execute( $operationid );
3663 return $sth->fetchrow_hashref;
3666 sub AddOfflineOperation {
3667 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3668 my $dbh = C4::Context->dbh;
3669 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3670 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3674 sub DeleteOfflineOperation {
3675 my $dbh = C4::Context->dbh;
3676 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3677 $sth->execute( shift );
3681 sub ProcessOfflineOperation {
3682 my $operation = shift;
3685 if ( $operation->{action} eq 'return' ) {
3686 $report = ProcessOfflineReturn( $operation );
3687 } elsif ( $operation->{action} eq 'issue' ) {
3688 $report = ProcessOfflineIssue( $operation );
3689 } elsif ( $operation->{action} eq 'payment' ) {
3690 $report = ProcessOfflinePayment( $operation );
3693 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3698 sub ProcessOfflineReturn {
3699 my $operation = shift;
3701 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3704 my $itemnumber = $item->itemnumber;
3705 my $issue = GetOpenIssue( $itemnumber );
3708 $issue->{borrowernumber},
3711 $operation->{timestamp},
3714 { renewals => 0, onloan => undef },
3715 $issue->{'biblionumber'},
3720 return "Item not issued.";
3723 return "Item not found.";
3727 sub ProcessOfflineIssue {
3728 my $operation = shift;
3730 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3733 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3735 return "Barcode not found.";
3737 my $itemnumber = $item->itemnumber;
3738 my $issue = GetOpenIssue( $itemnumber );
3740 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3742 $issue->{borrowernumber},
3745 $operation->{timestamp},
3750 $operation->{'barcode'},
3753 $operation->{timestamp},
3758 return "Borrower not found.";
3762 sub ProcessOfflinePayment {
3763 my $operation = shift;
3765 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} });
3766 my $amount = $operation->{amount};
3768 Koha::Account->new( { patron_id => $patron->id } )->pay( { amount => $amount } );
3776 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3778 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3783 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3785 my $item = GetItem( $itemnumber, $barcode )
3788 return C4::Letters::GetPreparedLetter (
3789 module => 'circulation',
3790 letter_code => 'TRANSFERSLIP',
3791 branchcode => $branch,
3793 'branches' => $to_branch,
3794 'biblio' => $item->{biblionumber},
3800 =head2 CheckIfIssuedToPatron
3802 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3804 Return 1 if any record item is issued to patron, otherwise return 0
3808 sub CheckIfIssuedToPatron {
3809 my ($borrowernumber, $biblionumber) = @_;
3811 my $dbh = C4::Context->dbh;
3813 SELECT COUNT(*) FROM issues
3814 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3815 WHERE items.biblionumber = ?
3816 AND issues.borrowernumber = ?
3818 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3819 return 1 if $is_issued;
3825 IsItemIssued( $itemnumber )
3827 Return 1 if the item is on loan, otherwise return 0
3832 my $itemnumber = shift;
3833 my $dbh = C4::Context->dbh;
3834 my $sth = $dbh->prepare(q{
3837 WHERE itemnumber = ?
3839 $sth->execute($itemnumber);
3840 return $sth->fetchrow;
3843 =head2 GetAgeRestriction
3845 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3846 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3848 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3849 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3851 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3852 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3853 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3854 Negative days mean the borrower has gone past the age restriction age.
3858 sub GetAgeRestriction {
3859 my ($record_restrictions, $borrower) = @_;
3860 my $markers = C4::Context->preference('AgeRestrictionMarker');
3862 # Split $record_restrictions to something like FSK 16 or PEGI 6
3863 my @values = split ' ', uc($record_restrictions);
3864 return unless @values;
3866 # Search first occurrence of one of the markers
3867 my @markers = split /\|/, uc($markers);
3868 return unless @markers;
3871 my $restriction_year = 0;
3872 for my $value (@values) {
3874 for my $marker (@markers) {
3875 $marker =~ s/^\s+//; #remove leading spaces
3876 $marker =~ s/\s+$//; #remove trailing spaces
3877 if ( $marker eq $value ) {
3878 if ( $index <= $#values ) {
3879 $restriction_year += $values[$index];
3883 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3885 # Perhaps it is something like "K16" (as in Finland)
3886 $restriction_year += $1;
3890 last if ( $restriction_year > 0 );
3893 #Check if the borrower is age restricted for this material and for how long.
3894 if ($restriction_year && $borrower) {
3895 if ( $borrower->{'dateofbirth'} ) {
3896 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3897 $alloweddate[0] += $restriction_year;
3899 #Prevent runime eror on leap year (invalid date)
3900 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3901 $alloweddate[2] = 28;
3904 #Get how many days the borrower has to reach the age restriction
3905 my @Today = split /-/, DateTime->today->ymd();
3906 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3907 #Negative days means the borrower went past the age restriction age
3908 return ($restriction_year, $daysToAgeRestriction);
3912 return ($restriction_year);
3916 =head2 GetPendingOnSiteCheckouts
3920 sub GetPendingOnSiteCheckouts {
3921 my $dbh = C4::Context->dbh;
3922 return $dbh->selectall_arrayref(q|
3928 items.itemcallnumber,
3932 issues.date_due < NOW() AS is_overdue,
3935 borrowers.firstname,
3937 borrowers.cardnumber,
3938 borrowers.borrowernumber
3940 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
3941 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
3942 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
3943 WHERE issues.onsite_checkout = 1
3944 |, { Slice => {} } );
3950 my ($count, $branch, $itemtype, $ccode, $newness)
3951 = @$params{qw(count branch itemtype ccode newness)};
3953 my $dbh = C4::Context->dbh;
3955 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
3956 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
3957 i.ccode, SUM(i.issues) AS count
3959 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
3960 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
3963 my (@where_strs, @where_args);
3966 push @where_strs, 'i.homebranch = ?';
3967 push @where_args, $branch;
3970 if (C4::Context->preference('item-level_itypes')){
3971 push @where_strs, 'i.itype = ?';
3972 push @where_args, $itemtype;
3974 push @where_strs, 'bi.itemtype = ?';
3975 push @where_args, $itemtype;
3979 push @where_strs, 'i.ccode = ?';
3980 push @where_args, $ccode;
3983 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
3984 push @where_args, $newness;
3988 $query .= 'WHERE ' . join(' AND ', @where_strs);
3992 GROUP BY b.biblionumber
3997 $count = int($count);
3999 $query .= "LIMIT $count";
4002 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4007 sub _CalculateAndUpdateFine {
4010 my $borrower = $params->{borrower};
4011 my $item = $params->{item};
4012 my $issue = $params->{issue};
4013 my $return_date = $params->{return_date};
4015 unless ($borrower) { carp "No borrower passed in!" && return; }
4016 unless ($item) { carp "No item passed in!" && return; }
4017 unless ($issue) { carp "No issue passed in!" && return; }
4019 my $datedue = dt_from_string( $issue->date_due );
4021 # we only need to calculate and change the fines if we want to do that on return
4022 # Should be on for hourly loans
4023 my $control = C4::Context->preference('CircControl');
4024 my $control_branchcode =
4025 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4026 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4027 : $issue->branchcode;
4029 my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4031 my ( $amount, $type, $unitcounttotal ) =
4032 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4036 if ( C4::Context->preference('finesMode') eq 'production' ) {
4037 if ( $amount > 0 ) {
4038 C4::Overdues::UpdateFine({
4039 issue_id => $issue->issue_id,
4040 itemnumber => $issue->itemnumber,
4041 borrowernumber => $issue->borrowernumber,
4044 due => output_pref($datedue),
4047 elsif ($return_date) {
4049 # Backdated returns may have fines that shouldn't exist,
4050 # so in this case, we need to drop those fines to 0
4052 C4::Overdues::UpdateFine({
4053 issue_id => $issue->issue_id,
4054 itemnumber => $issue->itemnumber,
4055 borrowernumber => $issue->borrowernumber,
4058 due => output_pref($datedue),
4070 Koha Development Team <http://koha-community.org/>