1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 #use warnings; FIXME - Bug 2505
33 use C4::ItemCirculationAlertPreference;
36 use C4::Log; # logaction
37 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
38 use C4::RotatingCollections qw(GetCollectionItemBranches);
39 use Algorithm::CheckDigits;
43 use Koha::AuthorisedValues;
46 use Koha::IssuingRules;
49 use Koha::Patron::Debarments;
53 use Koha::RefundLostItemFeeRule;
54 use Koha::RefundLostItemFeeRules;
56 use List::MoreUtils qw( uniq );
57 use Scalar::Util qw( looks_like_number );
67 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
73 # FIXME subs that should probably be elsewhere
78 &GetPendingOnSiteCheckouts
81 # subs to deal with issuing a book
89 &GetLatestAutoRenewDate
93 &GetBranchBorrowerCircRule
97 &AnonymiseIssueHistory
98 &CheckIfIssuedToPatron
103 # subs to deal with returns
109 # subs to deal with transfers
116 &IsBranchTransferAllowed
117 &CreateBranchTransferLimit
118 &DeleteBranchTransferLimits
122 # subs to deal with offline circulation
124 &GetOfflineOperations
127 &DeleteOfflineOperation
128 &ProcessOfflineOperation
134 C4::Circulation - Koha circulation module
142 The functions in this module deal with circulation, issues, and
143 returns, as well as general information about the library.
144 Also deals with inventory.
150 $str = &barcodedecode($barcode, [$filter]);
152 Generic filter function for barcode string.
153 Called on every circ if the System Pref itemBarcodeInputFilter is set.
154 Will do some manipulation of the barcode for systems that deliver a barcode
155 to circulation.pl that differs from the barcode stored for the item.
156 For proper functioning of this filter, calling the function on the
157 correct barcode string (items.barcode) should return an unaltered barcode.
159 The optional $filter argument is to allow for testing or explicit
160 behavior that ignores the System Pref. Valid values are the same as the
165 # FIXME -- the &decode fcn below should be wrapped into this one.
166 # FIXME -- these plugins should be moved out of Circulation.pm
169 my ($barcode, $filter) = @_;
170 my $branch = C4::Context::mybranch();
171 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
172 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
173 if ($filter eq 'whitespace') {
175 } elsif ($filter eq 'cuecat') {
177 my @fields = split( /\./, $barcode );
178 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
179 ($#results == 2) and return $results[2];
180 } elsif ($filter eq 'T-prefix') {
181 if ($barcode =~ /^[Tt](\d)/) {
182 (defined($1) and $1 eq '0') and return $barcode;
183 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
185 return sprintf("T%07d", $barcode);
186 # FIXME: $barcode could be "T1", causing warning: substr outside of string
187 # Why drop the nonzero digit after the T?
188 # Why pass non-digits (or empty string) to "T%07d"?
189 } elsif ($filter eq 'libsuite8') {
190 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
191 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
192 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
194 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
197 } elsif ($filter eq 'EAN13') {
198 my $ean = CheckDigits('ean');
199 if ( $ean->is_valid($barcode) ) {
200 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
201 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
203 warn "# [$barcode] not valid EAN-13/UPC-A\n";
206 return $barcode; # return barcode, modified or not
211 $str = &decode($chunk);
213 Decodes a segment of a string emitted by a CueCat barcode scanner and
216 FIXME: Should be replaced with Barcode::Cuecat from CPAN
217 or Javascript based decoding on the client side.
224 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
225 my @s = map { index( $seq, $_ ); } split( //, $encoded );
226 my $l = ( $#s + 1 ) % 4;
229 # warn "Error: Cuecat decode parsing failed!";
237 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
239 chr( ( $n >> 16 ) ^ 67 )
240 .chr( ( $n >> 8 & 255 ) ^ 67 )
241 .chr( ( $n & 255 ) ^ 67 );
244 $r = substr( $r, 0, length($r) - $l );
250 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
251 $barcode, $ignore_reserves);
253 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
255 C<$newbranch> is the code for the branch to which the item should be transferred.
257 C<$barcode> is the barcode of the item to be transferred.
259 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
260 Otherwise, if an item is reserved, the transfer fails.
262 Returns three values:
268 is true if the transfer was successful.
272 is a reference-to-hash which may have any of the following keys:
278 There is no item in the catalog with the given barcode. The value is C<$barcode>.
282 The item's home branch is permanent. This doesn't prevent the item from being transferred, though. The value is the code of the item's home branch.
284 =item C<DestinationEqualsHolding>
286 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
290 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
294 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
296 =item C<WasTransferred>
298 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
307 my ( $tbr, $barcode, $ignoreRs ) = @_;
310 my $itemnumber = GetItemnumberFromBarcode( $barcode );
311 my $issue = GetItemIssue($itemnumber);
312 my $biblio = GetBiblioFromItemNumber($itemnumber);
315 if ( not $itemnumber ) {
316 $messages->{'BadBarcode'} = $barcode;
320 # get branches of book...
321 my $hbr = $biblio->{'homebranch'};
322 my $fbr = $biblio->{'holdingbranch'};
324 # if using Branch Transfer Limits
325 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
326 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
327 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
328 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
331 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
332 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
338 # FIXME Is this still used by someone?
339 # See other FIXME in AddReturn
340 my $library = Koha::Libraries->find($hbr);
341 if ( $library and $library->get_categories->search({'me.categorycode' => 'PE'})->count ) {
342 $messages->{'IsPermanent'} = $hbr;
346 # can't transfer book if is already there....
347 if ( $fbr eq $tbr ) {
348 $messages->{'DestinationEqualsHolding'} = 1;
352 # check if it is still issued to someone, return it...
353 if ($issue->{borrowernumber}) {
354 AddReturn( $barcode, $fbr );
355 $messages->{'WasReturned'} = $issue->{borrowernumber};
359 # That'll save a database query.
360 my ( $resfound, $resrec, undef ) =
361 CheckReserves( $itemnumber );
362 if ( $resfound and not $ignoreRs ) {
363 $resrec->{'ResFound'} = $resfound;
365 # $messages->{'ResFound'} = $resrec;
369 #actually do the transfer....
371 ModItemTransfer( $itemnumber, $fbr, $tbr );
373 # don't need to update MARC anymore, we do it in batch now
374 $messages->{'WasTransfered'} = 1;
377 ModDateLastSeen( $itemnumber );
378 return ( $dotransfer, $messages, $biblio );
383 my $borrower = shift;
384 my $biblionumber = shift;
387 my $onsite_checkout = $params->{onsite_checkout} || 0;
388 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
389 my $cat_borrower = $borrower->{'categorycode'};
390 my $dbh = C4::Context->dbh;
392 # Get which branchcode we need
393 $branch = _GetCircControlBranch($item,$borrower);
394 my $type = (C4::Context->preference('item-level_itypes'))
395 ? $item->{'itype'} # item-level
396 : $item->{'itemtype'}; # biblio-level
398 # given branch, patron category, and item type, determine
399 # applicable issuing rule
400 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
401 { categorycode => $cat_borrower,
403 branchcode => $branch
408 # if a rule is found and has a loan limit set, count
409 # how many loans the patron already has that meet that
411 if (defined($issuing_rule) and defined($issuing_rule->maxissueqty)) {
414 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
416 JOIN items USING (itemnumber)
419 my $rule_itemtype = $issuing_rule->itemtype;
420 if ($rule_itemtype eq "*") {
421 # matching rule has the default item type, so count only
422 # those existing loans that don't fall under a more
424 if (C4::Context->preference('item-level_itypes')) {
425 $count_query .= " WHERE items.itype NOT IN (
426 SELECT itemtype FROM issuingrules
428 AND (categorycode = ? OR categorycode = ?)
432 $count_query .= " JOIN biblioitems USING (biblionumber)
433 WHERE biblioitems.itemtype NOT IN (
434 SELECT itemtype FROM issuingrules
436 AND (categorycode = ? OR categorycode = ?)
440 push @bind_params, $issuing_rule->branchcode;
441 push @bind_params, $issuing_rule->categorycode;
442 push @bind_params, $cat_borrower;
444 # rule has specific item type, so count loans of that
446 if (C4::Context->preference('item-level_itypes')) {
447 $count_query .= " WHERE items.itype = ? ";
449 $count_query .= " JOIN biblioitems USING (biblionumber)
450 WHERE biblioitems.itemtype= ? ";
452 push @bind_params, $type;
455 $count_query .= " AND borrowernumber = ? ";
456 push @bind_params, $borrower->{'borrowernumber'};
457 my $rule_branch = $issuing_rule->branchcode;
458 if ($rule_branch ne "*") {
459 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
460 $count_query .= " AND issues.branchcode = ? ";
461 push @bind_params, $branch;
462 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
463 ; # if branch is the patron's home branch, then count all loans by patron
465 $count_query .= " AND items.homebranch = ? ";
466 push @bind_params, $branch;
470 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
472 my $max_checkouts_allowed = $issuing_rule->maxissueqty;
473 my $max_onsite_checkouts_allowed = $issuing_rule->maxonsiteissueqty;
475 if ( $onsite_checkout ) {
476 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
478 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
479 count => $onsite_checkout_count,
480 max_allowed => $max_onsite_checkouts_allowed,
484 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
485 my $delta = $switch_onsite_checkout ? 1 : 0;
486 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
488 reason => 'TOO_MANY_CHECKOUTS',
489 count => $checkout_count,
490 max_allowed => $max_checkouts_allowed,
493 } elsif ( not $onsite_checkout ) {
494 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
496 reason => 'TOO_MANY_CHECKOUTS',
497 count => $checkout_count - $onsite_checkout_count,
498 max_allowed => $max_checkouts_allowed,
504 # Now count total loans against the limit for the branch
505 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
506 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
507 my @bind_params = ();
508 my $branch_count_query = q|
509 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
511 JOIN items USING (itemnumber)
512 WHERE borrowernumber = ?
514 push @bind_params, $borrower->{borrowernumber};
516 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
517 $branch_count_query .= " AND issues.branchcode = ? ";
518 push @bind_params, $branch;
519 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
520 ; # if branch is the patron's home branch, then count all loans by patron
522 $branch_count_query .= " AND items.homebranch = ? ";
523 push @bind_params, $branch;
525 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
526 my $max_checkouts_allowed = $branch_borrower_circ_rule->{maxissueqty};
527 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{maxonsiteissueqty};
529 if ( $onsite_checkout ) {
530 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
532 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
533 count => $onsite_checkout_count,
534 max_allowed => $max_onsite_checkouts_allowed,
538 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
539 my $delta = $switch_onsite_checkout ? 1 : 0;
540 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
542 reason => 'TOO_MANY_CHECKOUTS',
543 count => $checkout_count,
544 max_allowed => $max_checkouts_allowed,
547 } elsif ( not $onsite_checkout ) {
548 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
550 reason => 'TOO_MANY_CHECKOUTS',
551 count => $checkout_count - $onsite_checkout_count,
552 max_allowed => $max_checkouts_allowed,
558 if ( not defined( $issuing_rule ) and not defined($branch_borrower_circ_rule->{maxissueqty}) ) {
559 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
562 # OK, the patron can issue !!!
566 =head2 CanBookBeIssued
568 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
569 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
571 Check if a book can be issued.
573 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
577 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
579 =item C<$barcode> is the bar code of the book being issued.
581 =item C<$duedates> is a DateTime object.
583 =item C<$inprocess> boolean switch
585 =item C<$ignore_reserves> boolean switch
587 =item C<$params> Hashref of additional parameters
590 override_high_holds - Ignore high holds
591 onsite_checkout - Checkout is an onsite checkout that will not leave the library
599 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
600 Possible values are :
606 sticky due date is invalid
610 borrower gone with no address
614 borrower declared it's card lost
620 =head3 UNKNOWN_BARCODE
634 item is restricted (set by ??)
636 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
637 could be prevented, but ones that can be overriden by the operator.
639 Possible values are :
647 renewing, not issuing
649 =head3 ISSUED_TO_ANOTHER
651 issued to someone else.
655 reserved for someone else.
659 sticky due date is invalid or due date in the past
663 if the borrower borrows to much things
667 sub CanBookBeIssued {
668 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
669 my %needsconfirmation; # filled with problems that needs confirmations
670 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
671 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
672 my %messages; # filled with information messages that should be displayed.
674 my $onsite_checkout = $params->{onsite_checkout} || 0;
675 my $override_high_holds = $params->{override_high_holds} || 0;
677 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
678 my $issue = GetItemIssue($item->{itemnumber});
679 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
680 $item->{'itemtype'}=$item->{'itype'};
681 my $dbh = C4::Context->dbh;
683 # MANDATORY CHECKS - unless item exists, nothing else matters
684 unless ( $item->{barcode} ) {
685 $issuingimpossible{UNKNOWN_BARCODE} = 1;
687 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
690 # DUE DATE is OK ? -- should already have checked.
692 if ($duedate && ref $duedate ne 'DateTime') {
693 $duedate = dt_from_string($duedate);
695 my $now = DateTime->now( time_zone => C4::Context->tz() );
696 unless ( $duedate ) {
697 my $issuedate = $now->clone();
699 my $branch = _GetCircControlBranch($item,$borrower);
700 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
701 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
703 # Offline circ calls AddIssue directly, doesn't run through here
704 # So issuingimpossible should be ok.
707 my $today = $now->clone();
708 $today->truncate( to => 'minute');
709 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
710 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
713 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
719 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
720 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
722 branch => C4::Context->userenv->{'branch'},
724 itemnumber => $item->{'itemnumber'},
725 itemtype => $item->{'itype'},
726 borrowernumber => $borrower->{'borrowernumber'},
727 ccode => $item->{'ccode'}}
729 ModDateLastSeen( $item->{'itemnumber'} );
730 return( { STATS => 1 }, {});
732 if ( ref $borrower->{flags} ) {
733 if ( $borrower->{flags}->{GNA} ) {
734 $issuingimpossible{GNA} = 1;
736 if ( $borrower->{flags}->{'LOST'} ) {
737 $issuingimpossible{CARD_LOST} = 1;
739 if ( $borrower->{flags}->{'DBARRED'} ) {
740 $issuingimpossible{DEBARRED} = 1;
743 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
744 $issuingimpossible{EXPIRED} = 1;
746 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'sql', 'floating' );
747 $expiry_dt->truncate( to => 'day');
748 my $today = $now->clone()->truncate(to => 'day');
749 $today->set_time_zone( 'floating' );
750 if ( DateTime->compare($today, $expiry_dt) == 1 ) {
751 $issuingimpossible{EXPIRED} = 1;
760 my ($balance, $non_issue_charges, $other_charges) =
761 C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
763 my $amountlimit = C4::Context->preference("noissuescharge");
764 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
765 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
767 # Check the debt of this patrons guarantees
768 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
769 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
770 if ( defined $no_issues_charge_guarantees ) {
771 my $p = Koha::Patrons->find( $borrower->{borrowernumber} );
772 my @guarantees = $p->guarantees();
773 my $guarantees_non_issues_charges;
774 foreach my $g ( @guarantees ) {
775 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
776 $guarantees_non_issues_charges += $n;
779 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
780 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
781 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
782 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
783 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
784 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
788 if ( C4::Context->preference("IssuingInProcess") ) {
789 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
790 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
791 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
792 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
793 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
794 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
798 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
799 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
800 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
801 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
802 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
803 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
807 if ($balance > 0 && $other_charges > 0) {
808 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
811 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
812 if ( my $debarred_date = $patron->is_debarred ) {
813 # patron has accrued fine days or has a restriction. $count is a date
814 if ($debarred_date eq '9999-12-31') {
815 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
818 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
820 } elsif ( my $num_overdues = $patron->has_overdues ) {
821 ## patron has outstanding overdue loans
822 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
823 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
825 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
826 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
830 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
832 my $switch_onsite_checkout = (
833 C4::Context->preference('SwitchOnSiteCheckouts')
834 and $issue->{onsite_checkout}
836 and $issue->{borrowernumber} == $borrower->{'borrowernumber'} ? 1 : 0 );
837 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
838 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
840 if ( $toomany->{max_allowed} == 0 ) {
841 $needsconfirmation{PATRON_CANT} = 1;
843 if ( C4::Context->preference("AllowTooManyOverride") ) {
844 $needsconfirmation{TOO_MANY} = $toomany->{reason};
845 $needsconfirmation{current_loan_count} = $toomany->{count};
846 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
848 $issuingimpossible{TOO_MANY} = $toomany->{reason};
849 $issuingimpossible{current_loan_count} = $toomany->{count};
850 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
855 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
857 $patron = Koha::Patrons->find($borrower->{borrowernumber});
858 my $wants_check = $patron->wants_check_for_previous_checkout;
859 $needsconfirmation{PREVISSUE} = 1
860 if ($wants_check and $patron->do_check_for_previous_checkout($item));
865 if ( $item->{'notforloan'} )
867 if(!C4::Context->preference("AllowNotForLoanOverride")){
868 $issuingimpossible{NOT_FOR_LOAN} = 1;
869 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
871 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
872 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
876 # we have to check itemtypes.notforloan also
877 if (C4::Context->preference('item-level_itypes')){
878 # this should probably be a subroutine
879 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
880 $sth->execute($item->{'itemtype'});
881 my $notforloan=$sth->fetchrow_hashref();
882 if ($notforloan->{'notforloan'}) {
883 if (!C4::Context->preference("AllowNotForLoanOverride")) {
884 $issuingimpossible{NOT_FOR_LOAN} = 1;
885 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
887 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
888 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
892 elsif ($biblioitem->{'notforloan'} == 1){
893 if (!C4::Context->preference("AllowNotForLoanOverride")) {
894 $issuingimpossible{NOT_FOR_LOAN} = 1;
895 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
897 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
898 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
902 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
904 $issuingimpossible{WTHDRAWN} = 1;
906 if ( $item->{'restricted'}
907 && $item->{'restricted'} == 1 )
909 $issuingimpossible{RESTRICTED} = 1;
911 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
912 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->{itemlost} });
913 my $code = $av->count ? $av->next->lib : '';
914 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
915 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
917 if ( C4::Context->preference("IndependentBranches") ) {
918 my $userenv = C4::Context->userenv;
919 unless ( C4::Context->IsSuperLibrarian() ) {
920 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
921 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
922 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
924 $needsconfirmation{BORRNOTSAMEBRANCH} = $borrower->{'branchcode'}
925 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
929 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
931 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
933 if ( $rentalConfirmation ){
934 my ($rentalCharge) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
935 if ( $rentalCharge > 0 ){
936 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
941 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
943 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} ){
945 # Already issued to current borrower.
946 # If it is an on-site checkout if it can be switched to a normal checkout
947 # or ask whether the loan should be renewed
949 if ( $issue->{onsite_checkout}
950 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
951 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
953 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
954 $borrower->{'borrowernumber'},
955 $item->{'itemnumber'},
957 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
958 if ( $renewerror eq 'onsite_checkout' ) {
959 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
962 $issuingimpossible{NO_MORE_RENEWALS} = 1;
966 $needsconfirmation{RENEW_ISSUE} = 1;
970 elsif ($issue->{borrowernumber}) {
972 # issued to someone else
973 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
976 my ( $can_be_returned, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
978 unless ( $can_be_returned ) {
979 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
980 $issuingimpossible{branch_to_return} = $message;
982 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
983 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
984 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
985 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
986 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
990 unless ( $ignore_reserves ) {
991 # See if the item is on reserve.
992 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
994 my $resbor = $res->{'borrowernumber'};
995 if ( $resbor ne $borrower->{'borrowernumber'} ) {
996 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
997 if ( $restype eq "Waiting" )
999 # The item is on reserve and waiting, but has been
1000 # reserved by some other patron.
1001 $needsconfirmation{RESERVE_WAITING} = 1;
1002 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1003 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1004 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1005 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1006 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1007 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1009 elsif ( $restype eq "Reserved" ) {
1010 # The item is on reserve for someone else.
1011 $needsconfirmation{RESERVED} = 1;
1012 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1013 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1014 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1015 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1016 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1017 $needsconfirmation{'resreservedate'} = $res->{'reservedate'};
1023 ## CHECK AGE RESTRICTION
1024 my $agerestriction = $biblioitem->{'agerestriction'};
1025 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $borrower );
1026 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1027 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1028 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1031 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1035 ## check for high holds decreasing loan period
1036 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1037 my $check = checkHighHolds( $item, $borrower );
1039 if ( $check->{exceeded} ) {
1040 if ($override_high_holds) {
1041 $alerts{HIGHHOLDS} = {
1042 num_holds => $check->{outstanding},
1043 duration => $check->{duration},
1044 returndate => output_pref( $check->{due_date} ),
1048 $needsconfirmation{HIGHHOLDS} = {
1049 num_holds => $check->{outstanding},
1050 duration => $check->{duration},
1051 returndate => output_pref( $check->{due_date} ),
1058 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1059 # don't do the multiple loans per bib check if we've
1060 # already determined that we've got a loan on the same item
1061 !$issuingimpossible{NO_MORE_RENEWALS} &&
1062 !$needsconfirmation{RENEW_ISSUE}
1064 # Check if borrower has already issued an item from the same biblio
1065 # Only if it's not a subscription
1066 my $biblionumber = $item->{biblionumber};
1067 require C4::Serials;
1068 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1069 unless ($is_a_subscription) {
1070 my $issues = GetIssues( {
1071 borrowernumber => $borrower->{borrowernumber},
1072 biblionumber => $biblionumber,
1074 my @issues = $issues ? @$issues : ();
1075 # if we get here, we don't already have a loan on this item,
1076 # so if there are any loans on this bib, ask for confirmation
1077 if (scalar @issues > 0) {
1078 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1083 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1086 =head2 CanBookBeReturned
1088 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1090 Check whether the item can be returned to the provided branch
1094 =item C<$item> is a hash of item information as returned from GetItem
1096 =item C<$branch> is the branchcode where the return is taking place
1104 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1106 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1112 sub CanBookBeReturned {
1113 my ($item, $branch) = @_;
1114 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1116 # assume return is allowed to start
1120 # identify all cases where return is forbidden
1121 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1123 $message = $item->{'homebranch'};
1124 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1126 $message = $item->{'holdingbranch'};
1127 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1129 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1132 return ($allowed, $message);
1135 =head2 CheckHighHolds
1137 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1138 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1139 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1143 sub checkHighHolds {
1144 my ( $item, $borrower ) = @_;
1145 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1146 my $branch = _GetCircControlBranch( $item, $borrower );
1155 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1157 if ( $holds->count() ) {
1158 $return_data->{outstanding} = $holds->count();
1160 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1161 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1162 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1164 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1166 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1168 # static means just more than a given number of holds on the record
1170 # If the number of holds is less than the threshold, we can stop here
1171 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1172 return $return_data;
1175 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1177 # dynamic means X more than the number of holdable items on the record
1179 # let's get the items
1180 my @items = $holds->next()->biblio()->items();
1182 # Remove any items with status defined to be ignored even if the would not make item unholdable
1183 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1184 @items = grep { !$_->$status } @items;
1187 # Remove any items that are not holdable for this patron
1188 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber ) eq 'OK' } @items;
1190 my $items_count = scalar @items;
1192 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1194 # If the number of holds is less than the count of items we have
1195 # plus the number of holds allowed above that count, we can stop here
1196 if ( $holds->count() <= $threshold ) {
1197 return $return_data;
1201 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1203 my $calendar = Koha::Calendar->new( branchcode => $branch );
1206 ( C4::Context->preference('item-level_itypes') )
1207 ? $biblio->{'itype'}
1208 : $biblio->{'itemtype'};
1210 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1212 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1214 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1215 $reduced_datedue->set_hour($orig_due->hour);
1216 $reduced_datedue->set_minute($orig_due->minute);
1217 $reduced_datedue->truncate( to => 'minute' );
1219 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1220 $return_data->{exceeded} = 1;
1221 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1222 $return_data->{due_date} = $reduced_datedue;
1226 return $return_data;
1231 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1233 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1237 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1239 =item C<$barcode> is the barcode of the item being issued.
1241 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1242 Calculated if empty.
1244 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1246 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1247 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1249 AddIssue does the following things :
1251 - step 01: check that there is a borrowernumber & a barcode provided
1252 - check for RENEWAL (book issued & being issued to the same patron)
1253 - renewal YES = Calculate Charge & renew
1255 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1257 - fill reserve if reserve to this patron
1258 - cancel reserve or not, otherwise
1259 * TRANSFERT PENDING ?
1260 - complete the transfert
1268 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1270 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1271 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1272 my $auto_renew = $params && $params->{auto_renew};
1273 my $dbh = C4::Context->dbh;
1274 my $barcodecheck = CheckValidBarcode($barcode);
1278 if ( $datedue && ref $datedue ne 'DateTime' ) {
1279 $datedue = dt_from_string($datedue);
1282 # $issuedate defaults to today.
1283 if ( !defined $issuedate ) {
1284 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1287 if ( ref $issuedate ne 'DateTime' ) {
1288 $issuedate = dt_from_string($issuedate);
1293 # Stop here if the patron or barcode doesn't exist
1294 if ( $borrower && $barcode && $barcodecheck ) {
1295 # find which item we issue
1296 my $item = GetItem( '', $barcode )
1297 or return; # if we don't get an Item, abort.
1299 my $branch = _GetCircControlBranch( $item, $borrower );
1301 # get actual issuing if there is one
1302 my $actualissue = GetItemIssue( $item->{itemnumber} );
1304 # get biblioinformation for this item
1305 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1307 # check if we just renew the issue.
1308 if ( $actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}
1309 and not $switch_onsite_checkout ) {
1310 $datedue = AddRenewal(
1311 $borrower->{'borrowernumber'},
1312 $item->{'itemnumber'},
1315 $issuedate, # here interpreted as the renewal date
1319 # it's NOT a renewal
1320 if ( $actualissue->{borrowernumber}
1321 and not $switch_onsite_checkout ) {
1322 # This book is currently on loan, but not to the person
1323 # who wants to borrow it now. mark it returned before issuing to the new borrower
1324 my ( $allowed, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
1325 return unless $allowed;
1326 AddReturn( $item->{'barcode'}, C4::Context->userenv->{'branch'} );
1329 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1331 # Starting process for transfer job (checking transfert and validate it if we have one)
1332 my ($datesent) = GetTransfers( $item->{'itemnumber'} );
1334 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1335 my $sth = $dbh->prepare(
1336 "UPDATE branchtransfers
1337 SET datearrived = now(),
1339 comments = 'Forced branchtransfer'
1340 WHERE itemnumber= ? AND datearrived IS NULL"
1342 $sth->execute( C4::Context->userenv->{'branch'},
1343 $item->{'itemnumber'} );
1346 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1347 unless ($auto_renew) {
1348 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1349 { categorycode => $borrower->{categorycode},
1350 itemtype => $item->{itype},
1351 branchcode => $branch
1355 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1358 # Record in the database the fact that the book was issued.
1361 ( C4::Context->preference('item-level_itypes') )
1362 ? $biblio->{'itype'}
1363 : $biblio->{'itemtype'};
1364 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1367 $datedue->truncate( to => 'minute' );
1369 $issue = Koha::Database->new()->schema()->resultset('Issue')->update_or_create(
1371 borrowernumber => $borrower->{'borrowernumber'},
1372 itemnumber => $item->{'itemnumber'},
1373 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1374 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1375 branchcode => C4::Context->userenv->{'branch'},
1376 onsite_checkout => $onsite_checkout,
1377 auto_renew => $auto_renew ? 1 : 0
1381 if ( C4::Context->preference('ReturnToShelvingCart') ) {
1382 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1383 CartToShelf( $item->{'itemnumber'} );
1385 $item->{'issues'}++;
1386 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1387 UpdateTotalIssues( $item->{'biblionumber'}, 1 );
1390 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1391 if ( $item->{'itemlost'} ) {
1393 Koha::RefundLostItemFeeRules->should_refund(
1395 current_branch => C4::Context->userenv->{branch},
1396 item_home_branch => $item->{homebranch},
1397 item_holding_branch => $item->{holdingbranch}
1402 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef,
1403 $item->{'barcode'} );
1409 issues => $item->{'issues'},
1410 holdingbranch => C4::Context->userenv->{'branch'},
1412 onloan => $datedue->ymd(),
1413 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1415 $item->{'biblionumber'},
1416 $item->{'itemnumber'}
1418 ModDateLastSeen( $item->{'itemnumber'} );
1420 # If it costs to borrow this book, charge it to the patron's account.
1421 my ( $charge, $itemtype ) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1422 if ( $charge > 0 ) {
1423 AddIssuingCharge( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $charge );
1424 $item->{'charge'} = $charge;
1427 # Record the fact that this book was issued.
1430 branch => C4::Context->userenv->{'branch'},
1431 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1433 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1434 itemnumber => $item->{'itemnumber'},
1435 itemtype => $item->{'itype'},
1436 borrowernumber => $borrower->{'borrowernumber'},
1437 ccode => $item->{'ccode'}
1441 # Send a checkout slip.
1442 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1444 branchcode => $branch,
1445 categorycode => $borrower->{categorycode},
1446 item_type => $item->{itype},
1447 notification => 'CHECKOUT',
1449 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1450 SendCirculationAlert(
1454 borrower => $borrower,
1462 "CIRCULATION", "ISSUE",
1463 $borrower->{'borrowernumber'},
1464 $biblio->{'itemnumber'}
1465 ) if C4::Context->preference("IssueLog");
1470 =head2 GetLoanLength
1472 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1474 Get loan length for an itemtype, a borrower type and a branch
1479 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1480 my $dbh = C4::Context->dbh;
1481 my $sth = $dbh->prepare(qq{
1482 SELECT issuelength, lengthunit, renewalperiod
1484 WHERE categorycode=?
1487 AND issuelength IS NOT NULL
1490 # try to find issuelength & return the 1st available.
1491 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1492 $sth->execute( $borrowertype, $itemtype, $branchcode );
1493 my $loanlength = $sth->fetchrow_hashref;
1496 if defined($loanlength) && defined $loanlength->{issuelength};
1498 $sth->execute( $borrowertype, '*', $branchcode );
1499 $loanlength = $sth->fetchrow_hashref;
1501 if defined($loanlength) && defined $loanlength->{issuelength};
1503 $sth->execute( '*', $itemtype, $branchcode );
1504 $loanlength = $sth->fetchrow_hashref;
1506 if defined($loanlength) && defined $loanlength->{issuelength};
1508 $sth->execute( '*', '*', $branchcode );
1509 $loanlength = $sth->fetchrow_hashref;
1511 if defined($loanlength) && defined $loanlength->{issuelength};
1513 $sth->execute( $borrowertype, $itemtype, '*' );
1514 $loanlength = $sth->fetchrow_hashref;
1516 if defined($loanlength) && defined $loanlength->{issuelength};
1518 $sth->execute( $borrowertype, '*', '*' );
1519 $loanlength = $sth->fetchrow_hashref;
1521 if defined($loanlength) && defined $loanlength->{issuelength};
1523 $sth->execute( '*', $itemtype, '*' );
1524 $loanlength = $sth->fetchrow_hashref;
1526 if defined($loanlength) && defined $loanlength->{issuelength};
1528 $sth->execute( '*', '*', '*' );
1529 $loanlength = $sth->fetchrow_hashref;
1531 if defined($loanlength) && defined $loanlength->{issuelength};
1533 # if no rule is set => 0 day (hardcoded)
1537 lengthunit => 'days',
1543 =head2 GetHardDueDate
1545 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1547 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1551 sub GetHardDueDate {
1552 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1554 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1555 { categorycode => $borrowertype,
1556 itemtype => $itemtype,
1557 branchcode => $branchcode
1562 if ( defined( $issuing_rule ) ) {
1563 if ( $issuing_rule->hardduedate ) {
1564 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1566 return (undef, undef);
1571 =head2 GetBranchBorrowerCircRule
1573 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1575 Retrieves circulation rule attributes that apply to the given
1576 branch and patron category, regardless of item type.
1577 The return value is a hashref containing the following key:
1579 maxissueqty - maximum number of loans that a
1580 patron of the given category can have at the given
1581 branch. If the value is undef, no limit.
1583 maxonsiteissueqty - maximum of on-site checkouts that a
1584 patron of the given category can have at the given
1585 branch. If the value is undef, no limit.
1587 This will first check for a specific branch and
1588 category match from branch_borrower_circ_rules.
1590 If no rule is found, it will then check default_branch_circ_rules
1591 (same branch, default category). If no rule is found,
1592 it will then check default_borrower_circ_rules (default
1593 branch, same category), then failing that, default_circ_rules
1594 (default branch, default category).
1596 If no rule has been found in the database, it will default to
1600 maxonsiteissueqty - undef
1602 C<$branchcode> and C<$categorycode> should contain the
1603 literal branch code and patron category code, respectively - no
1608 sub GetBranchBorrowerCircRule {
1609 my ( $branchcode, $categorycode ) = @_;
1612 my $dbh = C4::Context->dbh();
1613 $rules = $dbh->selectrow_hashref( q|
1614 SELECT maxissueqty, maxonsiteissueqty
1615 FROM branch_borrower_circ_rules
1616 WHERE branchcode = ?
1617 AND categorycode = ?
1618 |, {}, $branchcode, $categorycode ) ;
1619 return $rules if $rules;
1621 # try same branch, default borrower category
1622 $rules = $dbh->selectrow_hashref( q|
1623 SELECT maxissueqty, maxonsiteissueqty
1624 FROM default_branch_circ_rules
1625 WHERE branchcode = ?
1626 |, {}, $branchcode ) ;
1627 return $rules if $rules;
1629 # try default branch, same borrower category
1630 $rules = $dbh->selectrow_hashref( q|
1631 SELECT maxissueqty, maxonsiteissueqty
1632 FROM default_borrower_circ_rules
1633 WHERE categorycode = ?
1634 |, {}, $categorycode ) ;
1635 return $rules if $rules;
1637 # try default branch, default borrower category
1638 $rules = $dbh->selectrow_hashref( q|
1639 SELECT maxissueqty, maxonsiteissueqty
1640 FROM default_circ_rules
1642 return $rules if $rules;
1644 # built-in default circulation rule
1646 maxissueqty => undef,
1647 maxonsiteissueqty => undef,
1651 =head2 GetBranchItemRule
1653 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1655 Retrieves circulation rule attributes that apply to the given
1656 branch and item type, regardless of patron category.
1658 The return value is a hashref containing the following keys:
1660 holdallowed => Hold policy for this branch and itemtype. Possible values:
1661 0: No holds allowed.
1662 1: Holds allowed only by patrons that have the same homebranch as the item.
1663 2: Holds allowed from any patron.
1665 returnbranch => branch to which to return item. Possible values:
1666 noreturn: do not return, let item remain where checked in (floating collections)
1667 homebranch: return to item's home branch
1668 holdingbranch: return to issuer branch
1670 This searches branchitemrules in the following order:
1672 * Same branchcode and itemtype
1673 * Same branchcode, itemtype '*'
1674 * branchcode '*', same itemtype
1675 * branchcode and itemtype '*'
1677 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1681 sub GetBranchItemRule {
1682 my ( $branchcode, $itemtype ) = @_;
1683 my $dbh = C4::Context->dbh();
1687 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1688 FROM branch_item_rules
1689 WHERE branchcode = ?
1690 AND itemtype = ?', $branchcode, $itemtype],
1691 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1692 FROM default_branch_circ_rules
1693 WHERE branchcode = ?', $branchcode],
1694 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1695 FROM default_branch_item_rules
1696 WHERE itemtype = ?', $itemtype],
1697 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1698 FROM default_circ_rules'],
1701 foreach my $attempt (@attempts) {
1702 my ($query, @bind_params) = @{$attempt};
1703 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1706 # Since branch/category and branch/itemtype use the same per-branch
1707 # defaults tables, we have to check that the key we want is set, not
1708 # just that a row was returned
1709 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1710 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1711 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1714 # built-in default circulation rule
1715 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1716 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1717 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1724 ($doreturn, $messages, $iteminformation, $borrower) =
1725 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1731 =item C<$barcode> is the bar code of the book being returned.
1733 =item C<$branch> is the code of the branch where the book is being returned.
1735 =item C<$exemptfine> indicates that overdue charges for the item will be
1738 =item C<$dropbox> indicates that the check-in date is assumed to be
1739 yesterday, or the last non-holiday as defined in C4::Calendar . If
1740 overdue charges are applied and C<$dropbox> is true, the last charge
1741 will be removed. This assumes that the fines accrual script has run
1742 for _today_. Optional.
1744 =item C<$return_date> allows the default return date to be overridden
1745 by the given return date. Optional.
1749 C<&AddReturn> returns a list of four items:
1751 C<$doreturn> is true iff the return succeeded.
1753 C<$messages> is a reference-to-hash giving feedback on the operation.
1754 The keys of the hash are:
1760 No item with this barcode exists. The value is C<$barcode>.
1764 The book is not currently on loan. The value is C<$barcode>.
1766 =item C<IsPermanent>
1768 The book's home branch is a permanent collection. If you have borrowed
1769 this book, you are not allowed to return it. The value is the code for
1770 the book's home branch.
1774 This book has been withdrawn/cancelled. The value should be ignored.
1776 =item C<Wrongbranch>
1778 This book has was returned to the wrong branch. The value is a hashref
1779 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1780 contain the branchcode of the incorrect and correct return library, respectively.
1784 The item was reserved. The value is a reference-to-hash whose keys are
1785 fields from the reserves table of the Koha database, and
1786 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1787 either C<Waiting>, C<Reserved>, or 0.
1789 =item C<WasReturned>
1791 Value 1 if return is successful.
1793 =item C<NeedsTransfer>
1795 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1799 C<$iteminformation> is a reference-to-hash, giving information about the
1800 returned item from the issues table.
1802 C<$borrower> is a reference-to-hash, giving information about the
1803 patron who last borrowed the book.
1808 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1810 if ($branch and not Koha::Libraries->find($branch)) {
1811 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1814 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1818 my $validTransfert = 0;
1819 my $stat_type = 'return';
1821 # get information on item
1822 my $item = GetItem( undef, $barcode );
1824 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1827 my $itemnumber = $item->{ itemnumber };
1829 my $item_level_itypes = C4::Context->preference("item-level_itypes");
1830 my $biblio = $item_level_itypes ? undef : GetBiblioData( $item->{ biblionumber } ); # don't get bib data unless we need it
1831 my $itemtype = $item_level_itypes ? $item->{itype} : $biblio->{itemtype};
1833 my $issue = GetItemIssue($itemnumber);
1834 if ($issue and $issue->{borrowernumber}) {
1835 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1836 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '$issue->{borrowernumber}'\n"
1837 . Dumper($issue) . "\n";
1839 $messages->{'NotIssued'} = $barcode;
1840 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1842 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1843 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1844 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1845 $messages->{'LocalUse'} = 1;
1846 $stat_type = 'localuse';
1850 if ( $item->{'location'} eq 'PROC' ) {
1851 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1852 $item->{'location'} = 'CART';
1855 $item->{location} = $item->{permanent_location};
1858 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
1861 # full item data, but no borrowernumber or checkout info (no issue)
1862 # we know GetItem should work because GetItemnumberFromBarcode worked
1863 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1864 # get the proper branch to which to return the item
1865 my $returnbranch = $item->{$hbr} || $branch ;
1866 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1868 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1870 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1872 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1874 eval { $rules = YAML::Load($yaml); };
1876 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1879 foreach my $key ( keys %$rules ) {
1880 if ( $item->{notforloan} eq $key ) {
1881 $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1882 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1890 # check if the book is in a permanent collection....
1891 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1892 if ( $returnbranch ) {
1893 my $library = Koha::Libraries->find($returnbranch);
1894 if ( $library and $library->get_categories->search({'me.categorycode' => 'PE'})->count ) {
1895 $messages->{'IsPermanent'} = $returnbranch;
1899 # check if the return is allowed at this branch
1900 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1901 unless ($returnallowed){
1902 $messages->{'Wrongbranch'} = {
1903 Wrongbranch => $branch,
1904 Rightbranch => $message
1907 return ( $doreturn, $messages, $issue, $borrower );
1910 if ( $item->{'withdrawn'} ) { # book has been cancelled
1911 $messages->{'withdrawn'} = 1;
1912 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1915 # case of a return of document (deal with issues and holdingbranch)
1916 my $today = DateTime->now( time_zone => C4::Context->tz() );
1919 my $datedue = $issue->{date_due};
1920 $borrower or warn "AddReturn without current borrower";
1921 my $circControlBranch;
1923 # define circControlBranch only if dropbox mode is set
1924 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1925 # FIXME: check issuedate > returndate, factoring in holidays
1927 $circControlBranch = _GetCircControlBranch($item,$borrower);
1928 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $dropboxdate ) == -1 ? 1 : 0;
1931 if ($borrowernumber) {
1932 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'} ) || $return_date ) {
1933 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $borrower, return_date => $return_date } );
1937 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1938 $circControlBranch, $return_date, $borrower->{'privacy'} );
1941 $messages->{'Wrongbranch'} = {
1942 Wrongbranch => $branch,
1943 Rightbranch => $message
1946 return ( 0, { WasReturned => 0 }, $issue, $borrower );
1949 # FIXME is the "= 1" right? This could be the borrower hash.
1950 $messages->{'WasReturned'} = 1;
1954 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1957 # the holdingbranch is updated if the document is returned to another location.
1958 # this is always done regardless of whether the item was on loan or not
1959 my $item_holding_branch = $item->{ holdingbranch };
1960 if ($item->{'holdingbranch'} ne $branch) {
1961 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1962 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1964 ModDateLastSeen( $item->{'itemnumber'} );
1966 # check if we have a transfer for this document
1967 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1969 # if we have a transfer to do, we update the line of transfers with the datearrived
1970 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1972 if ( $tobranch eq $branch ) {
1973 my $sth = C4::Context->dbh->prepare(
1974 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1976 $sth->execute( $item->{'itemnumber'} );
1977 # if we have a reservation with valid transfer, we can set it's status to 'W'
1978 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1979 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1981 $messages->{'WrongTransfer'} = $tobranch;
1982 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1984 $validTransfert = 1;
1986 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1989 # fix up the accounts.....
1990 if ( $item->{'itemlost'} ) {
1991 $messages->{'WasLost'} = 1;
1993 if ( $item->{'itemlost'} ) {
1995 Koha::RefundLostItemFeeRules->should_refund(
1997 current_branch => C4::Context->userenv->{branch},
1998 item_home_branch => $item->{homebranch},
1999 item_holding_branch => $item_holding_branch
2004 _FixAccountForLostAndReturned( $item->{'itemnumber'}, $borrowernumber, $barcode );
2005 $messages->{'LostItemFeeRefunded'} = 1;
2010 # fix up the overdues in accounts...
2011 if ($borrowernumber) {
2012 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
2013 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
2015 if ( $issue->{overdue} && $issue->{date_due} ) {
2017 $today = $dropboxdate if $dropbox;
2018 my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
2020 $messages->{'PrevDebarred'} = $debardate;
2022 $messages->{'Debarred'} = $debardate if $debardate;
2024 # there's no overdue on the item but borrower had been previously debarred
2025 } elsif ( $issue->{date_due} and $borrower->{'debarred'} ) {
2026 if ( $borrower->{debarred} eq "9999-12-31") {
2027 $messages->{'ForeverDebarred'} = $borrower->{'debarred'};
2029 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2030 $borrower_debar_dt->truncate(to => 'day');
2031 my $today_dt = $today->clone()->truncate(to => 'day');
2032 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2033 $messages->{'PrevDebarred'} = $borrower->{'debarred'};
2039 # find reserves.....
2040 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2041 my ($resfound, $resrec);
2042 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2043 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2045 $resrec->{'ResFound'} = $resfound;
2046 $messages->{'ResFound'} = $resrec;
2049 # Record the fact that this book was returned.
2053 itemnumber => $itemnumber,
2054 itemtype => $itemtype,
2055 borrowernumber => $borrowernumber,
2056 ccode => $item->{ ccode }
2059 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
2060 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2062 branchcode => $branch,
2063 categorycode => $borrower->{categorycode},
2064 item_type => $item->{itype},
2065 notification => 'CHECKIN',
2067 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2068 SendCirculationAlert({
2071 borrower => $borrower,
2076 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2077 if C4::Context->preference("ReturnLog");
2079 # Remove any OVERDUES related debarment if the borrower has no overdues
2080 if ( $borrowernumber
2081 && $borrower->{'debarred'}
2082 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2083 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2084 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2086 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2089 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2090 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2091 if (C4::Context->preference("AutomaticItemReturn" ) or
2092 (C4::Context->preference("UseBranchTransferLimits") and
2093 ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2095 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2096 $debug and warn "item: " . Dumper($item);
2097 ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2098 $messages->{'WasTransfered'} = 1;
2100 $messages->{'NeedsTransfer'} = $returnbranch;
2104 return ( $doreturn, $messages, $issue, $borrower );
2107 =head2 MarkIssueReturned
2109 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2111 Unconditionally marks an issue as being returned by
2112 moving the C<issues> row to C<old_issues> and
2113 setting C<returndate> to the current date, or
2114 the last non-holiday date of the branccode specified in
2115 C<dropbox_branch> . Assumes you've already checked that
2116 it's safe to do this, i.e. last non-holiday > issuedate.
2118 if C<$returndate> is specified (in iso format), it is used as the date
2119 of the return. It is ignored when a dropbox_branch is passed in.
2121 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2122 the old_issue is immediately anonymised
2124 Ideally, this function would be internal to C<C4::Circulation>,
2125 not exported, but it is currently needed by one
2126 routine in C<C4::Accounts>.
2130 sub MarkIssueReturned {
2131 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2133 my $anonymouspatron;
2134 if ( $privacy == 2 ) {
2135 # The default of 0 will not work due to foreign key constraints
2136 # The anonymisation will fail if AnonymousPatron is not a valid entry
2137 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2138 # Note that a warning should appear on the about page (System information tab).
2139 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2140 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."
2141 unless C4::Members::GetMember( borrowernumber => $anonymouspatron );
2143 my $database = Koha::Database->new();
2144 my $schema = $database->schema;
2145 my $dbh = C4::Context->dbh;
2147 my $issue_id = $dbh->selectrow_array(
2148 q|SELECT issue_id FROM issues WHERE itemnumber = ?|,
2152 my $query = 'UPDATE issues SET returndate=';
2154 if ($dropbox_branch) {
2155 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2156 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2158 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2159 } elsif ($returndate) {
2161 push @bind, $returndate;
2163 $query .= ' now() ';
2165 $query .= ' WHERE issue_id = ?';
2166 push @bind, $issue_id;
2168 # FIXME Improve the return value and handle it from callers
2169 $schema->txn_do(sub {
2170 $dbh->do( $query, undef, @bind );
2172 my $id_already_exists = $dbh->selectrow_array(
2173 q|SELECT COUNT(*) FROM old_issues WHERE issue_id = ?|,
2177 if ( $id_already_exists ) {
2178 my $new_issue_id = $dbh->selectrow_array(q|SELECT MAX(issue_id)+1 FROM old_issues|);
2180 q|UPDATE issues SET issue_id = ? WHERE issue_id = ?|,
2181 undef, $new_issue_id, $issue_id
2183 $issue_id = $new_issue_id;
2186 $dbh->do(q|INSERT INTO old_issues SELECT * FROM issues WHERE issue_id = ?|, undef, $issue_id);
2188 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2189 if ( $privacy == 2) {
2190 $dbh->do(q|UPDATE old_issues SET borrowernumber=? WHERE issue_id = ?|, undef, $anonymouspatron, $issue_id);
2193 $dbh->do(q|DELETE FROM issues WHERE issue_id = ?|, undef, $issue_id);
2195 ModItem( { 'onloan' => undef }, undef, $itemnumber );
2197 if ( C4::Context->preference('StoreLastBorrower') ) {
2198 my $item = Koha::Items->find( $itemnumber );
2199 my $patron = Koha::Patrons->find( $borrowernumber );
2200 $item->last_returned_by( $patron );
2205 =head2 _debar_user_on_return
2207 _debar_user_on_return($borrower, $item, $datedue, today);
2209 C<$borrower> borrower hashref
2211 C<$item> item hashref
2213 C<$datedue> date due DateTime object
2215 C<$today> DateTime object representing the return time
2217 Internal function, called only by AddReturn that calculates and updates
2218 the user fine days, and debars him if necessary.
2220 Should only be called for overdue returns
2224 sub _debar_user_on_return {
2225 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2227 my $branchcode = _GetCircControlBranch( $item, $borrower );
2229 my $circcontrol = C4::Context->preference('CircControl');
2230 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2231 { categorycode => $borrower->{categorycode},
2232 itemtype => $item->{itype},
2233 branchcode => $branchcode
2236 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2237 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2238 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $dt_today, $branchcode);
2242 # finedays is in days, so hourly loans must multiply by 24
2243 # thus 1 hour late equals 1 day suspension * finedays rate
2244 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2246 # grace period is measured in the same units as the loan
2248 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2250 my $deltadays = DateTime::Duration->new(
2251 days => $chargeable_units
2253 if ( $deltadays->subtract($grace)->is_positive() ) {
2254 my $suspension_days = $deltadays * $finedays;
2256 # If the max suspension days is < than the suspension days
2257 # the suspension days is limited to this maximum period.
2258 my $max_sd = $issuing_rule->maxsuspensiondays;
2259 if ( defined $max_sd ) {
2260 $max_sd = DateTime::Duration->new( days => $max_sd );
2261 $suspension_days = $max_sd
2262 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2266 $dt_today->clone()->add_duration( $suspension_days );
2268 Koha::Patron::Debarments::AddUniqueDebarment({
2269 borrowernumber => $borrower->{borrowernumber},
2270 expiration => $new_debar_dt->ymd(),
2271 type => 'SUSPENSION',
2273 # if borrower was already debarred but does not get an extra debarment
2274 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2275 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2276 return ($borrower->{debarred},1);
2278 return $new_debar_dt->ymd();
2284 =head2 _FixOverduesOnReturn
2286 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2288 C<$brn> borrowernumber
2292 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2293 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2295 Internal function, called only by AddReturn
2299 sub _FixOverduesOnReturn {
2300 my ($borrowernumber, $item);
2301 unless ($borrowernumber = shift) {
2302 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2305 unless ($item = shift) {
2306 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2309 my ($exemptfine, $dropbox) = @_;
2310 my $dbh = C4::Context->dbh;
2312 # check for overdue fine
2313 my $sth = $dbh->prepare(
2314 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2316 $sth->execute( $borrowernumber, $item );
2318 # alter fine to show that the book has been returned
2319 my $data = $sth->fetchrow_hashref;
2320 return 0 unless $data; # no warning, there's just nothing to fix
2323 my @bind = ($data->{'accountlines_id'});
2325 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2326 if (C4::Context->preference("FinesLog")) {
2327 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2329 } elsif ($dropbox && $data->{lastincrement}) {
2330 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2331 my $amt = $data->{amount} - $data->{lastincrement} ;
2332 if (C4::Context->preference("FinesLog")) {
2333 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2335 $uquery = "update accountlines set accounttype='F' ";
2336 if($outstanding >= 0 && $amt >=0) {
2337 $uquery .= ", amount = ? , amountoutstanding=? ";
2338 unshift @bind, ($amt, $outstanding) ;
2341 $uquery = "update accountlines set accounttype='F' ";
2343 $uquery .= " where (accountlines_id = ?)";
2344 my $usth = $dbh->prepare($uquery);
2345 return $usth->execute(@bind);
2348 =head2 _FixAccountForLostAndReturned
2350 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2352 Calculates the charge for a book lost and returned.
2354 Internal function, not exported, called only by AddReturn.
2356 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2357 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2361 sub _FixAccountForLostAndReturned {
2362 my $itemnumber = shift or return;
2363 my $borrowernumber = @_ ? shift : undef;
2364 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2365 my $dbh = C4::Context->dbh;
2366 # check for charge made for lost book
2367 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2368 $sth->execute($itemnumber);
2369 my $data = $sth->fetchrow_hashref;
2370 $data or return; # bail if there is nothing to do
2371 $data->{accounttype} eq 'W' and return; # Written off
2373 # writeoff this amount
2375 my $amount = $data->{'amount'};
2376 my $acctno = $data->{'accountno'};
2377 my $amountleft; # Starts off undef/zero.
2378 if ($data->{'amountoutstanding'} == $amount) {
2379 $offset = $data->{'amount'};
2380 $amountleft = 0; # Hey, it's zero here, too.
2382 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2383 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2385 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2386 WHERE (accountlines_id = ?)");
2387 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2388 #check if any credit is left if so writeoff other accounts
2389 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2390 $amountleft *= -1 if ($amountleft < 0);
2391 if ($amountleft > 0) {
2392 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2393 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2394 $msth->execute($data->{'borrowernumber'});
2395 # offset transactions
2398 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2399 if ($accdata->{'amountoutstanding'} < $amountleft) {
2401 $amountleft -= $accdata->{'amountoutstanding'};
2403 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2406 my $thisacct = $accdata->{'accountlines_id'};
2407 # FIXME: move prepares outside while loop!
2408 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2409 WHERE (accountlines_id = ?)");
2410 $usth->execute($newamtos,$thisacct);
2411 $usth = $dbh->prepare("INSERT INTO accountoffsets
2412 (borrowernumber, accountno, offsetaccount, offsetamount)
2415 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2418 $amountleft *= -1 if ($amountleft > 0);
2419 my $desc = "Item Returned " . $item_id;
2420 $usth = $dbh->prepare("INSERT INTO accountlines
2421 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2422 VALUES (?,?,now(),?,?,'CR',?)");
2423 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2424 if ($borrowernumber) {
2425 # FIXME: same as query above. use 1 sth for both
2426 $usth = $dbh->prepare("INSERT INTO accountoffsets
2427 (borrowernumber, accountno, offsetaccount, offsetamount)
2429 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2431 ModItem({ paidfor => '' }, undef, $itemnumber);
2435 =head2 _GetCircControlBranch
2437 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2441 Return the library code to be used to determine which circulation
2442 policy applies to a transaction. Looks up the CircControl and
2443 HomeOrHoldingBranch system preferences.
2445 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2447 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2451 sub _GetCircControlBranch {
2452 my ($item, $borrower) = @_;
2453 my $circcontrol = C4::Context->preference('CircControl');
2456 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2457 $branch= C4::Context->userenv->{'branch'};
2458 } elsif ($circcontrol eq 'PatronLibrary') {
2459 $branch=$borrower->{branchcode};
2461 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2462 $branch = $item->{$branchfield};
2463 # default to item home branch if holdingbranch is used
2464 # and is not defined
2465 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2466 $branch = $item->{homebranch};
2479 $issue = &GetItemIssue($itemnumber);
2481 Returns patron currently having a book, or undef if not checked out.
2483 C<$itemnumber> is the itemnumber.
2485 C<$issue> is a hashref of the row from the issues table.
2490 my ($itemnumber) = @_;
2491 return unless $itemnumber;
2492 my $sth = C4::Context->dbh->prepare(
2493 "SELECT items.*, issues.*
2495 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2496 WHERE issues.itemnumber=?");
2497 $sth->execute($itemnumber);
2498 my $data = $sth->fetchrow_hashref;
2499 return unless $data;
2500 $data->{issuedate_sql} = $data->{issuedate};
2501 $data->{date_due_sql} = $data->{date_due};
2502 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2503 $data->{issuedate}->truncate(to => 'minute');
2504 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2505 $data->{date_due}->truncate(to => 'minute');
2506 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2507 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2513 $issue = GetOpenIssue( $itemnumber );
2515 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2517 C<$itemnumber> is the item's itemnumber
2524 my ( $itemnumber ) = @_;
2525 return unless $itemnumber;
2526 my $dbh = C4::Context->dbh;
2527 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2528 $sth->execute( $itemnumber );
2529 return $sth->fetchrow_hashref();
2535 $issues = GetIssues({}); # return all issues!
2536 $issues = GetIssues({ borrowernumber => $borrowernumber, biblionumber => $biblionumber });
2538 Returns all pending issues that match given criteria.
2539 Returns a arrayref or undef if an error occurs.
2541 Allowed criteria are:
2545 =item * borrowernumber
2547 =item * biblionumber
2556 my ($criteria) = @_;
2560 my @allowed = qw(borrowernumber biblionumber itemnumber);
2561 foreach (@allowed) {
2562 if (defined $criteria->{$_}) {
2565 value => $criteria->{$_},
2570 # Do we need to join other tables ?
2572 if (defined $criteria->{biblionumber}) {
2579 $where = "WHERE " . join(' AND ', map { "$_->{field} = ?" } @filters);
2585 if (defined $join{items}) {
2587 LEFT JOIN items ON (issues.itemnumber = items.itemnumber)
2593 my $dbh = C4::Context->dbh;
2594 my $sth = $dbh->prepare($query);
2595 my $rv = $sth->execute(map { $_->{value} } @filters);
2597 return $rv ? $sth->fetchall_arrayref({}) : undef;
2600 =head2 GetItemIssues
2602 $issues = &GetItemIssues($itemnumber, $history);
2604 Returns patrons that have issued a book
2606 C<$itemnumber> is the itemnumber
2607 C<$history> is false if you just want the current "issuer" (if any)
2608 and true if you want issues history from old_issues also.
2610 Returns reference to an array of hashes
2615 my ( $itemnumber, $history ) = @_;
2617 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2618 $today->truncate( to => 'minute' );
2619 my $sql = "SELECT * FROM issues
2620 JOIN borrowers USING (borrowernumber)
2621 JOIN items USING (itemnumber)
2622 WHERE issues.itemnumber = ? ";
2625 SELECT * FROM old_issues
2626 LEFT JOIN borrowers USING (borrowernumber)
2627 JOIN items USING (itemnumber)
2628 WHERE old_issues.itemnumber = ? ";
2630 $sql .= "ORDER BY date_due DESC";
2631 my $sth = C4::Context->dbh->prepare($sql);
2633 $sth->execute($itemnumber, $itemnumber);
2635 $sth->execute($itemnumber);
2637 my $results = $sth->fetchall_arrayref({});
2638 foreach (@$results) {
2639 my $date_due = dt_from_string($_->{date_due},'sql');
2640 $date_due->truncate( to => 'minute' );
2642 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2647 =head2 GetBiblioIssues
2649 $issues = GetBiblioIssues($biblionumber);
2651 this function get all issues from a biblionumber.
2654 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2655 tables issues and the firstname,surname & cardnumber from borrowers.
2659 sub GetBiblioIssues {
2660 my $biblionumber = shift;
2661 return unless $biblionumber;
2662 my $dbh = C4::Context->dbh;
2664 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2666 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2667 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2668 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2669 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2670 WHERE biblio.biblionumber = ?
2672 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2674 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2675 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2676 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2677 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2678 WHERE biblio.biblionumber = ?
2681 my $sth = $dbh->prepare($query);
2682 $sth->execute($biblionumber, $biblionumber);
2685 while ( my $data = $sth->fetchrow_hashref ) {
2686 push @issues, $data;
2691 =head2 GetUpcomingDueIssues
2693 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2697 sub GetUpcomingDueIssues {
2700 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2701 my $dbh = C4::Context->dbh;
2703 my $statement = <<END_SQL;
2704 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2706 LEFT JOIN items USING (itemnumber)
2707 LEFT OUTER JOIN branches USING (branchcode)
2708 WHERE returndate is NULL
2709 HAVING days_until_due >= 0 AND days_until_due <= ?
2712 my @bind_parameters = ( $params->{'days_in_advance'} );
2714 my $sth = $dbh->prepare( $statement );
2715 $sth->execute( @bind_parameters );
2716 my $upcoming_dues = $sth->fetchall_arrayref({});
2718 return $upcoming_dues;
2721 =head2 CanBookBeRenewed
2723 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2725 Find out whether a borrowed item may be renewed.
2727 C<$borrowernumber> is the borrower number of the patron who currently
2728 has the item on loan.
2730 C<$itemnumber> is the number of the item to renew.
2732 C<$override_limit>, if supplied with a true value, causes
2733 the limit on the number of times that the loan can be renewed
2734 (as controlled by the item type) to be ignored. Overriding also allows
2735 to renew sooner than "No renewal before" and to manually renew loans
2736 that are automatically renewed.
2738 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2739 item must currently be on loan to the specified borrower; renewals
2740 must be allowed for the item's type; and the borrower must not have
2741 already renewed the loan. $error will contain the reason the renewal can not proceed
2745 sub CanBookBeRenewed {
2746 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2748 my $dbh = C4::Context->dbh;
2751 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2752 my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2753 return ( 0, 'onsite_checkout' ) if $itemissue->{onsite_checkout};
2755 $borrowernumber ||= $itemissue->{borrowernumber};
2756 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2759 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2761 # This item can fill one or more unfilled reserve, can those unfilled reserves
2762 # all be filled by other available items?
2764 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2766 my $schema = Koha::Database->new()->schema();
2768 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2770 # There is an item level hold on this item, no other item can fill the hold
2775 # Get all other items that could possibly fill reserves
2776 my @itemnumbers = $schema->resultset('Item')->search(
2778 biblionumber => $resrec->{biblionumber},
2781 -not => { itemnumber => $itemnumber }
2783 { columns => 'itemnumber' }
2784 )->get_column('itemnumber')->all();
2786 # Get all other reserves that could have been filled by this item
2787 my @borrowernumbers;
2789 my ( $reserve_found, $reserve, undef ) =
2790 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2792 if ($reserve_found) {
2793 push( @borrowernumbers, $reserve->{borrowernumber} );
2800 # If the count of the union of the lists of reservable items for each borrower
2801 # is equal or greater than the number of borrowers, we know that all reserves
2802 # can be filled with available items. We can get the union of the sets simply
2803 # by pushing all the elements onto an array and removing the duplicates.
2805 foreach my $b (@borrowernumbers) {
2806 my ($borr) = C4::Members::GetMember( borrowernumber => $b);
2807 foreach my $i (@itemnumbers) {
2808 my $item = GetItem($i);
2809 if ( !IsItemOnHoldAndFound($i)
2810 && IsAvailableForItemLevelRequest( $item, $borr )
2811 && CanItemBeReserved( $b, $i ) )
2813 push( @reservable, $i );
2818 @reservable = uniq(@reservable);
2820 if ( @reservable >= @borrowernumbers ) {
2825 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2827 return ( 1, undef ) if $override_limit;
2829 my $branchcode = _GetCircControlBranch( $item, $borrower );
2830 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2831 { categorycode => $borrower->{categorycode},
2832 itemtype => $item->{itype},
2833 branchcode => $branchcode
2837 return ( 0, "too_many" )
2838 if not $issuing_rule or $issuing_rule->renewalsallowed <= $itemissue->{renewals};
2840 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2841 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2842 my $patron = Koha::Patrons->find($borrowernumber);
2843 my $restricted = $patron->is_debarred;
2844 my $hasoverdues = $patron->has_overdues;
2846 if ( $restricted and $restrictionblockrenewing ) {
2847 return ( 0, 'restriction');
2848 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($itemissue->{overdue} and $overduesblockrenewing eq 'blockitem') ) {
2849 return ( 0, 'overdue');
2852 if ( $itemissue->{auto_renew}
2853 and defined $issuing_rule->no_auto_renewal_after
2854 and $issuing_rule->no_auto_renewal_after ne "" ) {
2856 # Get issue_date and add no_auto_renewal_after
2857 # If this is greater than today, it's too late for renewal.
2858 my $maximum_renewal_date = dt_from_string($itemissue->{issuedate});
2859 $maximum_renewal_date->add(
2860 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2862 my $now = dt_from_string;
2863 if ( $now >= $maximum_renewal_date ) {
2864 return ( 0, "auto_too_late" );
2868 if ( defined $issuing_rule->norenewalbefore
2869 and $issuing_rule->norenewalbefore ne "" )
2872 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2873 my $soonestrenewal =
2874 $itemissue->{date_due}->clone()
2876 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2878 # Depending on syspref reset the exact time, only check the date
2879 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2880 and $issuing_rule->lengthunit eq 'days' )
2882 $soonestrenewal->truncate( to => 'day' );
2885 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2887 return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2888 return ( 0, "too_soon" );
2890 elsif ( $itemissue->{auto_renew} ) {
2891 return ( 0, "auto_renew" );
2895 # Fallback for automatic renewals:
2896 # If norenewalbefore is undef, don't renew before due date.
2897 if ( $itemissue->{auto_renew} ) {
2898 my $now = dt_from_string;
2899 return ( 0, "auto_renew" )
2900 if $now >= $itemissue->{date_due};
2901 return ( 0, "auto_too_soon" );
2904 return ( 1, undef );
2909 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2913 C<$borrowernumber> is the borrower number of the patron who currently
2916 C<$itemnumber> is the number of the item to renew.
2918 C<$branch> is the library where the renewal took place (if any).
2919 The library that controls the circ policies for the renewal is retrieved from the issues record.
2921 C<$datedue> can be a DateTime object used to set the due date.
2923 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2924 this parameter is not supplied, lastreneweddate is set to the current date.
2926 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2927 from the book's item type.
2932 my $borrowernumber = shift;
2933 my $itemnumber = shift or return;
2935 my $datedue = shift;
2936 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2938 my $item = GetItem($itemnumber) or return;
2939 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2941 my $dbh = C4::Context->dbh;
2943 # Find the issues record for this book
2944 my $issuedata = GetItemIssue($itemnumber);
2946 return unless ( $issuedata );
2948 $borrowernumber ||= $issuedata->{borrowernumber};
2950 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2951 carp 'Invalid date passed to AddRenewal.';
2955 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2957 if ( C4::Context->preference('CalculateFinesOnReturn') && $issuedata->{overdue} ) {
2958 _CalculateAndUpdateFine( { issue => $issuedata, item => $item, borrower => $borrower } );
2960 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2962 # If the due date wasn't specified, calculate it by adding the
2963 # book's loan length to today's date or the current due date
2964 # based on the value of the RenewalPeriodBase syspref.
2967 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2969 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2970 dt_from_string( $issuedata->{date_due} ) :
2971 DateTime->now( time_zone => C4::Context->tz());
2972 $datedue = CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $borrower), $borrower, 'is a renewal');
2975 # Update the issues record to have the new due date, and a new count
2976 # of how many times it has been renewed.
2977 my $renews = $issuedata->{'renewals'} + 1;
2978 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2979 WHERE borrowernumber=?
2983 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2985 # Update the renewal count on the item, and tell zebra to reindex
2986 $renews = $biblio->{'renewals'} + 1;
2987 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2989 # Charge a new rental fee, if applicable?
2990 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2991 if ( $charge > 0 ) {
2992 my $accountno = getnextacctno( $borrowernumber );
2993 my $item = GetBiblioFromItemNumber($itemnumber);
2995 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2996 $sth = $dbh->prepare(
2997 "INSERT INTO accountlines
2998 (date, borrowernumber, accountno, amount, manager_id,
2999 description,accounttype, amountoutstanding, itemnumber)
3000 VALUES (now(),?,?,?,?,?,?,?,?)"
3002 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
3003 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
3004 'Rent', $charge, $itemnumber );
3007 # Send a renewal slip according to checkout alert preferencei
3008 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3009 $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
3010 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3012 branchcode => $branch,
3013 categorycode => $borrower->{categorycode},
3014 item_type => $item->{itype},
3015 notification => 'CHECKOUT',
3017 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3018 SendCirculationAlert(
3022 borrower => $borrower,
3029 # Remove any OVERDUES related debarment if the borrower has no overdues
3030 $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
3031 if ( $borrowernumber
3032 && $borrower->{'debarred'}
3033 && !Koha::Patrons->find( $borrowernumber )->has_overdues
3034 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3036 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3042 branch => C4::Context->userenv ? C4::Context->userenv->{branch} : $branch,
3045 itemnumber => $itemnumber,
3046 itemtype => $item->{itype},
3047 borrowernumber => $borrowernumber,
3048 ccode => $item->{'ccode'}
3056 # check renewal status
3057 my ( $bornum, $itemno ) = @_;
3058 my $dbh = C4::Context->dbh;
3060 my $renewsallowed = 0;
3063 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
3064 my $item = GetItem($itemno);
3066 # Look in the issues table for this item, lent to this borrower,
3067 # and not yet returned.
3069 # FIXME - I think this function could be redone to use only one SQL call.
3070 my $sth = $dbh->prepare(
3071 "select * from issues
3072 where (borrowernumber = ?)
3073 and (itemnumber = ?)"
3075 $sth->execute( $bornum, $itemno );
3076 my $data = $sth->fetchrow_hashref;
3077 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3078 # $item and $borrower should be calculated
3079 my $branchcode = _GetCircControlBranch($item, $borrower);
3081 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3082 { categorycode => $borrower->{categorycode},
3083 itemtype => $item->{itype},
3084 branchcode => $branchcode
3088 $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
3089 $renewsleft = $renewsallowed - $renewcount;
3090 if($renewsleft < 0){ $renewsleft = 0; }
3091 return ( $renewcount, $renewsallowed, $renewsleft );
3094 =head2 GetSoonestRenewDate
3096 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3098 Find out the soonest possible renew date of a borrowed item.
3100 C<$borrowernumber> is the borrower number of the patron who currently
3101 has the item on loan.
3103 C<$itemnumber> is the number of the item to renew.
3105 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3106 renew date, based on the value "No renewal before" of the applicable
3107 issuing rule. Returns the current date if the item can already be
3108 renewed, and returns undefined if the borrower, loan, or item
3113 sub GetSoonestRenewDate {
3114 my ( $borrowernumber, $itemnumber ) = @_;
3116 my $dbh = C4::Context->dbh;
3118 my $item = GetItem($itemnumber) or return;
3119 my $itemissue = GetItemIssue($itemnumber) or return;
3121 $borrowernumber ||= $itemissue->{borrowernumber};
3122 my $borrower = C4::Members::GetMemberDetails($borrowernumber)
3125 my $branchcode = _GetCircControlBranch( $item, $borrower );
3126 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3127 { categorycode => $borrower->{categorycode},
3128 itemtype => $item->{itype},
3129 branchcode => $branchcode
3133 my $now = dt_from_string;
3134 return $now unless $issuing_rule;
3136 if ( defined $issuing_rule->norenewalbefore
3137 and $issuing_rule->norenewalbefore ne "" )
3139 my $soonestrenewal =
3140 $itemissue->{date_due}->clone()
3142 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3144 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3145 and $issuing_rule->lengthunit eq 'days' )
3147 $soonestrenewal->truncate( to => 'day' );
3149 return $soonestrenewal if $now < $soonestrenewal;
3154 =head2 GetLatestAutoRenewDate
3156 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3158 Find out the latest possible auto renew date of a borrowed item.
3160 C<$borrowernumber> is the borrower number of the patron who currently
3161 has the item on loan.
3163 C<$itemnumber> is the number of the item to renew.
3165 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3166 auto renew date, based on the value "No auto renewal after" of the applicable
3168 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3169 or item cannot be found.
3173 sub GetLatestAutoRenewDate {
3174 my ( $borrowernumber, $itemnumber ) = @_;
3176 my $dbh = C4::Context->dbh;
3178 my $item = GetItem($itemnumber) or return;
3179 my $itemissue = GetItemIssue($itemnumber) or return;
3181 $borrowernumber ||= $itemissue->{borrowernumber};
3182 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
3185 my $branchcode = _GetCircControlBranch( $item, $borrower );
3186 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3187 { categorycode => $borrower->{categorycode},
3188 itemtype => $item->{itype},
3189 branchcode => $branchcode
3193 return unless $issuing_rule;
3194 return if not $issuing_rule->no_auto_renewal_after
3195 or $issuing_rule->no_auto_renewal_after eq '';
3197 my $maximum_renewal_date = dt_from_string($itemissue->{issuedate});
3198 $maximum_renewal_date->add(
3199 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3202 return $maximum_renewal_date;
3206 =head2 GetIssuingCharges
3208 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3210 Calculate how much it would cost for a given patron to borrow a given
3211 item, including any applicable discounts.
3213 C<$itemnumber> is the item number of item the patron wishes to borrow.
3215 C<$borrowernumber> is the patron's borrower number.
3217 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3218 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3223 sub GetIssuingCharges {
3225 # calculate charges due
3226 my ( $itemnumber, $borrowernumber ) = @_;
3228 my $dbh = C4::Context->dbh;
3231 # Get the book's item type and rental charge (via its biblioitem).
3232 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3233 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3234 $charge_query .= (C4::Context->preference('item-level_itypes'))
3235 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3236 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3238 $charge_query .= ' WHERE items.itemnumber =?';
3240 my $sth = $dbh->prepare($charge_query);
3241 $sth->execute($itemnumber);
3242 if ( my $item_data = $sth->fetchrow_hashref ) {
3243 $item_type = $item_data->{itemtype};
3244 $charge = $item_data->{rentalcharge};
3245 my $branch = C4::Context::mybranch();
3246 my $discount_query = q|SELECT rentaldiscount,
3247 issuingrules.itemtype, issuingrules.branchcode
3249 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3250 WHERE borrowers.borrowernumber = ?
3251 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3252 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3253 my $discount_sth = $dbh->prepare($discount_query);
3254 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3255 my $discount_rules = $discount_sth->fetchall_arrayref({});
3256 if (@{$discount_rules}) {
3257 # We may have multiple rules so get the most specific
3258 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3259 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3262 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3266 return ( $charge, $item_type );
3269 # Select most appropriate discount rule from those returned
3270 sub _get_discount_from_rule {
3271 my ($rules_ref, $branch, $itemtype) = @_;
3274 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3275 $discount = $rules_ref->[0]->{rentaldiscount};
3276 return (defined $discount) ? $discount : 0;
3278 # could have up to 4 does one match $branch and $itemtype
3279 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3281 $discount = $d[0]->{rentaldiscount};
3282 return (defined $discount) ? $discount : 0;
3284 # do we have item type + all branches
3285 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3287 $discount = $d[0]->{rentaldiscount};
3288 return (defined $discount) ? $discount : 0;
3290 # do we all item types + this branch
3291 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3293 $discount = $d[0]->{rentaldiscount};
3294 return (defined $discount) ? $discount : 0;
3296 # so all and all (surely we wont get here)
3297 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3299 $discount = $d[0]->{rentaldiscount};
3300 return (defined $discount) ? $discount : 0;
3306 =head2 AddIssuingCharge
3308 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3312 sub AddIssuingCharge {
3313 my ( $itemnumber, $borrowernumber, $charge ) = @_;
3314 my $dbh = C4::Context->dbh;
3315 my $nextaccntno = getnextacctno( $borrowernumber );
3317 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3319 INSERT INTO accountlines
3320 (borrowernumber, itemnumber, accountno,
3321 date, amount, description, accounttype,
3322 amountoutstanding, manager_id)
3323 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3325 my $sth = $dbh->prepare($query);
3326 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3331 GetTransfers($itemnumber);
3336 my ($itemnumber) = @_;
3338 my $dbh = C4::Context->dbh;
3344 FROM branchtransfers
3345 WHERE itemnumber = ?
3346 AND datearrived IS NULL
3348 my $sth = $dbh->prepare($query);
3349 $sth->execute($itemnumber);
3350 my @row = $sth->fetchrow_array();
3354 =head2 GetTransfersFromTo
3356 @results = GetTransfersFromTo($frombranch,$tobranch);
3358 Returns the list of pending transfers between $from and $to branch
3362 sub GetTransfersFromTo {
3363 my ( $frombranch, $tobranch ) = @_;
3364 return unless ( $frombranch && $tobranch );
3365 my $dbh = C4::Context->dbh;
3367 SELECT itemnumber,datesent,frombranch
3368 FROM branchtransfers
3371 AND datearrived IS NULL
3373 my $sth = $dbh->prepare($query);
3374 $sth->execute( $frombranch, $tobranch );
3377 while ( my $data = $sth->fetchrow_hashref ) {
3378 push @gettransfers, $data;
3380 return (@gettransfers);
3383 =head2 DeleteTransfer
3385 &DeleteTransfer($itemnumber);
3389 sub DeleteTransfer {
3390 my ($itemnumber) = @_;
3391 return unless $itemnumber;
3392 my $dbh = C4::Context->dbh;
3393 my $sth = $dbh->prepare(
3394 "DELETE FROM branchtransfers
3396 AND datearrived IS NULL "
3398 return $sth->execute($itemnumber);
3401 =head2 AnonymiseIssueHistory
3403 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
3405 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
3406 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
3408 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
3409 setting (force delete).
3411 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
3415 sub AnonymiseIssueHistory {
3417 my $borrowernumber = shift;
3418 my $dbh = C4::Context->dbh;
3421 SET borrowernumber = ?
3422 WHERE returndate < ?
3423 AND borrowernumber IS NOT NULL
3426 # The default of 0 does not work due to foreign key constraints
3427 # The anonymisation should not fail quietly if AnonymousPatron is not a valid entry
3428 # Set it to undef (NULL)
3429 my $anonymouspatron = C4::Context->preference('AnonymousPatron') || undef;
3430 my @bind_params = ($anonymouspatron, $date);
3431 if (defined $borrowernumber) {
3432 $query .= " AND borrowernumber = ?";
3433 push @bind_params, $borrowernumber;
3435 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
3437 my $sth = $dbh->prepare($query);
3438 $sth->execute(@bind_params);
3439 my $anonymisation_err = $dbh->err;
3440 my $rows_affected = $sth->rows; ### doublecheck row count return function
3441 return ($rows_affected, $anonymisation_err);
3444 =head2 SendCirculationAlert
3446 Send out a C<check-in> or C<checkout> alert using the messaging system.
3454 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3458 Hashref of information about the item being checked in or out.
3462 Hashref of information about the borrower of the item.
3466 The branchcode from where the checkout or check-in took place.
3472 SendCirculationAlert({
3475 borrower => $borrower,
3481 sub SendCirculationAlert {
3483 my ($type, $item, $borrower, $branch) =
3484 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3485 my %message_name = (
3486 CHECKIN => 'Item_Check_in',
3487 CHECKOUT => 'Item_Checkout',
3488 RENEWAL => 'Item_Checkout',
3490 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3491 borrowernumber => $borrower->{borrowernumber},
3492 message_name => $message_name{$type},
3494 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3496 my $schema = Koha::Database->new->schema;
3497 my @transports = keys %{ $borrower_preferences->{transports} };
3499 # From the MySQL doc:
3500 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3501 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3502 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3503 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3505 for my $mtt (@transports) {
3506 my $letter = C4::Letters::GetPreparedLetter (
3507 module => 'circulation',
3508 letter_code => $type,
3509 branchcode => $branch,
3510 message_transport_type => $mtt,
3512 $issues_table => $item->{itemnumber},
3513 'items' => $item->{itemnumber},
3514 'biblio' => $item->{biblionumber},
3515 'biblioitems' => $item->{biblionumber},
3516 'borrowers' => $borrower,
3517 'branches' => $branch,
3521 $schema->storage->txn_begin;
3522 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3523 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3524 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3525 unless ( $message ) {
3526 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3527 C4::Message->enqueue($letter, $borrower, $mtt);
3529 $message->append($letter);
3532 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3533 $schema->storage->txn_commit;
3539 =head2 updateWrongTransfer
3541 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3543 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
3547 sub updateWrongTransfer {
3548 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3549 my $dbh = C4::Context->dbh;
3550 # first step validate the actual line of transfert .
3553 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3555 $sth->execute($FromLibrary,$itemNumber);
3557 # second step create a new line of branchtransfer to the right location .
3558 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3560 #third step changing holdingbranch of item
3561 UpdateHoldingbranch($FromLibrary,$itemNumber);
3564 =head2 UpdateHoldingbranch
3566 $items = UpdateHoldingbranch($branch,$itmenumber);
3568 Simple methode for updating hodlingbranch in items BDD line
3572 sub UpdateHoldingbranch {
3573 my ( $branch,$itemnumber ) = @_;
3574 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3579 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3581 this function calculates the due date given the start date and configured circulation rules,
3582 checking against the holidays calendar as per the 'useDaysMode' syspref.
3583 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3584 C<$itemtype> = itemtype code of item in question
3585 C<$branch> = location whose calendar to use
3586 C<$borrower> = Borrower object
3587 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3592 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3596 # loanlength now a href
3598 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3600 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3606 if (ref $startdate ne 'DateTime' ) {
3607 $datedue = dt_from_string($datedue);
3609 $datedue = $startdate->clone;
3613 DateTime->now( time_zone => C4::Context->tz() )
3614 ->truncate( to => 'minute' );
3618 # calculate the datedue as normal
3619 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3620 { # ignoring calendar
3621 if ( $loanlength->{lengthunit} eq 'hours' ) {
3622 $datedue->add( hours => $loanlength->{$length_key} );
3624 $datedue->add( days => $loanlength->{$length_key} );
3625 $datedue->set_hour(23);
3626 $datedue->set_minute(59);
3630 if ($loanlength->{lengthunit} eq 'hours') {
3631 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3634 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3636 my $calendar = Koha::Calendar->new( branchcode => $branch );
3637 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3638 if ($loanlength->{lengthunit} eq 'days') {
3639 $datedue->set_hour(23);
3640 $datedue->set_minute(59);
3644 # if Hard Due Dates are used, retrieve them and apply as necessary
3645 my ( $hardduedate, $hardduedatecompare ) =
3646 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3647 if ($hardduedate) { # hardduedates are currently dates
3648 $hardduedate->truncate( to => 'minute' );
3649 $hardduedate->set_hour(23);
3650 $hardduedate->set_minute(59);
3651 my $cmp = DateTime->compare( $hardduedate, $datedue );
3653 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3654 # if the calculated date is before the 'after' Hard Due Date (floor), override
3655 # if the hard due date is set to 'exactly', overrride
3656 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3657 $datedue = $hardduedate->clone;
3660 # in all other cases, keep the date due as it is
3664 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3665 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3666 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3667 if( $expiry_dt ) { #skip empty expiry date..
3668 $expiry_dt->set( hour => 23, minute => 59);
3669 my $d1= $datedue->clone->set_time_zone('floating');
3670 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3671 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3680 sub CheckValidBarcode{
3682 my $dbh = C4::Context->dbh;
3683 my $query=qq|SELECT count(*)
3687 my $sth = $dbh->prepare($query);
3688 $sth->execute($barcode);
3689 my $exist=$sth->fetchrow ;
3693 =head2 IsBranchTransferAllowed
3695 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3697 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3701 sub IsBranchTransferAllowed {
3702 my ( $toBranch, $fromBranch, $code ) = @_;
3704 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3706 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3707 my $dbh = C4::Context->dbh;
3709 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3710 $sth->execute( $toBranch, $fromBranch, $code );
3711 my $limit = $sth->fetchrow_hashref();
3713 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3714 if ( $limit->{'limitId'} ) {
3721 =head2 CreateBranchTransferLimit
3723 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3725 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3729 sub CreateBranchTransferLimit {
3730 my ( $toBranch, $fromBranch, $code ) = @_;
3731 return unless defined($toBranch) && defined($fromBranch);
3732 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3734 my $dbh = C4::Context->dbh;
3736 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3737 return $sth->execute( $code, $toBranch, $fromBranch );
3740 =head2 DeleteBranchTransferLimits
3742 my $result = DeleteBranchTransferLimits($frombranch);
3744 Deletes all the library transfer limits for one library. Returns the
3745 number of limits deleted, 0e0 if no limits were deleted, or undef if
3746 no arguments are supplied.
3750 sub DeleteBranchTransferLimits {
3752 return unless defined $branch;
3753 my $dbh = C4::Context->dbh;
3754 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3755 return $sth->execute($branch);
3759 my ( $borrowernumber, $itemnum ) = @_;
3761 MarkIssueReturned( $borrowernumber, $itemnum );
3762 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3763 my $item = C4::Items::GetItem( $itemnum );
3764 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3765 my @datearr = localtime(time);
3766 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3767 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3768 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3773 my ($itemnumber, $mark_returned) = @_;
3775 my $dbh = C4::Context->dbh();
3776 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3778 JOIN items USING (itemnumber)
3779 JOIN biblio USING (biblionumber)
3780 WHERE issues.itemnumber=?");
3781 $sth->execute($itemnumber);
3782 my $issues=$sth->fetchrow_hashref();
3784 # If a borrower lost the item, add a replacement cost to the their record
3785 if ( my $borrowernumber = $issues->{borrowernumber} ){
3786 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3788 if (C4::Context->preference('WhenLostForgiveFine')){
3789 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3790 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3792 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3793 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3794 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3795 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3798 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3802 sub GetOfflineOperations {
3803 my $dbh = C4::Context->dbh;
3804 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3805 $sth->execute(C4::Context->userenv->{'branch'});
3806 my $results = $sth->fetchall_arrayref({});
3810 sub GetOfflineOperation {
3811 my $operationid = shift;
3812 return unless $operationid;
3813 my $dbh = C4::Context->dbh;
3814 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3815 $sth->execute( $operationid );
3816 return $sth->fetchrow_hashref;
3819 sub AddOfflineOperation {
3820 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3821 my $dbh = C4::Context->dbh;
3822 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3823 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3827 sub DeleteOfflineOperation {
3828 my $dbh = C4::Context->dbh;
3829 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3830 $sth->execute( shift );
3834 sub ProcessOfflineOperation {
3835 my $operation = shift;
3838 if ( $operation->{action} eq 'return' ) {
3839 $report = ProcessOfflineReturn( $operation );
3840 } elsif ( $operation->{action} eq 'issue' ) {
3841 $report = ProcessOfflineIssue( $operation );
3842 } elsif ( $operation->{action} eq 'payment' ) {
3843 $report = ProcessOfflinePayment( $operation );
3846 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3851 sub ProcessOfflineReturn {
3852 my $operation = shift;
3854 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3856 if ( $itemnumber ) {
3857 my $issue = GetOpenIssue( $itemnumber );
3860 $issue->{borrowernumber},
3863 $operation->{timestamp},
3866 { renewals => 0, onloan => undef },
3867 $issue->{'biblionumber'},
3872 return "Item not issued.";
3875 return "Item not found.";
3879 sub ProcessOfflineIssue {
3880 my $operation = shift;
3882 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3884 if ( $borrower->{borrowernumber} ) {
3885 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3886 unless ($itemnumber) {
3887 return "Barcode not found.";
3889 my $issue = GetOpenIssue( $itemnumber );
3891 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3893 $issue->{borrowernumber},
3896 $operation->{timestamp},
3901 $operation->{'barcode'},
3904 $operation->{timestamp},
3909 return "Borrower not found.";
3913 sub ProcessOfflinePayment {
3914 my $operation = shift;
3916 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} });
3917 my $amount = $operation->{amount};
3919 Koha::Account->new( { patron_id => $patron->id } )->pay( { amount => $amount } );
3927 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3929 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3934 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3936 my $item = GetItem( $itemnumber, $barcode )
3939 return C4::Letters::GetPreparedLetter (
3940 module => 'circulation',
3941 letter_code => 'TRANSFERSLIP',
3942 branchcode => $branch,
3944 'branches' => $to_branch,
3945 'biblio' => $item->{biblionumber},
3951 =head2 CheckIfIssuedToPatron
3953 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3955 Return 1 if any record item is issued to patron, otherwise return 0
3959 sub CheckIfIssuedToPatron {
3960 my ($borrowernumber, $biblionumber) = @_;
3962 my $dbh = C4::Context->dbh;
3964 SELECT COUNT(*) FROM issues
3965 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3966 WHERE items.biblionumber = ?
3967 AND issues.borrowernumber = ?
3969 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3970 return 1 if $is_issued;
3976 IsItemIssued( $itemnumber )
3978 Return 1 if the item is on loan, otherwise return 0
3983 my $itemnumber = shift;
3984 my $dbh = C4::Context->dbh;
3985 my $sth = $dbh->prepare(q{
3988 WHERE itemnumber = ?
3990 $sth->execute($itemnumber);
3991 return $sth->fetchrow;
3994 =head2 GetAgeRestriction
3996 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3997 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3999 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as he is older or as old as the agerestriction }
4000 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4002 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4003 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4004 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4005 Negative days mean the borrower has gone past the age restriction age.
4009 sub GetAgeRestriction {
4010 my ($record_restrictions, $borrower) = @_;
4011 my $markers = C4::Context->preference('AgeRestrictionMarker');
4013 # Split $record_restrictions to something like FSK 16 or PEGI 6
4014 my @values = split ' ', uc($record_restrictions);
4015 return unless @values;
4017 # Search first occurrence of one of the markers
4018 my @markers = split /\|/, uc($markers);
4019 return unless @markers;
4022 my $restriction_year = 0;
4023 for my $value (@values) {
4025 for my $marker (@markers) {
4026 $marker =~ s/^\s+//; #remove leading spaces
4027 $marker =~ s/\s+$//; #remove trailing spaces
4028 if ( $marker eq $value ) {
4029 if ( $index <= $#values ) {
4030 $restriction_year += $values[$index];
4034 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4036 # Perhaps it is something like "K16" (as in Finland)
4037 $restriction_year += $1;
4041 last if ( $restriction_year > 0 );
4044 #Check if the borrower is age restricted for this material and for how long.
4045 if ($restriction_year && $borrower) {
4046 if ( $borrower->{'dateofbirth'} ) {
4047 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4048 $alloweddate[0] += $restriction_year;
4050 #Prevent runime eror on leap year (invalid date)
4051 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4052 $alloweddate[2] = 28;
4055 #Get how many days the borrower has to reach the age restriction
4056 my @Today = split /-/, DateTime->today->ymd();
4057 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4058 #Negative days means the borrower went past the age restriction age
4059 return ($restriction_year, $daysToAgeRestriction);
4063 return ($restriction_year);
4067 =head2 GetPendingOnSiteCheckouts
4071 sub GetPendingOnSiteCheckouts {
4072 my $dbh = C4::Context->dbh;
4073 return $dbh->selectall_arrayref(q|
4079 items.itemcallnumber,
4083 issues.date_due < NOW() AS is_overdue,
4086 borrowers.firstname,
4088 borrowers.cardnumber,
4089 borrowers.borrowernumber
4091 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4092 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4093 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4094 WHERE issues.onsite_checkout = 1
4095 |, { Slice => {} } );
4101 my ($count, $branch, $itemtype, $ccode, $newness)
4102 = @$params{qw(count branch itemtype ccode newness)};
4104 my $dbh = C4::Context->dbh;
4106 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4107 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4108 i.ccode, SUM(i.issues) AS count
4110 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4111 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4114 my (@where_strs, @where_args);
4117 push @where_strs, 'i.homebranch = ?';
4118 push @where_args, $branch;
4121 if (C4::Context->preference('item-level_itypes')){
4122 push @where_strs, 'i.itype = ?';
4123 push @where_args, $itemtype;
4125 push @where_strs, 'bi.itemtype = ?';
4126 push @where_args, $itemtype;
4130 push @where_strs, 'i.ccode = ?';
4131 push @where_args, $ccode;
4134 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4135 push @where_args, $newness;
4139 $query .= 'WHERE ' . join(' AND ', @where_strs);
4143 GROUP BY b.biblionumber
4148 $count = int($count);
4150 $query .= "LIMIT $count";
4153 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4158 sub _CalculateAndUpdateFine {
4161 my $borrower = $params->{borrower};
4162 my $item = $params->{item};
4163 my $issue = $params->{issue};
4164 my $return_date = $params->{return_date};
4166 unless ($borrower) { carp "No borrower passed in!" && return; }
4167 unless ($item) { carp "No item passed in!" && return; }
4168 unless ($issue) { carp "No issue passed in!" && return; }
4170 my $datedue = $issue->{date_due};
4172 # we only need to calculate and change the fines if we want to do that on return
4173 # Should be on for hourly loans
4174 my $control = C4::Context->preference('CircControl');
4175 my $control_branchcode =
4176 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4177 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4178 : $issue->{branchcode};
4180 my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4182 my ( $amount, $type, $unitcounttotal ) =
4183 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4187 if ( C4::Context->preference('finesMode') eq 'production' ) {
4188 if ( $amount > 0 ) {
4189 C4::Overdues::UpdateFine({
4190 issue_id => $issue->{issue_id},
4191 itemnumber => $issue->{itemnumber},
4192 borrowernumber => $issue->{borrowernumber},
4195 due => output_pref($datedue),
4198 elsif ($return_date) {
4200 # Backdated returns may have fines that shouldn't exist,
4201 # so in this case, we need to drop those fines to 0
4203 C4::Overdues::UpdateFine({
4204 issue_id => $issue->{issue_id},
4205 itemnumber => $issue->{itemnumber},
4206 borrowernumber => $issue->{borrowernumber},
4209 due => output_pref($datedue),
4221 Koha Development Team <http://koha-community.org/>