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;
47 use Koha::IssuingRules;
50 use Koha::Patron::Debarments;
54 use Koha::RefundLostItemFeeRule;
55 use Koha::RefundLostItemFeeRules;
57 use List::MoreUtils qw( uniq );
58 use Scalar::Util qw( looks_like_number );
68 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
74 # FIXME subs that should probably be elsewhere
79 &GetPendingOnSiteCheckouts
82 # subs to deal with issuing a book
90 &GetLatestAutoRenewDate
93 &GetBranchBorrowerCircRule
97 &CheckIfIssuedToPatron
102 # subs to deal with returns
108 # subs to deal with transfers
115 &IsBranchTransferAllowed
116 &CreateBranchTransferLimit
117 &DeleteBranchTransferLimits
121 # subs to deal with offline circulation
123 &GetOfflineOperations
126 &DeleteOfflineOperation
127 &ProcessOfflineOperation
133 C4::Circulation - Koha circulation module
141 The functions in this module deal with circulation, issues, and
142 returns, as well as general information about the library.
143 Also deals with inventory.
149 $str = &barcodedecode($barcode, [$filter]);
151 Generic filter function for barcode string.
152 Called on every circ if the System Pref itemBarcodeInputFilter is set.
153 Will do some manipulation of the barcode for systems that deliver a barcode
154 to circulation.pl that differs from the barcode stored for the item.
155 For proper functioning of this filter, calling the function on the
156 correct barcode string (items.barcode) should return an unaltered barcode.
158 The optional $filter argument is to allow for testing or explicit
159 behavior that ignores the System Pref. Valid values are the same as the
164 # FIXME -- the &decode fcn below should be wrapped into this one.
165 # FIXME -- these plugins should be moved out of Circulation.pm
168 my ($barcode, $filter) = @_;
169 my $branch = C4::Context::mybranch();
170 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
171 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
172 if ($filter eq 'whitespace') {
174 } elsif ($filter eq 'cuecat') {
176 my @fields = split( /\./, $barcode );
177 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
178 ($#results == 2) and return $results[2];
179 } elsif ($filter eq 'T-prefix') {
180 if ($barcode =~ /^[Tt](\d)/) {
181 (defined($1) and $1 eq '0') and return $barcode;
182 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
184 return sprintf("T%07d", $barcode);
185 # FIXME: $barcode could be "T1", causing warning: substr outside of string
186 # Why drop the nonzero digit after the T?
187 # Why pass non-digits (or empty string) to "T%07d"?
188 } elsif ($filter eq 'libsuite8') {
189 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
190 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
191 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
193 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
196 } elsif ($filter eq 'EAN13') {
197 my $ean = CheckDigits('ean');
198 if ( $ean->is_valid($barcode) ) {
199 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
200 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
202 warn "# [$barcode] not valid EAN-13/UPC-A\n";
205 return $barcode; # return barcode, modified or not
210 $str = &decode($chunk);
212 Decodes a segment of a string emitted by a CueCat barcode scanner and
215 FIXME: Should be replaced with Barcode::Cuecat from CPAN
216 or Javascript based decoding on the client side.
223 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
224 my @s = map { index( $seq, $_ ); } split( //, $encoded );
225 my $l = ( $#s + 1 ) % 4;
228 # warn "Error: Cuecat decode parsing failed!";
236 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
238 chr( ( $n >> 16 ) ^ 67 )
239 .chr( ( $n >> 8 & 255 ) ^ 67 )
240 .chr( ( $n & 255 ) ^ 67 );
243 $r = substr( $r, 0, length($r) - $l );
249 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
250 $barcode, $ignore_reserves);
252 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
254 C<$newbranch> is the code for the branch to which the item should be transferred.
256 C<$barcode> is the barcode of the item to be transferred.
258 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
259 Otherwise, if an item is reserved, the transfer fails.
261 Returns three values:
267 is true if the transfer was successful.
271 is a reference-to-hash which may have any of the following keys:
277 There is no item in the catalog with the given barcode. The value is C<$barcode>.
281 The item's home branch is permanent. This doesn't prevent the item from being transferred, though. The value is the code of the item's home branch.
283 =item C<DestinationEqualsHolding>
285 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
289 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
293 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
295 =item C<WasTransferred>
297 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
306 my ( $tbr, $barcode, $ignoreRs ) = @_;
309 my $itemnumber = GetItemnumberFromBarcode( $barcode );
310 my $issue = GetItemIssue($itemnumber);
311 my $biblio = GetBiblioFromItemNumber($itemnumber);
314 if ( not $itemnumber ) {
315 $messages->{'BadBarcode'} = $barcode;
319 # get branches of book...
320 my $hbr = $biblio->{'homebranch'};
321 my $fbr = $biblio->{'holdingbranch'};
323 # if using Branch Transfer Limits
324 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
325 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
326 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
327 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
330 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
331 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
337 # FIXME Is this still used by someone?
338 # See other FIXME in AddReturn
339 my $library = Koha::Libraries->find($hbr);
340 if ( $library and $library->get_categories->search({'me.categorycode' => 'PE'})->count ) {
341 $messages->{'IsPermanent'} = $hbr;
345 # can't transfer book if is already there....
346 if ( $fbr eq $tbr ) {
347 $messages->{'DestinationEqualsHolding'} = 1;
351 # check if it is still issued to someone, return it...
352 if ($issue->{borrowernumber}) {
353 AddReturn( $barcode, $fbr );
354 $messages->{'WasReturned'} = $issue->{borrowernumber};
358 # That'll save a database query.
359 my ( $resfound, $resrec, undef ) =
360 CheckReserves( $itemnumber );
361 if ( $resfound and not $ignoreRs ) {
362 $resrec->{'ResFound'} = $resfound;
364 # $messages->{'ResFound'} = $resrec;
368 #actually do the transfer....
370 ModItemTransfer( $itemnumber, $fbr, $tbr );
372 # don't need to update MARC anymore, we do it in batch now
373 $messages->{'WasTransfered'} = 1;
376 ModDateLastSeen( $itemnumber );
377 return ( $dotransfer, $messages, $biblio );
382 my $borrower = shift;
383 my $biblionumber = shift;
386 my $onsite_checkout = $params->{onsite_checkout} || 0;
387 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
388 my $cat_borrower = $borrower->{'categorycode'};
389 my $dbh = C4::Context->dbh;
391 # Get which branchcode we need
392 $branch = _GetCircControlBranch($item,$borrower);
393 my $type = (C4::Context->preference('item-level_itypes'))
394 ? $item->{'itype'} # item-level
395 : $item->{'itemtype'}; # biblio-level
397 # given branch, patron category, and item type, determine
398 # applicable issuing rule
399 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
400 { categorycode => $cat_borrower,
402 branchcode => $branch
407 # if a rule is found and has a loan limit set, count
408 # how many loans the patron already has that meet that
410 if (defined($issuing_rule) and defined($issuing_rule->maxissueqty)) {
413 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
415 JOIN items USING (itemnumber)
418 my $rule_itemtype = $issuing_rule->itemtype;
419 if ($rule_itemtype eq "*") {
420 # matching rule has the default item type, so count only
421 # those existing loans that don't fall under a more
423 if (C4::Context->preference('item-level_itypes')) {
424 $count_query .= " WHERE items.itype NOT IN (
425 SELECT itemtype FROM issuingrules
427 AND (categorycode = ? OR categorycode = ?)
431 $count_query .= " JOIN biblioitems USING (biblionumber)
432 WHERE biblioitems.itemtype NOT IN (
433 SELECT itemtype FROM issuingrules
435 AND (categorycode = ? OR categorycode = ?)
439 push @bind_params, $issuing_rule->branchcode;
440 push @bind_params, $issuing_rule->categorycode;
441 push @bind_params, $cat_borrower;
443 # rule has specific item type, so count loans of that
445 if (C4::Context->preference('item-level_itypes')) {
446 $count_query .= " WHERE items.itype = ? ";
448 $count_query .= " JOIN biblioitems USING (biblionumber)
449 WHERE biblioitems.itemtype= ? ";
451 push @bind_params, $type;
454 $count_query .= " AND borrowernumber = ? ";
455 push @bind_params, $borrower->{'borrowernumber'};
456 my $rule_branch = $issuing_rule->branchcode;
457 if ($rule_branch ne "*") {
458 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
459 $count_query .= " AND issues.branchcode = ? ";
460 push @bind_params, $branch;
461 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
462 ; # if branch is the patron's home branch, then count all loans by patron
464 $count_query .= " AND items.homebranch = ? ";
465 push @bind_params, $branch;
469 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
471 my $max_checkouts_allowed = $issuing_rule->maxissueqty;
472 my $max_onsite_checkouts_allowed = $issuing_rule->maxonsiteissueqty;
474 if ( $onsite_checkout ) {
475 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
477 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
478 count => $onsite_checkout_count,
479 max_allowed => $max_onsite_checkouts_allowed,
483 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
484 my $delta = $switch_onsite_checkout ? 1 : 0;
485 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
487 reason => 'TOO_MANY_CHECKOUTS',
488 count => $checkout_count,
489 max_allowed => $max_checkouts_allowed,
492 } elsif ( not $onsite_checkout ) {
493 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
495 reason => 'TOO_MANY_CHECKOUTS',
496 count => $checkout_count - $onsite_checkout_count,
497 max_allowed => $max_checkouts_allowed,
503 # Now count total loans against the limit for the branch
504 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
505 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
506 my @bind_params = ();
507 my $branch_count_query = q|
508 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
510 JOIN items USING (itemnumber)
511 WHERE borrowernumber = ?
513 push @bind_params, $borrower->{borrowernumber};
515 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
516 $branch_count_query .= " AND issues.branchcode = ? ";
517 push @bind_params, $branch;
518 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
519 ; # if branch is the patron's home branch, then count all loans by patron
521 $branch_count_query .= " AND items.homebranch = ? ";
522 push @bind_params, $branch;
524 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
525 my $max_checkouts_allowed = $branch_borrower_circ_rule->{maxissueqty};
526 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{maxonsiteissueqty};
528 if ( $onsite_checkout ) {
529 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
531 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
532 count => $onsite_checkout_count,
533 max_allowed => $max_onsite_checkouts_allowed,
537 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
538 my $delta = $switch_onsite_checkout ? 1 : 0;
539 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
541 reason => 'TOO_MANY_CHECKOUTS',
542 count => $checkout_count,
543 max_allowed => $max_checkouts_allowed,
546 } elsif ( not $onsite_checkout ) {
547 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
549 reason => 'TOO_MANY_CHECKOUTS',
550 count => $checkout_count - $onsite_checkout_count,
551 max_allowed => $max_checkouts_allowed,
557 if ( not defined( $issuing_rule ) and not defined($branch_borrower_circ_rule->{maxissueqty}) ) {
558 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
561 # OK, the patron can issue !!!
565 =head2 CanBookBeIssued
567 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
568 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
570 Check if a book can be issued.
572 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
576 =item C<$borrower> hash with borrower informations (from GetMember)
578 =item C<$barcode> is the bar code of the book being issued.
580 =item C<$duedates> is a DateTime object.
582 =item C<$inprocess> boolean switch
584 =item C<$ignore_reserves> boolean switch
586 =item C<$params> Hashref of additional parameters
589 override_high_holds - Ignore high holds
590 onsite_checkout - Checkout is an onsite checkout that will not leave the library
598 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
599 Possible values are :
605 sticky due date is invalid
609 borrower gone with no address
613 borrower declared it's card lost
619 =head3 UNKNOWN_BARCODE
633 item is restricted (set by ??)
635 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
636 could be prevented, but ones that can be overriden by the operator.
638 Possible values are :
646 renewing, not issuing
648 =head3 ISSUED_TO_ANOTHER
650 issued to someone else.
654 reserved for someone else.
658 sticky due date is invalid or due date in the past
662 if the borrower borrows to much things
666 sub CanBookBeIssued {
667 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
668 my %needsconfirmation; # filled with problems that needs confirmations
669 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
670 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
671 my %messages; # filled with information messages that should be displayed.
673 my $onsite_checkout = $params->{onsite_checkout} || 0;
674 my $override_high_holds = $params->{override_high_holds} || 0;
676 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
677 my $issue = GetItemIssue($item->{itemnumber});
678 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
679 $item->{'itemtype'}=$item->{'itype'};
680 my $dbh = C4::Context->dbh;
682 # MANDATORY CHECKS - unless item exists, nothing else matters
683 unless ( $item->{barcode} ) {
684 $issuingimpossible{UNKNOWN_BARCODE} = 1;
686 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
689 # DUE DATE is OK ? -- should already have checked.
691 if ($duedate && ref $duedate ne 'DateTime') {
692 $duedate = dt_from_string($duedate);
694 my $now = DateTime->now( time_zone => C4::Context->tz() );
695 unless ( $duedate ) {
696 my $issuedate = $now->clone();
698 my $branch = _GetCircControlBranch($item,$borrower);
699 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
700 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
702 # Offline circ calls AddIssue directly, doesn't run through here
703 # So issuingimpossible should be ok.
706 my $today = $now->clone();
707 $today->truncate( to => 'minute');
708 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
709 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
712 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
718 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
719 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
721 branch => C4::Context->userenv->{'branch'},
723 itemnumber => $item->{'itemnumber'},
724 itemtype => $item->{'itype'},
725 borrowernumber => $borrower->{'borrowernumber'},
726 ccode => $item->{'ccode'}}
728 ModDateLastSeen( $item->{'itemnumber'} );
729 return( { STATS => 1 }, {});
732 my $flags = C4::Members::patronflags( $borrower );
734 if ( $flags->{GNA} ) {
735 $issuingimpossible{GNA} = 1;
737 if ( $flags->{'LOST'} ) {
738 $issuingimpossible{CARD_LOST} = 1;
740 if ( $flags->{'DBARRED'} ) {
741 $issuingimpossible{DEBARRED} = 1;
744 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
745 $issuingimpossible{EXPIRED} = 1;
747 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'sql', 'floating' );
748 $expiry_dt->truncate( to => 'day');
749 my $today = $now->clone()->truncate(to => 'day');
750 $today->set_time_zone( 'floating' );
751 if ( DateTime->compare($today, $expiry_dt) == 1 ) {
752 $issuingimpossible{EXPIRED} = 1;
761 my ($balance, $non_issue_charges, $other_charges) =
762 C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
764 my $amountlimit = C4::Context->preference("noissuescharge");
765 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
766 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
768 # Check the debt of this patrons guarantees
769 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
770 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
771 if ( defined $no_issues_charge_guarantees ) {
772 my $p = Koha::Patrons->find( $borrower->{borrowernumber} );
773 my @guarantees = $p->guarantees();
774 my $guarantees_non_issues_charges;
775 foreach my $g ( @guarantees ) {
776 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
777 $guarantees_non_issues_charges += $n;
780 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
781 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
782 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
783 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
784 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
785 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
789 if ( C4::Context->preference("IssuingInProcess") ) {
790 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
791 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
792 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
793 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
794 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
795 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
799 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
800 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
801 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
802 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
803 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
804 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
808 if ($balance > 0 && $other_charges > 0) {
809 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
812 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
813 if ( my $debarred_date = $patron->is_debarred ) {
814 # patron has accrued fine days or has a restriction. $count is a date
815 if ($debarred_date eq '9999-12-31') {
816 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
819 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
821 } elsif ( my $num_overdues = $patron->has_overdues ) {
822 ## patron has outstanding overdue loans
823 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
824 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
826 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
827 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
831 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
833 my $switch_onsite_checkout = (
834 C4::Context->preference('SwitchOnSiteCheckouts')
835 and $issue->{onsite_checkout}
837 and $issue->{borrowernumber} == $borrower->{'borrowernumber'} ? 1 : 0 );
838 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
839 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
841 if ( $toomany->{max_allowed} == 0 ) {
842 $needsconfirmation{PATRON_CANT} = 1;
844 if ( C4::Context->preference("AllowTooManyOverride") ) {
845 $needsconfirmation{TOO_MANY} = $toomany->{reason};
846 $needsconfirmation{current_loan_count} = $toomany->{count};
847 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
849 $issuingimpossible{TOO_MANY} = $toomany->{reason};
850 $issuingimpossible{current_loan_count} = $toomany->{count};
851 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
856 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
858 $patron = Koha::Patrons->find($borrower->{borrowernumber});
859 my $wants_check = $patron->wants_check_for_previous_checkout;
860 $needsconfirmation{PREVISSUE} = 1
861 if ($wants_check and $patron->do_check_for_previous_checkout($item));
866 if ( $item->{'notforloan'} )
868 if(!C4::Context->preference("AllowNotForLoanOverride")){
869 $issuingimpossible{NOT_FOR_LOAN} = 1;
870 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
872 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
873 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
877 # we have to check itemtypes.notforloan also
878 if (C4::Context->preference('item-level_itypes')){
879 # this should probably be a subroutine
880 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
881 $sth->execute($item->{'itemtype'});
882 my $notforloan=$sth->fetchrow_hashref();
883 if ($notforloan->{'notforloan'}) {
884 if (!C4::Context->preference("AllowNotForLoanOverride")) {
885 $issuingimpossible{NOT_FOR_LOAN} = 1;
886 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
888 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
889 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
893 elsif ($biblioitem->{'notforloan'} == 1){
894 if (!C4::Context->preference("AllowNotForLoanOverride")) {
895 $issuingimpossible{NOT_FOR_LOAN} = 1;
896 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
898 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
899 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
903 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
905 $issuingimpossible{WTHDRAWN} = 1;
907 if ( $item->{'restricted'}
908 && $item->{'restricted'} == 1 )
910 $issuingimpossible{RESTRICTED} = 1;
912 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
913 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->{itemlost} });
914 my $code = $av->count ? $av->next->lib : '';
915 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
916 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
918 if ( C4::Context->preference("IndependentBranches") ) {
919 my $userenv = C4::Context->userenv;
920 unless ( C4::Context->IsSuperLibrarian() ) {
921 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
922 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
923 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
925 $needsconfirmation{BORRNOTSAMEBRANCH} = $borrower->{'branchcode'}
926 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
930 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
932 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
934 if ( $rentalConfirmation ){
935 my ($rentalCharge) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
936 if ( $rentalCharge > 0 ){
937 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
942 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
944 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} ){
946 # Already issued to current borrower.
947 # If it is an on-site checkout if it can be switched to a normal checkout
948 # or ask whether the loan should be renewed
950 if ( $issue->{onsite_checkout}
951 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
952 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
954 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
955 $borrower->{'borrowernumber'},
956 $item->{'itemnumber'},
958 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
959 if ( $renewerror eq 'onsite_checkout' ) {
960 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
963 $issuingimpossible{NO_MORE_RENEWALS} = 1;
967 $needsconfirmation{RENEW_ISSUE} = 1;
971 elsif ($issue->{borrowernumber}) {
973 # issued to someone else
974 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
977 my ( $can_be_returned, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
979 unless ( $can_be_returned ) {
980 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
981 $issuingimpossible{branch_to_return} = $message;
983 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
984 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
985 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
986 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
987 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
991 unless ( $ignore_reserves ) {
992 # See if the item is on reserve.
993 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
995 my $resbor = $res->{'borrowernumber'};
996 if ( $resbor ne $borrower->{'borrowernumber'} ) {
997 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
998 if ( $restype eq "Waiting" )
1000 # The item is on reserve and waiting, but has been
1001 # reserved by some other patron.
1002 $needsconfirmation{RESERVE_WAITING} = 1;
1003 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1004 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1005 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1006 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1007 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1008 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1010 elsif ( $restype eq "Reserved" ) {
1011 # The item is on reserve for someone else.
1012 $needsconfirmation{RESERVED} = 1;
1013 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1014 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1015 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1016 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1017 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1018 $needsconfirmation{'resreservedate'} = $res->{'reservedate'};
1024 ## CHECK AGE RESTRICTION
1025 my $agerestriction = $biblioitem->{'agerestriction'};
1026 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $borrower );
1027 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1028 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1029 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1032 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1036 ## check for high holds decreasing loan period
1037 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1038 my $check = checkHighHolds( $item, $borrower );
1040 if ( $check->{exceeded} ) {
1041 if ($override_high_holds) {
1042 $alerts{HIGHHOLDS} = {
1043 num_holds => $check->{outstanding},
1044 duration => $check->{duration},
1045 returndate => output_pref( $check->{due_date} ),
1049 $needsconfirmation{HIGHHOLDS} = {
1050 num_holds => $check->{outstanding},
1051 duration => $check->{duration},
1052 returndate => output_pref( $check->{due_date} ),
1059 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1060 # don't do the multiple loans per bib check if we've
1061 # already determined that we've got a loan on the same item
1062 !$issuingimpossible{NO_MORE_RENEWALS} &&
1063 !$needsconfirmation{RENEW_ISSUE}
1065 # Check if borrower has already issued an item from the same biblio
1066 # Only if it's not a subscription
1067 my $biblionumber = $item->{biblionumber};
1068 require C4::Serials;
1069 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1070 unless ($is_a_subscription) {
1071 my $checkouts = Koha::Checkouts->search(
1073 borrowernumber => $borrower->{borrowernumber},
1074 biblionumber => $biblionumber,
1080 # if we get here, we don't already have a loan on this item,
1081 # so if there are any loans on this bib, ask for confirmation
1082 if ( $checkouts->count ) {
1083 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1088 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1091 =head2 CanBookBeReturned
1093 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1095 Check whether the item can be returned to the provided branch
1099 =item C<$item> is a hash of item information as returned from GetItem
1101 =item C<$branch> is the branchcode where the return is taking place
1109 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1111 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1117 sub CanBookBeReturned {
1118 my ($item, $branch) = @_;
1119 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1121 # assume return is allowed to start
1125 # identify all cases where return is forbidden
1126 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1128 $message = $item->{'homebranch'};
1129 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1131 $message = $item->{'holdingbranch'};
1132 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1134 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1137 return ($allowed, $message);
1140 =head2 CheckHighHolds
1142 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1143 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1144 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1148 sub checkHighHolds {
1149 my ( $item, $borrower ) = @_;
1150 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1151 my $branch = _GetCircControlBranch( $item, $borrower );
1160 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1162 if ( $holds->count() ) {
1163 $return_data->{outstanding} = $holds->count();
1165 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1166 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1167 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1169 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1171 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1173 # static means just more than a given number of holds on the record
1175 # If the number of holds is less than the threshold, we can stop here
1176 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1177 return $return_data;
1180 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1182 # dynamic means X more than the number of holdable items on the record
1184 # let's get the items
1185 my @items = $holds->next()->biblio()->items();
1187 # Remove any items with status defined to be ignored even if the would not make item unholdable
1188 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1189 @items = grep { !$_->$status } @items;
1192 # Remove any items that are not holdable for this patron
1193 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber ) eq 'OK' } @items;
1195 my $items_count = scalar @items;
1197 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1199 # If the number of holds is less than the count of items we have
1200 # plus the number of holds allowed above that count, we can stop here
1201 if ( $holds->count() <= $threshold ) {
1202 return $return_data;
1206 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1208 my $calendar = Koha::Calendar->new( branchcode => $branch );
1211 ( C4::Context->preference('item-level_itypes') )
1212 ? $biblio->{'itype'}
1213 : $biblio->{'itemtype'};
1215 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1217 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1219 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1220 $reduced_datedue->set_hour($orig_due->hour);
1221 $reduced_datedue->set_minute($orig_due->minute);
1222 $reduced_datedue->truncate( to => 'minute' );
1224 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1225 $return_data->{exceeded} = 1;
1226 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1227 $return_data->{due_date} = $reduced_datedue;
1231 return $return_data;
1236 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1238 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1242 =item C<$borrower> is a hash with borrower informations (from GetMember).
1244 =item C<$barcode> is the barcode of the item being issued.
1246 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1247 Calculated if empty.
1249 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1251 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1252 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1254 AddIssue does the following things :
1256 - step 01: check that there is a borrowernumber & a barcode provided
1257 - check for RENEWAL (book issued & being issued to the same patron)
1258 - renewal YES = Calculate Charge & renew
1260 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1262 - fill reserve if reserve to this patron
1263 - cancel reserve or not, otherwise
1264 * TRANSFERT PENDING ?
1265 - complete the transfert
1273 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1275 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1276 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1277 my $auto_renew = $params && $params->{auto_renew};
1278 my $dbh = C4::Context->dbh;
1279 my $barcodecheck = CheckValidBarcode($barcode);
1283 if ( $datedue && ref $datedue ne 'DateTime' ) {
1284 $datedue = dt_from_string($datedue);
1287 # $issuedate defaults to today.
1288 if ( !defined $issuedate ) {
1289 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1292 if ( ref $issuedate ne 'DateTime' ) {
1293 $issuedate = dt_from_string($issuedate);
1298 # Stop here if the patron or barcode doesn't exist
1299 if ( $borrower && $barcode && $barcodecheck ) {
1300 # find which item we issue
1301 my $item = GetItem( '', $barcode )
1302 or return; # if we don't get an Item, abort.
1304 my $branch = _GetCircControlBranch( $item, $borrower );
1306 # get actual issuing if there is one
1307 my $actualissue = GetItemIssue( $item->{itemnumber} );
1309 # get biblioinformation for this item
1310 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1312 # check if we just renew the issue.
1313 if ( $actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}
1314 and not $switch_onsite_checkout ) {
1315 $datedue = AddRenewal(
1316 $borrower->{'borrowernumber'},
1317 $item->{'itemnumber'},
1320 $issuedate, # here interpreted as the renewal date
1324 # it's NOT a renewal
1325 if ( $actualissue->{borrowernumber}
1326 and not $switch_onsite_checkout ) {
1327 # This book is currently on loan, but not to the person
1328 # who wants to borrow it now. mark it returned before issuing to the new borrower
1329 my ( $allowed, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
1330 return unless $allowed;
1331 AddReturn( $item->{'barcode'}, C4::Context->userenv->{'branch'} );
1334 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1336 # Starting process for transfer job (checking transfert and validate it if we have one)
1337 my ($datesent) = GetTransfers( $item->{'itemnumber'} );
1339 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1340 my $sth = $dbh->prepare(
1341 "UPDATE branchtransfers
1342 SET datearrived = now(),
1344 comments = 'Forced branchtransfer'
1345 WHERE itemnumber= ? AND datearrived IS NULL"
1347 $sth->execute( C4::Context->userenv->{'branch'},
1348 $item->{'itemnumber'} );
1351 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1352 unless ($auto_renew) {
1353 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1354 { categorycode => $borrower->{categorycode},
1355 itemtype => $item->{itype},
1356 branchcode => $branch
1360 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1363 # Record in the database the fact that the book was issued.
1366 ( C4::Context->preference('item-level_itypes') )
1367 ? $biblio->{'itype'}
1368 : $biblio->{'itemtype'};
1369 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1372 $datedue->truncate( to => 'minute' );
1374 $issue = Koha::Database->new()->schema()->resultset('Issue')->update_or_create(
1376 borrowernumber => $borrower->{'borrowernumber'},
1377 itemnumber => $item->{'itemnumber'},
1378 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1379 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1380 branchcode => C4::Context->userenv->{'branch'},
1381 onsite_checkout => $onsite_checkout,
1382 auto_renew => $auto_renew ? 1 : 0
1386 if ( C4::Context->preference('ReturnToShelvingCart') ) {
1387 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1388 CartToShelf( $item->{'itemnumber'} );
1390 $item->{'issues'}++;
1391 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1392 UpdateTotalIssues( $item->{'biblionumber'}, 1 );
1395 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1396 if ( $item->{'itemlost'} ) {
1398 Koha::RefundLostItemFeeRules->should_refund(
1400 current_branch => C4::Context->userenv->{branch},
1401 item_home_branch => $item->{homebranch},
1402 item_holding_branch => $item->{holdingbranch}
1407 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef,
1408 $item->{'barcode'} );
1414 issues => $item->{'issues'},
1415 holdingbranch => C4::Context->userenv->{'branch'},
1417 onloan => $datedue->ymd(),
1418 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1420 $item->{'biblionumber'},
1421 $item->{'itemnumber'}
1423 ModDateLastSeen( $item->{'itemnumber'} );
1425 # If it costs to borrow this book, charge it to the patron's account.
1426 my ( $charge, $itemtype ) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1427 if ( $charge > 0 ) {
1428 AddIssuingCharge( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $charge );
1429 $item->{'charge'} = $charge;
1432 # Record the fact that this book was issued.
1435 branch => C4::Context->userenv->{'branch'},
1436 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1438 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1439 itemnumber => $item->{'itemnumber'},
1440 itemtype => $item->{'itype'},
1441 borrowernumber => $borrower->{'borrowernumber'},
1442 ccode => $item->{'ccode'}
1446 # Send a checkout slip.
1447 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1449 branchcode => $branch,
1450 categorycode => $borrower->{categorycode},
1451 item_type => $item->{itype},
1452 notification => 'CHECKOUT',
1454 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1455 SendCirculationAlert(
1459 borrower => $borrower,
1467 "CIRCULATION", "ISSUE",
1468 $borrower->{'borrowernumber'},
1469 $biblio->{'itemnumber'}
1470 ) if C4::Context->preference("IssueLog");
1475 =head2 GetLoanLength
1477 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1479 Get loan length for an itemtype, a borrower type and a branch
1484 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1485 my $dbh = C4::Context->dbh;
1486 my $sth = $dbh->prepare(qq{
1487 SELECT issuelength, lengthunit, renewalperiod
1489 WHERE categorycode=?
1492 AND issuelength IS NOT NULL
1495 # try to find issuelength & return the 1st available.
1496 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1497 $sth->execute( $borrowertype, $itemtype, $branchcode );
1498 my $loanlength = $sth->fetchrow_hashref;
1501 if defined($loanlength) && defined $loanlength->{issuelength};
1503 $sth->execute( $borrowertype, '*', $branchcode );
1504 $loanlength = $sth->fetchrow_hashref;
1506 if defined($loanlength) && defined $loanlength->{issuelength};
1508 $sth->execute( '*', $itemtype, $branchcode );
1509 $loanlength = $sth->fetchrow_hashref;
1511 if defined($loanlength) && defined $loanlength->{issuelength};
1513 $sth->execute( '*', '*', $branchcode );
1514 $loanlength = $sth->fetchrow_hashref;
1516 if defined($loanlength) && defined $loanlength->{issuelength};
1518 $sth->execute( $borrowertype, $itemtype, '*' );
1519 $loanlength = $sth->fetchrow_hashref;
1521 if defined($loanlength) && defined $loanlength->{issuelength};
1523 $sth->execute( $borrowertype, '*', '*' );
1524 $loanlength = $sth->fetchrow_hashref;
1526 if defined($loanlength) && defined $loanlength->{issuelength};
1528 $sth->execute( '*', $itemtype, '*' );
1529 $loanlength = $sth->fetchrow_hashref;
1531 if defined($loanlength) && defined $loanlength->{issuelength};
1533 $sth->execute( '*', '*', '*' );
1534 $loanlength = $sth->fetchrow_hashref;
1536 if defined($loanlength) && defined $loanlength->{issuelength};
1538 # if no rule is set => 0 day (hardcoded)
1542 lengthunit => 'days',
1548 =head2 GetHardDueDate
1550 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1552 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1556 sub GetHardDueDate {
1557 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1559 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1560 { categorycode => $borrowertype,
1561 itemtype => $itemtype,
1562 branchcode => $branchcode
1567 if ( defined( $issuing_rule ) ) {
1568 if ( $issuing_rule->hardduedate ) {
1569 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1571 return (undef, undef);
1576 =head2 GetBranchBorrowerCircRule
1578 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1580 Retrieves circulation rule attributes that apply to the given
1581 branch and patron category, regardless of item type.
1582 The return value is a hashref containing the following key:
1584 maxissueqty - maximum number of loans that a
1585 patron of the given category can have at the given
1586 branch. If the value is undef, no limit.
1588 maxonsiteissueqty - maximum of on-site checkouts that a
1589 patron of the given category can have at the given
1590 branch. If the value is undef, no limit.
1592 This will first check for a specific branch and
1593 category match from branch_borrower_circ_rules.
1595 If no rule is found, it will then check default_branch_circ_rules
1596 (same branch, default category). If no rule is found,
1597 it will then check default_borrower_circ_rules (default
1598 branch, same category), then failing that, default_circ_rules
1599 (default branch, default category).
1601 If no rule has been found in the database, it will default to
1605 maxonsiteissueqty - undef
1607 C<$branchcode> and C<$categorycode> should contain the
1608 literal branch code and patron category code, respectively - no
1613 sub GetBranchBorrowerCircRule {
1614 my ( $branchcode, $categorycode ) = @_;
1617 my $dbh = C4::Context->dbh();
1618 $rules = $dbh->selectrow_hashref( q|
1619 SELECT maxissueqty, maxonsiteissueqty
1620 FROM branch_borrower_circ_rules
1621 WHERE branchcode = ?
1622 AND categorycode = ?
1623 |, {}, $branchcode, $categorycode ) ;
1624 return $rules if $rules;
1626 # try same branch, default borrower category
1627 $rules = $dbh->selectrow_hashref( q|
1628 SELECT maxissueqty, maxonsiteissueqty
1629 FROM default_branch_circ_rules
1630 WHERE branchcode = ?
1631 |, {}, $branchcode ) ;
1632 return $rules if $rules;
1634 # try default branch, same borrower category
1635 $rules = $dbh->selectrow_hashref( q|
1636 SELECT maxissueqty, maxonsiteissueqty
1637 FROM default_borrower_circ_rules
1638 WHERE categorycode = ?
1639 |, {}, $categorycode ) ;
1640 return $rules if $rules;
1642 # try default branch, default borrower category
1643 $rules = $dbh->selectrow_hashref( q|
1644 SELECT maxissueqty, maxonsiteissueqty
1645 FROM default_circ_rules
1647 return $rules if $rules;
1649 # built-in default circulation rule
1651 maxissueqty => undef,
1652 maxonsiteissueqty => undef,
1656 =head2 GetBranchItemRule
1658 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1660 Retrieves circulation rule attributes that apply to the given
1661 branch and item type, regardless of patron category.
1663 The return value is a hashref containing the following keys:
1665 holdallowed => Hold policy for this branch and itemtype. Possible values:
1666 0: No holds allowed.
1667 1: Holds allowed only by patrons that have the same homebranch as the item.
1668 2: Holds allowed from any patron.
1670 returnbranch => branch to which to return item. Possible values:
1671 noreturn: do not return, let item remain where checked in (floating collections)
1672 homebranch: return to item's home branch
1673 holdingbranch: return to issuer branch
1675 This searches branchitemrules in the following order:
1677 * Same branchcode and itemtype
1678 * Same branchcode, itemtype '*'
1679 * branchcode '*', same itemtype
1680 * branchcode and itemtype '*'
1682 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1686 sub GetBranchItemRule {
1687 my ( $branchcode, $itemtype ) = @_;
1688 my $dbh = C4::Context->dbh();
1692 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1693 FROM branch_item_rules
1694 WHERE branchcode = ?
1695 AND itemtype = ?', $branchcode, $itemtype],
1696 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1697 FROM default_branch_circ_rules
1698 WHERE branchcode = ?', $branchcode],
1699 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1700 FROM default_branch_item_rules
1701 WHERE itemtype = ?', $itemtype],
1702 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1703 FROM default_circ_rules'],
1706 foreach my $attempt (@attempts) {
1707 my ($query, @bind_params) = @{$attempt};
1708 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1711 # Since branch/category and branch/itemtype use the same per-branch
1712 # defaults tables, we have to check that the key we want is set, not
1713 # just that a row was returned
1714 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1715 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1716 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1719 # built-in default circulation rule
1720 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1721 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1722 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1729 ($doreturn, $messages, $iteminformation, $borrower) =
1730 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1736 =item C<$barcode> is the bar code of the book being returned.
1738 =item C<$branch> is the code of the branch where the book is being returned.
1740 =item C<$exemptfine> indicates that overdue charges for the item will be
1743 =item C<$dropbox> indicates that the check-in date is assumed to be
1744 yesterday, or the last non-holiday as defined in C4::Calendar . If
1745 overdue charges are applied and C<$dropbox> is true, the last charge
1746 will be removed. This assumes that the fines accrual script has run
1747 for _today_. Optional.
1749 =item C<$return_date> allows the default return date to be overridden
1750 by the given return date. Optional.
1754 C<&AddReturn> returns a list of four items:
1756 C<$doreturn> is true iff the return succeeded.
1758 C<$messages> is a reference-to-hash giving feedback on the operation.
1759 The keys of the hash are:
1765 No item with this barcode exists. The value is C<$barcode>.
1769 The book is not currently on loan. The value is C<$barcode>.
1771 =item C<IsPermanent>
1773 The book's home branch is a permanent collection. If you have borrowed
1774 this book, you are not allowed to return it. The value is the code for
1775 the book's home branch.
1779 This book has been withdrawn/cancelled. The value should be ignored.
1781 =item C<Wrongbranch>
1783 This book has was returned to the wrong branch. The value is a hashref
1784 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1785 contain the branchcode of the incorrect and correct return library, respectively.
1789 The item was reserved. The value is a reference-to-hash whose keys are
1790 fields from the reserves table of the Koha database, and
1791 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1792 either C<Waiting>, C<Reserved>, or 0.
1794 =item C<WasReturned>
1796 Value 1 if return is successful.
1798 =item C<NeedsTransfer>
1800 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1804 C<$iteminformation> is a reference-to-hash, giving information about the
1805 returned item from the issues table.
1807 C<$borrower> is a reference-to-hash, giving information about the
1808 patron who last borrowed the book.
1813 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1815 if ($branch and not Koha::Libraries->find($branch)) {
1816 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1819 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1823 my $validTransfert = 0;
1824 my $stat_type = 'return';
1826 # get information on item
1827 my $item = GetItem( undef, $barcode );
1829 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1832 my $itemnumber = $item->{ itemnumber };
1834 my $item_level_itypes = C4::Context->preference("item-level_itypes");
1835 my $biblio = $item_level_itypes ? undef : GetBiblioData( $item->{ biblionumber } ); # don't get bib data unless we need it
1836 my $itemtype = $item_level_itypes ? $item->{itype} : $biblio->{itemtype};
1838 my $issue = GetItemIssue($itemnumber);
1839 if ($issue and $issue->{borrowernumber}) {
1840 $borrower = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} )
1841 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '$issue->{borrowernumber}'\n"
1842 . Dumper($issue) . "\n";
1844 $messages->{'NotIssued'} = $barcode;
1845 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1847 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1848 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1849 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1850 $messages->{'LocalUse'} = 1;
1851 $stat_type = 'localuse';
1855 if ( $item->{'location'} eq 'PROC' ) {
1856 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1857 $item->{'location'} = 'CART';
1860 $item->{location} = $item->{permanent_location};
1863 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
1866 # full item data, but no borrowernumber or checkout info (no issue)
1867 # we know GetItem should work because GetItemnumberFromBarcode worked
1868 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1869 # get the proper branch to which to return the item
1870 my $returnbranch = $item->{$hbr} || $branch ;
1871 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1873 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1875 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1877 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1879 eval { $rules = YAML::Load($yaml); };
1881 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1884 foreach my $key ( keys %$rules ) {
1885 if ( $item->{notforloan} eq $key ) {
1886 $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1887 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1895 # check if the book is in a permanent collection....
1896 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1897 if ( $returnbranch ) {
1898 my $library = Koha::Libraries->find($returnbranch);
1899 if ( $library and $library->get_categories->search({'me.categorycode' => 'PE'})->count ) {
1900 $messages->{'IsPermanent'} = $returnbranch;
1904 # check if the return is allowed at this branch
1905 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1906 unless ($returnallowed){
1907 $messages->{'Wrongbranch'} = {
1908 Wrongbranch => $branch,
1909 Rightbranch => $message
1912 return ( $doreturn, $messages, $issue, $borrower );
1915 if ( $item->{'withdrawn'} ) { # book has been cancelled
1916 $messages->{'withdrawn'} = 1;
1917 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1920 # case of a return of document (deal with issues and holdingbranch)
1921 my $today = DateTime->now( time_zone => C4::Context->tz() );
1924 my $datedue = $issue->{date_due};
1925 $borrower or warn "AddReturn without current borrower";
1926 my $circControlBranch;
1928 # define circControlBranch only if dropbox mode is set
1929 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1930 # FIXME: check issuedate > returndate, factoring in holidays
1932 $circControlBranch = _GetCircControlBranch($item,$borrower);
1933 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $dropboxdate ) == -1 ? 1 : 0;
1936 if ($borrowernumber) {
1938 my $issue_id = MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1939 $circControlBranch, $return_date, $borrower->{'privacy'} );
1940 $issue->{issue_id} = $issue_id;
1943 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'} ) || $return_date ) {
1944 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $borrower, return_date => $return_date } );
1947 $messages->{'Wrongbranch'} = {
1948 Wrongbranch => $branch,
1949 Rightbranch => $message
1952 return ( 0, { WasReturned => 0 }, $issue, $borrower );
1955 # FIXME is the "= 1" right? This could be the borrower hash.
1956 $messages->{'WasReturned'} = 1;
1960 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1963 # the holdingbranch is updated if the document is returned to another location.
1964 # this is always done regardless of whether the item was on loan or not
1965 my $item_holding_branch = $item->{ holdingbranch };
1966 if ($item->{'holdingbranch'} ne $branch) {
1967 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1968 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1970 ModDateLastSeen( $item->{'itemnumber'} );
1972 # check if we have a transfer for this document
1973 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1975 # if we have a transfer to do, we update the line of transfers with the datearrived
1976 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1978 if ( $tobranch eq $branch ) {
1979 my $sth = C4::Context->dbh->prepare(
1980 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1982 $sth->execute( $item->{'itemnumber'} );
1983 # if we have a reservation with valid transfer, we can set it's status to 'W'
1984 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1985 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1987 $messages->{'WrongTransfer'} = $tobranch;
1988 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1990 $validTransfert = 1;
1992 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1995 # fix up the accounts.....
1996 if ( $item->{'itemlost'} ) {
1997 $messages->{'WasLost'} = 1;
1999 if ( $item->{'itemlost'} ) {
2001 Koha::RefundLostItemFeeRules->should_refund(
2003 current_branch => C4::Context->userenv->{branch},
2004 item_home_branch => $item->{homebranch},
2005 item_holding_branch => $item_holding_branch
2010 _FixAccountForLostAndReturned( $item->{'itemnumber'}, $borrowernumber, $barcode );
2011 $messages->{'LostItemFeeRefunded'} = 1;
2016 # fix up the overdues in accounts...
2017 if ($borrowernumber) {
2018 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
2019 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
2021 if ( $issue->{overdue} && $issue->{date_due} ) {
2023 $today = $dropboxdate if $dropbox;
2024 my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
2026 $messages->{'PrevDebarred'} = $debardate;
2028 $messages->{'Debarred'} = $debardate if $debardate;
2030 # there's no overdue on the item but borrower had been previously debarred
2031 } elsif ( $issue->{date_due} and $borrower->{'debarred'} ) {
2032 if ( $borrower->{debarred} eq "9999-12-31") {
2033 $messages->{'ForeverDebarred'} = $borrower->{'debarred'};
2035 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2036 $borrower_debar_dt->truncate(to => 'day');
2037 my $today_dt = $today->clone()->truncate(to => 'day');
2038 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2039 $messages->{'PrevDebarred'} = $borrower->{'debarred'};
2045 # find reserves.....
2046 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2047 my ($resfound, $resrec);
2048 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2049 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2051 $resrec->{'ResFound'} = $resfound;
2052 $messages->{'ResFound'} = $resrec;
2055 # Record the fact that this book was returned.
2059 itemnumber => $itemnumber,
2060 itemtype => $itemtype,
2061 borrowernumber => $borrowernumber,
2062 ccode => $item->{ ccode }
2065 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
2066 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2068 branchcode => $branch,
2069 categorycode => $borrower->{categorycode},
2070 item_type => $item->{itype},
2071 notification => 'CHECKIN',
2073 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2074 SendCirculationAlert({
2077 borrower => $borrower,
2082 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2083 if C4::Context->preference("ReturnLog");
2085 # Remove any OVERDUES related debarment if the borrower has no overdues
2086 if ( $borrowernumber
2087 && $borrower->{'debarred'}
2088 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2089 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2090 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2092 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2095 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2096 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2097 if (C4::Context->preference("AutomaticItemReturn" ) or
2098 (C4::Context->preference("UseBranchTransferLimits") and
2099 ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2101 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2102 $debug and warn "item: " . Dumper($item);
2103 ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2104 $messages->{'WasTransfered'} = 1;
2106 $messages->{'NeedsTransfer'} = $returnbranch;
2110 return ( $doreturn, $messages, $issue, $borrower );
2113 =head2 MarkIssueReturned
2115 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2117 Unconditionally marks an issue as being returned by
2118 moving the C<issues> row to C<old_issues> and
2119 setting C<returndate> to the current date, or
2120 the last non-holiday date of the branccode specified in
2121 C<dropbox_branch> . Assumes you've already checked that
2122 it's safe to do this, i.e. last non-holiday > issuedate.
2124 if C<$returndate> is specified (in iso format), it is used as the date
2125 of the return. It is ignored when a dropbox_branch is passed in.
2127 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2128 the old_issue is immediately anonymised
2130 Ideally, this function would be internal to C<C4::Circulation>,
2131 not exported, but it is currently needed by one
2132 routine in C<C4::Accounts>.
2136 sub MarkIssueReturned {
2137 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2139 my $anonymouspatron;
2140 if ( $privacy == 2 ) {
2141 # The default of 0 will not work due to foreign key constraints
2142 # The anonymisation will fail if AnonymousPatron is not a valid entry
2143 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2144 # Note that a warning should appear on the about page (System information tab).
2145 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2146 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."
2147 unless C4::Members::GetMember( borrowernumber => $anonymouspatron );
2149 my $database = Koha::Database->new();
2150 my $schema = $database->schema;
2151 my $dbh = C4::Context->dbh;
2153 my $issue_id = $dbh->selectrow_array(
2154 q|SELECT issue_id FROM issues WHERE itemnumber = ?|,
2158 my $query = 'UPDATE issues SET returndate=';
2160 if ($dropbox_branch) {
2161 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2162 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2164 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2165 } elsif ($returndate) {
2167 push @bind, $returndate;
2169 $query .= ' now() ';
2171 $query .= ' WHERE issue_id = ?';
2172 push @bind, $issue_id;
2174 # FIXME Improve the return value and handle it from callers
2175 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
2176 $schema->txn_do(sub {
2178 $dbh->do( $query, undef, @bind );
2180 C4::Context->dbh->do(q|LOCK TABLE old_issues READ|) unless $do_not_lock;
2181 C4::Context->dbh->do(q|LOCK TABLE old_issues WRITE|) unless $do_not_lock;
2183 my $original_issue_id = $issue_id;
2184 my $issue = Koha::Checkouts->find( $issue_id ); # FIXME should be fetched earlier
2186 # Create the old_issues entry
2187 my $old_checkout_data = $issue->unblessed;
2189 if ( Koha::Old::Checkouts->find( $issue_id ) ) {
2190 my $new_issue_id = Koha::Old::Checkouts->search(
2192 { columns => [ { max_issue_id => { max => 'issue_id' } } ] }
2193 )->get_column('max_issue_id') + 1;
2194 $issue_id = $new_issue_id;
2196 $old_checkout_data->{issue_id} = $issue_id;
2197 my $old_checkout = Koha::Old::Checkout->new($old_checkout_data)->store;
2199 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
2202 $dbh->do(q|UPDATE accountlines SET issue_id = ? WHERE issue_id = ?|, undef, $old_checkout->issue_id, $issue->issue_id);
2204 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2205 if ( $privacy == 2) {
2206 $dbh->do(q|UPDATE old_issues SET borrowernumber=? WHERE issue_id = ?|, undef, $anonymouspatron, $old_checkout->issue_id);
2212 ModItem( { 'onloan' => undef }, undef, $itemnumber );
2214 if ( C4::Context->preference('StoreLastBorrower') ) {
2215 my $item = Koha::Items->find( $itemnumber );
2216 my $patron = Koha::Patrons->find( $borrowernumber );
2217 $item->last_returned_by( $patron );
2224 =head2 _debar_user_on_return
2226 _debar_user_on_return($borrower, $item, $datedue, today);
2228 C<$borrower> borrower hashref
2230 C<$item> item hashref
2232 C<$datedue> date due DateTime object
2234 C<$return_date> DateTime object representing the return time
2236 Internal function, called only by AddReturn that calculates and updates
2237 the user fine days, and debars them if necessary.
2239 Should only be called for overdue returns
2243 sub _debar_user_on_return {
2244 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2246 my $branchcode = _GetCircControlBranch( $item, $borrower );
2248 my $circcontrol = C4::Context->preference('CircControl');
2249 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2250 { categorycode => $borrower->{categorycode},
2251 itemtype => $item->{itype},
2252 branchcode => $branchcode
2255 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2256 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2257 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2261 # finedays is in days, so hourly loans must multiply by 24
2262 # thus 1 hour late equals 1 day suspension * finedays rate
2263 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2265 # grace period is measured in the same units as the loan
2267 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2269 my $deltadays = DateTime::Duration->new(
2270 days => $chargeable_units
2272 if ( $deltadays->subtract($grace)->is_positive() ) {
2273 my $suspension_days = $deltadays * $finedays;
2275 # If the max suspension days is < than the suspension days
2276 # the suspension days is limited to this maximum period.
2277 my $max_sd = $issuing_rule->maxsuspensiondays;
2278 if ( defined $max_sd ) {
2279 $max_sd = DateTime::Duration->new( days => $max_sd );
2280 $suspension_days = $max_sd
2281 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2284 my ( $has_been_extended, $is_a_reminder );
2285 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2286 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2288 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2289 $has_been_extended = 1;
2294 $return_date->clone()->add_duration( $suspension_days );
2296 Koha::Patron::Debarments::AddUniqueDebarment({
2297 borrowernumber => $borrower->{borrowernumber},
2298 expiration => $new_debar_dt->ymd(),
2299 type => 'SUSPENSION',
2301 # if borrower was already debarred but does not get an extra debarment
2302 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2303 my $new_debarment_str;
2304 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2306 $new_debarment_str = $borrower->{debarred};
2308 $new_debarment_str = $new_debar_dt->ymd();
2310 # FIXME Should return a DateTime object
2311 return $new_debarment_str, $is_a_reminder;
2317 =head2 _FixOverduesOnReturn
2319 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2321 C<$brn> borrowernumber
2325 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2326 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2328 Internal function, called only by AddReturn
2332 sub _FixOverduesOnReturn {
2333 my ($borrowernumber, $item);
2334 unless ($borrowernumber = shift) {
2335 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2338 unless ($item = shift) {
2339 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2342 my ($exemptfine, $dropbox) = @_;
2343 my $dbh = C4::Context->dbh;
2345 # check for overdue fine
2346 my $sth = $dbh->prepare(
2347 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2349 $sth->execute( $borrowernumber, $item );
2351 # alter fine to show that the book has been returned
2352 my $data = $sth->fetchrow_hashref;
2353 return 0 unless $data; # no warning, there's just nothing to fix
2356 my @bind = ($data->{'accountlines_id'});
2358 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2359 if (C4::Context->preference("FinesLog")) {
2360 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2362 } elsif ($dropbox && $data->{lastincrement}) {
2363 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2364 my $amt = $data->{amount} - $data->{lastincrement} ;
2365 if (C4::Context->preference("FinesLog")) {
2366 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2368 $uquery = "update accountlines set accounttype='F' ";
2369 if($outstanding >= 0 && $amt >=0) {
2370 $uquery .= ", amount = ? , amountoutstanding=? ";
2371 unshift @bind, ($amt, $outstanding) ;
2374 $uquery = "update accountlines set accounttype='F' ";
2376 $uquery .= " where (accountlines_id = ?)";
2377 my $usth = $dbh->prepare($uquery);
2378 return $usth->execute(@bind);
2381 =head2 _FixAccountForLostAndReturned
2383 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2385 Calculates the charge for a book lost and returned.
2387 Internal function, not exported, called only by AddReturn.
2389 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2390 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2394 sub _FixAccountForLostAndReturned {
2395 my $itemnumber = shift or return;
2396 my $borrowernumber = @_ ? shift : undef;
2397 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2398 my $dbh = C4::Context->dbh;
2399 # check for charge made for lost book
2400 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2401 $sth->execute($itemnumber);
2402 my $data = $sth->fetchrow_hashref;
2403 $data or return; # bail if there is nothing to do
2404 $data->{accounttype} eq 'W' and return; # Written off
2406 # writeoff this amount
2408 my $amount = $data->{'amount'};
2409 my $acctno = $data->{'accountno'};
2410 my $amountleft; # Starts off undef/zero.
2411 if ($data->{'amountoutstanding'} == $amount) {
2412 $offset = $data->{'amount'};
2413 $amountleft = 0; # Hey, it's zero here, too.
2415 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2416 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2418 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2419 WHERE (accountlines_id = ?)");
2420 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2421 #check if any credit is left if so writeoff other accounts
2422 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2423 $amountleft *= -1 if ($amountleft < 0);
2424 if ($amountleft > 0) {
2425 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2426 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2427 $msth->execute($data->{'borrowernumber'});
2428 # offset transactions
2431 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2432 if ($accdata->{'amountoutstanding'} < $amountleft) {
2434 $amountleft -= $accdata->{'amountoutstanding'};
2436 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2439 my $thisacct = $accdata->{'accountlines_id'};
2440 # FIXME: move prepares outside while loop!
2441 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2442 WHERE (accountlines_id = ?)");
2443 $usth->execute($newamtos,$thisacct);
2444 $usth = $dbh->prepare("INSERT INTO accountoffsets
2445 (borrowernumber, accountno, offsetaccount, offsetamount)
2448 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2451 $amountleft *= -1 if ($amountleft > 0);
2452 my $desc = "Item Returned " . $item_id;
2453 $usth = $dbh->prepare("INSERT INTO accountlines
2454 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2455 VALUES (?,?,now(),?,?,'CR',?)");
2456 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2457 if ($borrowernumber) {
2458 # FIXME: same as query above. use 1 sth for both
2459 $usth = $dbh->prepare("INSERT INTO accountoffsets
2460 (borrowernumber, accountno, offsetaccount, offsetamount)
2462 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2464 ModItem({ paidfor => '' }, undef, $itemnumber);
2468 =head2 _GetCircControlBranch
2470 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2474 Return the library code to be used to determine which circulation
2475 policy applies to a transaction. Looks up the CircControl and
2476 HomeOrHoldingBranch system preferences.
2478 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2480 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2484 sub _GetCircControlBranch {
2485 my ($item, $borrower) = @_;
2486 my $circcontrol = C4::Context->preference('CircControl');
2489 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2490 $branch= C4::Context->userenv->{'branch'};
2491 } elsif ($circcontrol eq 'PatronLibrary') {
2492 $branch=$borrower->{branchcode};
2494 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2495 $branch = $item->{$branchfield};
2496 # default to item home branch if holdingbranch is used
2497 # and is not defined
2498 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2499 $branch = $item->{homebranch};
2512 $issue = &GetItemIssue($itemnumber);
2514 Returns patron currently having a book, or undef if not checked out.
2516 C<$itemnumber> is the itemnumber.
2518 C<$issue> is a hashref of the row from the issues table.
2523 my ($itemnumber) = @_;
2524 return unless $itemnumber;
2525 my $sth = C4::Context->dbh->prepare(
2526 "SELECT items.*, issues.*
2528 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2529 WHERE issues.itemnumber=?");
2530 $sth->execute($itemnumber);
2531 my $data = $sth->fetchrow_hashref;
2532 return unless $data;
2533 $data->{issuedate_sql} = $data->{issuedate};
2534 $data->{date_due_sql} = $data->{date_due};
2535 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2536 $data->{issuedate}->truncate(to => 'minute');
2537 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2538 $data->{date_due}->truncate(to => 'minute');
2539 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2540 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2546 $issue = GetOpenIssue( $itemnumber );
2548 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2550 C<$itemnumber> is the item's itemnumber
2557 my ( $itemnumber ) = @_;
2558 return unless $itemnumber;
2559 my $dbh = C4::Context->dbh;
2560 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2561 $sth->execute( $itemnumber );
2562 return $sth->fetchrow_hashref();
2566 =head2 GetBiblioIssues
2568 $issues = GetBiblioIssues($biblionumber);
2570 this function get all issues from a biblionumber.
2573 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2574 tables issues and the firstname,surname & cardnumber from borrowers.
2578 sub GetBiblioIssues {
2579 my $biblionumber = shift;
2580 return unless $biblionumber;
2581 my $dbh = C4::Context->dbh;
2583 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2585 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2586 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2587 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2588 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2589 WHERE biblio.biblionumber = ?
2591 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2593 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2594 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2595 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2596 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2597 WHERE biblio.biblionumber = ?
2600 my $sth = $dbh->prepare($query);
2601 $sth->execute($biblionumber, $biblionumber);
2604 while ( my $data = $sth->fetchrow_hashref ) {
2605 push @issues, $data;
2610 =head2 GetUpcomingDueIssues
2612 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2616 sub GetUpcomingDueIssues {
2619 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2620 my $dbh = C4::Context->dbh;
2622 my $statement = <<END_SQL;
2623 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2625 LEFT JOIN items USING (itemnumber)
2626 LEFT OUTER JOIN branches USING (branchcode)
2627 WHERE returndate is NULL
2628 HAVING days_until_due >= 0 AND days_until_due <= ?
2631 my @bind_parameters = ( $params->{'days_in_advance'} );
2633 my $sth = $dbh->prepare( $statement );
2634 $sth->execute( @bind_parameters );
2635 my $upcoming_dues = $sth->fetchall_arrayref({});
2637 return $upcoming_dues;
2640 =head2 CanBookBeRenewed
2642 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2644 Find out whether a borrowed item may be renewed.
2646 C<$borrowernumber> is the borrower number of the patron who currently
2647 has the item on loan.
2649 C<$itemnumber> is the number of the item to renew.
2651 C<$override_limit>, if supplied with a true value, causes
2652 the limit on the number of times that the loan can be renewed
2653 (as controlled by the item type) to be ignored. Overriding also allows
2654 to renew sooner than "No renewal before" and to manually renew loans
2655 that are automatically renewed.
2657 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2658 item must currently be on loan to the specified borrower; renewals
2659 must be allowed for the item's type; and the borrower must not have
2660 already renewed the loan. $error will contain the reason the renewal can not proceed
2664 sub CanBookBeRenewed {
2665 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2667 my $dbh = C4::Context->dbh;
2670 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2671 my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2672 return ( 0, 'onsite_checkout' ) if $itemissue->{onsite_checkout};
2674 $borrowernumber ||= $itemissue->{borrowernumber};
2675 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2678 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2680 # This item can fill one or more unfilled reserve, can those unfilled reserves
2681 # all be filled by other available items?
2683 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2685 my $schema = Koha::Database->new()->schema();
2687 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2689 # There is an item level hold on this item, no other item can fill the hold
2694 # Get all other items that could possibly fill reserves
2695 my @itemnumbers = $schema->resultset('Item')->search(
2697 biblionumber => $resrec->{biblionumber},
2700 -not => { itemnumber => $itemnumber }
2702 { columns => 'itemnumber' }
2703 )->get_column('itemnumber')->all();
2705 # Get all other reserves that could have been filled by this item
2706 my @borrowernumbers;
2708 my ( $reserve_found, $reserve, undef ) =
2709 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2711 if ($reserve_found) {
2712 push( @borrowernumbers, $reserve->{borrowernumber} );
2719 # If the count of the union of the lists of reservable items for each borrower
2720 # is equal or greater than the number of borrowers, we know that all reserves
2721 # can be filled with available items. We can get the union of the sets simply
2722 # by pushing all the elements onto an array and removing the duplicates.
2725 ITEM: foreach my $i (@itemnumbers) {
2726 my $item = GetItem($i);
2727 next if IsItemOnHoldAndFound($i);
2728 for my $b (@borrowernumbers) {
2729 my $borr = $borrowers{$b}//= C4::Members::GetMember(borrowernumber => $b);
2730 next unless IsAvailableForItemLevelRequest($item, $borr);
2731 next unless CanItemBeReserved($b,$i);
2733 push @reservable, $i;
2734 if (@reservable >= @borrowernumbers) {
2743 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2745 return ( 1, undef ) if $override_limit;
2747 my $branchcode = _GetCircControlBranch( $item, $borrower );
2748 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2749 { categorycode => $borrower->{categorycode},
2750 itemtype => $item->{itype},
2751 branchcode => $branchcode
2755 return ( 0, "too_many" )
2756 if not $issuing_rule or $issuing_rule->renewalsallowed <= $itemissue->{renewals};
2758 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2759 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2760 my $patron = Koha::Patrons->find($borrowernumber);
2761 my $restricted = $patron->is_debarred;
2762 my $hasoverdues = $patron->has_overdues;
2764 if ( $restricted and $restrictionblockrenewing ) {
2765 return ( 0, 'restriction');
2766 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($itemissue->{overdue} and $overduesblockrenewing eq 'blockitem') ) {
2767 return ( 0, 'overdue');
2770 if ( $itemissue->{auto_renew} ) {
2771 if ( defined $issuing_rule->no_auto_renewal_after
2772 and $issuing_rule->no_auto_renewal_after ne "" ) {
2773 # Get issue_date and add no_auto_renewal_after
2774 # If this is greater than today, it's too late for renewal.
2775 my $maximum_renewal_date = dt_from_string($itemissue->{issuedate});
2776 $maximum_renewal_date->add(
2777 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2779 my $now = dt_from_string;
2780 if ( $now >= $maximum_renewal_date ) {
2781 return ( 0, "auto_too_late" );
2784 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2785 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2786 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2787 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2788 return ( 0, "auto_too_late" );
2792 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2793 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2794 my ( $amountoutstanding ) = C4::Members::GetMemberAccountRecords($borrower->{borrowernumber});
2795 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2796 return ( 0, "auto_too_much_oweing" );
2801 if ( defined $issuing_rule->norenewalbefore
2802 and $issuing_rule->norenewalbefore ne "" )
2805 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2806 my $soonestrenewal =
2807 $itemissue->{date_due}->clone()
2809 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2811 # Depending on syspref reset the exact time, only check the date
2812 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2813 and $issuing_rule->lengthunit eq 'days' )
2815 $soonestrenewal->truncate( to => 'day' );
2818 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2820 return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2821 return ( 0, "too_soon" );
2823 elsif ( $itemissue->{auto_renew} ) {
2824 return ( 0, "auto_renew" );
2828 # Fallback for automatic renewals:
2829 # If norenewalbefore is undef, don't renew before due date.
2830 if ( $itemissue->{auto_renew} ) {
2831 my $now = dt_from_string;
2832 return ( 0, "auto_renew" )
2833 if $now >= $itemissue->{date_due};
2834 return ( 0, "auto_too_soon" );
2837 return ( 1, undef );
2842 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2846 C<$borrowernumber> is the borrower number of the patron who currently
2849 C<$itemnumber> is the number of the item to renew.
2851 C<$branch> is the library where the renewal took place (if any).
2852 The library that controls the circ policies for the renewal is retrieved from the issues record.
2854 C<$datedue> can be a DateTime object used to set the due date.
2856 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2857 this parameter is not supplied, lastreneweddate is set to the current date.
2859 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2860 from the book's item type.
2865 my $borrowernumber = shift;
2866 my $itemnumber = shift or return;
2868 my $datedue = shift;
2869 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2871 my $item = GetItem($itemnumber) or return;
2872 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2874 my $dbh = C4::Context->dbh;
2876 # Find the issues record for this book
2877 my $issuedata = GetItemIssue($itemnumber);
2879 return unless ( $issuedata );
2881 $borrowernumber ||= $issuedata->{borrowernumber};
2883 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2884 carp 'Invalid date passed to AddRenewal.';
2888 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2890 if ( C4::Context->preference('CalculateFinesOnReturn') && $issuedata->{overdue} ) {
2891 _CalculateAndUpdateFine( { issue => $issuedata, item => $item, borrower => $borrower } );
2893 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2895 # If the due date wasn't specified, calculate it by adding the
2896 # book's loan length to today's date or the current due date
2897 # based on the value of the RenewalPeriodBase syspref.
2900 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2902 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2903 dt_from_string( $issuedata->{date_due} ) :
2904 DateTime->now( time_zone => C4::Context->tz());
2905 $datedue = CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $borrower), $borrower, 'is a renewal');
2908 # Update the issues record to have the new due date, and a new count
2909 # of how many times it has been renewed.
2910 my $renews = $issuedata->{'renewals'} + 1;
2911 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2912 WHERE borrowernumber=?
2916 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2918 # Update the renewal count on the item, and tell zebra to reindex
2919 $renews = $biblio->{'renewals'} + 1;
2920 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2922 # Charge a new rental fee, if applicable?
2923 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2924 if ( $charge > 0 ) {
2925 my $accountno = getnextacctno( $borrowernumber );
2926 my $item = GetBiblioFromItemNumber($itemnumber);
2928 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2929 $sth = $dbh->prepare(
2930 "INSERT INTO accountlines
2931 (date, borrowernumber, accountno, amount, manager_id,
2932 description,accounttype, amountoutstanding, itemnumber)
2933 VALUES (now(),?,?,?,?,?,?,?,?)"
2935 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2936 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2937 'Rent', $charge, $itemnumber );
2940 # Send a renewal slip according to checkout alert preferencei
2941 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2942 $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2943 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2945 branchcode => $branch,
2946 categorycode => $borrower->{categorycode},
2947 item_type => $item->{itype},
2948 notification => 'CHECKOUT',
2950 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2951 SendCirculationAlert(
2955 borrower => $borrower,
2962 # Remove any OVERDUES related debarment if the borrower has no overdues
2963 $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2964 if ( $borrowernumber
2965 && $borrower->{'debarred'}
2966 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2967 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2969 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2972 # Add the renewal to stats
2975 branch => C4::Context->userenv ? C4::Context->userenv->{branch} : $branch,
2978 itemnumber => $itemnumber,
2979 itemtype => $item->{itype},
2980 borrowernumber => $borrowernumber,
2981 ccode => $item->{'ccode'}
2986 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2991 # check renewal status
2992 my ( $bornum, $itemno ) = @_;
2993 my $dbh = C4::Context->dbh;
2995 my $renewsallowed = 0;
2998 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2999 my $item = GetItem($itemno);
3001 # Look in the issues table for this item, lent to this borrower,
3002 # and not yet returned.
3004 # FIXME - I think this function could be redone to use only one SQL call.
3005 my $sth = $dbh->prepare(
3006 "select * from issues
3007 where (borrowernumber = ?)
3008 and (itemnumber = ?)"
3010 $sth->execute( $bornum, $itemno );
3011 my $data = $sth->fetchrow_hashref;
3012 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3013 # $item and $borrower should be calculated
3014 my $branchcode = _GetCircControlBranch($item, $borrower);
3016 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3017 { categorycode => $borrower->{categorycode},
3018 itemtype => $item->{itype},
3019 branchcode => $branchcode
3023 $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
3024 $renewsleft = $renewsallowed - $renewcount;
3025 if($renewsleft < 0){ $renewsleft = 0; }
3026 return ( $renewcount, $renewsallowed, $renewsleft );
3029 =head2 GetSoonestRenewDate
3031 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3033 Find out the soonest possible renew date of a borrowed item.
3035 C<$borrowernumber> is the borrower number of the patron who currently
3036 has the item on loan.
3038 C<$itemnumber> is the number of the item to renew.
3040 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3041 renew date, based on the value "No renewal before" of the applicable
3042 issuing rule. Returns the current date if the item can already be
3043 renewed, and returns undefined if the borrower, loan, or item
3048 sub GetSoonestRenewDate {
3049 my ( $borrowernumber, $itemnumber ) = @_;
3051 my $dbh = C4::Context->dbh;
3053 my $item = GetItem($itemnumber) or return;
3054 my $itemissue = GetItemIssue($itemnumber) or return;
3056 $borrowernumber ||= $itemissue->{borrowernumber};
3057 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
3060 my $branchcode = _GetCircControlBranch( $item, $borrower );
3061 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3062 { categorycode => $borrower->{categorycode},
3063 itemtype => $item->{itype},
3064 branchcode => $branchcode
3068 my $now = dt_from_string;
3069 return $now unless $issuing_rule;
3071 if ( defined $issuing_rule->norenewalbefore
3072 and $issuing_rule->norenewalbefore ne "" )
3074 my $soonestrenewal =
3075 $itemissue->{date_due}->clone()
3077 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3079 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3080 and $issuing_rule->lengthunit eq 'days' )
3082 $soonestrenewal->truncate( to => 'day' );
3084 return $soonestrenewal if $now < $soonestrenewal;
3089 =head2 GetLatestAutoRenewDate
3091 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3093 Find out the latest possible auto renew date of a borrowed item.
3095 C<$borrowernumber> is the borrower number of the patron who currently
3096 has the item on loan.
3098 C<$itemnumber> is the number of the item to renew.
3100 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3101 auto renew date, based on the value "No auto renewal after" and the "No auto
3102 renewal after (hard limit) of the applicable issuing rule.
3103 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3104 or item cannot be found.
3108 sub GetLatestAutoRenewDate {
3109 my ( $borrowernumber, $itemnumber ) = @_;
3111 my $dbh = C4::Context->dbh;
3113 my $item = GetItem($itemnumber) or return;
3114 my $itemissue = GetItemIssue($itemnumber) or return;
3116 $borrowernumber ||= $itemissue->{borrowernumber};
3117 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
3120 my $branchcode = _GetCircControlBranch( $item, $borrower );
3121 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3122 { categorycode => $borrower->{categorycode},
3123 itemtype => $item->{itype},
3124 branchcode => $branchcode
3128 return unless $issuing_rule;
3130 if ( not $issuing_rule->no_auto_renewal_after
3131 or $issuing_rule->no_auto_renewal_after eq '' )
3132 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3133 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3135 my $maximum_renewal_date;
3136 if ( $issuing_rule->no_auto_renewal_after ) {
3137 $maximum_renewal_date = dt_from_string($itemissue->{issuedate});
3138 $maximum_renewal_date->add(
3139 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3143 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3144 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3145 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3147 return $maximum_renewal_date;
3151 =head2 GetIssuingCharges
3153 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3155 Calculate how much it would cost for a given patron to borrow a given
3156 item, including any applicable discounts.
3158 C<$itemnumber> is the item number of item the patron wishes to borrow.
3160 C<$borrowernumber> is the patron's borrower number.
3162 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3163 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3168 sub GetIssuingCharges {
3170 # calculate charges due
3171 my ( $itemnumber, $borrowernumber ) = @_;
3173 my $dbh = C4::Context->dbh;
3176 # Get the book's item type and rental charge (via its biblioitem).
3177 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3178 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3179 $charge_query .= (C4::Context->preference('item-level_itypes'))
3180 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3181 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3183 $charge_query .= ' WHERE items.itemnumber =?';
3185 my $sth = $dbh->prepare($charge_query);
3186 $sth->execute($itemnumber);
3187 if ( my $item_data = $sth->fetchrow_hashref ) {
3188 $item_type = $item_data->{itemtype};
3189 $charge = $item_data->{rentalcharge};
3190 my $branch = C4::Context::mybranch();
3191 my $discount_query = q|SELECT rentaldiscount,
3192 issuingrules.itemtype, issuingrules.branchcode
3194 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3195 WHERE borrowers.borrowernumber = ?
3196 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3197 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3198 my $discount_sth = $dbh->prepare($discount_query);
3199 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3200 my $discount_rules = $discount_sth->fetchall_arrayref({});
3201 if (@{$discount_rules}) {
3202 # We may have multiple rules so get the most specific
3203 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3204 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3207 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3211 return ( $charge, $item_type );
3214 # Select most appropriate discount rule from those returned
3215 sub _get_discount_from_rule {
3216 my ($rules_ref, $branch, $itemtype) = @_;
3219 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3220 $discount = $rules_ref->[0]->{rentaldiscount};
3221 return (defined $discount) ? $discount : 0;
3223 # could have up to 4 does one match $branch and $itemtype
3224 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3226 $discount = $d[0]->{rentaldiscount};
3227 return (defined $discount) ? $discount : 0;
3229 # do we have item type + all branches
3230 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3232 $discount = $d[0]->{rentaldiscount};
3233 return (defined $discount) ? $discount : 0;
3235 # do we all item types + this branch
3236 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3238 $discount = $d[0]->{rentaldiscount};
3239 return (defined $discount) ? $discount : 0;
3241 # so all and all (surely we wont get here)
3242 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3244 $discount = $d[0]->{rentaldiscount};
3245 return (defined $discount) ? $discount : 0;
3251 =head2 AddIssuingCharge
3253 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3257 sub AddIssuingCharge {
3258 my ( $itemnumber, $borrowernumber, $charge ) = @_;
3259 my $dbh = C4::Context->dbh;
3260 my $nextaccntno = getnextacctno( $borrowernumber );
3262 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3264 INSERT INTO accountlines
3265 (borrowernumber, itemnumber, accountno,
3266 date, amount, description, accounttype,
3267 amountoutstanding, manager_id)
3268 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3270 my $sth = $dbh->prepare($query);
3271 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3276 GetTransfers($itemnumber);
3281 my ($itemnumber) = @_;
3283 my $dbh = C4::Context->dbh;
3290 FROM branchtransfers
3291 WHERE itemnumber = ?
3292 AND datearrived IS NULL
3294 my $sth = $dbh->prepare($query);
3295 $sth->execute($itemnumber);
3296 my @row = $sth->fetchrow_array();
3300 =head2 GetTransfersFromTo
3302 @results = GetTransfersFromTo($frombranch,$tobranch);
3304 Returns the list of pending transfers between $from and $to branch
3308 sub GetTransfersFromTo {
3309 my ( $frombranch, $tobranch ) = @_;
3310 return unless ( $frombranch && $tobranch );
3311 my $dbh = C4::Context->dbh;
3313 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3314 FROM branchtransfers
3317 AND datearrived IS NULL
3319 my $sth = $dbh->prepare($query);
3320 $sth->execute( $frombranch, $tobranch );
3323 while ( my $data = $sth->fetchrow_hashref ) {
3324 push @gettransfers, $data;
3326 return (@gettransfers);
3329 =head2 DeleteTransfer
3331 &DeleteTransfer($itemnumber);
3335 sub DeleteTransfer {
3336 my ($itemnumber) = @_;
3337 return unless $itemnumber;
3338 my $dbh = C4::Context->dbh;
3339 my $sth = $dbh->prepare(
3340 "DELETE FROM branchtransfers
3342 AND datearrived IS NULL "
3344 return $sth->execute($itemnumber);
3347 =head2 SendCirculationAlert
3349 Send out a C<check-in> or C<checkout> alert using the messaging system.
3357 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3361 Hashref of information about the item being checked in or out.
3365 Hashref of information about the borrower of the item.
3369 The branchcode from where the checkout or check-in took place.
3375 SendCirculationAlert({
3378 borrower => $borrower,
3384 sub SendCirculationAlert {
3386 my ($type, $item, $borrower, $branch) =
3387 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3388 my %message_name = (
3389 CHECKIN => 'Item_Check_in',
3390 CHECKOUT => 'Item_Checkout',
3391 RENEWAL => 'Item_Checkout',
3393 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3394 borrowernumber => $borrower->{borrowernumber},
3395 message_name => $message_name{$type},
3397 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3399 my $schema = Koha::Database->new->schema;
3400 my @transports = keys %{ $borrower_preferences->{transports} };
3402 # From the MySQL doc:
3403 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3404 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3405 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3406 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3408 for my $mtt (@transports) {
3409 my $letter = C4::Letters::GetPreparedLetter (
3410 module => 'circulation',
3411 letter_code => $type,
3412 branchcode => $branch,
3413 message_transport_type => $mtt,
3414 lang => $borrower->{lang},
3416 $issues_table => $item->{itemnumber},
3417 'items' => $item->{itemnumber},
3418 'biblio' => $item->{biblionumber},
3419 'biblioitems' => $item->{biblionumber},
3420 'borrowers' => $borrower,
3421 'branches' => $branch,
3425 $schema->storage->txn_begin;
3426 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3427 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3428 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3429 unless ( $message ) {
3430 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3431 C4::Message->enqueue($letter, $borrower, $mtt);
3433 $message->append($letter);
3436 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3437 $schema->storage->txn_commit;
3443 =head2 updateWrongTransfer
3445 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3447 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
3451 sub updateWrongTransfer {
3452 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3453 my $dbh = C4::Context->dbh;
3454 # first step validate the actual line of transfert .
3457 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3459 $sth->execute($FromLibrary,$itemNumber);
3461 # second step create a new line of branchtransfer to the right location .
3462 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3464 #third step changing holdingbranch of item
3465 UpdateHoldingbranch($FromLibrary,$itemNumber);
3468 =head2 UpdateHoldingbranch
3470 $items = UpdateHoldingbranch($branch,$itmenumber);
3472 Simple methode for updating hodlingbranch in items BDD line
3476 sub UpdateHoldingbranch {
3477 my ( $branch,$itemnumber ) = @_;
3478 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3483 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3485 this function calculates the due date given the start date and configured circulation rules,
3486 checking against the holidays calendar as per the 'useDaysMode' syspref.
3487 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3488 C<$itemtype> = itemtype code of item in question
3489 C<$branch> = location whose calendar to use
3490 C<$borrower> = Borrower object
3491 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3496 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3500 # loanlength now a href
3502 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3504 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3510 if (ref $startdate ne 'DateTime' ) {
3511 $datedue = dt_from_string($datedue);
3513 $datedue = $startdate->clone;
3517 DateTime->now( time_zone => C4::Context->tz() )
3518 ->truncate( to => 'minute' );
3522 # calculate the datedue as normal
3523 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3524 { # ignoring calendar
3525 if ( $loanlength->{lengthunit} eq 'hours' ) {
3526 $datedue->add( hours => $loanlength->{$length_key} );
3528 $datedue->add( days => $loanlength->{$length_key} );
3529 $datedue->set_hour(23);
3530 $datedue->set_minute(59);
3534 if ($loanlength->{lengthunit} eq 'hours') {
3535 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3538 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3540 my $calendar = Koha::Calendar->new( branchcode => $branch );
3541 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3542 if ($loanlength->{lengthunit} eq 'days') {
3543 $datedue->set_hour(23);
3544 $datedue->set_minute(59);
3548 # if Hard Due Dates are used, retrieve them and apply as necessary
3549 my ( $hardduedate, $hardduedatecompare ) =
3550 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3551 if ($hardduedate) { # hardduedates are currently dates
3552 $hardduedate->truncate( to => 'minute' );
3553 $hardduedate->set_hour(23);
3554 $hardduedate->set_minute(59);
3555 my $cmp = DateTime->compare( $hardduedate, $datedue );
3557 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3558 # if the calculated date is before the 'after' Hard Due Date (floor), override
3559 # if the hard due date is set to 'exactly', overrride
3560 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3561 $datedue = $hardduedate->clone;
3564 # in all other cases, keep the date due as it is
3568 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3569 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3570 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3571 if( $expiry_dt ) { #skip empty expiry date..
3572 $expiry_dt->set( hour => 23, minute => 59);
3573 my $d1= $datedue->clone->set_time_zone('floating');
3574 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3575 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3584 sub CheckValidBarcode{
3586 my $dbh = C4::Context->dbh;
3587 my $query=qq|SELECT count(*)
3591 my $sth = $dbh->prepare($query);
3592 $sth->execute($barcode);
3593 my $exist=$sth->fetchrow ;
3597 =head2 IsBranchTransferAllowed
3599 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3601 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3605 sub IsBranchTransferAllowed {
3606 my ( $toBranch, $fromBranch, $code ) = @_;
3608 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3610 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3611 my $dbh = C4::Context->dbh;
3613 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3614 $sth->execute( $toBranch, $fromBranch, $code );
3615 my $limit = $sth->fetchrow_hashref();
3617 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3618 if ( $limit->{'limitId'} ) {
3625 =head2 CreateBranchTransferLimit
3627 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3629 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3633 sub CreateBranchTransferLimit {
3634 my ( $toBranch, $fromBranch, $code ) = @_;
3635 return unless defined($toBranch) && defined($fromBranch);
3636 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3638 my $dbh = C4::Context->dbh;
3640 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3641 return $sth->execute( $code, $toBranch, $fromBranch );
3644 =head2 DeleteBranchTransferLimits
3646 my $result = DeleteBranchTransferLimits($frombranch);
3648 Deletes all the library transfer limits for one library. Returns the
3649 number of limits deleted, 0e0 if no limits were deleted, or undef if
3650 no arguments are supplied.
3654 sub DeleteBranchTransferLimits {
3656 return unless defined $branch;
3657 my $dbh = C4::Context->dbh;
3658 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3659 return $sth->execute($branch);
3663 my ( $borrowernumber, $itemnum ) = @_;
3665 MarkIssueReturned( $borrowernumber, $itemnum );
3666 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3667 my $item = C4::Items::GetItem( $itemnum );
3668 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3669 my @datearr = localtime(time);
3670 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3671 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3672 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3677 my ($itemnumber, $mark_returned) = @_;
3679 my $dbh = C4::Context->dbh();
3680 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3682 JOIN items USING (itemnumber)
3683 JOIN biblio USING (biblionumber)
3684 WHERE issues.itemnumber=?");
3685 $sth->execute($itemnumber);
3686 my $issues=$sth->fetchrow_hashref();
3688 # If a borrower lost the item, add a replacement cost to the their record
3689 if ( my $borrowernumber = $issues->{borrowernumber} ){
3690 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
3692 if (C4::Context->preference('WhenLostForgiveFine')){
3693 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3694 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3696 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3697 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3698 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3699 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3702 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3706 sub GetOfflineOperations {
3707 my $dbh = C4::Context->dbh;
3708 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3709 $sth->execute(C4::Context->userenv->{'branch'});
3710 my $results = $sth->fetchall_arrayref({});
3714 sub GetOfflineOperation {
3715 my $operationid = shift;
3716 return unless $operationid;
3717 my $dbh = C4::Context->dbh;
3718 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3719 $sth->execute( $operationid );
3720 return $sth->fetchrow_hashref;
3723 sub AddOfflineOperation {
3724 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3725 my $dbh = C4::Context->dbh;
3726 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3727 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3731 sub DeleteOfflineOperation {
3732 my $dbh = C4::Context->dbh;
3733 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3734 $sth->execute( shift );
3738 sub ProcessOfflineOperation {
3739 my $operation = shift;
3742 if ( $operation->{action} eq 'return' ) {
3743 $report = ProcessOfflineReturn( $operation );
3744 } elsif ( $operation->{action} eq 'issue' ) {
3745 $report = ProcessOfflineIssue( $operation );
3746 } elsif ( $operation->{action} eq 'payment' ) {
3747 $report = ProcessOfflinePayment( $operation );
3750 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3755 sub ProcessOfflineReturn {
3756 my $operation = shift;
3758 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3760 if ( $itemnumber ) {
3761 my $issue = GetOpenIssue( $itemnumber );
3764 $issue->{borrowernumber},
3767 $operation->{timestamp},
3770 { renewals => 0, onloan => undef },
3771 $issue->{'biblionumber'},
3776 return "Item not issued.";
3779 return "Item not found.";
3783 sub ProcessOfflineIssue {
3784 my $operation = shift;
3786 my $borrower = C4::Members::GetMember( cardnumber => $operation->{cardnumber} );
3788 if ( $borrower->{borrowernumber} ) {
3789 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3790 unless ($itemnumber) {
3791 return "Barcode not found.";
3793 my $issue = GetOpenIssue( $itemnumber );
3795 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3797 $issue->{borrowernumber},
3800 $operation->{timestamp},
3805 $operation->{'barcode'},
3808 $operation->{timestamp},
3813 return "Borrower not found.";
3817 sub ProcessOfflinePayment {
3818 my $operation = shift;
3820 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} });
3821 my $amount = $operation->{amount};
3823 Koha::Account->new( { patron_id => $patron->id } )->pay( { amount => $amount } );
3831 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3833 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3838 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3840 my $item = GetItem( $itemnumber, $barcode )
3843 return C4::Letters::GetPreparedLetter (
3844 module => 'circulation',
3845 letter_code => 'TRANSFERSLIP',
3846 branchcode => $branch,
3848 'branches' => $to_branch,
3849 'biblio' => $item->{biblionumber},
3855 =head2 CheckIfIssuedToPatron
3857 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3859 Return 1 if any record item is issued to patron, otherwise return 0
3863 sub CheckIfIssuedToPatron {
3864 my ($borrowernumber, $biblionumber) = @_;
3866 my $dbh = C4::Context->dbh;
3868 SELECT COUNT(*) FROM issues
3869 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3870 WHERE items.biblionumber = ?
3871 AND issues.borrowernumber = ?
3873 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3874 return 1 if $is_issued;
3880 IsItemIssued( $itemnumber )
3882 Return 1 if the item is on loan, otherwise return 0
3887 my $itemnumber = shift;
3888 my $dbh = C4::Context->dbh;
3889 my $sth = $dbh->prepare(q{
3892 WHERE itemnumber = ?
3894 $sth->execute($itemnumber);
3895 return $sth->fetchrow;
3898 =head2 GetAgeRestriction
3900 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3901 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3903 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3904 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3906 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3907 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3908 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3909 Negative days mean the borrower has gone past the age restriction age.
3913 sub GetAgeRestriction {
3914 my ($record_restrictions, $borrower) = @_;
3915 my $markers = C4::Context->preference('AgeRestrictionMarker');
3917 # Split $record_restrictions to something like FSK 16 or PEGI 6
3918 my @values = split ' ', uc($record_restrictions);
3919 return unless @values;
3921 # Search first occurrence of one of the markers
3922 my @markers = split /\|/, uc($markers);
3923 return unless @markers;
3926 my $restriction_year = 0;
3927 for my $value (@values) {
3929 for my $marker (@markers) {
3930 $marker =~ s/^\s+//; #remove leading spaces
3931 $marker =~ s/\s+$//; #remove trailing spaces
3932 if ( $marker eq $value ) {
3933 if ( $index <= $#values ) {
3934 $restriction_year += $values[$index];
3938 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3940 # Perhaps it is something like "K16" (as in Finland)
3941 $restriction_year += $1;
3945 last if ( $restriction_year > 0 );
3948 #Check if the borrower is age restricted for this material and for how long.
3949 if ($restriction_year && $borrower) {
3950 if ( $borrower->{'dateofbirth'} ) {
3951 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3952 $alloweddate[0] += $restriction_year;
3954 #Prevent runime eror on leap year (invalid date)
3955 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3956 $alloweddate[2] = 28;
3959 #Get how many days the borrower has to reach the age restriction
3960 my @Today = split /-/, DateTime->today->ymd();
3961 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3962 #Negative days means the borrower went past the age restriction age
3963 return ($restriction_year, $daysToAgeRestriction);
3967 return ($restriction_year);
3971 =head2 GetPendingOnSiteCheckouts
3975 sub GetPendingOnSiteCheckouts {
3976 my $dbh = C4::Context->dbh;
3977 return $dbh->selectall_arrayref(q|
3983 items.itemcallnumber,
3987 issues.date_due < NOW() AS is_overdue,
3990 borrowers.firstname,
3992 borrowers.cardnumber,
3993 borrowers.borrowernumber
3995 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
3996 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
3997 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
3998 WHERE issues.onsite_checkout = 1
3999 |, { Slice => {} } );
4005 my ($count, $branch, $itemtype, $ccode, $newness)
4006 = @$params{qw(count branch itemtype ccode newness)};
4008 my $dbh = C4::Context->dbh;
4010 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4011 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4012 i.ccode, SUM(i.issues) AS count
4014 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4015 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4018 my (@where_strs, @where_args);
4021 push @where_strs, 'i.homebranch = ?';
4022 push @where_args, $branch;
4025 if (C4::Context->preference('item-level_itypes')){
4026 push @where_strs, 'i.itype = ?';
4027 push @where_args, $itemtype;
4029 push @where_strs, 'bi.itemtype = ?';
4030 push @where_args, $itemtype;
4034 push @where_strs, 'i.ccode = ?';
4035 push @where_args, $ccode;
4038 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4039 push @where_args, $newness;
4043 $query .= 'WHERE ' . join(' AND ', @where_strs);
4047 GROUP BY b.biblionumber
4052 $count = int($count);
4054 $query .= "LIMIT $count";
4057 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4062 sub _CalculateAndUpdateFine {
4065 my $borrower = $params->{borrower};
4066 my $item = $params->{item};
4067 my $issue = $params->{issue};
4068 my $return_date = $params->{return_date};
4070 unless ($borrower) { carp "No borrower passed in!" && return; }
4071 unless ($item) { carp "No item passed in!" && return; }
4072 unless ($issue) { carp "No issue passed in!" && return; }
4074 my $datedue = $issue->{date_due};
4076 # we only need to calculate and change the fines if we want to do that on return
4077 # Should be on for hourly loans
4078 my $control = C4::Context->preference('CircControl');
4079 my $control_branchcode =
4080 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4081 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4082 : $issue->{branchcode};
4084 my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4086 my ( $amount, $type, $unitcounttotal ) =
4087 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4091 if ( C4::Context->preference('finesMode') eq 'production' ) {
4092 if ( $amount > 0 ) {
4093 C4::Overdues::UpdateFine({
4094 issue_id => $issue->{issue_id},
4095 itemnumber => $issue->{itemnumber},
4096 borrowernumber => $issue->{borrowernumber},
4099 due => output_pref($datedue),
4102 elsif ($return_date) {
4104 # Backdated returns may have fines that shouldn't exist,
4105 # so in this case, we need to drop those fines to 0
4107 C4::Overdues::UpdateFine({
4108 issue_id => $issue->{issue_id},
4109 itemnumber => $issue->{itemnumber},
4110 borrowernumber => $issue->{borrowernumber},
4113 due => output_pref($datedue),
4125 Koha Development Team <http://koha-community.org/>