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;
46 use Koha::IssuingRules;
49 use Koha::Patron::Debarments;
53 use Koha::RefundLostItemFeeRule;
54 use Koha::RefundLostItemFeeRules;
56 use List::MoreUtils qw( uniq );
57 use Scalar::Util qw( looks_like_number );
67 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
73 # FIXME subs that should probably be elsewhere
78 &GetPendingOnSiteCheckouts
81 # subs to deal with issuing a book
89 &GetLatestAutoRenewDate
93 &GetBranchBorrowerCircRule
97 &AnonymiseIssueHistory
98 &CheckIfIssuedToPatron
103 # subs to deal with returns
109 # subs to deal with transfers
116 &IsBranchTransferAllowed
117 &CreateBranchTransferLimit
118 &DeleteBranchTransferLimits
122 # subs to deal with offline circulation
124 &GetOfflineOperations
127 &DeleteOfflineOperation
128 &ProcessOfflineOperation
134 C4::Circulation - Koha circulation module
142 The functions in this module deal with circulation, issues, and
143 returns, as well as general information about the library.
144 Also deals with inventory.
150 $str = &barcodedecode($barcode, [$filter]);
152 Generic filter function for barcode string.
153 Called on every circ if the System Pref itemBarcodeInputFilter is set.
154 Will do some manipulation of the barcode for systems that deliver a barcode
155 to circulation.pl that differs from the barcode stored for the item.
156 For proper functioning of this filter, calling the function on the
157 correct barcode string (items.barcode) should return an unaltered barcode.
159 The optional $filter argument is to allow for testing or explicit
160 behavior that ignores the System Pref. Valid values are the same as the
165 # FIXME -- the &decode fcn below should be wrapped into this one.
166 # FIXME -- these plugins should be moved out of Circulation.pm
169 my ($barcode, $filter) = @_;
170 my $branch = C4::Context::mybranch();
171 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
172 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
173 if ($filter eq 'whitespace') {
175 } elsif ($filter eq 'cuecat') {
177 my @fields = split( /\./, $barcode );
178 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
179 ($#results == 2) and return $results[2];
180 } elsif ($filter eq 'T-prefix') {
181 if ($barcode =~ /^[Tt](\d)/) {
182 (defined($1) and $1 eq '0') and return $barcode;
183 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
185 return sprintf("T%07d", $barcode);
186 # FIXME: $barcode could be "T1", causing warning: substr outside of string
187 # Why drop the nonzero digit after the T?
188 # Why pass non-digits (or empty string) to "T%07d"?
189 } elsif ($filter eq 'libsuite8') {
190 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
191 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
192 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
194 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
197 } elsif ($filter eq 'EAN13') {
198 my $ean = CheckDigits('ean');
199 if ( $ean->is_valid($barcode) ) {
200 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
201 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
203 warn "# [$barcode] not valid EAN-13/UPC-A\n";
206 return $barcode; # return barcode, modified or not
211 $str = &decode($chunk);
213 Decodes a segment of a string emitted by a CueCat barcode scanner and
216 FIXME: Should be replaced with Barcode::Cuecat from CPAN
217 or Javascript based decoding on the client side.
224 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
225 my @s = map { index( $seq, $_ ); } split( //, $encoded );
226 my $l = ( $#s + 1 ) % 4;
229 # warn "Error: Cuecat decode parsing failed!";
237 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
239 chr( ( $n >> 16 ) ^ 67 )
240 .chr( ( $n >> 8 & 255 ) ^ 67 )
241 .chr( ( $n & 255 ) ^ 67 );
244 $r = substr( $r, 0, length($r) - $l );
250 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
251 $barcode, $ignore_reserves);
253 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
255 C<$newbranch> is the code for the branch to which the item should be transferred.
257 C<$barcode> is the barcode of the item to be transferred.
259 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
260 Otherwise, if an item is reserved, the transfer fails.
262 Returns three values:
268 is true if the transfer was successful.
272 is a reference-to-hash which may have any of the following keys:
278 There is no item in the catalog with the given barcode. The value is C<$barcode>.
282 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.
284 =item C<DestinationEqualsHolding>
286 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
290 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
294 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
296 =item C<WasTransferred>
298 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
307 my ( $tbr, $barcode, $ignoreRs ) = @_;
310 my $itemnumber = GetItemnumberFromBarcode( $barcode );
311 my $issue = GetItemIssue($itemnumber);
312 my $biblio = GetBiblioFromItemNumber($itemnumber);
315 if ( not $itemnumber ) {
316 $messages->{'BadBarcode'} = $barcode;
320 # get branches of book...
321 my $hbr = $biblio->{'homebranch'};
322 my $fbr = $biblio->{'holdingbranch'};
324 # if using Branch Transfer Limits
325 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
326 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
327 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
328 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
331 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
332 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
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...
353 if ($issue->{borrowernumber}) {
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, $biblio );
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 # OK, the patron can issue !!!
562 =head2 CanBookBeIssued
564 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
565 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
567 Check if a book can be issued.
569 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
573 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
575 =item C<$barcode> is the bar code of the book being issued.
577 =item C<$duedates> is a DateTime object.
579 =item C<$inprocess> boolean switch
581 =item C<$ignore_reserves> boolean switch
583 =item C<$params> Hashref of additional parameters
586 override_high_holds - Ignore high holds
587 onsite_checkout - Checkout is an onsite checkout that will not leave the library
595 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
596 Possible values are :
602 sticky due date is invalid
606 borrower gone with no address
610 borrower declared it's card lost
616 =head3 UNKNOWN_BARCODE
630 item is restricted (set by ??)
632 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
633 could be prevented, but ones that can be overriden by the operator.
635 Possible values are :
643 renewing, not issuing
645 =head3 ISSUED_TO_ANOTHER
647 issued to someone else.
651 reserved for someone else.
655 sticky due date is invalid or due date in the past
659 if the borrower borrows to much things
663 sub CanBookBeIssued {
664 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
665 my %needsconfirmation; # filled with problems that needs confirmations
666 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
667 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
668 my %messages; # filled with information messages that should be displayed.
670 my $onsite_checkout = $params->{onsite_checkout} || 0;
671 my $override_high_holds = $params->{override_high_holds} || 0;
673 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
674 my $issue = GetItemIssue($item->{itemnumber});
675 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
676 $item->{'itemtype'}=$item->{'itype'};
677 my $dbh = C4::Context->dbh;
679 # MANDATORY CHECKS - unless item exists, nothing else matters
680 unless ( $item->{barcode} ) {
681 $issuingimpossible{UNKNOWN_BARCODE} = 1;
683 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
686 # DUE DATE is OK ? -- should already have checked.
688 if ($duedate && ref $duedate ne 'DateTime') {
689 $duedate = dt_from_string($duedate);
691 my $now = DateTime->now( time_zone => C4::Context->tz() );
692 unless ( $duedate ) {
693 my $issuedate = $now->clone();
695 my $branch = _GetCircControlBranch($item,$borrower);
696 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
697 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
699 # Offline circ calls AddIssue directly, doesn't run through here
700 # So issuingimpossible should be ok.
703 my $today = $now->clone();
704 $today->truncate( to => 'minute');
705 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
706 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
709 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
715 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
716 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
718 branch => C4::Context->userenv->{'branch'},
720 itemnumber => $item->{'itemnumber'},
721 itemtype => $item->{'itype'},
722 borrowernumber => $borrower->{'borrowernumber'},
723 ccode => $item->{'ccode'}}
725 ModDateLastSeen( $item->{'itemnumber'} );
726 return( { STATS => 1 }, {});
728 if ( ref $borrower->{flags} ) {
729 if ( $borrower->{flags}->{GNA} ) {
730 $issuingimpossible{GNA} = 1;
732 if ( $borrower->{flags}->{'LOST'} ) {
733 $issuingimpossible{CARD_LOST} = 1;
735 if ( $borrower->{flags}->{'DBARRED'} ) {
736 $issuingimpossible{DEBARRED} = 1;
739 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
740 $issuingimpossible{EXPIRED} = 1;
742 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'sql', 'floating' );
743 $expiry_dt->truncate( to => 'day');
744 my $today = $now->clone()->truncate(to => 'day');
745 $today->set_time_zone( 'floating' );
746 if ( DateTime->compare($today, $expiry_dt) == 1 ) {
747 $issuingimpossible{EXPIRED} = 1;
756 my ($balance, $non_issue_charges, $other_charges) =
757 C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
759 my $amountlimit = C4::Context->preference("noissuescharge");
760 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
761 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
763 # Check the debt of this patrons guarantees
764 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
765 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
766 if ( defined $no_issues_charge_guarantees ) {
767 my $p = Koha::Patrons->find( $borrower->{borrowernumber} );
768 my @guarantees = $p->guarantees();
769 my $guarantees_non_issues_charges;
770 foreach my $g ( @guarantees ) {
771 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
772 $guarantees_non_issues_charges += $n;
775 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
776 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
777 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
778 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
779 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
780 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
784 if ( C4::Context->preference("IssuingInProcess") ) {
785 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
786 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
787 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
788 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
789 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
790 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
794 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
795 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
796 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
797 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
798 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
799 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
803 if ($balance > 0 && $other_charges > 0) {
804 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
807 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
808 if ( my $debarred_date = $patron->is_debarred ) {
809 # patron has accrued fine days or has a restriction. $count is a date
810 if ($debarred_date eq '9999-12-31') {
811 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
814 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
816 } elsif ( my $num_overdues = $patron->has_overdues ) {
817 ## patron has outstanding overdue loans
818 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
819 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
821 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
822 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
826 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
828 my $switch_onsite_checkout =
829 C4::Context->preference('SwitchOnSiteCheckouts')
830 and $issue->{onsite_checkout}
832 and $issue->{borrowernumber} == $borrower->{'borrowernumber'} ? 1 : 0;
833 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
834 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
836 if ( $toomany->{max_allowed} == 0 ) {
837 $needsconfirmation{PATRON_CANT} = 1;
839 if ( C4::Context->preference("AllowTooManyOverride") ) {
840 $needsconfirmation{TOO_MANY} = $toomany->{reason};
841 $needsconfirmation{current_loan_count} = $toomany->{count};
842 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
844 $issuingimpossible{TOO_MANY} = $toomany->{reason};
845 $issuingimpossible{current_loan_count} = $toomany->{count};
846 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
851 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
853 $patron = Koha::Patrons->find($borrower->{borrowernumber});
854 my $wants_check = $patron->wants_check_for_previous_checkout;
855 $needsconfirmation{PREVISSUE} = 1
856 if ($wants_check and $patron->do_check_for_previous_checkout($item));
861 if ( $item->{'notforloan'} )
863 if(!C4::Context->preference("AllowNotForLoanOverride")){
864 $issuingimpossible{NOT_FOR_LOAN} = 1;
865 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
867 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
868 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
872 # we have to check itemtypes.notforloan also
873 if (C4::Context->preference('item-level_itypes')){
874 # this should probably be a subroutine
875 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
876 $sth->execute($item->{'itemtype'});
877 my $notforloan=$sth->fetchrow_hashref();
878 if ($notforloan->{'notforloan'}) {
879 if (!C4::Context->preference("AllowNotForLoanOverride")) {
880 $issuingimpossible{NOT_FOR_LOAN} = 1;
881 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
883 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
884 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
888 elsif ($biblioitem->{'notforloan'} == 1){
889 if (!C4::Context->preference("AllowNotForLoanOverride")) {
890 $issuingimpossible{NOT_FOR_LOAN} = 1;
891 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
893 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
894 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
898 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
900 $issuingimpossible{WTHDRAWN} = 1;
902 if ( $item->{'restricted'}
903 && $item->{'restricted'} == 1 )
905 $issuingimpossible{RESTRICTED} = 1;
907 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
908 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->{itemlost} });
909 my $code = $av->count ? $av->next->lib : '';
910 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
911 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
913 if ( C4::Context->preference("IndependentBranches") ) {
914 my $userenv = C4::Context->userenv;
915 unless ( C4::Context->IsSuperLibrarian() ) {
916 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
917 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
918 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
920 $needsconfirmation{BORRNOTSAMEBRANCH} = $borrower->{'branchcode'}
921 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
925 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
927 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
929 if ( $rentalConfirmation ){
930 my ($rentalCharge) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
931 if ( $rentalCharge > 0 ){
932 $rentalCharge = sprintf("%.02f", $rentalCharge);
933 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
938 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
940 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} ){
942 # Already issued to current borrower.
943 # If it is an on-site checkout if it can be switched to a normal checkout
944 # or ask whether the loan should be renewed
946 if ( $issue->{onsite_checkout}
947 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
948 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
950 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
951 $borrower->{'borrowernumber'},
952 $item->{'itemnumber'},
954 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
955 if ( $renewerror eq 'onsite_checkout' ) {
956 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
959 $issuingimpossible{NO_MORE_RENEWALS} = 1;
963 $needsconfirmation{RENEW_ISSUE} = 1;
967 elsif ($issue->{borrowernumber}) {
969 # issued to someone else
970 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
973 my ( $can_be_returned, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
975 unless ( $can_be_returned ) {
976 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
977 $issuingimpossible{branch_to_return} = $message;
979 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
980 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
981 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
982 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
983 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
987 unless ( $ignore_reserves ) {
988 # See if the item is on reserve.
989 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
991 my $resbor = $res->{'borrowernumber'};
992 if ( $resbor ne $borrower->{'borrowernumber'} ) {
993 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
994 if ( $restype eq "Waiting" )
996 # The item is on reserve and waiting, but has been
997 # reserved by some other patron.
998 $needsconfirmation{RESERVE_WAITING} = 1;
999 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1000 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1001 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1002 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1003 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1004 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1006 elsif ( $restype eq "Reserved" ) {
1007 # The item is on reserve for someone else.
1008 $needsconfirmation{RESERVED} = 1;
1009 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1010 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1011 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1012 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1013 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1014 $needsconfirmation{'resreservedate'} = $res->{'reservedate'};
1020 ## CHECK AGE RESTRICTION
1021 my $agerestriction = $biblioitem->{'agerestriction'};
1022 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $borrower );
1023 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1024 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1025 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1028 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1032 ## check for high holds decreasing loan period
1033 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1034 my $check = checkHighHolds( $item, $borrower );
1036 if ( $check->{exceeded} ) {
1037 if ($override_high_holds) {
1038 $alerts{HIGHHOLDS} = {
1039 num_holds => $check->{outstanding},
1040 duration => $check->{duration},
1041 returndate => output_pref( $check->{due_date} ),
1045 $needsconfirmation{HIGHHOLDS} = {
1046 num_holds => $check->{outstanding},
1047 duration => $check->{duration},
1048 returndate => output_pref( $check->{due_date} ),
1055 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1056 # don't do the multiple loans per bib check if we've
1057 # already determined that we've got a loan on the same item
1058 !$issuingimpossible{NO_MORE_RENEWALS} &&
1059 !$needsconfirmation{RENEW_ISSUE}
1061 # Check if borrower has already issued an item from the same biblio
1062 # Only if it's not a subscription
1063 my $biblionumber = $item->{biblionumber};
1064 require C4::Serials;
1065 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1066 unless ($is_a_subscription) {
1067 my $issues = GetIssues( {
1068 borrowernumber => $borrower->{borrowernumber},
1069 biblionumber => $biblionumber,
1071 my @issues = $issues ? @$issues : ();
1072 # if we get here, we don't already have a loan on this item,
1073 # so if there are any loans on this bib, ask for confirmation
1074 if (scalar @issues > 0) {
1075 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1080 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1083 =head2 CanBookBeReturned
1085 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1087 Check whether the item can be returned to the provided branch
1091 =item C<$item> is a hash of item information as returned from GetItem
1093 =item C<$branch> is the branchcode where the return is taking place
1101 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1103 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1109 sub CanBookBeReturned {
1110 my ($item, $branch) = @_;
1111 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1113 # assume return is allowed to start
1117 # identify all cases where return is forbidden
1118 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1120 $message = $item->{'homebranch'};
1121 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1123 $message = $item->{'holdingbranch'};
1124 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1126 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1129 return ($allowed, $message);
1132 =head2 CheckHighHolds
1134 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1135 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1136 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1140 sub checkHighHolds {
1141 my ( $item, $borrower ) = @_;
1142 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1143 my $branch = _GetCircControlBranch( $item, $borrower );
1152 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1154 if ( $holds->count() ) {
1155 $return_data->{outstanding} = $holds->count();
1157 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1158 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1159 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1161 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1163 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1165 # static means just more than a given number of holds on the record
1167 # If the number of holds is less than the threshold, we can stop here
1168 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1169 return $return_data;
1172 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1174 # dynamic means X more than the number of holdable items on the record
1176 # let's get the items
1177 my @items = $holds->next()->biblio()->items();
1179 # Remove any items with status defined to be ignored even if the would not make item unholdable
1180 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1181 @items = grep { !$_->$status } @items;
1184 # Remove any items that are not holdable for this patron
1185 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber ) eq 'OK' } @items;
1187 my $items_count = scalar @items;
1189 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1191 # If the number of holds is less than the count of items we have
1192 # plus the number of holds allowed above that count, we can stop here
1193 if ( $holds->count() <= $threshold ) {
1194 return $return_data;
1198 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1200 my $calendar = Koha::Calendar->new( branchcode => $branch );
1203 ( C4::Context->preference('item-level_itypes') )
1204 ? $biblio->{'itype'}
1205 : $biblio->{'itemtype'};
1207 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1209 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1211 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1213 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1214 $return_data->{exceeded} = 1;
1215 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1216 $return_data->{due_date} = $reduced_datedue;
1220 return $return_data;
1225 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1227 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1231 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1233 =item C<$barcode> is the barcode of the item being issued.
1235 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1236 Calculated if empty.
1238 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1240 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1241 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1243 AddIssue does the following things :
1245 - step 01: check that there is a borrowernumber & a barcode provided
1246 - check for RENEWAL (book issued & being issued to the same patron)
1247 - renewal YES = Calculate Charge & renew
1249 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1251 - fill reserve if reserve to this patron
1252 - cancel reserve or not, otherwise
1253 * TRANSFERT PENDING ?
1254 - complete the transfert
1262 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1264 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1265 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1266 my $auto_renew = $params && $params->{auto_renew};
1267 my $dbh = C4::Context->dbh;
1268 my $barcodecheck = CheckValidBarcode($barcode);
1272 if ( $datedue && ref $datedue ne 'DateTime' ) {
1273 $datedue = dt_from_string($datedue);
1276 # $issuedate defaults to today.
1277 if ( !defined $issuedate ) {
1278 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1281 if ( ref $issuedate ne 'DateTime' ) {
1282 $issuedate = dt_from_string($issuedate);
1287 # Stop here if the patron or barcode doesn't exist
1288 if ( $borrower && $barcode && $barcodecheck ) {
1289 # find which item we issue
1290 my $item = GetItem( '', $barcode )
1291 or return; # if we don't get an Item, abort.
1293 my $branch = _GetCircControlBranch( $item, $borrower );
1295 # get actual issuing if there is one
1296 my $actualissue = GetItemIssue( $item->{itemnumber} );
1298 # get biblioinformation for this item
1299 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1301 # check if we just renew the issue.
1302 if ( $actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}
1303 and not $switch_onsite_checkout ) {
1304 $datedue = AddRenewal(
1305 $borrower->{'borrowernumber'},
1306 $item->{'itemnumber'},
1309 $issuedate, # here interpreted as the renewal date
1313 # it's NOT a renewal
1314 if ( $actualissue->{borrowernumber}
1315 and not $switch_onsite_checkout ) {
1316 # This book is currently on loan, but not to the person
1317 # who wants to borrow it now. mark it returned before issuing to the new borrower
1318 my ( $allowed, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
1319 return unless $allowed;
1320 AddReturn( $item->{'barcode'}, C4::Context->userenv->{'branch'} );
1323 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1325 # Starting process for transfer job (checking transfert and validate it if we have one)
1326 my ($datesent) = GetTransfers( $item->{'itemnumber'} );
1328 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1329 my $sth = $dbh->prepare(
1330 "UPDATE branchtransfers
1331 SET datearrived = now(),
1333 comments = 'Forced branchtransfer'
1334 WHERE itemnumber= ? AND datearrived IS NULL"
1336 $sth->execute( C4::Context->userenv->{'branch'},
1337 $item->{'itemnumber'} );
1340 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1341 unless ($auto_renew) {
1342 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1343 { categorycode => $borrower->{categorycode},
1344 itemtype => $item->{itype},
1345 branchcode => $branch
1349 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1352 # Record in the database the fact that the book was issued.
1355 ( C4::Context->preference('item-level_itypes') )
1356 ? $biblio->{'itype'}
1357 : $biblio->{'itemtype'};
1358 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1361 $datedue->truncate( to => 'minute' );
1363 $issue = Koha::Database->new()->schema()->resultset('Issue')->update_or_create(
1365 borrowernumber => $borrower->{'borrowernumber'},
1366 itemnumber => $item->{'itemnumber'},
1367 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1368 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1369 branchcode => C4::Context->userenv->{'branch'},
1370 onsite_checkout => $onsite_checkout,
1371 auto_renew => $auto_renew ? 1 : 0
1375 if ( C4::Context->preference('ReturnToShelvingCart') ) {
1376 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1377 CartToShelf( $item->{'itemnumber'} );
1379 $item->{'issues'}++;
1380 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1381 UpdateTotalIssues( $item->{'biblionumber'}, 1 );
1384 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1385 if ( $item->{'itemlost'} ) {
1387 Koha::RefundLostItemFeeRules->should_refund(
1389 current_branch => C4::Context->userenv->{branch},
1390 item_home_branch => $item->{homebranch},
1391 item_holding_branch => $item->{holdingbranch}
1396 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef,
1397 $item->{'barcode'} );
1403 issues => $item->{'issues'},
1404 holdingbranch => C4::Context->userenv->{'branch'},
1406 onloan => $datedue->ymd(),
1407 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1409 $item->{'biblionumber'},
1410 $item->{'itemnumber'}
1412 ModDateLastSeen( $item->{'itemnumber'} );
1414 # If it costs to borrow this book, charge it to the patron's account.
1415 my ( $charge, $itemtype ) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1416 if ( $charge > 0 ) {
1417 AddIssuingCharge( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $charge );
1418 $item->{'charge'} = $charge;
1421 # Record the fact that this book was issued.
1424 branch => C4::Context->userenv->{'branch'},
1425 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1427 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1428 itemnumber => $item->{'itemnumber'},
1429 itemtype => $item->{'itype'},
1430 borrowernumber => $borrower->{'borrowernumber'},
1431 ccode => $item->{'ccode'}
1435 # Send a checkout slip.
1436 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1438 branchcode => $branch,
1439 categorycode => $borrower->{categorycode},
1440 item_type => $item->{itype},
1441 notification => 'CHECKOUT',
1443 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1444 SendCirculationAlert(
1448 borrower => $borrower,
1456 "CIRCULATION", "ISSUE",
1457 $borrower->{'borrowernumber'},
1458 $biblio->{'itemnumber'}
1459 ) if C4::Context->preference("IssueLog");
1464 =head2 GetLoanLength
1466 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1468 Get loan length for an itemtype, a borrower type and a branch
1473 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1474 my $dbh = C4::Context->dbh;
1475 my $sth = $dbh->prepare(qq{
1476 SELECT issuelength, lengthunit, renewalperiod
1478 WHERE categorycode=?
1481 AND issuelength IS NOT NULL
1484 # try to find issuelength & return the 1st available.
1485 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1486 $sth->execute( $borrowertype, $itemtype, $branchcode );
1487 my $loanlength = $sth->fetchrow_hashref;
1490 if defined($loanlength) && defined $loanlength->{issuelength};
1492 $sth->execute( $borrowertype, '*', $branchcode );
1493 $loanlength = $sth->fetchrow_hashref;
1495 if defined($loanlength) && defined $loanlength->{issuelength};
1497 $sth->execute( '*', $itemtype, $branchcode );
1498 $loanlength = $sth->fetchrow_hashref;
1500 if defined($loanlength) && defined $loanlength->{issuelength};
1502 $sth->execute( '*', '*', $branchcode );
1503 $loanlength = $sth->fetchrow_hashref;
1505 if defined($loanlength) && defined $loanlength->{issuelength};
1507 $sth->execute( $borrowertype, $itemtype, '*' );
1508 $loanlength = $sth->fetchrow_hashref;
1510 if defined($loanlength) && defined $loanlength->{issuelength};
1512 $sth->execute( $borrowertype, '*', '*' );
1513 $loanlength = $sth->fetchrow_hashref;
1515 if defined($loanlength) && defined $loanlength->{issuelength};
1517 $sth->execute( '*', $itemtype, '*' );
1518 $loanlength = $sth->fetchrow_hashref;
1520 if defined($loanlength) && defined $loanlength->{issuelength};
1522 $sth->execute( '*', '*', '*' );
1523 $loanlength = $sth->fetchrow_hashref;
1525 if defined($loanlength) && defined $loanlength->{issuelength};
1527 # if no rule is set => 0 day (hardcoded)
1531 lengthunit => 'days',
1537 =head2 GetHardDueDate
1539 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1541 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1545 sub GetHardDueDate {
1546 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1548 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1549 { categorycode => $borrowertype,
1550 itemtype => $itemtype,
1551 branchcode => $branchcode
1556 if ( defined( $issuing_rule ) ) {
1557 if ( $issuing_rule->hardduedate ) {
1558 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1560 return (undef, undef);
1565 =head2 GetBranchBorrowerCircRule
1567 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1569 Retrieves circulation rule attributes that apply to the given
1570 branch and patron category, regardless of item type.
1571 The return value is a hashref containing the following key:
1573 maxissueqty - maximum number of loans that a
1574 patron of the given category can have at the given
1575 branch. If the value is undef, no limit.
1577 maxonsiteissueqty - maximum of on-site checkouts that a
1578 patron of the given category can have at the given
1579 branch. If the value is undef, no limit.
1581 This will first check for a specific branch and
1582 category match from branch_borrower_circ_rules.
1584 If no rule is found, it will then check default_branch_circ_rules
1585 (same branch, default category). If no rule is found,
1586 it will then check default_borrower_circ_rules (default
1587 branch, same category), then failing that, default_circ_rules
1588 (default branch, default category).
1590 If no rule has been found in the database, it will default to
1594 maxonsiteissueqty - undef
1596 C<$branchcode> and C<$categorycode> should contain the
1597 literal branch code and patron category code, respectively - no
1602 sub GetBranchBorrowerCircRule {
1603 my ( $branchcode, $categorycode ) = @_;
1606 my $dbh = C4::Context->dbh();
1607 $rules = $dbh->selectrow_hashref( q|
1608 SELECT maxissueqty, maxonsiteissueqty
1609 FROM branch_borrower_circ_rules
1610 WHERE branchcode = ?
1611 AND categorycode = ?
1612 |, {}, $branchcode, $categorycode ) ;
1613 return $rules if $rules;
1615 # try same branch, default borrower category
1616 $rules = $dbh->selectrow_hashref( q|
1617 SELECT maxissueqty, maxonsiteissueqty
1618 FROM default_branch_circ_rules
1619 WHERE branchcode = ?
1620 |, {}, $branchcode ) ;
1621 return $rules if $rules;
1623 # try default branch, same borrower category
1624 $rules = $dbh->selectrow_hashref( q|
1625 SELECT maxissueqty, maxonsiteissueqty
1626 FROM default_borrower_circ_rules
1627 WHERE categorycode = ?
1628 |, {}, $categorycode ) ;
1629 return $rules if $rules;
1631 # try default branch, default borrower category
1632 $rules = $dbh->selectrow_hashref( q|
1633 SELECT maxissueqty, maxonsiteissueqty
1634 FROM default_circ_rules
1636 return $rules if $rules;
1638 # built-in default circulation rule
1640 maxissueqty => undef,
1641 maxonsiteissueqty => undef,
1645 =head2 GetBranchItemRule
1647 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1649 Retrieves circulation rule attributes that apply to the given
1650 branch and item type, regardless of patron category.
1652 The return value is a hashref containing the following keys:
1654 holdallowed => Hold policy for this branch and itemtype. Possible values:
1655 0: No holds allowed.
1656 1: Holds allowed only by patrons that have the same homebranch as the item.
1657 2: Holds allowed from any patron.
1659 returnbranch => branch to which to return item. Possible values:
1660 noreturn: do not return, let item remain where checked in (floating collections)
1661 homebranch: return to item's home branch
1662 holdingbranch: return to issuer branch
1664 This searches branchitemrules in the following order:
1666 * Same branchcode and itemtype
1667 * Same branchcode, itemtype '*'
1668 * branchcode '*', same itemtype
1669 * branchcode and itemtype '*'
1671 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1675 sub GetBranchItemRule {
1676 my ( $branchcode, $itemtype ) = @_;
1677 my $dbh = C4::Context->dbh();
1681 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1682 FROM branch_item_rules
1683 WHERE branchcode = ?
1684 AND itemtype = ?', $branchcode, $itemtype],
1685 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1686 FROM default_branch_circ_rules
1687 WHERE branchcode = ?', $branchcode],
1688 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1689 FROM default_branch_item_rules
1690 WHERE itemtype = ?', $itemtype],
1691 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1692 FROM default_circ_rules'],
1695 foreach my $attempt (@attempts) {
1696 my ($query, @bind_params) = @{$attempt};
1697 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1700 # Since branch/category and branch/itemtype use the same per-branch
1701 # defaults tables, we have to check that the key we want is set, not
1702 # just that a row was returned
1703 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1704 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1705 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1708 # built-in default circulation rule
1709 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1710 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1711 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1718 ($doreturn, $messages, $iteminformation, $borrower) =
1719 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1725 =item C<$barcode> is the bar code of the book being returned.
1727 =item C<$branch> is the code of the branch where the book is being returned.
1729 =item C<$exemptfine> indicates that overdue charges for the item will be
1732 =item C<$dropbox> indicates that the check-in date is assumed to be
1733 yesterday, or the last non-holiday as defined in C4::Calendar . If
1734 overdue charges are applied and C<$dropbox> is true, the last charge
1735 will be removed. This assumes that the fines accrual script has run
1736 for _today_. Optional.
1738 =item C<$return_date> allows the default return date to be overridden
1739 by the given return date. Optional.
1743 C<&AddReturn> returns a list of four items:
1745 C<$doreturn> is true iff the return succeeded.
1747 C<$messages> is a reference-to-hash giving feedback on the operation.
1748 The keys of the hash are:
1754 No item with this barcode exists. The value is C<$barcode>.
1758 The book is not currently on loan. The value is C<$barcode>.
1760 =item C<IsPermanent>
1762 The book's home branch is a permanent collection. If you have borrowed
1763 this book, you are not allowed to return it. The value is the code for
1764 the book's home branch.
1768 This book has been withdrawn/cancelled. The value should be ignored.
1770 =item C<Wrongbranch>
1772 This book has was returned to the wrong branch. The value is a hashref
1773 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1774 contain the branchcode of the incorrect and correct return library, respectively.
1778 The item was reserved. The value is a reference-to-hash whose keys are
1779 fields from the reserves table of the Koha database, and
1780 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1781 either C<Waiting>, C<Reserved>, or 0.
1783 =item C<WasReturned>
1785 Value 1 if return is successful.
1787 =item C<NeedsTransfer>
1789 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1793 C<$iteminformation> is a reference-to-hash, giving information about the
1794 returned item from the issues table.
1796 C<$borrower> is a reference-to-hash, giving information about the
1797 patron who last borrowed the book.
1802 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1804 if ($branch and not Koha::Libraries->find($branch)) {
1805 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1808 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1812 my $validTransfert = 0;
1813 my $stat_type = 'return';
1815 # get information on item
1816 my $item = GetItem( undef, $barcode );
1818 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1821 my $itemnumber = $item->{ itemnumber };
1823 my $item_level_itypes = C4::Context->preference("item-level_itypes");
1824 my $biblio = $item_level_itypes ? undef : GetBiblioData( $item->{ biblionumber } ); # don't get bib data unless we need it
1825 my $itemtype = $item_level_itypes ? $item->{itype} : $biblio->{itemtype};
1827 my $issue = GetItemIssue($itemnumber);
1828 if ($issue and $issue->{borrowernumber}) {
1829 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1830 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '$issue->{borrowernumber}'\n"
1831 . Dumper($issue) . "\n";
1833 $messages->{'NotIssued'} = $barcode;
1834 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1836 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1837 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1838 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1839 $messages->{'LocalUse'} = 1;
1840 $stat_type = 'localuse';
1844 if ( $item->{'location'} eq 'PROC' ) {
1845 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1846 $item->{'location'} = 'CART';
1849 $item->{location} = $item->{permanent_location};
1852 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
1855 # full item data, but no borrowernumber or checkout info (no issue)
1856 # we know GetItem should work because GetItemnumberFromBarcode worked
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 = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1864 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1866 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1868 eval { $rules = YAML::Load($yaml); };
1870 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1873 foreach my $key ( keys %$rules ) {
1874 if ( $item->{notforloan} eq $key ) {
1875 $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1876 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1884 # check if the book is in a permanent collection....
1885 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1886 if ( $returnbranch ) {
1887 my $library = Koha::Libraries->find($returnbranch);
1888 if ( $library and $library->get_categories->search({'me.categorycode' => 'PE'})->count ) {
1889 $messages->{'IsPermanent'} = $returnbranch;
1893 # check if the return is allowed at this branch
1894 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1895 unless ($returnallowed){
1896 $messages->{'Wrongbranch'} = {
1897 Wrongbranch => $branch,
1898 Rightbranch => $message
1901 return ( $doreturn, $messages, $issue, $borrower );
1904 if ( $item->{'withdrawn'} ) { # book has been cancelled
1905 $messages->{'withdrawn'} = 1;
1906 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1909 # case of a return of document (deal with issues and holdingbranch)
1910 my $today = DateTime->now( time_zone => C4::Context->tz() );
1913 my $datedue = $issue->{date_due};
1914 $borrower or warn "AddReturn without current borrower";
1915 my $circControlBranch;
1917 # define circControlBranch only if dropbox mode is set
1918 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1919 # FIXME: check issuedate > returndate, factoring in holidays
1921 $circControlBranch = _GetCircControlBranch($item,$borrower);
1922 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $dropboxdate ) == -1 ? 1 : 0;
1925 if ($borrowernumber) {
1926 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'} ) || $return_date ) {
1927 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $borrower, return_date => $return_date } );
1931 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1932 $circControlBranch, $return_date, $borrower->{'privacy'} );
1935 $messages->{'Wrongbranch'} = {
1936 Wrongbranch => $branch,
1937 Rightbranch => $message
1940 return ( 0, { WasReturned => 0 }, $issue, $borrower );
1943 # FIXME is the "= 1" right? This could be the borrower hash.
1944 $messages->{'WasReturned'} = 1;
1948 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1951 # the holdingbranch is updated if the document is returned to another location.
1952 # this is always done regardless of whether the item was on loan or not
1953 my $item_holding_branch = $item->{ holdingbranch };
1954 if ($item->{'holdingbranch'} ne $branch) {
1955 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1956 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1958 ModDateLastSeen( $item->{'itemnumber'} );
1960 # check if we have a transfer for this document
1961 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1963 # if we have a transfer to do, we update the line of transfers with the datearrived
1964 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1966 if ( $tobranch eq $branch ) {
1967 my $sth = C4::Context->dbh->prepare(
1968 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1970 $sth->execute( $item->{'itemnumber'} );
1971 # if we have a reservation with valid transfer, we can set it's status to 'W'
1972 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1973 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1975 $messages->{'WrongTransfer'} = $tobranch;
1976 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1978 $validTransfert = 1;
1980 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1983 # fix up the accounts.....
1984 if ( $item->{'itemlost'} ) {
1985 $messages->{'WasLost'} = 1;
1987 if ( $item->{'itemlost'} ) {
1989 Koha::RefundLostItemFeeRules->should_refund(
1991 current_branch => C4::Context->userenv->{branch},
1992 item_home_branch => $item->{homebranch},
1993 item_holding_branch => $item_holding_branch
1998 _FixAccountForLostAndReturned( $item->{'itemnumber'}, $borrowernumber, $barcode );
1999 $messages->{'LostItemFeeRefunded'} = 1;
2004 # fix up the overdues in accounts...
2005 if ($borrowernumber) {
2006 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
2007 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
2009 if ( $issue->{overdue} && $issue->{date_due} ) {
2011 $today = $dropboxdate if $dropbox;
2012 my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
2014 $messages->{'PrevDebarred'} = $debardate;
2016 $messages->{'Debarred'} = $debardate if $debardate;
2018 # there's no overdue on the item but borrower had been previously debarred
2019 } elsif ( $issue->{date_due} and $borrower->{'debarred'} ) {
2020 if ( $borrower->{debarred} eq "9999-12-31") {
2021 $messages->{'ForeverDebarred'} = $borrower->{'debarred'};
2023 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2024 $borrower_debar_dt->truncate(to => 'day');
2025 my $today_dt = $today->clone()->truncate(to => 'day');
2026 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2027 $messages->{'PrevDebarred'} = $borrower->{'debarred'};
2033 # find reserves.....
2034 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2035 my ($resfound, $resrec);
2036 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2037 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2039 $resrec->{'ResFound'} = $resfound;
2040 $messages->{'ResFound'} = $resrec;
2043 # Record the fact that this book was returned.
2047 itemnumber => $itemnumber,
2048 itemtype => $itemtype,
2049 borrowernumber => $borrowernumber,
2050 ccode => $item->{ ccode }
2053 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
2054 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2056 branchcode => $branch,
2057 categorycode => $borrower->{categorycode},
2058 item_type => $item->{itype},
2059 notification => 'CHECKIN',
2061 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2062 SendCirculationAlert({
2065 borrower => $borrower,
2070 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2071 if C4::Context->preference("ReturnLog");
2073 # Remove any OVERDUES related debarment if the borrower has no overdues
2074 if ( $borrowernumber
2075 && $borrower->{'debarred'}
2076 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2077 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2078 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2080 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2083 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2084 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2085 if (C4::Context->preference("AutomaticItemReturn" ) or
2086 (C4::Context->preference("UseBranchTransferLimits") and
2087 ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2089 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2090 $debug and warn "item: " . Dumper($item);
2091 ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2092 $messages->{'WasTransfered'} = 1;
2094 $messages->{'NeedsTransfer'} = $returnbranch;
2098 return ( $doreturn, $messages, $issue, $borrower );
2101 =head2 MarkIssueReturned
2103 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2105 Unconditionally marks an issue as being returned by
2106 moving the C<issues> row to C<old_issues> and
2107 setting C<returndate> to the current date, or
2108 the last non-holiday date of the branccode specified in
2109 C<dropbox_branch> . Assumes you've already checked that
2110 it's safe to do this, i.e. last non-holiday > issuedate.
2112 if C<$returndate> is specified (in iso format), it is used as the date
2113 of the return. It is ignored when a dropbox_branch is passed in.
2115 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2116 the old_issue is immediately anonymised
2118 Ideally, this function would be internal to C<C4::Circulation>,
2119 not exported, but it is currently needed by one
2120 routine in C<C4::Accounts>.
2124 sub MarkIssueReturned {
2125 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2127 my $anonymouspatron;
2128 if ( $privacy == 2 ) {
2129 # The default of 0 will not work due to foreign key constraints
2130 # The anonymisation will fail if AnonymousPatron is not a valid entry
2131 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2132 # Note that a warning should appear on the about page (System information tab).
2133 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2134 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."
2135 unless C4::Members::GetMember( borrowernumber => $anonymouspatron );
2137 my $dbh = C4::Context->dbh;
2138 my $query = 'UPDATE issues SET returndate=';
2140 if ($dropbox_branch) {
2141 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2142 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2144 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2145 } elsif ($returndate) {
2147 push @bind, $returndate;
2149 $query .= ' now() ';
2151 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
2152 push @bind, $borrowernumber, $itemnumber;
2154 my $sth_upd = $dbh->prepare($query);
2155 $sth_upd->execute(@bind);
2156 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
2157 WHERE borrowernumber = ?
2158 AND itemnumber = ?');
2159 $sth_copy->execute($borrowernumber, $itemnumber);
2160 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2161 if ( $privacy == 2) {
2162 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
2163 WHERE borrowernumber = ?
2164 AND itemnumber = ?");
2165 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2167 my $sth_del = $dbh->prepare("DELETE FROM issues
2168 WHERE borrowernumber = ?
2169 AND itemnumber = ?");
2170 $sth_del->execute($borrowernumber, $itemnumber);
2172 ModItem( { 'onloan' => undef }, undef, $itemnumber );
2174 if ( C4::Context->preference('StoreLastBorrower') ) {
2175 my $item = Koha::Items->find( $itemnumber );
2176 my $patron = Koha::Patrons->find( $borrowernumber );
2177 $item->last_returned_by( $patron );
2181 =head2 _debar_user_on_return
2183 _debar_user_on_return($borrower, $item, $datedue, today);
2185 C<$borrower> borrower hashref
2187 C<$item> item hashref
2189 C<$datedue> date due DateTime object
2191 C<$today> DateTime object representing the return time
2193 Internal function, called only by AddReturn that calculates and updates
2194 the user fine days, and debars him if necessary.
2196 Should only be called for overdue returns
2200 sub _debar_user_on_return {
2201 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2203 my $branchcode = _GetCircControlBranch( $item, $borrower );
2205 my $circcontrol = C4::Context->preference('CircControl');
2206 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2207 { categorycode => $borrower->{categorycode},
2208 itemtype => $item->{itype},
2209 branchcode => $branchcode
2212 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2213 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2214 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $dt_today, $branchcode);
2218 # finedays is in days, so hourly loans must multiply by 24
2219 # thus 1 hour late equals 1 day suspension * finedays rate
2220 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2222 # grace period is measured in the same units as the loan
2224 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2226 my $deltadays = DateTime::Duration->new(
2227 days => $chargeable_units
2229 if ( $deltadays->subtract($grace)->is_positive() ) {
2230 my $suspension_days = $deltadays * $finedays;
2232 # If the max suspension days is < than the suspension days
2233 # the suspension days is limited to this maximum period.
2234 my $max_sd = $issuing_rule->maxsuspensiondays;
2235 if ( defined $max_sd ) {
2236 $max_sd = DateTime::Duration->new( days => $max_sd );
2237 $suspension_days = $max_sd
2238 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2242 $dt_today->clone()->add_duration( $suspension_days );
2244 Koha::Patron::Debarments::AddUniqueDebarment({
2245 borrowernumber => $borrower->{borrowernumber},
2246 expiration => $new_debar_dt->ymd(),
2247 type => 'SUSPENSION',
2249 # if borrower was already debarred but does not get an extra debarment
2250 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2251 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2252 return ($borrower->{debarred},1);
2254 return $new_debar_dt->ymd();
2260 =head2 _FixOverduesOnReturn
2262 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2264 C<$brn> borrowernumber
2268 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2269 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2271 Internal function, called only by AddReturn
2275 sub _FixOverduesOnReturn {
2276 my ($borrowernumber, $item);
2277 unless ($borrowernumber = shift) {
2278 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2281 unless ($item = shift) {
2282 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2285 my ($exemptfine, $dropbox) = @_;
2286 my $dbh = C4::Context->dbh;
2288 # check for overdue fine
2289 my $sth = $dbh->prepare(
2290 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2292 $sth->execute( $borrowernumber, $item );
2294 # alter fine to show that the book has been returned
2295 my $data = $sth->fetchrow_hashref;
2296 return 0 unless $data; # no warning, there's just nothing to fix
2299 my @bind = ($data->{'accountlines_id'});
2301 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2302 if (C4::Context->preference("FinesLog")) {
2303 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2305 } elsif ($dropbox && $data->{lastincrement}) {
2306 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2307 my $amt = $data->{amount} - $data->{lastincrement} ;
2308 if (C4::Context->preference("FinesLog")) {
2309 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2311 $uquery = "update accountlines set accounttype='F' ";
2312 if($outstanding >= 0 && $amt >=0) {
2313 $uquery .= ", amount = ? , amountoutstanding=? ";
2314 unshift @bind, ($amt, $outstanding) ;
2317 $uquery = "update accountlines set accounttype='F' ";
2319 $uquery .= " where (accountlines_id = ?)";
2320 my $usth = $dbh->prepare($uquery);
2321 return $usth->execute(@bind);
2324 =head2 _FixAccountForLostAndReturned
2326 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2328 Calculates the charge for a book lost and returned.
2330 Internal function, not exported, called only by AddReturn.
2332 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2333 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2337 sub _FixAccountForLostAndReturned {
2338 my $itemnumber = shift or return;
2339 my $borrowernumber = @_ ? shift : undef;
2340 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2341 my $dbh = C4::Context->dbh;
2342 # check for charge made for lost book
2343 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2344 $sth->execute($itemnumber);
2345 my $data = $sth->fetchrow_hashref;
2346 $data or return; # bail if there is nothing to do
2347 $data->{accounttype} eq 'W' and return; # Written off
2349 # writeoff this amount
2351 my $amount = $data->{'amount'};
2352 my $acctno = $data->{'accountno'};
2353 my $amountleft; # Starts off undef/zero.
2354 if ($data->{'amountoutstanding'} == $amount) {
2355 $offset = $data->{'amount'};
2356 $amountleft = 0; # Hey, it's zero here, too.
2358 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2359 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2361 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2362 WHERE (accountlines_id = ?)");
2363 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2364 #check if any credit is left if so writeoff other accounts
2365 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2366 $amountleft *= -1 if ($amountleft < 0);
2367 if ($amountleft > 0) {
2368 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2369 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2370 $msth->execute($data->{'borrowernumber'});
2371 # offset transactions
2374 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2375 if ($accdata->{'amountoutstanding'} < $amountleft) {
2377 $amountleft -= $accdata->{'amountoutstanding'};
2379 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2382 my $thisacct = $accdata->{'accountlines_id'};
2383 # FIXME: move prepares outside while loop!
2384 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2385 WHERE (accountlines_id = ?)");
2386 $usth->execute($newamtos,$thisacct);
2387 $usth = $dbh->prepare("INSERT INTO accountoffsets
2388 (borrowernumber, accountno, offsetaccount, offsetamount)
2391 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2394 $amountleft *= -1 if ($amountleft > 0);
2395 my $desc = "Item Returned " . $item_id;
2396 $usth = $dbh->prepare("INSERT INTO accountlines
2397 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2398 VALUES (?,?,now(),?,?,'CR',?)");
2399 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2400 if ($borrowernumber) {
2401 # FIXME: same as query above. use 1 sth for both
2402 $usth = $dbh->prepare("INSERT INTO accountoffsets
2403 (borrowernumber, accountno, offsetaccount, offsetamount)
2405 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2407 ModItem({ paidfor => '' }, undef, $itemnumber);
2411 =head2 _GetCircControlBranch
2413 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2417 Return the library code to be used to determine which circulation
2418 policy applies to a transaction. Looks up the CircControl and
2419 HomeOrHoldingBranch system preferences.
2421 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2423 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2427 sub _GetCircControlBranch {
2428 my ($item, $borrower) = @_;
2429 my $circcontrol = C4::Context->preference('CircControl');
2432 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2433 $branch= C4::Context->userenv->{'branch'};
2434 } elsif ($circcontrol eq 'PatronLibrary') {
2435 $branch=$borrower->{branchcode};
2437 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2438 $branch = $item->{$branchfield};
2439 # default to item home branch if holdingbranch is used
2440 # and is not defined
2441 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2442 $branch = $item->{homebranch};
2455 $issue = &GetItemIssue($itemnumber);
2457 Returns patron currently having a book, or undef if not checked out.
2459 C<$itemnumber> is the itemnumber.
2461 C<$issue> is a hashref of the row from the issues table.
2466 my ($itemnumber) = @_;
2467 return unless $itemnumber;
2468 my $sth = C4::Context->dbh->prepare(
2469 "SELECT items.*, issues.*
2471 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2472 WHERE issues.itemnumber=?");
2473 $sth->execute($itemnumber);
2474 my $data = $sth->fetchrow_hashref;
2475 return unless $data;
2476 $data->{issuedate_sql} = $data->{issuedate};
2477 $data->{date_due_sql} = $data->{date_due};
2478 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2479 $data->{issuedate}->truncate(to => 'minute');
2480 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2481 $data->{date_due}->truncate(to => 'minute');
2482 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2483 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2489 $issue = GetOpenIssue( $itemnumber );
2491 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2493 C<$itemnumber> is the item's itemnumber
2500 my ( $itemnumber ) = @_;
2501 return unless $itemnumber;
2502 my $dbh = C4::Context->dbh;
2503 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2504 $sth->execute( $itemnumber );
2505 return $sth->fetchrow_hashref();
2511 $issues = GetIssues({}); # return all issues!
2512 $issues = GetIssues({ borrowernumber => $borrowernumber, biblionumber => $biblionumber });
2514 Returns all pending issues that match given criteria.
2515 Returns a arrayref or undef if an error occurs.
2517 Allowed criteria are:
2521 =item * borrowernumber
2523 =item * biblionumber
2532 my ($criteria) = @_;
2536 my @allowed = qw(borrowernumber biblionumber itemnumber);
2537 foreach (@allowed) {
2538 if (defined $criteria->{$_}) {
2541 value => $criteria->{$_},
2546 # Do we need to join other tables ?
2548 if (defined $criteria->{biblionumber}) {
2555 $where = "WHERE " . join(' AND ', map { "$_->{field} = ?" } @filters);
2561 if (defined $join{items}) {
2563 LEFT JOIN items ON (issues.itemnumber = items.itemnumber)
2569 my $dbh = C4::Context->dbh;
2570 my $sth = $dbh->prepare($query);
2571 my $rv = $sth->execute(map { $_->{value} } @filters);
2573 return $rv ? $sth->fetchall_arrayref({}) : undef;
2576 =head2 GetItemIssues
2578 $issues = &GetItemIssues($itemnumber, $history);
2580 Returns patrons that have issued a book
2582 C<$itemnumber> is the itemnumber
2583 C<$history> is false if you just want the current "issuer" (if any)
2584 and true if you want issues history from old_issues also.
2586 Returns reference to an array of hashes
2591 my ( $itemnumber, $history ) = @_;
2593 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2594 $today->truncate( to => 'minute' );
2595 my $sql = "SELECT * FROM issues
2596 JOIN borrowers USING (borrowernumber)
2597 JOIN items USING (itemnumber)
2598 WHERE issues.itemnumber = ? ";
2601 SELECT * FROM old_issues
2602 LEFT JOIN borrowers USING (borrowernumber)
2603 JOIN items USING (itemnumber)
2604 WHERE old_issues.itemnumber = ? ";
2606 $sql .= "ORDER BY date_due DESC";
2607 my $sth = C4::Context->dbh->prepare($sql);
2609 $sth->execute($itemnumber, $itemnumber);
2611 $sth->execute($itemnumber);
2613 my $results = $sth->fetchall_arrayref({});
2614 foreach (@$results) {
2615 my $date_due = dt_from_string($_->{date_due},'sql');
2616 $date_due->truncate( to => 'minute' );
2618 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2623 =head2 GetBiblioIssues
2625 $issues = GetBiblioIssues($biblionumber);
2627 this function get all issues from a biblionumber.
2630 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2631 tables issues and the firstname,surname & cardnumber from borrowers.
2635 sub GetBiblioIssues {
2636 my $biblionumber = shift;
2637 return unless $biblionumber;
2638 my $dbh = C4::Context->dbh;
2640 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2642 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2643 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2644 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2645 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2646 WHERE biblio.biblionumber = ?
2648 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2650 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2651 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2652 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2653 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2654 WHERE biblio.biblionumber = ?
2657 my $sth = $dbh->prepare($query);
2658 $sth->execute($biblionumber, $biblionumber);
2661 while ( my $data = $sth->fetchrow_hashref ) {
2662 push @issues, $data;
2667 =head2 GetUpcomingDueIssues
2669 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2673 sub GetUpcomingDueIssues {
2676 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2677 my $dbh = C4::Context->dbh;
2679 my $statement = <<END_SQL;
2680 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2682 LEFT JOIN items USING (itemnumber)
2683 LEFT OUTER JOIN branches USING (branchcode)
2684 WHERE returndate is NULL
2685 HAVING days_until_due >= 0 AND days_until_due <= ?
2688 my @bind_parameters = ( $params->{'days_in_advance'} );
2690 my $sth = $dbh->prepare( $statement );
2691 $sth->execute( @bind_parameters );
2692 my $upcoming_dues = $sth->fetchall_arrayref({});
2694 return $upcoming_dues;
2697 =head2 CanBookBeRenewed
2699 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2701 Find out whether a borrowed item may be renewed.
2703 C<$borrowernumber> is the borrower number of the patron who currently
2704 has the item on loan.
2706 C<$itemnumber> is the number of the item to renew.
2708 C<$override_limit>, if supplied with a true value, causes
2709 the limit on the number of times that the loan can be renewed
2710 (as controlled by the item type) to be ignored. Overriding also allows
2711 to renew sooner than "No renewal before" and to manually renew loans
2712 that are automatically renewed.
2714 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2715 item must currently be on loan to the specified borrower; renewals
2716 must be allowed for the item's type; and the borrower must not have
2717 already renewed the loan. $error will contain the reason the renewal can not proceed
2721 sub CanBookBeRenewed {
2722 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2724 my $dbh = C4::Context->dbh;
2727 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2728 my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2729 return ( 0, 'onsite_checkout' ) if $itemissue->{onsite_checkout};
2731 $borrowernumber ||= $itemissue->{borrowernumber};
2732 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2735 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2737 # This item can fill one or more unfilled reserve, can those unfilled reserves
2738 # all be filled by other available items?
2740 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2742 my $schema = Koha::Database->new()->schema();
2744 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2746 # There is an item level hold on this item, no other item can fill the hold
2751 # Get all other items that could possibly fill reserves
2752 my @itemnumbers = $schema->resultset('Item')->search(
2754 biblionumber => $resrec->{biblionumber},
2757 -not => { itemnumber => $itemnumber }
2759 { columns => 'itemnumber' }
2760 )->get_column('itemnumber')->all();
2762 # Get all other reserves that could have been filled by this item
2763 my @borrowernumbers;
2765 my ( $reserve_found, $reserve, undef ) =
2766 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2768 if ($reserve_found) {
2769 push( @borrowernumbers, $reserve->{borrowernumber} );
2776 # If the count of the union of the lists of reservable items for each borrower
2777 # is equal or greater than the number of borrowers, we know that all reserves
2778 # can be filled with available items. We can get the union of the sets simply
2779 # by pushing all the elements onto an array and removing the duplicates.
2781 foreach my $b (@borrowernumbers) {
2782 my ($borr) = C4::Members::GetMember( borrowernumber => $b);
2783 foreach my $i (@itemnumbers) {
2784 my $item = GetItem($i);
2785 if ( !IsItemOnHoldAndFound($i)
2786 && IsAvailableForItemLevelRequest( $item, $borr )
2787 && CanItemBeReserved( $b, $i ) )
2789 push( @reservable, $i );
2794 @reservable = uniq(@reservable);
2796 if ( @reservable >= @borrowernumbers ) {
2801 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2803 return ( 1, undef ) if $override_limit;
2805 my $branchcode = _GetCircControlBranch( $item, $borrower );
2806 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2807 { categorycode => $borrower->{categorycode},
2808 itemtype => $item->{itype},
2809 branchcode => $branchcode
2813 return ( 0, "too_many" )
2814 if not $issuing_rule or $issuing_rule->renewalsallowed <= $itemissue->{renewals};
2816 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2817 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2818 my $patron = Koha::Patrons->find($borrowernumber);
2819 my $restricted = $patron->is_debarred;
2820 my $hasoverdues = $patron->has_overdues;
2822 if ( $restricted and $restrictionblockrenewing ) {
2823 return ( 0, 'restriction');
2824 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($itemissue->{overdue} and $overduesblockrenewing eq 'blockitem') ) {
2825 return ( 0, 'overdue');
2828 if ( $itemissue->{auto_renew}
2829 and defined $issuing_rule->no_auto_renewal_after
2830 and $issuing_rule->no_auto_renewal_after ne "" ) {
2832 # Get issue_date and add no_auto_renewal_after
2833 # If this is greater than today, it's too late for renewal.
2834 my $maximum_renewal_date = dt_from_string($itemissue->{issuedate});
2835 $maximum_renewal_date->add(
2836 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2838 my $now = dt_from_string;
2839 if ( $now >= $maximum_renewal_date ) {
2840 return ( 0, "auto_too_late" );
2844 if ( defined $issuing_rule->norenewalbefore
2845 and $issuing_rule->norenewalbefore ne "" )
2848 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2849 my $soonestrenewal =
2850 $itemissue->{date_due}->clone()
2852 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2854 # Depending on syspref reset the exact time, only check the date
2855 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2856 and $issuing_rule->lengthunit eq 'days' )
2858 $soonestrenewal->truncate( to => 'day' );
2861 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2863 return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2864 return ( 0, "too_soon" );
2866 elsif ( $itemissue->{auto_renew} ) {
2867 return ( 0, "auto_renew" );
2871 # Fallback for automatic renewals:
2872 # If norenewalbefore is undef, don't renew before due date.
2873 if ( $itemissue->{auto_renew} ) {
2874 my $now = dt_from_string;
2875 return ( 0, "auto_renew" )
2876 if $now >= $itemissue->{date_due};
2877 return ( 0, "auto_too_soon" );
2880 return ( 1, undef );
2885 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2889 C<$borrowernumber> is the borrower number of the patron who currently
2892 C<$itemnumber> is the number of the item to renew.
2894 C<$branch> is the library where the renewal took place (if any).
2895 The library that controls the circ policies for the renewal is retrieved from the issues record.
2897 C<$datedue> can be a DateTime object used to set the due date.
2899 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2900 this parameter is not supplied, lastreneweddate is set to the current date.
2902 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2903 from the book's item type.
2908 my $borrowernumber = shift;
2909 my $itemnumber = shift or return;
2911 my $datedue = shift;
2912 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2914 my $item = GetItem($itemnumber) or return;
2915 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2917 my $dbh = C4::Context->dbh;
2919 # Find the issues record for this book
2920 my $issuedata = GetItemIssue($itemnumber);
2922 return unless ( $issuedata );
2924 $borrowernumber ||= $issuedata->{borrowernumber};
2926 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2927 carp 'Invalid date passed to AddRenewal.';
2931 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2933 if ( C4::Context->preference('CalculateFinesOnReturn') && $issuedata->{overdue} ) {
2934 _CalculateAndUpdateFine( { issue => $issuedata, item => $item, borrower => $borrower } );
2936 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2938 # If the due date wasn't specified, calculate it by adding the
2939 # book's loan length to today's date or the current due date
2940 # based on the value of the RenewalPeriodBase syspref.
2943 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2945 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2946 dt_from_string( $issuedata->{date_due} ) :
2947 DateTime->now( time_zone => C4::Context->tz());
2948 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2951 # Update the issues record to have the new due date, and a new count
2952 # of how many times it has been renewed.
2953 my $renews = $issuedata->{'renewals'} + 1;
2954 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2955 WHERE borrowernumber=?
2959 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2961 # Update the renewal count on the item, and tell zebra to reindex
2962 $renews = $biblio->{'renewals'} + 1;
2963 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2965 # Charge a new rental fee, if applicable?
2966 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2967 if ( $charge > 0 ) {
2968 my $accountno = getnextacctno( $borrowernumber );
2969 my $item = GetBiblioFromItemNumber($itemnumber);
2971 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2972 $sth = $dbh->prepare(
2973 "INSERT INTO accountlines
2974 (date, borrowernumber, accountno, amount, manager_id,
2975 description,accounttype, amountoutstanding, itemnumber)
2976 VALUES (now(),?,?,?,?,?,?,?,?)"
2978 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2979 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2980 'Rent', $charge, $itemnumber );
2983 # Send a renewal slip according to checkout alert preferencei
2984 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2985 $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2986 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2988 branchcode => $branch,
2989 categorycode => $borrower->{categorycode},
2990 item_type => $item->{itype},
2991 notification => 'CHECKOUT',
2993 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2994 SendCirculationAlert(
2998 borrower => $borrower,
3005 # Remove any OVERDUES related debarment if the borrower has no overdues
3006 $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
3007 if ( $borrowernumber
3008 && $borrower->{'debarred'}
3009 && !Koha::Patrons->find( $borrowernumber )->has_overdues
3010 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3012 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3018 branch => C4::Context->userenv ? C4::Context->userenv->{branch} : $branch,
3021 itemnumber => $itemnumber,
3022 itemtype => $item->{itype},
3023 borrowernumber => $borrowernumber,
3024 ccode => $item->{'ccode'}
3032 # check renewal status
3033 my ( $bornum, $itemno ) = @_;
3034 my $dbh = C4::Context->dbh;
3036 my $renewsallowed = 0;
3039 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
3040 my $item = GetItem($itemno);
3042 # Look in the issues table for this item, lent to this borrower,
3043 # and not yet returned.
3045 # FIXME - I think this function could be redone to use only one SQL call.
3046 my $sth = $dbh->prepare(
3047 "select * from issues
3048 where (borrowernumber = ?)
3049 and (itemnumber = ?)"
3051 $sth->execute( $bornum, $itemno );
3052 my $data = $sth->fetchrow_hashref;
3053 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3054 # $item and $borrower should be calculated
3055 my $branchcode = _GetCircControlBranch($item, $borrower);
3057 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3058 { categorycode => $borrower->{categorycode},
3059 itemtype => $item->{itype},
3060 branchcode => $branchcode
3064 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : undef; # FIXME Just replace undef with 0 to get what we expected. But what about the side-effects? TODO LATER
3065 $renewsleft = $renewsallowed - $renewcount;
3066 if($renewsleft < 0){ $renewsleft = 0; }
3067 return ( $renewcount, $renewsallowed, $renewsleft );
3070 =head2 GetSoonestRenewDate
3072 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3074 Find out the soonest possible renew date of a borrowed item.
3076 C<$borrowernumber> is the borrower number of the patron who currently
3077 has the item on loan.
3079 C<$itemnumber> is the number of the item to renew.
3081 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3082 renew date, based on the value "No renewal before" of the applicable
3083 issuing rule. Returns the current date if the item can already be
3084 renewed, and returns undefined if the borrower, loan, or item
3089 sub GetSoonestRenewDate {
3090 my ( $borrowernumber, $itemnumber ) = @_;
3092 my $dbh = C4::Context->dbh;
3094 my $item = GetItem($itemnumber) or return;
3095 my $itemissue = GetItemIssue($itemnumber) or return;
3097 $borrowernumber ||= $itemissue->{borrowernumber};
3098 my $borrower = C4::Members::GetMemberDetails($borrowernumber)
3101 my $branchcode = _GetCircControlBranch( $item, $borrower );
3102 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3103 { categorycode => $borrower->{categorycode},
3104 itemtype => $item->{itype},
3105 branchcode => $branchcode
3109 my $now = dt_from_string;
3110 return $now unless $issuing_rule;
3112 if ( defined $issuing_rule->norenewalbefore
3113 and $issuing_rule->norenewalbefore ne "" )
3115 my $soonestrenewal =
3116 $itemissue->{date_due}->clone()
3118 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3120 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3121 and $issuing_rule->lengthunit eq 'days' )
3123 $soonestrenewal->truncate( to => 'day' );
3125 return $soonestrenewal if $now < $soonestrenewal;
3130 =head2 GetLatestAutoRenewDate
3132 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3134 Find out the latest possible auto renew date of a borrowed item.
3136 C<$borrowernumber> is the borrower number of the patron who currently
3137 has the item on loan.
3139 C<$itemnumber> is the number of the item to renew.
3141 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3142 auto renew date, based on the value "No auto renewal after" of the applicable
3144 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3145 or item cannot be found.
3149 sub GetLatestAutoRenewDate {
3150 my ( $borrowernumber, $itemnumber ) = @_;
3152 my $dbh = C4::Context->dbh;
3154 my $item = GetItem($itemnumber) or return;
3155 my $itemissue = GetItemIssue($itemnumber) or return;
3157 $borrowernumber ||= $itemissue->{borrowernumber};
3158 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
3161 my $branchcode = _GetCircControlBranch( $item, $borrower );
3162 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3163 { categorycode => $borrower->{categorycode},
3164 itemtype => $item->{itype},
3165 branchcode => $branchcode
3169 return unless $issuing_rule;
3170 return if not $issuing_rule->no_auto_renewal_after
3171 or $issuing_rule->no_auto_renewal_after eq '';
3173 my $maximum_renewal_date = dt_from_string($itemissue->{issuedate});
3174 $maximum_renewal_date->add(
3175 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3178 return $maximum_renewal_date;
3182 =head2 GetIssuingCharges
3184 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3186 Calculate how much it would cost for a given patron to borrow a given
3187 item, including any applicable discounts.
3189 C<$itemnumber> is the item number of item the patron wishes to borrow.
3191 C<$borrowernumber> is the patron's borrower number.
3193 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3194 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3199 sub GetIssuingCharges {
3201 # calculate charges due
3202 my ( $itemnumber, $borrowernumber ) = @_;
3204 my $dbh = C4::Context->dbh;
3207 # Get the book's item type and rental charge (via its biblioitem).
3208 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3209 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3210 $charge_query .= (C4::Context->preference('item-level_itypes'))
3211 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3212 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3214 $charge_query .= ' WHERE items.itemnumber =?';
3216 my $sth = $dbh->prepare($charge_query);
3217 $sth->execute($itemnumber);
3218 if ( my $item_data = $sth->fetchrow_hashref ) {
3219 $item_type = $item_data->{itemtype};
3220 $charge = $item_data->{rentalcharge};
3221 my $branch = C4::Context::mybranch();
3222 my $discount_query = q|SELECT rentaldiscount,
3223 issuingrules.itemtype, issuingrules.branchcode
3225 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3226 WHERE borrowers.borrowernumber = ?
3227 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3228 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3229 my $discount_sth = $dbh->prepare($discount_query);
3230 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3231 my $discount_rules = $discount_sth->fetchall_arrayref({});
3232 if (@{$discount_rules}) {
3233 # We may have multiple rules so get the most specific
3234 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3235 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3239 return ( $charge, $item_type );
3242 # Select most appropriate discount rule from those returned
3243 sub _get_discount_from_rule {
3244 my ($rules_ref, $branch, $itemtype) = @_;
3247 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3248 $discount = $rules_ref->[0]->{rentaldiscount};
3249 return (defined $discount) ? $discount : 0;
3251 # could have up to 4 does one match $branch and $itemtype
3252 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3254 $discount = $d[0]->{rentaldiscount};
3255 return (defined $discount) ? $discount : 0;
3257 # do we have item type + all branches
3258 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3260 $discount = $d[0]->{rentaldiscount};
3261 return (defined $discount) ? $discount : 0;
3263 # do we all item types + this branch
3264 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3266 $discount = $d[0]->{rentaldiscount};
3267 return (defined $discount) ? $discount : 0;
3269 # so all and all (surely we wont get here)
3270 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3272 $discount = $d[0]->{rentaldiscount};
3273 return (defined $discount) ? $discount : 0;
3279 =head2 AddIssuingCharge
3281 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3285 sub AddIssuingCharge {
3286 my ( $itemnumber, $borrowernumber, $charge ) = @_;
3287 my $dbh = C4::Context->dbh;
3288 my $nextaccntno = getnextacctno( $borrowernumber );
3290 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3292 INSERT INTO accountlines
3293 (borrowernumber, itemnumber, accountno,
3294 date, amount, description, accounttype,
3295 amountoutstanding, manager_id)
3296 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3298 my $sth = $dbh->prepare($query);
3299 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3304 GetTransfers($itemnumber);
3309 my ($itemnumber) = @_;
3311 my $dbh = C4::Context->dbh;
3317 FROM branchtransfers
3318 WHERE itemnumber = ?
3319 AND datearrived IS NULL
3321 my $sth = $dbh->prepare($query);
3322 $sth->execute($itemnumber);
3323 my @row = $sth->fetchrow_array();
3327 =head2 GetTransfersFromTo
3329 @results = GetTransfersFromTo($frombranch,$tobranch);
3331 Returns the list of pending transfers between $from and $to branch
3335 sub GetTransfersFromTo {
3336 my ( $frombranch, $tobranch ) = @_;
3337 return unless ( $frombranch && $tobranch );
3338 my $dbh = C4::Context->dbh;
3340 SELECT itemnumber,datesent,frombranch
3341 FROM branchtransfers
3344 AND datearrived IS NULL
3346 my $sth = $dbh->prepare($query);
3347 $sth->execute( $frombranch, $tobranch );
3350 while ( my $data = $sth->fetchrow_hashref ) {
3351 push @gettransfers, $data;
3353 return (@gettransfers);
3356 =head2 DeleteTransfer
3358 &DeleteTransfer($itemnumber);
3362 sub DeleteTransfer {
3363 my ($itemnumber) = @_;
3364 return unless $itemnumber;
3365 my $dbh = C4::Context->dbh;
3366 my $sth = $dbh->prepare(
3367 "DELETE FROM branchtransfers
3369 AND datearrived IS NULL "
3371 return $sth->execute($itemnumber);
3374 =head2 AnonymiseIssueHistory
3376 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
3378 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
3379 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
3381 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
3382 setting (force delete).
3384 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
3388 sub AnonymiseIssueHistory {
3390 my $borrowernumber = shift;
3391 my $dbh = C4::Context->dbh;
3394 SET borrowernumber = ?
3395 WHERE returndate < ?
3396 AND borrowernumber IS NOT NULL
3399 # The default of 0 does not work due to foreign key constraints
3400 # The anonymisation should not fail quietly if AnonymousPatron is not a valid entry
3401 # Set it to undef (NULL)
3402 my $anonymouspatron = C4::Context->preference('AnonymousPatron') || undef;
3403 my @bind_params = ($anonymouspatron, $date);
3404 if (defined $borrowernumber) {
3405 $query .= " AND borrowernumber = ?";
3406 push @bind_params, $borrowernumber;
3408 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
3410 my $sth = $dbh->prepare($query);
3411 $sth->execute(@bind_params);
3412 my $anonymisation_err = $dbh->err;
3413 my $rows_affected = $sth->rows; ### doublecheck row count return function
3414 return ($rows_affected, $anonymisation_err);
3417 =head2 SendCirculationAlert
3419 Send out a C<check-in> or C<checkout> alert using the messaging system.
3427 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3431 Hashref of information about the item being checked in or out.
3435 Hashref of information about the borrower of the item.
3439 The branchcode from where the checkout or check-in took place.
3445 SendCirculationAlert({
3448 borrower => $borrower,
3454 sub SendCirculationAlert {
3456 my ($type, $item, $borrower, $branch) =
3457 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3458 my %message_name = (
3459 CHECKIN => 'Item_Check_in',
3460 CHECKOUT => 'Item_Checkout',
3461 RENEWAL => 'Item_Checkout',
3463 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3464 borrowernumber => $borrower->{borrowernumber},
3465 message_name => $message_name{$type},
3467 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3469 my @transports = keys %{ $borrower_preferences->{transports} };
3470 # warn "no transports" unless @transports;
3472 # warn "transport: $_";
3473 my $message = C4::Message->find_last_message($borrower, $type, $_);
3475 #warn "create new message";
3476 my $letter = C4::Letters::GetPreparedLetter (
3477 module => 'circulation',
3478 letter_code => $type,
3479 branchcode => $branch,
3480 message_transport_type => $_,
3482 $issues_table => $item->{itemnumber},
3483 'items' => $item->{itemnumber},
3484 'biblio' => $item->{biblionumber},
3485 'biblioitems' => $item->{biblionumber},
3486 'borrowers' => $borrower,
3487 'branches' => $branch,
3490 C4::Message->enqueue($letter, $borrower, $_);
3492 #warn "append to old message";
3493 my $letter = C4::Letters::GetPreparedLetter (
3494 module => 'circulation',
3495 letter_code => $type,
3496 branchcode => $branch,
3497 message_transport_type => $_,
3499 $issues_table => $item->{itemnumber},
3500 'items' => $item->{itemnumber},
3501 'biblio' => $item->{biblionumber},
3502 'biblioitems' => $item->{biblionumber},
3503 'borrowers' => $borrower,
3504 'branches' => $branch,
3507 $message->append($letter);
3515 =head2 updateWrongTransfer
3517 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3519 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
3523 sub updateWrongTransfer {
3524 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3525 my $dbh = C4::Context->dbh;
3526 # first step validate the actual line of transfert .
3529 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3531 $sth->execute($FromLibrary,$itemNumber);
3533 # second step create a new line of branchtransfer to the right location .
3534 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3536 #third step changing holdingbranch of item
3537 UpdateHoldingbranch($FromLibrary,$itemNumber);
3540 =head2 UpdateHoldingbranch
3542 $items = UpdateHoldingbranch($branch,$itmenumber);
3544 Simple methode for updating hodlingbranch in items BDD line
3548 sub UpdateHoldingbranch {
3549 my ( $branch,$itemnumber ) = @_;
3550 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3555 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3557 this function calculates the due date given the start date and configured circulation rules,
3558 checking against the holidays calendar as per the 'useDaysMode' syspref.
3559 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3560 C<$itemtype> = itemtype code of item in question
3561 C<$branch> = location whose calendar to use
3562 C<$borrower> = Borrower object
3563 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3568 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3572 # loanlength now a href
3574 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3576 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3582 if (ref $startdate ne 'DateTime' ) {
3583 $datedue = dt_from_string($datedue);
3585 $datedue = $startdate->clone;
3589 DateTime->now( time_zone => C4::Context->tz() )
3590 ->truncate( to => 'minute' );
3594 # calculate the datedue as normal
3595 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3596 { # ignoring calendar
3597 if ( $loanlength->{lengthunit} eq 'hours' ) {
3598 $datedue->add( hours => $loanlength->{$length_key} );
3600 $datedue->add( days => $loanlength->{$length_key} );
3601 $datedue->set_hour(23);
3602 $datedue->set_minute(59);
3606 if ($loanlength->{lengthunit} eq 'hours') {
3607 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3610 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3612 my $calendar = Koha::Calendar->new( branchcode => $branch );
3613 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3614 if ($loanlength->{lengthunit} eq 'days') {
3615 $datedue->set_hour(23);
3616 $datedue->set_minute(59);
3620 # if Hard Due Dates are used, retrieve them and apply as necessary
3621 my ( $hardduedate, $hardduedatecompare ) =
3622 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3623 if ($hardduedate) { # hardduedates are currently dates
3624 $hardduedate->truncate( to => 'minute' );
3625 $hardduedate->set_hour(23);
3626 $hardduedate->set_minute(59);
3627 my $cmp = DateTime->compare( $hardduedate, $datedue );
3629 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3630 # if the calculated date is before the 'after' Hard Due Date (floor), override
3631 # if the hard due date is set to 'exactly', overrride
3632 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3633 $datedue = $hardduedate->clone;
3636 # in all other cases, keep the date due as it is
3640 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3641 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3642 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3643 if( $expiry_dt ) { #skip empty expiry date..
3644 $expiry_dt->set( hour => 23, minute => 59);
3645 my $d1= $datedue->clone->set_time_zone('floating');
3646 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3647 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3656 sub CheckValidBarcode{
3658 my $dbh = C4::Context->dbh;
3659 my $query=qq|SELECT count(*)
3663 my $sth = $dbh->prepare($query);
3664 $sth->execute($barcode);
3665 my $exist=$sth->fetchrow ;
3669 =head2 IsBranchTransferAllowed
3671 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3673 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3677 sub IsBranchTransferAllowed {
3678 my ( $toBranch, $fromBranch, $code ) = @_;
3680 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3682 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3683 my $dbh = C4::Context->dbh;
3685 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3686 $sth->execute( $toBranch, $fromBranch, $code );
3687 my $limit = $sth->fetchrow_hashref();
3689 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3690 if ( $limit->{'limitId'} ) {
3697 =head2 CreateBranchTransferLimit
3699 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3701 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3705 sub CreateBranchTransferLimit {
3706 my ( $toBranch, $fromBranch, $code ) = @_;
3707 return unless defined($toBranch) && defined($fromBranch);
3708 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3710 my $dbh = C4::Context->dbh;
3712 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3713 return $sth->execute( $code, $toBranch, $fromBranch );
3716 =head2 DeleteBranchTransferLimits
3718 my $result = DeleteBranchTransferLimits($frombranch);
3720 Deletes all the library transfer limits for one library. Returns the
3721 number of limits deleted, 0e0 if no limits were deleted, or undef if
3722 no arguments are supplied.
3726 sub DeleteBranchTransferLimits {
3728 return unless defined $branch;
3729 my $dbh = C4::Context->dbh;
3730 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3731 return $sth->execute($branch);
3735 my ( $borrowernumber, $itemnum ) = @_;
3737 MarkIssueReturned( $borrowernumber, $itemnum );
3738 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3739 my $item = C4::Items::GetItem( $itemnum );
3740 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3741 my @datearr = localtime(time);
3742 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3743 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3744 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3749 my ($itemnumber, $mark_returned) = @_;
3751 my $dbh = C4::Context->dbh();
3752 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3754 JOIN items USING (itemnumber)
3755 JOIN biblio USING (biblionumber)
3756 WHERE issues.itemnumber=?");
3757 $sth->execute($itemnumber);
3758 my $issues=$sth->fetchrow_hashref();
3760 # If a borrower lost the item, add a replacement cost to the their record
3761 if ( my $borrowernumber = $issues->{borrowernumber} ){
3762 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3764 if (C4::Context->preference('WhenLostForgiveFine')){
3765 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3766 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3768 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3769 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3770 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3771 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3774 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3778 sub GetOfflineOperations {
3779 my $dbh = C4::Context->dbh;
3780 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3781 $sth->execute(C4::Context->userenv->{'branch'});
3782 my $results = $sth->fetchall_arrayref({});
3786 sub GetOfflineOperation {
3787 my $operationid = shift;
3788 return unless $operationid;
3789 my $dbh = C4::Context->dbh;
3790 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3791 $sth->execute( $operationid );
3792 return $sth->fetchrow_hashref;
3795 sub AddOfflineOperation {
3796 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3797 my $dbh = C4::Context->dbh;
3798 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3799 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3803 sub DeleteOfflineOperation {
3804 my $dbh = C4::Context->dbh;
3805 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3806 $sth->execute( shift );
3810 sub ProcessOfflineOperation {
3811 my $operation = shift;
3814 if ( $operation->{action} eq 'return' ) {
3815 $report = ProcessOfflineReturn( $operation );
3816 } elsif ( $operation->{action} eq 'issue' ) {
3817 $report = ProcessOfflineIssue( $operation );
3818 } elsif ( $operation->{action} eq 'payment' ) {
3819 $report = ProcessOfflinePayment( $operation );
3822 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3827 sub ProcessOfflineReturn {
3828 my $operation = shift;
3830 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3832 if ( $itemnumber ) {
3833 my $issue = GetOpenIssue( $itemnumber );
3836 $issue->{borrowernumber},
3839 $operation->{timestamp},
3842 { renewals => 0, onloan => undef },
3843 $issue->{'biblionumber'},
3848 return "Item not issued.";
3851 return "Item not found.";
3855 sub ProcessOfflineIssue {
3856 my $operation = shift;
3858 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3860 if ( $borrower->{borrowernumber} ) {
3861 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3862 unless ($itemnumber) {
3863 return "Barcode not found.";
3865 my $issue = GetOpenIssue( $itemnumber );
3867 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3869 $issue->{borrowernumber},
3872 $operation->{timestamp},
3877 $operation->{'barcode'},
3880 $operation->{timestamp},
3885 return "Borrower not found.";
3889 sub ProcessOfflinePayment {
3890 my $operation = shift;
3892 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} });
3893 my $amount = $operation->{amount};
3895 Koha::Account->new( { patron_id => $patron->id } )->pay( { amount => $amount } );
3903 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3905 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3910 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3912 my $item = GetItem( $itemnumber, $barcode )
3915 return C4::Letters::GetPreparedLetter (
3916 module => 'circulation',
3917 letter_code => 'TRANSFERSLIP',
3918 branchcode => $branch,
3920 'branches' => $to_branch,
3921 'biblio' => $item->{biblionumber},
3927 =head2 CheckIfIssuedToPatron
3929 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3931 Return 1 if any record item is issued to patron, otherwise return 0
3935 sub CheckIfIssuedToPatron {
3936 my ($borrowernumber, $biblionumber) = @_;
3938 my $dbh = C4::Context->dbh;
3940 SELECT COUNT(*) FROM issues
3941 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3942 WHERE items.biblionumber = ?
3943 AND issues.borrowernumber = ?
3945 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3946 return 1 if $is_issued;
3952 IsItemIssued( $itemnumber )
3954 Return 1 if the item is on loan, otherwise return 0
3959 my $itemnumber = shift;
3960 my $dbh = C4::Context->dbh;
3961 my $sth = $dbh->prepare(q{
3964 WHERE itemnumber = ?
3966 $sth->execute($itemnumber);
3967 return $sth->fetchrow;
3970 =head2 GetAgeRestriction
3972 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3973 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3975 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as he is older or as old as the agerestriction }
3976 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3978 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3979 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3980 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3981 Negative days mean the borrower has gone past the age restriction age.
3985 sub GetAgeRestriction {
3986 my ($record_restrictions, $borrower) = @_;
3987 my $markers = C4::Context->preference('AgeRestrictionMarker');
3989 # Split $record_restrictions to something like FSK 16 or PEGI 6
3990 my @values = split ' ', uc($record_restrictions);
3991 return unless @values;
3993 # Search first occurrence of one of the markers
3994 my @markers = split /\|/, uc($markers);
3995 return unless @markers;
3998 my $restriction_year = 0;
3999 for my $value (@values) {
4001 for my $marker (@markers) {
4002 $marker =~ s/^\s+//; #remove leading spaces
4003 $marker =~ s/\s+$//; #remove trailing spaces
4004 if ( $marker eq $value ) {
4005 if ( $index <= $#values ) {
4006 $restriction_year += $values[$index];
4010 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4012 # Perhaps it is something like "K16" (as in Finland)
4013 $restriction_year += $1;
4017 last if ( $restriction_year > 0 );
4020 #Check if the borrower is age restricted for this material and for how long.
4021 if ($restriction_year && $borrower) {
4022 if ( $borrower->{'dateofbirth'} ) {
4023 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4024 $alloweddate[0] += $restriction_year;
4026 #Prevent runime eror on leap year (invalid date)
4027 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4028 $alloweddate[2] = 28;
4031 #Get how many days the borrower has to reach the age restriction
4032 my @Today = split /-/, DateTime->today->ymd();
4033 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4034 #Negative days means the borrower went past the age restriction age
4035 return ($restriction_year, $daysToAgeRestriction);
4039 return ($restriction_year);
4043 =head2 GetPendingOnSiteCheckouts
4047 sub GetPendingOnSiteCheckouts {
4048 my $dbh = C4::Context->dbh;
4049 return $dbh->selectall_arrayref(q|
4055 items.itemcallnumber,
4059 issues.date_due < NOW() AS is_overdue,
4062 borrowers.firstname,
4064 borrowers.cardnumber,
4065 borrowers.borrowernumber
4067 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4068 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4069 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4070 WHERE issues.onsite_checkout = 1
4071 |, { Slice => {} } );
4077 my ($count, $branch, $itemtype, $ccode, $newness)
4078 = @$params{qw(count branch itemtype ccode newness)};
4080 my $dbh = C4::Context->dbh;
4082 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4083 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4084 i.ccode, SUM(i.issues) AS count
4086 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4087 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4090 my (@where_strs, @where_args);
4093 push @where_strs, 'i.homebranch = ?';
4094 push @where_args, $branch;
4097 if (C4::Context->preference('item-level_itypes')){
4098 push @where_strs, 'i.itype = ?';
4099 push @where_args, $itemtype;
4101 push @where_strs, 'bi.itemtype = ?';
4102 push @where_args, $itemtype;
4106 push @where_strs, 'i.ccode = ?';
4107 push @where_args, $ccode;
4110 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4111 push @where_args, $newness;
4115 $query .= 'WHERE ' . join(' AND ', @where_strs);
4119 GROUP BY b.biblionumber
4124 $count = int($count);
4126 $query .= "LIMIT $count";
4129 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4134 sub _CalculateAndUpdateFine {
4137 my $borrower = $params->{borrower};
4138 my $item = $params->{item};
4139 my $issue = $params->{issue};
4140 my $return_date = $params->{return_date};
4142 unless ($borrower) { carp "No borrower passed in!" && return; }
4143 unless ($item) { carp "No item passed in!" && return; }
4144 unless ($issue) { carp "No issue passed in!" && return; }
4146 my $datedue = $issue->{date_due};
4148 # we only need to calculate and change the fines if we want to do that on return
4149 # Should be on for hourly loans
4150 my $control = C4::Context->preference('CircControl');
4151 my $control_branchcode =
4152 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4153 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4154 : $issue->{branchcode};
4156 my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4158 my ( $amount, $type, $unitcounttotal ) =
4159 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4163 if ( C4::Context->preference('finesMode') eq 'production' ) {
4164 if ( $amount > 0 ) {
4165 C4::Overdues::UpdateFine({
4166 issue_id => $issue->{issue_id},
4167 itemnumber => $issue->{itemnumber},
4168 borrowernumber => $issue->{borrowernumber},
4171 due => output_pref($datedue),
4174 elsif ($return_date) {
4176 # Backdated returns may have fines that shouldn't exist,
4177 # so in this case, we need to drop those fines to 0
4179 C4::Overdues::UpdateFine({
4180 issue_id => $issue->{issue_id},
4181 itemnumber => $issue->{itemnumber},
4182 borrowernumber => $issue->{borrowernumber},
4185 due => output_pref($datedue),
4197 Koha Development Team <http://koha-community.org/>