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 POSIX qw( floor );
32 use C4::ItemCirculationAlertPreference;
35 use C4::Log; # logaction
36 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits;
42 use Koha::AuthorisedValues;
43 use Koha::Biblioitems;
49 use Koha::Patron::Debarments;
52 use Koha::Account::Lines;
54 use Koha::RefundLostItemFeeRules;
55 use Koha::Account::Lines;
56 use Koha::Account::Offsets;
57 use Koha::Config::SysPrefs;
58 use Koha::Charges::Fees;
59 use Koha::Util::SystemPreferences;
60 use Koha::Checkouts::ReturnClaims;
62 use List::MoreUtils qw( uniq any );
63 use Scalar::Util qw( looks_like_number );
73 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
79 # FIXME subs that should probably be elsewhere
84 &GetPendingOnSiteCheckouts
87 # subs to deal with issuing a book
95 &GetLatestAutoRenewDate
97 &GetBranchBorrowerCircRule
101 &CheckIfIssuedToPatron
106 # subs to deal with returns
112 # subs to deal with transfers
119 &IsBranchTransferAllowed
120 &CreateBranchTransferLimit
121 &DeleteBranchTransferLimits
125 # subs to deal with offline circulation
127 &GetOfflineOperations
130 &DeleteOfflineOperation
131 &ProcessOfflineOperation
137 C4::Circulation - Koha circulation module
145 The functions in this module deal with circulation, issues, and
146 returns, as well as general information about the library.
147 Also deals with inventory.
153 $str = &barcodedecode($barcode, [$filter]);
155 Generic filter function for barcode string.
156 Called on every circ if the System Pref itemBarcodeInputFilter is set.
157 Will do some manipulation of the barcode for systems that deliver a barcode
158 to circulation.pl that differs from the barcode stored for the item.
159 For proper functioning of this filter, calling the function on the
160 correct barcode string (items.barcode) should return an unaltered barcode.
162 The optional $filter argument is to allow for testing or explicit
163 behavior that ignores the System Pref. Valid values are the same as the
168 # FIXME -- the &decode fcn below should be wrapped into this one.
169 # FIXME -- these plugins should be moved out of Circulation.pm
172 my ($barcode, $filter) = @_;
173 my $branch = C4::Context::mybranch();
174 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
175 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
176 if ($filter eq 'whitespace') {
178 } elsif ($filter eq 'cuecat') {
180 my @fields = split( /\./, $barcode );
181 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
182 ($#results == 2) and return $results[2];
183 } elsif ($filter eq 'T-prefix') {
184 if ($barcode =~ /^[Tt](\d)/) {
185 (defined($1) and $1 eq '0') and return $barcode;
186 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
188 return sprintf("T%07d", $barcode);
189 # FIXME: $barcode could be "T1", causing warning: substr outside of string
190 # Why drop the nonzero digit after the T?
191 # Why pass non-digits (or empty string) to "T%07d"?
192 } elsif ($filter eq 'libsuite8') {
193 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
194 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
195 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
197 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
200 } elsif ($filter eq 'EAN13') {
201 my $ean = CheckDigits('ean');
202 if ( $ean->is_valid($barcode) ) {
203 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
204 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
206 warn "# [$barcode] not valid EAN-13/UPC-A\n";
209 return $barcode; # return barcode, modified or not
214 $str = &decode($chunk);
216 Decodes a segment of a string emitted by a CueCat barcode scanner and
219 FIXME: Should be replaced with Barcode::Cuecat from CPAN
220 or Javascript based decoding on the client side.
227 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
228 my @s = map { index( $seq, $_ ); } split( //, $encoded );
229 my $l = ( $#s + 1 ) % 4;
232 # warn "Error: Cuecat decode parsing failed!";
240 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
242 chr( ( $n >> 16 ) ^ 67 )
243 .chr( ( $n >> 8 & 255 ) ^ 67 )
244 .chr( ( $n & 255 ) ^ 67 );
247 $r = substr( $r, 0, length($r) - $l );
253 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
254 $barcode, $ignore_reserves);
256 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
258 C<$newbranch> is the code for the branch to which the item should be transferred.
260 C<$barcode> is the barcode of the item to be transferred.
262 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
263 Otherwise, if an item is reserved, the transfer fails.
265 Returns three values:
271 is true if the transfer was successful.
275 is a reference-to-hash which may have any of the following keys:
281 There is no item in the catalog with the given barcode. The value is C<$barcode>.
283 =item C<DestinationEqualsHolding>
285 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
289 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
293 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
295 =item C<WasTransferred>
297 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
306 my ( $tbr, $barcode, $ignoreRs ) = @_;
309 my $item = Koha::Items->find( { barcode => $barcode } );
313 $messages->{'BadBarcode'} = $barcode;
315 return ( $dotransfer, $messages );
318 my $itemnumber = $item->itemnumber;
319 # get branches of book...
320 my $hbr = $item->homebranch;
321 my $fbr = $item->holdingbranch;
323 # if using Branch Transfer Limits
324 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
325 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
326 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
327 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
328 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
331 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
332 $messages->{'NotAllowed'} = $tbr . "::" . $code;
337 # can't transfer book if is already there....
338 if ( $fbr eq $tbr ) {
339 $messages->{'DestinationEqualsHolding'} = 1;
343 # check if it is still issued to someone, return it...
344 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
346 AddReturn( $barcode, $fbr );
347 $messages->{'WasReturned'} = $issue->borrowernumber;
351 # That'll save a database query.
352 my ( $resfound, $resrec, undef ) =
353 CheckReserves( $itemnumber );
354 if ( $resfound and not $ignoreRs ) {
355 $resrec->{'ResFound'} = $resfound;
357 # $messages->{'ResFound'} = $resrec;
361 #actually do the transfer....
363 ModItemTransfer( $itemnumber, $fbr, $tbr );
365 # don't need to update MARC anymore, we do it in batch now
366 $messages->{'WasTransfered'} = 1;
369 ModDateLastSeen( $itemnumber );
370 return ( $dotransfer, $messages );
375 my $borrower = shift;
376 my $item_object = shift;
378 my $onsite_checkout = $params->{onsite_checkout} || 0;
379 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
380 my $cat_borrower = $borrower->{'categorycode'};
381 my $dbh = C4::Context->dbh;
383 # Get which branchcode we need
384 $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
385 my $type = $item_object->effective_itemtype;
387 # given branch, patron category, and item type, determine
388 # applicable issuing rule
389 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
391 categorycode => $cat_borrower,
393 branchcode => $branch,
394 rule_name => 'maxissueqty',
397 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
399 categorycode => $cat_borrower,
401 branchcode => $branch,
402 rule_name => 'maxonsiteissueqty',
407 # if a rule is found and has a loan limit set, count
408 # how many loans the patron already has that meet that
410 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne '') {
413 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
415 JOIN items USING (itemnumber)
418 my $rule_itemtype = $maxissueqty_rule->itemtype;
419 unless ($rule_itemtype) {
420 # matching rule has the default item type, so count only
421 # those existing loans that don't fall under a more
423 if (C4::Context->preference('item-level_itypes')) {
424 $count_query .= " WHERE items.itype NOT IN (
425 SELECT itemtype FROM circulation_rules
427 AND (categorycode = ? OR categorycode = ?)
428 AND itemtype IS NOT NULL
429 AND rule_name = 'maxissueqty'
432 $count_query .= " JOIN biblioitems USING (biblionumber)
433 WHERE biblioitems.itemtype NOT IN (
434 SELECT itemtype FROM circulation_rules
436 AND (categorycode = ? OR categorycode = ?)
437 AND itemtype IS NOT NULL
438 AND rule_name = 'maxissueqty'
441 push @bind_params, $maxissueqty_rule->branchcode;
442 push @bind_params, $maxissueqty_rule->categorycode;
443 push @bind_params, $cat_borrower;
445 # rule has specific item type, so count loans of that
447 if (C4::Context->preference('item-level_itypes')) {
448 $count_query .= " WHERE items.itype = ? ";
450 $count_query .= " JOIN biblioitems USING (biblionumber)
451 WHERE biblioitems.itemtype= ? ";
453 push @bind_params, $type;
456 $count_query .= " AND borrowernumber = ? ";
457 push @bind_params, $borrower->{'borrowernumber'};
458 my $rule_branch = $maxissueqty_rule->branchcode;
460 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
461 $count_query .= " AND issues.branchcode = ? ";
462 push @bind_params, $rule_branch;
463 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
464 ; # if branch is the patron's home branch, then count all loans by patron
466 $count_query .= " AND items.homebranch = ? ";
467 push @bind_params, $rule_branch;
471 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
473 my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
474 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
476 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
477 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
479 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
480 count => $onsite_checkout_count,
481 max_allowed => $max_onsite_checkouts_allowed,
485 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
486 my $delta = $switch_onsite_checkout ? 1 : 0;
487 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
489 reason => 'TOO_MANY_CHECKOUTS',
490 count => $checkout_count,
491 max_allowed => $max_checkouts_allowed,
494 } elsif ( not $onsite_checkout ) {
495 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
497 reason => 'TOO_MANY_CHECKOUTS',
498 count => $checkout_count - $onsite_checkout_count,
499 max_allowed => $max_checkouts_allowed,
505 # Now count total loans against the limit for the branch
506 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
507 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
508 my @bind_params = ();
509 my $branch_count_query = q|
510 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
512 JOIN items USING (itemnumber)
513 WHERE borrowernumber = ?
515 push @bind_params, $borrower->{borrowernumber};
517 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
518 $branch_count_query .= " AND issues.branchcode = ? ";
519 push @bind_params, $branch;
520 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
521 ; # if branch is the patron's home branch, then count all loans by patron
523 $branch_count_query .= " AND items.homebranch = ? ";
524 push @bind_params, $branch;
526 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
527 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
528 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
530 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
531 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
533 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
534 count => $onsite_checkout_count,
535 max_allowed => $max_onsite_checkouts_allowed,
539 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
540 my $delta = $switch_onsite_checkout ? 1 : 0;
541 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
543 reason => 'TOO_MANY_CHECKOUTS',
544 count => $checkout_count,
545 max_allowed => $max_checkouts_allowed,
548 } elsif ( not $onsite_checkout ) {
549 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
551 reason => 'TOO_MANY_CHECKOUTS',
552 count => $checkout_count - $onsite_checkout_count,
553 max_allowed => $max_checkouts_allowed,
559 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
560 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
563 # OK, the patron can issue !!!
567 =head2 CanBookBeIssued
569 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
570 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
572 Check if a book can be issued.
574 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
576 IMPORTANT: The assumption by users of this routine is that causes blocking
577 the issue are keyed by uppercase labels and other returned
578 data is keyed in lower case!
582 =item C<$patron> is a Koha::Patron
584 =item C<$barcode> is the bar code of the book being issued.
586 =item C<$duedates> is a DateTime object.
588 =item C<$inprocess> boolean switch
590 =item C<$ignore_reserves> boolean switch
592 =item C<$params> Hashref of additional parameters
595 override_high_holds - Ignore high holds
596 onsite_checkout - Checkout is an onsite checkout that will not leave the library
604 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
605 Possible values are :
611 sticky due date is invalid
615 borrower gone with no address
619 borrower declared it's card lost
625 =head3 UNKNOWN_BARCODE
639 item is restricted (set by ??)
641 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
642 could be prevented, but ones that can be overriden by the operator.
644 Possible values are :
652 renewing, not issuing
654 =head3 ISSUED_TO_ANOTHER
656 issued to someone else.
660 reserved for someone else.
664 sticky due date is invalid or due date in the past
668 if the borrower borrows to much things
672 sub CanBookBeIssued {
673 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
674 my %needsconfirmation; # filled with problems that needs confirmations
675 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
676 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
677 my %messages; # filled with information messages that should be displayed.
679 my $onsite_checkout = $params->{onsite_checkout} || 0;
680 my $override_high_holds = $params->{override_high_holds} || 0;
682 my $item_object = Koha::Items->find({barcode => $barcode });
684 # MANDATORY CHECKS - unless item exists, nothing else matters
685 unless ( $item_object ) {
686 $issuingimpossible{UNKNOWN_BARCODE} = 1;
688 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
690 my $item_unblessed = $item_object->unblessed; # Transition...
691 my $issue = $item_object->checkout;
692 my $biblio = $item_object->biblio;
694 my $biblioitem = $biblio->biblioitem;
695 my $effective_itemtype = $item_object->effective_itemtype;
696 my $dbh = C4::Context->dbh;
697 my $patron_unblessed = $patron->unblessed;
699 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
701 # DUE DATE is OK ? -- should already have checked.
703 if ($duedate && ref $duedate ne 'DateTime') {
704 $duedate = dt_from_string($duedate);
706 my $now = DateTime->now( time_zone => C4::Context->tz() );
707 unless ( $duedate ) {
708 my $issuedate = $now->clone();
710 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
712 # Offline circ calls AddIssue directly, doesn't run through here
713 # So issuingimpossible should be ok.
716 my $fees = Koha::Charges::Fees->new(
719 library => $circ_library,
720 item => $item_object,
726 my $today = $now->clone();
727 $today->truncate( to => 'minute');
728 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
729 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
732 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
738 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
739 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
741 branch => C4::Context->userenv->{'branch'},
743 itemnumber => $item_object->itemnumber,
744 itemtype => $effective_itemtype,
745 borrowernumber => $patron->borrowernumber,
746 ccode => $item_object->ccode}
748 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
749 return( { STATS => 1 }, {});
752 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
753 $issuingimpossible{GNA} = 1;
756 if ( $patron->lost && $patron->lost == 1 ) {
757 $issuingimpossible{CARD_LOST} = 1;
759 if ( $patron->is_debarred ) {
760 $issuingimpossible{DEBARRED} = 1;
763 if ( $patron->is_expired ) {
764 $issuingimpossible{EXPIRED} = 1;
772 my $account = $patron->account;
773 my $balance = $account->balance;
774 my $non_issues_charges = $account->non_issues_charges;
775 my $other_charges = $balance - $non_issues_charges;
777 my $amountlimit = C4::Context->preference("noissuescharge");
778 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
779 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
781 # Check the debt of this patrons guarantees
782 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
783 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
784 if ( defined $no_issues_charge_guarantees ) {
785 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
786 my $guarantees_non_issues_charges;
787 foreach my $g ( @guarantees ) {
788 $guarantees_non_issues_charges += $g->account->non_issues_charges;
791 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
792 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
793 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
794 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
795 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
796 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
800 if ( C4::Context->preference("IssuingInProcess") ) {
801 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
802 $issuingimpossible{DEBT} = $non_issues_charges;
803 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
804 $needsconfirmation{DEBT} = $non_issues_charges;
805 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
806 $needsconfirmation{DEBT} = $non_issues_charges;
810 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
811 $needsconfirmation{DEBT} = $non_issues_charges;
812 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
813 $issuingimpossible{DEBT} = $non_issues_charges;
814 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
815 $needsconfirmation{DEBT} = $non_issues_charges;
819 if ($balance > 0 && $other_charges > 0) {
820 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
823 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
824 $patron_unblessed = $patron->unblessed;
826 if ( my $debarred_date = $patron->is_debarred ) {
827 # patron has accrued fine days or has a restriction. $count is a date
828 if ($debarred_date eq '9999-12-31') {
829 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
832 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
834 } elsif ( my $num_overdues = $patron->has_overdues ) {
835 ## patron has outstanding overdue loans
836 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
837 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
839 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
840 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
845 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
847 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
849 # Already issued to current borrower.
850 # If it is an on-site checkout if it can be switched to a normal checkout
851 # or ask whether the loan should be renewed
853 if ( $issue->onsite_checkout
854 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
855 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
857 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
858 $patron->borrowernumber,
859 $item_object->itemnumber,
861 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
862 if ( $renewerror eq 'onsite_checkout' ) {
863 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
866 $issuingimpossible{NO_MORE_RENEWALS} = 1;
870 $needsconfirmation{RENEW_ISSUE} = 1;
876 # issued to someone else
878 my $patron = Koha::Patrons->find( $issue->borrowernumber );
880 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
882 unless ( $can_be_returned ) {
883 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
884 $issuingimpossible{branch_to_return} = $message;
886 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
887 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
889 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
890 $needsconfirmation{issued_firstname} = $patron->firstname;
891 $needsconfirmation{issued_surname} = $patron->surname;
892 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
893 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
898 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
900 my $switch_onsite_checkout = (
901 C4::Context->preference('SwitchOnSiteCheckouts')
903 and $issue->onsite_checkout
904 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
905 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
906 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
907 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
908 if ( $toomany->{max_allowed} == 0 ) {
909 $needsconfirmation{PATRON_CANT} = 1;
911 if ( C4::Context->preference("AllowTooManyOverride") ) {
912 $needsconfirmation{TOO_MANY} = $toomany->{reason};
913 $needsconfirmation{current_loan_count} = $toomany->{count};
914 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
916 $issuingimpossible{TOO_MANY} = $toomany->{reason};
917 $issuingimpossible{current_loan_count} = $toomany->{count};
918 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
923 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
925 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
926 my $wants_check = $patron->wants_check_for_previous_checkout;
927 $needsconfirmation{PREVISSUE} = 1
928 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
933 if ( $item_object->notforloan )
935 if(!C4::Context->preference("AllowNotForLoanOverride")){
936 $issuingimpossible{NOT_FOR_LOAN} = 1;
937 $issuingimpossible{item_notforloan} = $item_object->notforloan;
939 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
940 $needsconfirmation{item_notforloan} = $item_object->notforloan;
944 # we have to check itemtypes.notforloan also
945 if (C4::Context->preference('item-level_itypes')){
946 # this should probably be a subroutine
947 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
948 $sth->execute($effective_itemtype);
949 my $notforloan=$sth->fetchrow_hashref();
950 if ($notforloan->{'notforloan'}) {
951 if (!C4::Context->preference("AllowNotForLoanOverride")) {
952 $issuingimpossible{NOT_FOR_LOAN} = 1;
953 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
955 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
956 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
961 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
962 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
963 if (!C4::Context->preference("AllowNotForLoanOverride")) {
964 $issuingimpossible{NOT_FOR_LOAN} = 1;
965 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
967 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
968 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
973 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
975 $issuingimpossible{WTHDRAWN} = 1;
977 if ( $item_object->restricted
978 && $item_object->restricted == 1 )
980 $issuingimpossible{RESTRICTED} = 1;
982 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
983 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
984 my $code = $av->count ? $av->next->lib : '';
985 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
986 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
988 if ( C4::Context->preference("IndependentBranches") ) {
989 my $userenv = C4::Context->userenv;
990 unless ( C4::Context->IsSuperLibrarian() ) {
991 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
992 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
993 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
994 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
996 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
997 if ( $patron->branchcode ne $userenv->{branch} );
1002 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1004 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1005 if ($rentalConfirmation) {
1006 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1008 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1009 if ($itemtype_object) {
1010 my $accumulate_charge = $fees->accumulate_rentalcharge();
1011 if ( $accumulate_charge > 0 ) {
1012 $rentalCharge += $accumulate_charge;
1016 if ( $rentalCharge > 0 ) {
1017 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1021 unless ( $ignore_reserves ) {
1022 # See if the item is on reserve.
1023 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1025 my $resbor = $res->{'borrowernumber'};
1026 if ( $resbor ne $patron->borrowernumber ) {
1027 my $patron = Koha::Patrons->find( $resbor );
1028 if ( $restype eq "Waiting" )
1030 # The item is on reserve and waiting, but has been
1031 # reserved by some other patron.
1032 $needsconfirmation{RESERVE_WAITING} = 1;
1033 $needsconfirmation{'resfirstname'} = $patron->firstname;
1034 $needsconfirmation{'ressurname'} = $patron->surname;
1035 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1036 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1037 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1038 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1040 elsif ( $restype eq "Reserved" ) {
1041 # The item is on reserve for someone else.
1042 $needsconfirmation{RESERVED} = 1;
1043 $needsconfirmation{'resfirstname'} = $patron->firstname;
1044 $needsconfirmation{'ressurname'} = $patron->surname;
1045 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1046 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1047 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1048 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1054 ## CHECK AGE RESTRICTION
1055 my $agerestriction = $biblioitem->agerestriction;
1056 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1057 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1058 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1059 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1062 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1066 ## check for high holds decreasing loan period
1067 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1068 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1070 if ( $check->{exceeded} ) {
1071 if ($override_high_holds) {
1072 $alerts{HIGHHOLDS} = {
1073 num_holds => $check->{outstanding},
1074 duration => $check->{duration},
1075 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1079 $needsconfirmation{HIGHHOLDS} = {
1080 num_holds => $check->{outstanding},
1081 duration => $check->{duration},
1082 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1089 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1090 # don't do the multiple loans per bib check if we've
1091 # already determined that we've got a loan on the same item
1092 !$issuingimpossible{NO_MORE_RENEWALS} &&
1093 !$needsconfirmation{RENEW_ISSUE}
1095 # Check if borrower has already issued an item from the same biblio
1096 # Only if it's not a subscription
1097 my $biblionumber = $item_object->biblionumber;
1098 require C4::Serials;
1099 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1100 unless ($is_a_subscription) {
1101 # FIXME Should be $patron->checkouts($args);
1102 my $checkouts = Koha::Checkouts->search(
1104 borrowernumber => $patron->borrowernumber,
1105 biblionumber => $biblionumber,
1111 # if we get here, we don't already have a loan on this item,
1112 # so if there are any loans on this bib, ask for confirmation
1113 if ( $checkouts->count ) {
1114 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1119 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1122 =head2 CanBookBeReturned
1124 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1126 Check whether the item can be returned to the provided branch
1130 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1132 =item C<$branch> is the branchcode where the return is taking place
1140 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1142 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1148 sub CanBookBeReturned {
1149 my ($item, $branch) = @_;
1150 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1152 # assume return is allowed to start
1156 # identify all cases where return is forbidden
1157 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1159 $message = $item->{'homebranch'};
1160 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1162 $message = $item->{'holdingbranch'};
1163 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1165 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1168 return ($allowed, $message);
1171 =head2 CheckHighHolds
1173 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1174 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1175 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1179 sub checkHighHolds {
1180 my ( $item, $borrower ) = @_;
1181 my $branchcode = _GetCircControlBranch( $item, $borrower );
1182 my $item_object = Koha::Items->find( $item->{itemnumber} );
1191 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1193 if ( $holds->count() ) {
1194 $return_data->{outstanding} = $holds->count();
1196 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1197 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1198 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1200 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1202 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1204 # static means just more than a given number of holds on the record
1206 # If the number of holds is less than the threshold, we can stop here
1207 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1208 return $return_data;
1211 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1213 # dynamic means X more than the number of holdable items on the record
1215 # let's get the items
1216 my @items = $holds->next()->biblio()->items()->as_list;
1218 # Remove any items with status defined to be ignored even if the would not make item unholdable
1219 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1220 @items = grep { !$_->$status } @items;
1223 # Remove any items that are not holdable for this patron
1224 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber )->{status} eq 'OK' } @items;
1226 my $items_count = scalar @items;
1228 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1230 # If the number of holds is less than the count of items we have
1231 # plus the number of holds allowed above that count, we can stop here
1232 if ( $holds->count() <= $threshold ) {
1233 return $return_data;
1237 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1239 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
1241 my $itype = $item_object->effective_itemtype;
1242 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1244 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1246 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1247 $reduced_datedue->set_hour($orig_due->hour);
1248 $reduced_datedue->set_minute($orig_due->minute);
1249 $reduced_datedue->truncate( to => 'minute' );
1251 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1252 $return_data->{exceeded} = 1;
1253 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1254 $return_data->{due_date} = $reduced_datedue;
1258 return $return_data;
1263 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1265 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1269 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1271 =item C<$barcode> is the barcode of the item being issued.
1273 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1274 Calculated if empty.
1276 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1278 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1279 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1281 AddIssue does the following things :
1283 - step 01: check that there is a borrowernumber & a barcode provided
1284 - check for RENEWAL (book issued & being issued to the same patron)
1285 - renewal YES = Calculate Charge & renew
1287 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1289 - fill reserve if reserve to this patron
1290 - cancel reserve or not, otherwise
1291 * TRANSFERT PENDING ?
1292 - complete the transfert
1300 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1302 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1303 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1304 my $auto_renew = $params && $params->{auto_renew};
1305 my $dbh = C4::Context->dbh;
1306 my $barcodecheck = CheckValidBarcode($barcode);
1310 if ( $datedue && ref $datedue ne 'DateTime' ) {
1311 $datedue = dt_from_string($datedue);
1314 # $issuedate defaults to today.
1315 if ( !defined $issuedate ) {
1316 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1319 if ( ref $issuedate ne 'DateTime' ) {
1320 $issuedate = dt_from_string($issuedate);
1325 # Stop here if the patron or barcode doesn't exist
1326 if ( $borrower && $barcode && $barcodecheck ) {
1327 # find which item we issue
1328 my $item_object = Koha::Items->find({ barcode => $barcode })
1329 or return; # if we don't get an Item, abort.
1330 my $item_unblessed = $item_object->unblessed;
1332 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1334 # get actual issuing if there is one
1335 my $actualissue = $item_object->checkout;
1337 # check if we just renew the issue.
1338 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1339 and not $switch_onsite_checkout ) {
1340 $datedue = AddRenewal(
1341 $borrower->{'borrowernumber'},
1342 $item_object->itemnumber,
1345 $issuedate, # here interpreted as the renewal date
1350 my $itype = $item_object->effective_itemtype;
1351 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1354 $datedue->truncate( to => 'minute' );
1356 my $patron = Koha::Patrons->find( $borrower );
1357 my $library = Koha::Libraries->find( $branchcode );
1358 my $fees = Koha::Charges::Fees->new(
1361 library => $library,
1362 item => $item_object,
1363 to_date => $datedue,
1367 # it's NOT a renewal
1368 if ( $actualissue and not $switch_onsite_checkout ) {
1369 # This book is currently on loan, but not to the person
1370 # who wants to borrow it now. mark it returned before issuing to the new borrower
1371 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1372 return unless $allowed;
1373 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1376 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1378 # Starting process for transfer job (checking transfert and validate it if we have one)
1379 my ($datesent) = GetTransfers( $item_object->itemnumber );
1381 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1382 my $sth = $dbh->prepare(
1383 "UPDATE branchtransfers
1384 SET datearrived = now(),
1386 comments = 'Forced branchtransfer'
1387 WHERE itemnumber= ? AND datearrived IS NULL"
1389 $sth->execute( C4::Context->userenv->{'branch'},
1390 $item_object->itemnumber );
1393 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1394 unless ($auto_renew) {
1395 my $rule = Koha::CirculationRules->get_effective_rule(
1397 categorycode => $borrower->{categorycode},
1398 itemtype => $item_object->effective_itemtype,
1399 branchcode => $branchcode,
1400 rule_name => 'auto_renew'
1404 $auto_renew = $rule->rule_value if $rule;
1407 # Record in the database the fact that the book was issued.
1409 my $itype = $item_object->effective_itemtype;
1410 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1413 $datedue->truncate( to => 'minute' );
1415 my $issue_attributes = {
1416 borrowernumber => $borrower->{'borrowernumber'},
1417 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1418 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1419 branchcode => C4::Context->userenv->{'branch'},
1420 onsite_checkout => $onsite_checkout,
1421 auto_renew => $auto_renew ? 1 : 0,
1424 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1426 $issue->set($issue_attributes)->store;
1429 $issue = Koha::Checkout->new(
1431 itemnumber => $item_object->itemnumber,
1436 if ( $item_object->location && $item_object->location eq 'CART'
1437 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1438 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1439 CartToShelf( $item_object->itemnumber );
1442 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1443 UpdateTotalIssues( $item_object->biblionumber, 1 );
1446 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1447 if ( $item_object->itemlost ) {
1449 Koha::RefundLostItemFeeRules->should_refund(
1451 current_branch => C4::Context->userenv->{branch},
1452 item_home_branch => $item_object->homebranch,
1453 item_holding_branch => $item_object->holdingbranch,
1458 _FixAccountForLostAndReturned( $item_object->itemnumber, undef,
1459 $item_object->barcode );
1465 issues => ( $item_object->issues || 0 ) + 1,
1466 holdingbranch => C4::Context->userenv->{'branch'},
1468 onloan => $datedue->ymd(),
1469 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1471 $item_object->biblionumber,
1472 $item_object->itemnumber,
1475 ModDateLastSeen( $item_object->itemnumber );
1477 # If it costs to borrow this book, charge it to the patron's account.
1478 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1479 if ( $charge && $charge > 0 ) {
1480 AddIssuingCharge( $issue, $charge, 'RENT' );
1483 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1484 if ( $itemtype_object ) {
1485 my $accumulate_charge = $fees->accumulate_rentalcharge();
1486 if ( $accumulate_charge > 0 ) {
1487 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1488 $charge += $accumulate_charge;
1489 $item_unblessed->{charge} = $charge;
1493 # Record the fact that this book was issued.
1496 branch => C4::Context->userenv->{'branch'},
1497 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1499 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1500 itemnumber => $item_object->itemnumber,
1501 itemtype => $item_object->effective_itemtype,
1502 location => $item_object->location,
1503 borrowernumber => $borrower->{'borrowernumber'},
1504 ccode => $item_object->ccode,
1508 # Send a checkout slip.
1509 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1511 branchcode => $branchcode,
1512 categorycode => $borrower->{categorycode},
1513 item_type => $item_object->effective_itemtype,
1514 notification => 'CHECKOUT',
1516 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1517 SendCirculationAlert(
1520 item => $item_object->unblessed,
1521 borrower => $borrower,
1522 branch => $branchcode,
1527 "CIRCULATION", "ISSUE",
1528 $borrower->{'borrowernumber'},
1529 $item_object->itemnumber,
1530 ) if C4::Context->preference("IssueLog");
1536 =head2 GetLoanLength
1538 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1540 Get loan length for an itemtype, a borrower type and a branch
1545 my ( $categorycode, $itemtype, $branchcode ) = @_;
1547 # Set search precedences
1550 categorycode => $categorycode,
1551 itemtype => $itemtype,
1552 branchcode => $branchcode,
1555 categorycode => $categorycode,
1557 branchcode => $branchcode,
1560 categorycode => undef,
1561 itemtype => $itemtype,
1562 branchcode => $branchcode,
1565 categorycode => undef,
1567 branchcode => $branchcode,
1570 categorycode => $categorycode,
1571 itemtype => $itemtype,
1572 branchcode => undef,
1575 categorycode => $categorycode,
1577 branchcode => undef,
1580 categorycode => undef,
1581 itemtype => $itemtype,
1582 branchcode => undef,
1585 categorycode => undef,
1587 branchcode => undef,
1591 # Initialize default values
1595 lengthunit => 'days',
1599 foreach my $rule_name (qw( issuelength renewalperiod lengthunit )) {
1600 foreach my $params (@params) {
1601 my $rule = Koha::CirculationRules->search(
1603 rule_name => $rule_name,
1609 $rules->{$rule_name} = $rule->rule_value;
1619 =head2 GetHardDueDate
1621 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1623 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1627 sub GetHardDueDate {
1628 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1630 my $rules = Koha::CirculationRules->get_effective_rules(
1632 categorycode => $borrowertype,
1633 itemtype => $itemtype,
1634 branchcode => $branchcode,
1635 rules => [ 'hardduedate', 'hardduedatecompare' ],
1639 if ( defined( $rules->{hardduedate} ) ) {
1640 if ( $rules->{hardduedate} ) {
1641 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1644 return ( undef, undef );
1649 =head2 GetBranchBorrowerCircRule
1651 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1653 Retrieves circulation rule attributes that apply to the given
1654 branch and patron category, regardless of item type.
1655 The return value is a hashref containing the following key:
1657 patron_maxissueqty - maximum number of loans that a
1658 patron of the given category can have at the given
1659 branch. If the value is undef, no limit.
1661 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1662 patron of the given category can have at the given
1663 branch. If the value is undef, no limit.
1665 This will check for different branch/category combinations in the following order:
1669 default branch and category
1671 If no rule has been found in the database, it will default to
1674 patron_maxissueqty - undef
1675 patron_maxonsiteissueqty - undef
1677 C<$branchcode> and C<$categorycode> should contain the
1678 literal branch code and patron category code, respectively - no
1683 sub GetBranchBorrowerCircRule {
1684 my ( $branchcode, $categorycode ) = @_;
1686 # Initialize default values
1688 patron_maxissueqty => undef,
1689 patron_maxonsiteissueqty => undef,
1693 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1694 my $rule = Koha::CirculationRules->get_effective_rule(
1696 categorycode => $categorycode,
1698 branchcode => $branchcode,
1699 rule_name => $rule_name,
1703 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1709 =head2 GetBranchItemRule
1711 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1713 Retrieves circulation rule attributes that apply to the given
1714 branch and item type, regardless of patron category.
1716 The return value is a hashref containing the following keys:
1718 holdallowed => Hold policy for this branch and itemtype. Possible values:
1719 0: No holds allowed.
1720 1: Holds allowed only by patrons that have the same homebranch as the item.
1721 2: Holds allowed from any patron.
1723 returnbranch => branch to which to return item. Possible values:
1724 noreturn: do not return, let item remain where checked in (floating collections)
1725 homebranch: return to item's home branch
1726 holdingbranch: return to issuer branch
1728 This searches branchitemrules in the following order:
1730 * Same branchcode and itemtype
1731 * Same branchcode, itemtype '*'
1732 * branchcode '*', same itemtype
1733 * branchcode and itemtype '*'
1735 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1739 sub GetBranchItemRule {
1740 my ( $branchcode, $itemtype ) = @_;
1743 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1745 branchcode => $branchcode,
1746 itemtype => $itemtype,
1747 rule_name => 'holdallowed',
1750 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1752 branchcode => $branchcode,
1753 itemtype => $itemtype,
1754 rule_name => 'hold_fulfillment_policy',
1757 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1759 branchcode => $branchcode,
1760 itemtype => $itemtype,
1761 rule_name => 'returnbranch',
1765 # built-in default circulation rule
1767 $rules->{holdallowed} = defined $holdallowed_rule
1768 ? $holdallowed_rule->rule_value
1770 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1771 ? $hold_fulfillment_policy_rule->rule_value
1773 $rules->{returnbranch} = defined $returnbranch_rule
1774 ? $returnbranch_rule->rule_value
1782 ($doreturn, $messages, $iteminformation, $borrower) =
1783 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1789 =item C<$barcode> is the bar code of the book being returned.
1791 =item C<$branch> is the code of the branch where the book is being returned.
1793 =item C<$exemptfine> indicates that overdue charges for the item will be
1796 =item C<$return_date> allows the default return date to be overridden
1797 by the given return date. Optional.
1801 C<&AddReturn> returns a list of four items:
1803 C<$doreturn> is true iff the return succeeded.
1805 C<$messages> is a reference-to-hash giving feedback on the operation.
1806 The keys of the hash are:
1812 No item with this barcode exists. The value is C<$barcode>.
1816 The book is not currently on loan. The value is C<$barcode>.
1820 This book has been withdrawn/cancelled. The value should be ignored.
1822 =item C<Wrongbranch>
1824 This book has was returned to the wrong branch. The value is a hashref
1825 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1826 contain the branchcode of the incorrect and correct return library, respectively.
1830 The item was reserved. The value is a reference-to-hash whose keys are
1831 fields from the reserves table of the Koha database, and
1832 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1833 either C<Waiting>, C<Reserved>, or 0.
1835 =item C<WasReturned>
1837 Value 1 if return is successful.
1839 =item C<NeedsTransfer>
1841 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1845 C<$iteminformation> is a reference-to-hash, giving information about the
1846 returned item from the issues table.
1848 C<$borrower> is a reference-to-hash, giving information about the
1849 patron who last borrowed the book.
1854 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1856 if ($branch and not Koha::Libraries->find($branch)) {
1857 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1860 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1861 $return_date //= dt_from_string();
1865 my $validTransfert = 0;
1866 my $stat_type = 'return';
1868 # get information on item
1869 my $item = Koha::Items->find({ barcode => $barcode });
1871 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1874 my $itemnumber = $item->itemnumber;
1875 my $itemtype = $item->effective_itemtype;
1877 my $issue = $item->checkout;
1879 $patron = $issue->patron
1880 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1881 . Dumper($issue->unblessed) . "\n";
1883 $messages->{'NotIssued'} = $barcode;
1884 ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1885 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1887 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1888 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1889 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1890 $messages->{'LocalUse'} = 1;
1891 $stat_type = 'localuse';
1895 my $item_unblessed = $item->unblessed;
1896 # full item data, but no borrowernumber or checkout info (no issue)
1897 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1898 # get the proper branch to which to return the item
1899 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1900 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1902 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1903 my $patron_unblessed = $patron ? $patron->unblessed : {};
1905 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1906 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1907 if ($update_loc_rules) {
1908 if (defined $update_loc_rules->{_ALL_}) {
1909 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1910 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1911 if ( $item->location ne $update_loc_rules->{_ALL_}) {
1912 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1913 ModItem( { location => $update_loc_rules->{_ALL_} }, undef, $itemnumber );
1917 foreach my $key ( keys %$update_loc_rules ) {
1918 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1919 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1920 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1921 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1922 ModItem( { location => $update_loc_rules->{$key} }, undef, $itemnumber );
1929 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1931 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1933 eval { $rules = YAML::Load($yaml); };
1935 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1938 foreach my $key ( keys %$rules ) {
1939 if ( $item->notforloan eq $key ) {
1940 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1941 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1948 # check if the return is allowed at this branch
1949 my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1950 unless ($returnallowed){
1951 $messages->{'Wrongbranch'} = {
1952 Wrongbranch => $branch,
1953 Rightbranch => $message
1956 return ( $doreturn, $messages, $issue, $patron_unblessed);
1959 if ( $item->withdrawn ) { # book has been cancelled
1960 $messages->{'withdrawn'} = 1;
1961 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1964 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1968 # case of a return of document (deal with issues and holdingbranch)
1970 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1971 $patron or warn "AddReturn without current borrower";
1975 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1978 if ( C4::Context->preference('CalculateFinesOnReturn') && !$item->itemlost ) {
1979 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1982 carp "The checkin for the following issue failed, Please go to the about page, section 'data corrupted' to know how to fix this problem ($@)" . Dumper( $issue->unblessed );
1984 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1987 # FIXME is the "= 1" right? This could be the borrower hash.
1988 $messages->{'WasReturned'} = 1;
1992 ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1995 # the holdingbranch is updated if the document is returned to another location.
1996 # this is always done regardless of whether the item was on loan or not
1997 my $item_holding_branch = $item->holdingbranch;
1998 if ($item->holdingbranch ne $branch) {
1999 UpdateHoldingbranch($branch, $item->itemnumber);
2000 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
2003 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2004 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
2006 # check if we have a transfer for this document
2007 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2009 # if we have a transfer to do, we update the line of transfers with the datearrived
2010 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2012 if ( $tobranch eq $branch ) {
2013 my $sth = C4::Context->dbh->prepare(
2014 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2016 $sth->execute( $item->itemnumber );
2017 # if we have a reservation with valid transfer, we can set it's status to 'W'
2018 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2020 $messages->{'WrongTransfer'} = $tobranch;
2021 $messages->{'WrongTransferItem'} = $item->itemnumber;
2023 $validTransfert = 1;
2026 # fix up the accounts.....
2027 if ( $item->itemlost ) {
2028 $messages->{'WasLost'} = 1;
2029 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2031 Koha::RefundLostItemFeeRules->should_refund(
2033 current_branch => C4::Context->userenv->{branch},
2034 item_home_branch => $item->homebranch,
2035 item_holding_branch => $item_holding_branch
2040 _FixAccountForLostAndReturned( $item->itemnumber,
2041 $borrowernumber, $barcode );
2042 $messages->{'LostItemFeeRefunded'} = 1;
2047 # fix up the overdues in accounts...
2048 if ($borrowernumber) {
2049 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2050 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2052 if ( $issue and $issue->is_overdue ) {
2054 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $return_date );
2056 $messages->{'PrevDebarred'} = $debardate;
2058 $messages->{'Debarred'} = $debardate if $debardate;
2060 # there's no overdue on the item but borrower had been previously debarred
2061 } elsif ( $issue->date_due and $patron->debarred ) {
2062 if ( $patron->debarred eq "9999-12-31") {
2063 $messages->{'ForeverDebarred'} = $patron->debarred;
2065 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2066 $borrower_debar_dt->truncate(to => 'day');
2067 my $today_dt = $return_date->clone()->truncate(to => 'day');
2068 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2069 $messages->{'PrevDebarred'} = $patron->debarred;
2075 # find reserves.....
2076 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2077 my ($resfound, $resrec);
2078 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2079 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2081 $resrec->{'ResFound'} = $resfound;
2082 $messages->{'ResFound'} = $resrec;
2085 # Record the fact that this book was returned.
2089 itemnumber => $itemnumber,
2090 itemtype => $itemtype,
2091 borrowernumber => $borrowernumber,
2092 ccode => $item->ccode,
2095 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2097 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2099 branchcode => $branch,
2100 categorycode => $patron->categorycode,
2101 item_type => $itemtype,
2102 notification => 'CHECKIN',
2104 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2105 SendCirculationAlert({
2107 item => $item_unblessed,
2108 borrower => $patron->unblessed,
2113 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2114 if C4::Context->preference("ReturnLog");
2117 # Remove any OVERDUES related debarment if the borrower has no overdues
2118 if ( $borrowernumber
2119 && $patron->debarred
2120 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2121 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2122 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2124 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2127 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2128 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2129 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2130 if (C4::Context->preference("AutomaticItemReturn" ) or
2131 (C4::Context->preference("UseBranchTransferLimits") and
2132 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2134 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2135 $debug and warn "item: " . Dumper($item_unblessed);
2136 ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2137 $messages->{'WasTransfered'} = 1;
2139 $messages->{'NeedsTransfer'} = $returnbranch;
2143 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2144 my $claims = Koha::Checkouts::ReturnClaims->search(
2146 itemnumber => $item->id,
2147 resolution => undef,
2151 if ( $claims->count ) {
2152 $messages->{ReturnClaims} = $claims;
2156 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2159 =head2 MarkIssueReturned
2161 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2163 Unconditionally marks an issue as being returned by
2164 moving the C<issues> row to C<old_issues> and
2165 setting C<returndate> to the current date.
2167 if C<$returndate> is specified (in iso format), it is used as the date
2170 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2171 the old_issue is immediately anonymised
2173 Ideally, this function would be internal to C<C4::Circulation>,
2174 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2175 and offline_circ/process_koc.pl.
2179 sub MarkIssueReturned {
2180 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2182 # Retrieve the issue
2183 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2185 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2187 my $issue_id = $issue->issue_id;
2189 my $anonymouspatron;
2190 if ( $privacy && $privacy == 2 ) {
2191 # The default of 0 will not work due to foreign key constraints
2192 # The anonymisation will fail if AnonymousPatron is not a valid entry
2193 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2194 # Note that a warning should appear on the about page (System information tab).
2195 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2196 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."
2197 unless Koha::Patrons->find( $anonymouspatron );
2200 my $schema = Koha::Database->schema;
2202 # FIXME Improve the return value and handle it from callers
2203 $schema->txn_do(sub {
2205 # Update the returndate value
2206 if ( $returndate ) {
2207 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2210 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2213 # Create the old_issues entry
2214 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2216 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2217 if ( $privacy && $privacy == 2) {
2218 $old_checkout->borrowernumber($anonymouspatron)->store;
2221 # And finally delete the issue
2224 ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2226 if ( C4::Context->preference('StoreLastBorrower') ) {
2227 my $item = Koha::Items->find( $itemnumber );
2228 my $patron = Koha::Patrons->find( $borrowernumber );
2229 $item->last_returned_by( $patron );
2236 =head2 _debar_user_on_return
2238 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2240 C<$borrower> borrower hashref
2242 C<$item> item hashref
2244 C<$datedue> date due DateTime object
2246 C<$returndate> DateTime object representing the return time
2248 Internal function, called only by AddReturn that calculates and updates
2249 the user fine days, and debars them if necessary.
2251 Should only be called for overdue returns
2253 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2258 sub _calculate_new_debar_dt {
2259 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2261 my $branchcode = _GetCircControlBranch( $item, $borrower );
2262 my $circcontrol = C4::Context->preference('CircControl');
2263 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2264 { categorycode => $borrower->{categorycode},
2265 itemtype => $item->{itype},
2266 branchcode => $branchcode,
2271 'maxsuspensiondays',
2272 'suspension_chargeperiod',
2276 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2277 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2278 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2280 return unless $finedays;
2282 # finedays is in days, so hourly loans must multiply by 24
2283 # thus 1 hour late equals 1 day suspension * finedays rate
2284 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2286 # grace period is measured in the same units as the loan
2288 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2290 my $deltadays = DateTime::Duration->new(
2291 days => $chargeable_units
2294 if ( $deltadays->subtract($grace)->is_positive() ) {
2295 my $suspension_days = $deltadays * $finedays;
2297 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2298 # No need to / 1 and do not consider / 0
2299 $suspension_days = DateTime::Duration->new(
2300 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2304 # If the max suspension days is < than the suspension days
2305 # the suspension days is limited to this maximum period.
2306 my $max_sd = $issuing_rule->{maxsuspensiondays};
2307 if ( defined $max_sd && $max_sd ne '' ) {
2308 $max_sd = DateTime::Duration->new( days => $max_sd );
2309 $suspension_days = $max_sd
2310 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2313 my ( $has_been_extended );
2314 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2315 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2317 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2318 $has_been_extended = 1;
2323 # Use the calendar or not to calculate the debarment date
2324 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2325 my $calendar = Koha::Calendar->new(
2326 branchcode => $branchcode,
2327 days_mode => 'Calendar'
2329 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2332 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2334 return $new_debar_dt;
2339 sub _debar_user_on_return {
2340 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2342 $return_date //= dt_from_string();
2344 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2346 return unless $new_debar_dt;
2348 Koha::Patron::Debarments::AddUniqueDebarment({
2349 borrowernumber => $borrower->{borrowernumber},
2350 expiration => $new_debar_dt->ymd(),
2351 type => 'SUSPENSION',
2353 # if borrower was already debarred but does not get an extra debarment
2354 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2355 my ($new_debarment_str, $is_a_reminder);
2356 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2358 $new_debarment_str = $borrower->{debarred};
2360 $new_debarment_str = $new_debar_dt->ymd();
2362 # FIXME Should return a DateTime object
2363 return $new_debarment_str, $is_a_reminder;
2366 =head2 _FixOverduesOnReturn
2368 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2370 C<$borrowernumber> borrowernumber
2372 C<$itemnumber> itemnumber
2374 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2376 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2382 sub _FixOverduesOnReturn {
2383 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2384 unless( $borrowernumber ) {
2385 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2389 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2393 warn "_FixOverduesOnReturn() not supplied valid status";
2397 my $schema = Koha::Database->schema;
2399 my $result = $schema->txn_do(
2401 # check for overdue fine
2402 my $accountlines = Koha::Account::Lines->search(
2404 borrowernumber => $borrowernumber,
2405 itemnumber => $item,
2406 debit_type_code => 'OVERDUE',
2407 status => 'UNRETURNED'
2410 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2412 my $accountline = $accountlines->next;
2414 my $amountoutstanding = $accountline->amountoutstanding;
2416 my $account = Koha::Account->new({patron_id => $borrowernumber});
2417 my $credit = $account->add_credit(
2419 amount => $amountoutstanding,
2420 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2421 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2422 interface => C4::Context->interface,
2428 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2430 $accountline->status('FORGIVEN');
2432 if (C4::Context->preference("FinesLog")) {
2433 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2436 $accountline->status($status);
2439 return $accountline->store();
2446 =head2 _FixAccountForLostAndReturned
2448 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2450 Finds the most recent lost item charge for this item and refunds the borrower
2451 appropriatly, taking into account any payments or writeoffs already applied
2454 Internal function, not exported, called only by AddReturn.
2458 sub _FixAccountForLostAndReturned {
2459 my $itemnumber = shift or return;
2460 my $borrowernumber = @_ ? shift : undef;
2461 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2465 # check for charge made for lost book
2466 my $accountlines = Koha::Account::Lines->search(
2468 itemnumber => $itemnumber,
2469 debit_type_code => 'LOST',
2470 status => [ undef, { '<>' => 'RETURNED' } ]
2473 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2477 return unless $accountlines->count > 0;
2478 my $accountline = $accountlines->next;
2479 my $total_to_refund = 0;
2481 return unless $accountline->borrowernumber;
2482 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2483 return unless $patron; # Patron has been deleted, nobody to credit the return to
2485 my $account = $patron->account;
2488 if ( $accountline->amount > $accountline->amountoutstanding ) {
2489 # some amount has been cancelled. collect the offsets that are not writeoffs
2490 # this works because the only way to subtract from this kind of a debt is
2491 # using the UI buttons 'Pay' and 'Write off'
2492 my $credits_offsets = Koha::Account::Offsets->search({
2493 debit_id => $accountline->id,
2494 credit_id => { '!=' => undef }, # it is not the debit itself
2495 type => { '!=' => 'Writeoff' },
2496 amount => { '<' => 0 } # credits are negative on the DB
2499 $total_to_refund = ( $credits_offsets->count > 0 )
2500 ? $credits_offsets->total * -1 # credits are negative on the DB
2504 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2506 if ( $credit_total > 0 ) {
2507 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2508 $credit = $account->add_credit(
2509 { amount => $credit_total,
2510 description => 'Item Returned ' . $item_id,
2511 type => 'LOST_RETURN',
2512 interface => C4::Context->interface,
2513 library_id => $branchcode
2517 $credit->apply( { debits => [ $accountline ] } );
2520 # Update the account status
2521 $accountline->discard_changes->status('RETURNED');
2522 $accountline->store;
2524 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2525 $account->reconcile_balance;
2528 return ($credit) ? $credit->id : undef;
2531 =head2 _GetCircControlBranch
2533 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2537 Return the library code to be used to determine which circulation
2538 policy applies to a transaction. Looks up the CircControl and
2539 HomeOrHoldingBranch system preferences.
2541 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2543 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2547 sub _GetCircControlBranch {
2548 my ($item, $borrower) = @_;
2549 my $circcontrol = C4::Context->preference('CircControl');
2552 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2553 $branch= C4::Context->userenv->{'branch'};
2554 } elsif ($circcontrol eq 'PatronLibrary') {
2555 $branch=$borrower->{branchcode};
2557 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2558 $branch = $item->{$branchfield};
2559 # default to item home branch if holdingbranch is used
2560 # and is not defined
2561 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2562 $branch = $item->{homebranch};
2570 $issue = GetOpenIssue( $itemnumber );
2572 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2574 C<$itemnumber> is the item's itemnumber
2581 my ( $itemnumber ) = @_;
2582 return unless $itemnumber;
2583 my $dbh = C4::Context->dbh;
2584 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2585 $sth->execute( $itemnumber );
2586 return $sth->fetchrow_hashref();
2590 =head2 GetBiblioIssues
2592 $issues = GetBiblioIssues($biblionumber);
2594 this function get all issues from a biblionumber.
2597 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2598 tables issues and the firstname,surname & cardnumber from borrowers.
2602 sub GetBiblioIssues {
2603 my $biblionumber = shift;
2604 return unless $biblionumber;
2605 my $dbh = C4::Context->dbh;
2607 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2609 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2610 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2611 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2612 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2613 WHERE biblio.biblionumber = ?
2615 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2617 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2618 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2619 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2620 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2621 WHERE biblio.biblionumber = ?
2624 my $sth = $dbh->prepare($query);
2625 $sth->execute($biblionumber, $biblionumber);
2628 while ( my $data = $sth->fetchrow_hashref ) {
2629 push @issues, $data;
2634 =head2 GetUpcomingDueIssues
2636 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2640 sub GetUpcomingDueIssues {
2643 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2644 my $dbh = C4::Context->dbh;
2646 my $statement = <<END_SQL;
2649 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2651 LEFT JOIN items USING (itemnumber)
2652 LEFT OUTER JOIN branches USING (branchcode)
2653 WHERE returndate is NULL
2655 WHERE days_until_due >= 0 AND days_until_due <= ?
2658 my @bind_parameters = ( $params->{'days_in_advance'} );
2660 my $sth = $dbh->prepare( $statement );
2661 $sth->execute( @bind_parameters );
2662 my $upcoming_dues = $sth->fetchall_arrayref({});
2664 return $upcoming_dues;
2667 =head2 CanBookBeRenewed
2669 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2671 Find out whether a borrowed item may be renewed.
2673 C<$borrowernumber> is the borrower number of the patron who currently
2674 has the item on loan.
2676 C<$itemnumber> is the number of the item to renew.
2678 C<$override_limit>, if supplied with a true value, causes
2679 the limit on the number of times that the loan can be renewed
2680 (as controlled by the item type) to be ignored. Overriding also allows
2681 to renew sooner than "No renewal before" and to manually renew loans
2682 that are automatically renewed.
2684 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2685 item must currently be on loan to the specified borrower; renewals
2686 must be allowed for the item's type; and the borrower must not have
2687 already renewed the loan. $error will contain the reason the renewal can not proceed
2691 sub CanBookBeRenewed {
2692 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2694 my $dbh = C4::Context->dbh;
2698 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2699 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2700 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2701 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2703 my $patron = $issue->patron or return;
2705 # override_limit will override anything else except on_reserve
2706 unless ( $override_limit ){
2707 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2708 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2710 categorycode => $patron->categorycode,
2711 itemtype => $item->effective_itemtype,
2712 branchcode => $branchcode,
2715 'no_auto_renewal_after',
2716 'no_auto_renewal_after_hard_limit',
2723 return ( 0, "too_many" )
2724 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2726 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2727 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2728 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2729 my $restricted = $patron->is_debarred;
2730 my $hasoverdues = $patron->has_overdues;
2732 if ( $restricted and $restrictionblockrenewing ) {
2733 return ( 0, 'restriction');
2734 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2735 return ( 0, 'overdue');
2738 if ( $issue->auto_renew ) {
2740 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2741 return ( 0, 'auto_account_expired' );
2744 if ( defined $issuing_rule->{no_auto_renewal_after}
2745 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2746 # Get issue_date and add no_auto_renewal_after
2747 # If this is greater than today, it's too late for renewal.
2748 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2749 $maximum_renewal_date->add(
2750 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2752 my $now = dt_from_string;
2753 if ( $now >= $maximum_renewal_date ) {
2754 return ( 0, "auto_too_late" );
2757 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2758 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2759 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2760 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2761 return ( 0, "auto_too_late" );
2765 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2766 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2767 my $amountoutstanding =
2768 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2769 ? $patron->account->balance
2770 : $patron->account->outstanding_debits->total_outstanding;
2771 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2772 return ( 0, "auto_too_much_oweing" );
2777 if ( defined $issuing_rule->{norenewalbefore}
2778 and $issuing_rule->{norenewalbefore} ne "" )
2781 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2782 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2783 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2785 # Depending on syspref reset the exact time, only check the date
2786 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2787 and $issuing_rule->{lengthunit} eq 'days' )
2789 $soonestrenewal->truncate( to => 'day' );
2792 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2794 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2795 return ( 0, "too_soon" );
2797 elsif ( $issue->auto_renew ) {
2802 # Fallback for automatic renewals:
2803 # If norenewalbefore is undef, don't renew before due date.
2804 if ( $issue->auto_renew && !$auto_renew ) {
2805 my $now = dt_from_string;
2806 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2809 return ( 0, "auto_too_soon" );
2814 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2816 # This item can fill one or more unfilled reserve, can those unfilled reserves
2817 # all be filled by other available items?
2819 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2821 my $schema = Koha::Database->new()->schema();
2823 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2825 # There is an item level hold on this item, no other item can fill the hold
2830 # Get all other items that could possibly fill reserves
2831 my @itemnumbers = $schema->resultset('Item')->search(
2833 biblionumber => $resrec->{biblionumber},
2836 -not => { itemnumber => $itemnumber }
2838 { columns => 'itemnumber' }
2839 )->get_column('itemnumber')->all();
2841 # Get all other reserves that could have been filled by this item
2842 my @borrowernumbers;
2844 my ( $reserve_found, $reserve, undef ) =
2845 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2847 if ($reserve_found) {
2848 push( @borrowernumbers, $reserve->{borrowernumber} );
2855 # If the count of the union of the lists of reservable items for each borrower
2856 # is equal or greater than the number of borrowers, we know that all reserves
2857 # can be filled with available items. We can get the union of the sets simply
2858 # by pushing all the elements onto an array and removing the duplicates.
2861 ITEM: foreach my $itemnumber (@itemnumbers) {
2862 my $item = Koha::Items->find( $itemnumber );
2863 next if IsItemOnHoldAndFound( $itemnumber );
2864 for my $borrowernumber (@borrowernumbers) {
2865 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2866 next unless IsAvailableForItemLevelRequest($item, $patron);
2867 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2869 push @reservable, $itemnumber;
2870 if (@reservable >= @borrowernumbers) {
2879 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2880 return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
2882 return ( 1, undef );
2887 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2891 C<$borrowernumber> is the borrower number of the patron who currently
2894 C<$itemnumber> is the number of the item to renew.
2896 C<$branch> is the library where the renewal took place (if any).
2897 The library that controls the circ policies for the renewal is retrieved from the issues record.
2899 C<$datedue> can be a DateTime object used to set the due date.
2901 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2902 this parameter is not supplied, lastreneweddate is set to the current date.
2904 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2905 from the book's item type.
2910 my $borrowernumber = shift;
2911 my $itemnumber = shift or return;
2913 my $datedue = shift;
2914 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2916 my $item_object = Koha::Items->find($itemnumber) or return;
2917 my $biblio = $item_object->biblio;
2918 my $issue = $item_object->checkout;
2919 my $item_unblessed = $item_object->unblessed;
2921 my $dbh = C4::Context->dbh;
2923 return unless $issue;
2925 $borrowernumber ||= $issue->borrowernumber;
2927 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2928 carp 'Invalid date passed to AddRenewal.';
2932 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2933 my $patron_unblessed = $patron->unblessed;
2935 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2937 my $schema = Koha::Database->schema;
2938 $schema->txn_do(sub{
2940 if ( C4::Context->preference('CalculateFinesOnReturn') ) {
2941 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2943 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2945 # If the due date wasn't specified, calculate it by adding the
2946 # book's loan length to today's date or the current due date
2947 # based on the value of the RenewalPeriodBase syspref.
2948 my $itemtype = $item_object->effective_itemtype;
2951 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2952 dt_from_string( $issue->date_due, 'sql' ) :
2953 DateTime->now( time_zone => C4::Context->tz());
2954 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2957 my $fees = Koha::Charges::Fees->new(
2960 library => $circ_library,
2961 item => $item_object,
2962 from_date => dt_from_string( $issue->date_due, 'sql' ),
2963 to_date => dt_from_string($datedue),
2967 # Update the issues record to have the new due date, and a new count
2968 # of how many times it has been renewed.
2969 my $renews = ( $issue->renewals || 0 ) + 1;
2970 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2971 WHERE borrowernumber=?
2975 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2977 # Update the renewal count on the item, and tell zebra to reindex
2978 $renews = ( $item_object->renewals || 0 ) + 1;
2979 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2981 # Charge a new rental fee, if applicable
2982 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2983 if ( $charge > 0 ) {
2984 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
2987 # Charge a new accumulate rental fee, if applicable
2988 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2989 if ( $itemtype_object ) {
2990 my $accumulate_charge = $fees->accumulate_rentalcharge();
2991 if ( $accumulate_charge > 0 ) {
2992 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
2994 $charge += $accumulate_charge;
2997 # Send a renewal slip according to checkout alert preferencei
2998 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2999 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3001 branchcode => $branch,
3002 categorycode => $patron->categorycode,
3003 item_type => $itemtype,
3004 notification => 'CHECKOUT',
3006 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3007 SendCirculationAlert(
3010 item => $item_unblessed,
3011 borrower => $patron->unblessed,
3018 # Remove any OVERDUES related debarment if the borrower has no overdues
3020 && $patron->is_debarred
3021 && ! $patron->has_overdues
3022 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3024 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3027 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
3028 $branch = ( C4::Context->userenv && defined C4::Context->userenv->{branch} ) ? C4::Context->userenv->{branch} : $branch;
3031 # Add the renewal to stats
3037 itemnumber => $itemnumber,
3038 itemtype => $itemtype,
3039 location => $item_object->location,
3040 borrowernumber => $borrowernumber,
3041 ccode => $item_object->ccode,
3046 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3053 # check renewal status
3054 my ( $bornum, $itemno ) = @_;
3055 my $dbh = C4::Context->dbh;
3057 my $renewsallowed = 0;
3060 my $patron = Koha::Patrons->find( $bornum );
3061 my $item = Koha::Items->find($itemno);
3063 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3065 # Look in the issues table for this item, lent to this borrower,
3066 # and not yet returned.
3068 # FIXME - I think this function could be redone to use only one SQL call.
3069 my $sth = $dbh->prepare(
3070 "select * from issues
3071 where (borrowernumber = ?)
3072 and (itemnumber = ?)"
3074 $sth->execute( $bornum, $itemno );
3075 my $data = $sth->fetchrow_hashref;
3076 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3077 # $item and $borrower should be calculated
3078 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3080 my $rule = Koha::CirculationRules->get_effective_rule(
3082 categorycode => $patron->categorycode,
3083 itemtype => $item->effective_itemtype,
3084 branchcode => $branchcode,
3085 rule_name => 'renewalsallowed',
3089 $renewsallowed = $rule ? $rule->rule_value : 0;
3090 $renewsleft = $renewsallowed - $renewcount;
3091 if($renewsleft < 0){ $renewsleft = 0; }
3092 return ( $renewcount, $renewsallowed, $renewsleft );
3095 =head2 GetSoonestRenewDate
3097 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3099 Find out the soonest possible renew date of a borrowed item.
3101 C<$borrowernumber> is the borrower number of the patron who currently
3102 has the item on loan.
3104 C<$itemnumber> is the number of the item to renew.
3106 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3107 renew date, based on the value "No renewal before" of the applicable
3108 issuing rule. Returns the current date if the item can already be
3109 renewed, and returns undefined if the borrower, loan, or item
3114 sub GetSoonestRenewDate {
3115 my ( $borrowernumber, $itemnumber ) = @_;
3117 my $dbh = C4::Context->dbh;
3119 my $item = Koha::Items->find($itemnumber) or return;
3120 my $itemissue = $item->checkout or return;
3122 $borrowernumber ||= $itemissue->borrowernumber;
3123 my $patron = Koha::Patrons->find( $borrowernumber )
3126 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3127 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3128 { categorycode => $patron->categorycode,
3129 itemtype => $item->effective_itemtype,
3130 branchcode => $branchcode,
3138 my $now = dt_from_string;
3139 return $now unless $issuing_rule;
3141 if ( defined $issuing_rule->{norenewalbefore}
3142 and $issuing_rule->{norenewalbefore} ne "" )
3144 my $soonestrenewal =
3145 dt_from_string( $itemissue->date_due )->subtract(
3146 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3148 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3149 and $issuing_rule->{lengthunit} eq 'days' )
3151 $soonestrenewal->truncate( to => 'day' );
3153 return $soonestrenewal if $now < $soonestrenewal;
3158 =head2 GetLatestAutoRenewDate
3160 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3162 Find out the latest possible auto renew date of a borrowed item.
3164 C<$borrowernumber> is the borrower number of the patron who currently
3165 has the item on loan.
3167 C<$itemnumber> is the number of the item to renew.
3169 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3170 auto renew date, based on the value "No auto renewal after" and the "No auto
3171 renewal after (hard limit) of the applicable issuing rule.
3172 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3173 or item cannot be found.
3177 sub GetLatestAutoRenewDate {
3178 my ( $borrowernumber, $itemnumber ) = @_;
3180 my $dbh = C4::Context->dbh;
3182 my $item = Koha::Items->find($itemnumber) or return;
3183 my $itemissue = $item->checkout or return;
3185 $borrowernumber ||= $itemissue->borrowernumber;
3186 my $patron = Koha::Patrons->find( $borrowernumber )
3189 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3190 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3192 categorycode => $patron->categorycode,
3193 itemtype => $item->effective_itemtype,
3194 branchcode => $branchcode,
3196 'no_auto_renewal_after',
3197 'no_auto_renewal_after_hard_limit',
3203 return unless $circulation_rules;
3205 if ( not $circulation_rules->{no_auto_renewal_after}
3206 or $circulation_rules->{no_auto_renewal_after} eq '' )
3207 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3208 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3210 my $maximum_renewal_date;
3211 if ( $circulation_rules->{no_auto_renewal_after} ) {
3212 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3213 $maximum_renewal_date->add(
3214 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3218 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3219 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3220 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3222 return $maximum_renewal_date;
3226 =head2 GetIssuingCharges
3228 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3230 Calculate how much it would cost for a given patron to borrow a given
3231 item, including any applicable discounts.
3233 C<$itemnumber> is the item number of item the patron wishes to borrow.
3235 C<$borrowernumber> is the patron's borrower number.
3237 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3238 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3243 sub GetIssuingCharges {
3245 # calculate charges due
3246 my ( $itemnumber, $borrowernumber ) = @_;
3248 my $dbh = C4::Context->dbh;
3251 # Get the book's item type and rental charge (via its biblioitem).
3252 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3253 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3254 $charge_query .= (C4::Context->preference('item-level_itypes'))
3255 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3256 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3258 $charge_query .= ' WHERE items.itemnumber =?';
3260 my $sth = $dbh->prepare($charge_query);
3261 $sth->execute($itemnumber);
3262 if ( my $item_data = $sth->fetchrow_hashref ) {
3263 $item_type = $item_data->{itemtype};
3264 $charge = $item_data->{rentalcharge};
3265 my $branch = C4::Context::mybranch();
3266 my $patron = Koha::Patrons->find( $borrowernumber );
3267 my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3269 # We may have multiple rules so get the most specific
3270 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3273 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3277 return ( $charge, $item_type );
3280 # Select most appropriate discount rule from those returned
3281 sub _get_discount_from_rule {
3282 my ($categorycode, $branchcode, $itemtype) = @_;
3284 # Set search precedences
3287 branchcode => $branchcode,
3288 itemtype => $itemtype,
3289 categorycode => $categorycode,
3292 branchcode => undef,
3293 categorycode => $categorycode,
3294 itemtype => $itemtype,
3297 branchcode => $branchcode,
3298 categorycode => $categorycode,
3302 branchcode => undef,
3303 categorycode => $categorycode,
3308 foreach my $params (@params) {
3309 my $rule = Koha::CirculationRules->search(
3311 rule_name => 'rentaldiscount',
3316 return $rule->rule_value if $rule;
3323 =head2 AddIssuingCharge
3325 &AddIssuingCharge( $checkout, $charge, $type )
3329 sub AddIssuingCharge {
3330 my ( $checkout, $charge, $type ) = @_;
3332 # FIXME What if checkout does not exist?
3334 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3335 my $accountline = $account->add_debit(
3339 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3340 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3341 interface => C4::Context->interface,
3343 item_id => $checkout->itemnumber,
3344 issue_id => $checkout->issue_id,
3351 GetTransfers($itemnumber);
3356 my ($itemnumber) = @_;
3358 my $dbh = C4::Context->dbh;
3365 FROM branchtransfers
3366 WHERE itemnumber = ?
3367 AND datearrived IS NULL
3369 my $sth = $dbh->prepare($query);
3370 $sth->execute($itemnumber);
3371 my @row = $sth->fetchrow_array();
3375 =head2 GetTransfersFromTo
3377 @results = GetTransfersFromTo($frombranch,$tobranch);
3379 Returns the list of pending transfers between $from and $to branch
3383 sub GetTransfersFromTo {
3384 my ( $frombranch, $tobranch ) = @_;
3385 return unless ( $frombranch && $tobranch );
3386 my $dbh = C4::Context->dbh;
3388 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3389 FROM branchtransfers
3392 AND datearrived IS NULL
3394 my $sth = $dbh->prepare($query);
3395 $sth->execute( $frombranch, $tobranch );
3398 while ( my $data = $sth->fetchrow_hashref ) {
3399 push @gettransfers, $data;
3401 return (@gettransfers);
3404 =head2 DeleteTransfer
3406 &DeleteTransfer($itemnumber);
3410 sub DeleteTransfer {
3411 my ($itemnumber) = @_;
3412 return unless $itemnumber;
3413 my $dbh = C4::Context->dbh;
3414 my $sth = $dbh->prepare(
3415 "DELETE FROM branchtransfers
3417 AND datearrived IS NULL "
3419 return $sth->execute($itemnumber);
3422 =head2 SendCirculationAlert
3424 Send out a C<check-in> or C<checkout> alert using the messaging system.
3432 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3436 Hashref of information about the item being checked in or out.
3440 Hashref of information about the borrower of the item.
3444 The branchcode from where the checkout or check-in took place.
3450 SendCirculationAlert({
3453 borrower => $borrower,
3459 sub SendCirculationAlert {
3461 my ($type, $item, $borrower, $branch) =
3462 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3463 my %message_name = (
3464 CHECKIN => 'Item_Check_in',
3465 CHECKOUT => 'Item_Checkout',
3466 RENEWAL => 'Item_Checkout',
3468 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3469 borrowernumber => $borrower->{borrowernumber},
3470 message_name => $message_name{$type},
3472 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3474 my $schema = Koha::Database->new->schema;
3475 my @transports = keys %{ $borrower_preferences->{transports} };
3477 # From the MySQL doc:
3478 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3479 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3480 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3481 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3483 for my $mtt (@transports) {
3484 my $letter = C4::Letters::GetPreparedLetter (
3485 module => 'circulation',
3486 letter_code => $type,
3487 branchcode => $branch,
3488 message_transport_type => $mtt,
3489 lang => $borrower->{lang},
3491 $issues_table => $item->{itemnumber},
3492 'items' => $item->{itemnumber},
3493 'biblio' => $item->{biblionumber},
3494 'biblioitems' => $item->{biblionumber},
3495 'borrowers' => $borrower,
3496 'branches' => $branch,
3500 $schema->storage->txn_begin;
3501 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3502 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3503 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3504 unless ( $message ) {
3505 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3506 C4::Message->enqueue($letter, $borrower, $mtt);
3508 $message->append($letter);
3511 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3512 $schema->storage->txn_commit;
3518 =head2 updateWrongTransfer
3520 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3522 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
3526 sub updateWrongTransfer {
3527 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3528 my $dbh = C4::Context->dbh;
3529 # first step validate the actual line of transfert .
3532 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3534 $sth->execute($FromLibrary,$itemNumber);
3536 # second step create a new line of branchtransfer to the right location .
3537 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3539 #third step changing holdingbranch of item
3540 UpdateHoldingbranch($FromLibrary,$itemNumber);
3543 =head2 UpdateHoldingbranch
3545 $items = UpdateHoldingbranch($branch,$itmenumber);
3547 Simple methode for updating hodlingbranch in items BDD line
3551 sub UpdateHoldingbranch {
3552 my ( $branch,$itemnumber ) = @_;
3553 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3558 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3560 this function calculates the due date given the start date and configured circulation rules,
3561 checking against the holidays calendar as per the 'useDaysMode' syspref.
3562 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3563 C<$itemtype> = itemtype code of item in question
3564 C<$branch> = location whose calendar to use
3565 C<$borrower> = Borrower object
3566 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3571 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3575 # loanlength now a href
3577 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3579 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3585 if (ref $startdate ne 'DateTime' ) {
3586 $datedue = dt_from_string($datedue);
3588 $datedue = $startdate->clone;
3592 DateTime->now( time_zone => C4::Context->tz() )
3593 ->truncate( to => 'minute' );
3597 # calculate the datedue as normal
3598 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3599 { # ignoring calendar
3600 if ( $loanlength->{lengthunit} eq 'hours' ) {
3601 $datedue->add( hours => $loanlength->{$length_key} );
3603 $datedue->add( days => $loanlength->{$length_key} );
3604 $datedue->set_hour(23);
3605 $datedue->set_minute(59);
3609 if ($loanlength->{lengthunit} eq 'hours') {
3610 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3613 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3615 my $calendar = Koha::Calendar->new( branchcode => $branch );
3616 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3617 if ($loanlength->{lengthunit} eq 'days') {
3618 $datedue->set_hour(23);
3619 $datedue->set_minute(59);
3623 # if Hard Due Dates are used, retrieve them and apply as necessary
3624 my ( $hardduedate, $hardduedatecompare ) =
3625 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3626 if ($hardduedate) { # hardduedates are currently dates
3627 $hardduedate->truncate( to => 'minute' );
3628 $hardduedate->set_hour(23);
3629 $hardduedate->set_minute(59);
3630 my $cmp = DateTime->compare( $hardduedate, $datedue );
3632 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3633 # if the calculated date is before the 'after' Hard Due Date (floor), override
3634 # if the hard due date is set to 'exactly', overrride
3635 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3636 $datedue = $hardduedate->clone;
3639 # in all other cases, keep the date due as it is
3643 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3644 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3645 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3646 if( $expiry_dt ) { #skip empty expiry date..
3647 $expiry_dt->set( hour => 23, minute => 59);
3648 my $d1= $datedue->clone->set_time_zone('floating');
3649 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3650 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3653 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3654 my $calendar = Koha::Calendar->new( branchcode => $branch );
3655 if ( $calendar->is_holiday($datedue) ) {
3656 # Don't return on a closed day
3657 $datedue = $calendar->prev_open_days( $datedue, 1 );
3666 sub CheckValidBarcode{
3668 my $dbh = C4::Context->dbh;
3669 my $query=qq|SELECT count(*)
3673 my $sth = $dbh->prepare($query);
3674 $sth->execute($barcode);
3675 my $exist=$sth->fetchrow ;
3679 =head2 IsBranchTransferAllowed
3681 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3683 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3685 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3686 Koha::Item->can_be_transferred.
3690 sub IsBranchTransferAllowed {
3691 my ( $toBranch, $fromBranch, $code ) = @_;
3693 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3695 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3696 my $dbh = C4::Context->dbh;
3698 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3699 $sth->execute( $toBranch, $fromBranch, $code );
3700 my $limit = $sth->fetchrow_hashref();
3702 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3703 if ( $limit->{'limitId'} ) {
3710 =head2 CreateBranchTransferLimit
3712 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3714 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3716 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3720 sub CreateBranchTransferLimit {
3721 my ( $toBranch, $fromBranch, $code ) = @_;
3722 return unless defined($toBranch) && defined($fromBranch);
3723 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3725 my $dbh = C4::Context->dbh;
3727 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3728 return $sth->execute( $code, $toBranch, $fromBranch );
3731 =head2 DeleteBranchTransferLimits
3733 my $result = DeleteBranchTransferLimits($frombranch);
3735 Deletes all the library transfer limits for one library. Returns the
3736 number of limits deleted, 0e0 if no limits were deleted, or undef if
3737 no arguments are supplied.
3739 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3740 fromBranch => $fromBranch
3745 sub DeleteBranchTransferLimits {
3747 return unless defined $branch;
3748 my $dbh = C4::Context->dbh;
3749 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3750 return $sth->execute($branch);
3754 my ( $borrowernumber, $itemnum ) = @_;
3755 MarkIssueReturned( $borrowernumber, $itemnum );
3760 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3762 unless ( $mark_lost_from ) {
3763 # Temporary check to avoid regressions
3764 die q|LostItem called without $mark_lost_from, check the API.|;
3768 if ( $force_mark_returned ) {
3771 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3772 $mark_returned = ( $pref =~ m|$mark_lost_from| );
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 $patron = Koha::Patrons->find( $borrowernumber );
3788 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3789 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3791 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3792 C4::Accounts::chargelostitem(
3795 $issues->{'replacementprice'},
3796 sprintf( "%s %s %s",
3797 $issues->{'title'} || q{},
3798 $issues->{'barcode'} || q{},
3799 $issues->{'itemcallnumber'} || q{},
3802 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3803 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3806 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3809 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3810 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3811 ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3813 my $transferdeleted = DeleteTransfer($itemnumber);
3816 sub GetOfflineOperations {
3817 my $dbh = C4::Context->dbh;
3818 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3819 $sth->execute(C4::Context->userenv->{'branch'});
3820 my $results = $sth->fetchall_arrayref({});
3824 sub GetOfflineOperation {
3825 my $operationid = shift;
3826 return unless $operationid;
3827 my $dbh = C4::Context->dbh;
3828 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3829 $sth->execute( $operationid );
3830 return $sth->fetchrow_hashref;
3833 sub AddOfflineOperation {
3834 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3835 my $dbh = C4::Context->dbh;
3836 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3837 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3841 sub DeleteOfflineOperation {
3842 my $dbh = C4::Context->dbh;
3843 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3844 $sth->execute( shift );
3848 sub ProcessOfflineOperation {
3849 my $operation = shift;
3852 if ( $operation->{action} eq 'return' ) {
3853 $report = ProcessOfflineReturn( $operation );
3854 } elsif ( $operation->{action} eq 'issue' ) {
3855 $report = ProcessOfflineIssue( $operation );
3856 } elsif ( $operation->{action} eq 'payment' ) {
3857 $report = ProcessOfflinePayment( $operation );
3860 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3865 sub ProcessOfflineReturn {
3866 my $operation = shift;
3868 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3871 my $itemnumber = $item->itemnumber;
3872 my $issue = GetOpenIssue( $itemnumber );
3875 $issue->{borrowernumber},
3877 $operation->{timestamp},
3880 { renewals => 0, onloan => undef },
3881 $issue->{'biblionumber'},
3887 return "Item not issued.";
3890 return "Item not found.";
3894 sub ProcessOfflineIssue {
3895 my $operation = shift;
3897 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3900 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3902 return "Barcode not found.";
3904 my $itemnumber = $item->itemnumber;
3905 my $issue = GetOpenIssue( $itemnumber );
3907 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3909 $issue->{borrowernumber},
3911 $operation->{timestamp},
3916 $operation->{'barcode'},
3919 $operation->{timestamp},
3924 return "Borrower not found.";
3928 sub ProcessOfflinePayment {
3929 my $operation = shift;
3931 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3933 $patron->account->pay(
3935 amount => $operation->{amount},
3936 library_id => $operation->{branchcode},
3946 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3948 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3953 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3957 ? Koha::Items->find($itemnumber)
3958 : Koha::Items->find( { barcode => $barcode } );
3962 return C4::Letters::GetPreparedLetter (
3963 module => 'circulation',
3964 letter_code => 'TRANSFERSLIP',
3965 branchcode => $branch,
3967 'branches' => $to_branch,
3968 'biblio' => $item->biblionumber,
3969 'items' => $item->unblessed,
3974 =head2 CheckIfIssuedToPatron
3976 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3978 Return 1 if any record item is issued to patron, otherwise return 0
3982 sub CheckIfIssuedToPatron {
3983 my ($borrowernumber, $biblionumber) = @_;
3985 my $dbh = C4::Context->dbh;
3987 SELECT COUNT(*) FROM issues
3988 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3989 WHERE items.biblionumber = ?
3990 AND issues.borrowernumber = ?
3992 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3993 return 1 if $is_issued;
3999 IsItemIssued( $itemnumber )
4001 Return 1 if the item is on loan, otherwise return 0
4006 my $itemnumber = shift;
4007 my $dbh = C4::Context->dbh;
4008 my $sth = $dbh->prepare(q{
4011 WHERE itemnumber = ?
4013 $sth->execute($itemnumber);
4014 return $sth->fetchrow;
4017 =head2 GetAgeRestriction
4019 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4020 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4022 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4023 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4025 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4026 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4027 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4028 Negative days mean the borrower has gone past the age restriction age.
4032 sub GetAgeRestriction {
4033 my ($record_restrictions, $borrower) = @_;
4034 my $markers = C4::Context->preference('AgeRestrictionMarker');
4036 return unless $record_restrictions;
4037 # Split $record_restrictions to something like FSK 16 or PEGI 6
4038 my @values = split ' ', uc($record_restrictions);
4039 return unless @values;
4041 # Search first occurrence of one of the markers
4042 my @markers = split /\|/, uc($markers);
4043 return unless @markers;
4046 my $restriction_year = 0;
4047 for my $value (@values) {
4049 for my $marker (@markers) {
4050 $marker =~ s/^\s+//; #remove leading spaces
4051 $marker =~ s/\s+$//; #remove trailing spaces
4052 if ( $marker eq $value ) {
4053 if ( $index <= $#values ) {
4054 $restriction_year += $values[$index];
4058 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4060 # Perhaps it is something like "K16" (as in Finland)
4061 $restriction_year += $1;
4065 last if ( $restriction_year > 0 );
4068 #Check if the borrower is age restricted for this material and for how long.
4069 if ($restriction_year && $borrower) {
4070 if ( $borrower->{'dateofbirth'} ) {
4071 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4072 $alloweddate[0] += $restriction_year;
4074 #Prevent runime eror on leap year (invalid date)
4075 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4076 $alloweddate[2] = 28;
4079 #Get how many days the borrower has to reach the age restriction
4080 my @Today = split /-/, DateTime->today->ymd();
4081 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4082 #Negative days means the borrower went past the age restriction age
4083 return ($restriction_year, $daysToAgeRestriction);
4087 return ($restriction_year);
4091 =head2 GetPendingOnSiteCheckouts
4095 sub GetPendingOnSiteCheckouts {
4096 my $dbh = C4::Context->dbh;
4097 return $dbh->selectall_arrayref(q|
4103 items.itemcallnumber,
4107 issues.date_due < NOW() AS is_overdue,
4110 borrowers.firstname,
4112 borrowers.cardnumber,
4113 borrowers.borrowernumber
4115 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4116 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4117 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4118 WHERE issues.onsite_checkout = 1
4119 |, { Slice => {} } );
4125 my ($count, $branch, $itemtype, $ccode, $newness)
4126 = @$params{qw(count branch itemtype ccode newness)};
4128 my $dbh = C4::Context->dbh;
4131 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4132 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4133 i.ccode, SUM(i.issues) AS count
4135 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4136 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4139 my (@where_strs, @where_args);
4142 push @where_strs, 'i.homebranch = ?';
4143 push @where_args, $branch;
4146 if (C4::Context->preference('item-level_itypes')){
4147 push @where_strs, 'i.itype = ?';
4148 push @where_args, $itemtype;
4150 push @where_strs, 'bi.itemtype = ?';
4151 push @where_args, $itemtype;
4155 push @where_strs, 'i.ccode = ?';
4156 push @where_args, $ccode;
4159 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4160 push @where_args, $newness;
4164 $query .= 'WHERE ' . join(' AND ', @where_strs);
4168 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4169 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4174 $query .= q{ ) xxx WHERE count > 0 };
4175 $count = int($count);
4177 $query .= "LIMIT $count";
4180 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4185 sub _CalculateAndUpdateFine {
4188 my $borrower = $params->{borrower};
4189 my $item = $params->{item};
4190 my $issue = $params->{issue};
4191 my $return_date = $params->{return_date};
4193 unless ($borrower) { carp "No borrower passed in!" && return; }
4194 unless ($item) { carp "No item passed in!" && return; }
4195 unless ($issue) { carp "No issue passed in!" && return; }
4197 my $datedue = dt_from_string( $issue->date_due );
4199 # we only need to calculate and change the fines if we want to do that on return
4200 # Should be on for hourly loans
4201 my $control = C4::Context->preference('CircControl');
4202 my $control_branchcode =
4203 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4204 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4205 : $issue->branchcode;
4207 my $date_returned = $return_date ? $return_date : dt_from_string();
4209 my ( $amount, $unitcounttotal, $unitcount ) =
4210 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4212 if ( C4::Context->preference('finesMode') eq 'production' ) {
4213 if ( $amount > 0 ) {
4214 C4::Overdues::UpdateFine({
4215 issue_id => $issue->issue_id,
4216 itemnumber => $issue->itemnumber,
4217 borrowernumber => $issue->borrowernumber,
4219 due => output_pref($datedue),
4222 elsif ($return_date) {
4224 # Backdated returns may have fines that shouldn't exist,
4225 # so in this case, we need to drop those fines to 0
4227 C4::Overdues::UpdateFine({
4228 issue_id => $issue->issue_id,
4229 itemnumber => $issue->itemnumber,
4230 borrowernumber => $issue->borrowernumber,
4232 due => output_pref($datedue),
4238 sub _item_denied_renewal {
4241 my $item = $params->{item};
4242 return unless $item;
4244 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4245 return unless $denyingrules;
4246 foreach my $field (keys %$denyingrules) {
4247 my $val = $item->$field;
4248 if( !defined $val) {
4249 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4252 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4253 # If the results matches the values in the syspref
4254 # We return true if match found
4268 Koha Development Team <http://koha-community.org/>