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;
47 use Koha::Illrequests;
50 use Koha::Patron::Debarments;
53 use Koha::Account::Lines;
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 );
74 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
80 # FIXME subs that should probably be elsewhere
85 &GetPendingOnSiteCheckouts
88 # subs to deal with issuing a book
96 &GetLatestAutoRenewDate
98 &GetBranchBorrowerCircRule
102 &CheckIfIssuedToPatron
107 # subs to deal with returns
113 # subs to deal with transfers
120 &IsBranchTransferAllowed
121 &CreateBranchTransferLimit
122 &DeleteBranchTransferLimits
126 # subs to deal with offline circulation
128 &GetOfflineOperations
131 &DeleteOfflineOperation
132 &ProcessOfflineOperation
138 C4::Circulation - Koha circulation module
146 The functions in this module deal with circulation, issues, and
147 returns, as well as general information about the library.
148 Also deals with inventory.
154 $str = &barcodedecode($barcode, [$filter]);
156 Generic filter function for barcode string.
157 Called on every circ if the System Pref itemBarcodeInputFilter is set.
158 Will do some manipulation of the barcode for systems that deliver a barcode
159 to circulation.pl that differs from the barcode stored for the item.
160 For proper functioning of this filter, calling the function on the
161 correct barcode string (items.barcode) should return an unaltered barcode.
163 The optional $filter argument is to allow for testing or explicit
164 behavior that ignores the System Pref. Valid values are the same as the
169 # FIXME -- the &decode fcn below should be wrapped into this one.
170 # FIXME -- these plugins should be moved out of Circulation.pm
173 my ($barcode, $filter) = @_;
174 my $branch = C4::Context::mybranch();
175 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
176 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
177 if ($filter eq 'whitespace') {
179 } elsif ($filter eq 'cuecat') {
181 my @fields = split( /\./, $barcode );
182 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
183 ($#results == 2) and return $results[2];
184 } elsif ($filter eq 'T-prefix') {
185 if ($barcode =~ /^[Tt](\d)/) {
186 (defined($1) and $1 eq '0') and return $barcode;
187 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
189 return sprintf("T%07d", $barcode);
190 # FIXME: $barcode could be "T1", causing warning: substr outside of string
191 # Why drop the nonzero digit after the T?
192 # Why pass non-digits (or empty string) to "T%07d"?
193 } elsif ($filter eq 'libsuite8') {
194 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
195 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
196 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
198 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
201 } elsif ($filter eq 'EAN13') {
202 my $ean = CheckDigits('ean');
203 if ( $ean->is_valid($barcode) ) {
204 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
205 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
207 warn "# [$barcode] not valid EAN-13/UPC-A\n";
210 return $barcode; # return barcode, modified or not
215 $str = &decode($chunk);
217 Decodes a segment of a string emitted by a CueCat barcode scanner and
220 FIXME: Should be replaced with Barcode::Cuecat from CPAN
221 or Javascript based decoding on the client side.
228 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
229 my @s = map { index( $seq, $_ ); } split( //, $encoded );
230 my $l = ( $#s + 1 ) % 4;
233 # warn "Error: Cuecat decode parsing failed!";
241 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
243 chr( ( $n >> 16 ) ^ 67 )
244 .chr( ( $n >> 8 & 255 ) ^ 67 )
245 .chr( ( $n & 255 ) ^ 67 );
248 $r = substr( $r, 0, length($r) - $l );
254 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
255 $barcode, $ignore_reserves, $trigger);
257 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
259 C<$newbranch> is the code for the branch to which the item should be transferred.
261 C<$barcode> is the barcode of the item to be transferred.
263 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
264 Otherwise, if an item is reserved, the transfer fails.
266 C<$trigger> is the enum value for what triggered the transfer.
268 Returns three values:
274 is true if the transfer was successful.
278 is a reference-to-hash which may have any of the following keys:
284 There is no item in the catalog with the given barcode. The value is C<$barcode>.
286 =item C<DestinationEqualsHolding>
288 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.
292 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.
296 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>.
298 =item C<WasTransferred>
300 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
309 my ( $tbr, $barcode, $ignoreRs, $trigger ) = @_;
312 my $item = Koha::Items->find( { barcode => $barcode } );
316 $messages->{'BadBarcode'} = $barcode;
318 return ( $dotransfer, $messages );
321 my $itemnumber = $item->itemnumber;
322 # get branches of book...
323 my $hbr = $item->homebranch;
324 my $fbr = $item->holdingbranch;
326 # if using Branch Transfer Limits
327 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
328 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
329 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
330 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
331 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
334 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
335 $messages->{'NotAllowed'} = $tbr . "::" . $code;
340 # can't transfer book if is already there....
341 if ( $fbr eq $tbr ) {
342 $messages->{'DestinationEqualsHolding'} = 1;
346 # check if it is still issued to someone, return it...
347 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
349 AddReturn( $barcode, $fbr );
350 $messages->{'WasReturned'} = $issue->borrowernumber;
354 # That'll save a database query.
355 my ( $resfound, $resrec, undef ) =
356 CheckReserves( $itemnumber );
357 if ( $resfound and not $ignoreRs ) {
358 $resrec->{'ResFound'} = $resfound;
359 $messages->{'ResFound'} = $resrec;
363 #actually do the transfer....
365 ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
367 # don't need to update MARC anymore, we do it in batch now
368 $messages->{'WasTransfered'} = 1;
371 ModDateLastSeen( $itemnumber );
372 return ( $dotransfer, $messages );
377 my $borrower = shift;
378 my $item_object = shift;
380 my $onsite_checkout = $params->{onsite_checkout} || 0;
381 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
382 my $cat_borrower = $borrower->{'categorycode'};
383 my $dbh = C4::Context->dbh;
385 # Get which branchcode we need
386 $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
387 my $type = $item_object->effective_itemtype;
389 my ($type_object, $parent_type, $parent_maxissueqty_rule);
390 $type_object = Koha::ItemTypes->find( $type );
391 $parent_type = $type_object->parent_type if $type_object;
392 my $child_types = Koha::ItemTypes->search({ parent_type => $type });
393 # Find any children if we are a parent_type;
395 # given branch, patron category, and item type, determine
396 # applicable issuing rule
398 $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
400 categorycode => $cat_borrower,
401 itemtype => $parent_type,
402 branchcode => $branch,
403 rule_name => 'maxissueqty',
406 # If the parent rule is for default type we discount it
407 $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
409 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
411 categorycode => $cat_borrower,
413 branchcode => $branch,
414 rule_name => 'maxissueqty',
419 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
421 categorycode => $cat_borrower,
423 branchcode => $branch,
424 rule_name => 'maxonsiteissueqty',
429 # if a rule is found and has a loan limit set, count
430 # how many loans the patron already has that meet that
432 if (defined($maxissueqty_rule) and defined($maxissueqty_rule->rule_value)) {
435 my $count_query = "";
437 if (C4::Context->preference('item-level_itypes')) {
438 $count_query .= q|SELECT COALESCE( SUM( IF(items.itype = '| .$type . q|',1,0) ), 0) as type_total, COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts|;
440 $count_query .= q|SELECT COALESCE(SUM( IF(biblioitems.itemtype = '| .$type . q|',1,0) ), 0) as type_total, COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts|;
445 JOIN items USING (itemnumber)
448 my $rule_itemtype = $maxissueqty_rule->itemtype;
449 unless ($rule_itemtype) {
450 # matching rule has the default item type, so count only
451 # those existing loans that don't fall under a more
453 my $issuing_itemtypes_query = q{
454 SELECT itemtype FROM circulation_rules
456 AND (categorycode = ? OR categorycode = ?)
457 AND itemtype IS NOT NULL
458 AND rule_name = 'maxissueqty'
460 if (C4::Context->preference('item-level_itypes')) {
461 $count_query .= " WHERE items.itype NOT IN ( $issuing_itemtypes_query )";
463 $count_query .= " JOIN biblioitems USING (biblionumber)
464 WHERE biblioitems.itemtype NOT IN ( $issuing_itemtypes_query )";
466 push @bind_params, $maxissueqty_rule->branchcode;
467 push @bind_params, $maxissueqty_rule->categorycode;
468 push @bind_params, $cat_borrower;
471 if ( $parent_maxissueqty_rule ) {
472 # if we have a parent item type then we count loans of the
473 # specific item type or its siblings or parent
474 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
475 @types = $children->get_column('itemtype');
476 push @types, $parent_type;
477 } elsif ( $child_types ) {
478 # If we are a parent type, we need to count all child types and our own type
479 @types = $child_types->get_column('itemtype');
480 push @types, $type; # And don't forget to count our own types
481 } else { push @types, $type; } # Otherwise only count the specific itemtype
482 my $types_param = ( '?,' ) x @types;
483 $types_param =~ s/,$//;
484 if (C4::Context->preference('item-level_itypes')) {
485 $count_query .= " WHERE items.itype IN (" . $types_param . ")";
487 $count_query .= " JOIN biblioitems USING (biblionumber)
488 WHERE biblioitems.itemtype IN (" . $types_param . ")";
490 push @bind_params, @types;
493 $count_query .= " AND borrowernumber = ? ";
494 push @bind_params, $borrower->{'borrowernumber'};
495 my $rule_branch = $maxissueqty_rule->branchcode;
497 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
498 $count_query .= " AND issues.branchcode = ? ";
499 push @bind_params, $rule_branch;
500 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
501 ; # if branch is the patron's home branch, then count all loans by patron
503 $count_query .= " AND items.homebranch = ? ";
504 push @bind_params, $rule_branch;
508 my ( $checkout_count_type, $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
510 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
512 # If parent rules exists
513 if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
514 my $max_checkouts_allowed = $parent_maxissueqty_rule->rule_value;
516 my $qty_over = _check_max_qty({
517 checkout_count => $checkout_count,
518 onsite_checkout_count => $onsite_checkout_count,
519 onsite_checkout => $onsite_checkout,
520 max_checkouts_allowed => $max_checkouts_allowed,
521 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
522 switch_onsite_checkout => $switch_onsite_checkout
524 return $qty_over if defined $qty_over;
527 # If the parent rule is less than or equal to the child, we only need check the parent
528 if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
529 my $max_checkouts_allowed = $maxissueqty_rule->rule_value;
530 my $qty_over = _check_max_qty({
531 checkout_count => $checkout_count_type,
532 onsite_checkout_count => $onsite_checkout_count,
533 onsite_checkout => $onsite_checkout,
534 max_checkouts_allowed => $max_checkouts_allowed,
535 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
536 switch_onsite_checkout => $switch_onsite_checkout
538 return $qty_over if defined $qty_over;
542 my $max_checkouts_allowed = $maxissueqty_rule->rule_value;
543 my $qty_over = _check_max_qty({
544 checkout_count => $checkout_count,
545 onsite_checkout_count => $onsite_checkout_count,
546 onsite_checkout => $onsite_checkout,
547 max_checkouts_allowed => $max_checkouts_allowed,
548 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
549 switch_onsite_checkout => $switch_onsite_checkout
551 return $qty_over if defined $qty_over;
557 # Now count total loans against the limit for the branch
558 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
559 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
560 my @bind_params = ();
561 my $branch_count_query = q|
562 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
564 JOIN items USING (itemnumber)
565 WHERE borrowernumber = ?
567 push @bind_params, $borrower->{borrowernumber};
569 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
570 $branch_count_query .= " AND issues.branchcode = ? ";
571 push @bind_params, $branch;
572 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
573 ; # if branch is the patron's home branch, then count all loans by patron
575 $branch_count_query .= " AND items.homebranch = ? ";
576 push @bind_params, $branch;
578 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
579 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
580 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
582 my $qty_over = _check_max_qty({
583 checkout_count => $checkout_count,
584 onsite_checkout_count => $onsite_checkout_count,
585 onsite_checkout => $onsite_checkout,
586 max_checkouts_allowed => $max_checkouts_allowed,
587 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
588 switch_onsite_checkout => $switch_onsite_checkout
590 return $qty_over if defined $qty_over;
594 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
595 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
598 # OK, the patron can issue !!!
604 my $checkout_count = $params->{checkout_count};
605 my $onsite_checkout_count = $params->{onsite_checkout_count};
606 my $onsite_checkout = $params->{onsite_checkout};
607 my $max_checkouts_allowed = $params->{max_checkouts_allowed};
608 my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
609 my $switch_onsite_checkout = $params->{switch_onsite_checkout};
611 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
612 if( $max_onsite_checkouts_allowed eq '' ){ return;}
613 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
615 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
616 count => $onsite_checkout_count,
617 max_allowed => $max_onsite_checkouts_allowed,
621 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
622 if( $max_checkouts_allowed eq '' ){ return;}
623 my $delta = $switch_onsite_checkout ? 1 : 0;
624 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
626 reason => 'TOO_MANY_CHECKOUTS',
627 count => $checkout_count,
628 max_allowed => $max_checkouts_allowed,
631 } elsif ( not $onsite_checkout ) {
632 if( $max_checkouts_allowed eq '' ){ return;}
633 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
635 reason => 'TOO_MANY_CHECKOUTS',
636 count => $checkout_count - $onsite_checkout_count,
637 max_allowed => $max_checkouts_allowed,
645 =head2 CanBookBeIssued
647 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
648 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
650 Check if a book can be issued.
652 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
654 IMPORTANT: The assumption by users of this routine is that causes blocking
655 the issue are keyed by uppercase labels and other returned
656 data is keyed in lower case!
660 =item C<$patron> is a Koha::Patron
662 =item C<$barcode> is the bar code of the book being issued.
664 =item C<$duedates> is a DateTime object.
666 =item C<$inprocess> boolean switch
668 =item C<$ignore_reserves> boolean switch
670 =item C<$params> Hashref of additional parameters
673 override_high_holds - Ignore high holds
674 onsite_checkout - Checkout is an onsite checkout that will not leave the library
682 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
683 Possible values are :
689 sticky due date is invalid
693 borrower gone with no address
697 borrower declared it's card lost
703 =head3 UNKNOWN_BARCODE
717 item is restricted (set by ??)
719 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
720 could be prevented, but ones that can be overriden by the operator.
722 Possible values are :
730 renewing, not issuing
732 =head3 ISSUED_TO_ANOTHER
734 issued to someone else.
738 reserved for someone else.
742 sticky due date is invalid or due date in the past
746 if the borrower borrows to much things
750 sub CanBookBeIssued {
751 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
752 my %needsconfirmation; # filled with problems that needs confirmations
753 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
754 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
755 my %messages; # filled with information messages that should be displayed.
757 my $onsite_checkout = $params->{onsite_checkout} || 0;
758 my $override_high_holds = $params->{override_high_holds} || 0;
760 my $item_object = Koha::Items->find({barcode => $barcode });
762 # MANDATORY CHECKS - unless item exists, nothing else matters
763 unless ( $item_object ) {
764 $issuingimpossible{UNKNOWN_BARCODE} = 1;
766 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
768 my $item_unblessed = $item_object->unblessed; # Transition...
769 my $issue = $item_object->checkout;
770 my $biblio = $item_object->biblio;
772 my $biblioitem = $biblio->biblioitem;
773 my $effective_itemtype = $item_object->effective_itemtype;
774 my $dbh = C4::Context->dbh;
775 my $patron_unblessed = $patron->unblessed;
777 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
779 # DUE DATE is OK ? -- should already have checked.
781 if ($duedate && ref $duedate ne 'DateTime') {
782 $duedate = dt_from_string($duedate);
784 my $now = dt_from_string();
785 unless ( $duedate ) {
786 my $issuedate = $now->clone();
788 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
790 # Offline circ calls AddIssue directly, doesn't run through here
791 # So issuingimpossible should be ok.
794 my $fees = Koha::Charges::Fees->new(
797 library => $circ_library,
798 item => $item_object,
804 my $today = $now->clone();
805 $today->truncate( to => 'minute');
806 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
807 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
810 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
816 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
817 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
819 branch => C4::Context->userenv->{'branch'},
821 itemnumber => $item_object->itemnumber,
822 itemtype => $effective_itemtype,
823 borrowernumber => $patron->borrowernumber,
824 ccode => $item_object->ccode}
826 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
827 return( { STATS => 1 }, {});
830 if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
831 $issuingimpossible{GNA} = 1;
834 if ( $patron->lost && $patron->lost == 1 ) {
835 $issuingimpossible{CARD_LOST} = 1;
837 if ( $patron->is_debarred ) {
838 $issuingimpossible{DEBARRED} = 1;
841 if ( $patron->is_expired ) {
842 $issuingimpossible{EXPIRED} = 1;
850 my $account = $patron->account;
851 my $balance = $account->balance;
852 my $non_issues_charges = $account->non_issues_charges;
853 my $other_charges = $balance - $non_issues_charges;
855 my $amountlimit = C4::Context->preference("noissuescharge");
856 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
857 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
859 # Check the debt of this patrons guarantees
860 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
861 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
862 if ( defined $no_issues_charge_guarantees ) {
863 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
864 my $guarantees_non_issues_charges;
865 foreach my $g ( @guarantees ) {
866 $guarantees_non_issues_charges += $g->account->non_issues_charges;
869 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
870 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
871 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
872 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
873 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
874 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
878 if ( C4::Context->preference("IssuingInProcess") ) {
879 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
880 $issuingimpossible{DEBT} = $non_issues_charges;
881 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
882 $needsconfirmation{DEBT} = $non_issues_charges;
883 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
884 $needsconfirmation{DEBT} = $non_issues_charges;
888 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
889 $needsconfirmation{DEBT} = $non_issues_charges;
890 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
891 $issuingimpossible{DEBT} = $non_issues_charges;
892 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
893 $needsconfirmation{DEBT} = $non_issues_charges;
897 if ($balance > 0 && $other_charges > 0) {
898 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
901 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
902 $patron_unblessed = $patron->unblessed;
904 if ( my $debarred_date = $patron->is_debarred ) {
905 # patron has accrued fine days or has a restriction. $count is a date
906 if ($debarred_date eq '9999-12-31') {
907 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
910 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
912 } elsif ( my $num_overdues = $patron->has_overdues ) {
913 ## patron has outstanding overdue loans
914 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
915 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
917 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
918 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
923 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
925 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
927 # Already issued to current borrower.
928 # If it is an on-site checkout if it can be switched to a normal checkout
929 # or ask whether the loan should be renewed
931 if ( $issue->onsite_checkout
932 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
933 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
935 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
936 $patron->borrowernumber,
937 $item_object->itemnumber,
939 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
940 if ( $renewerror eq 'onsite_checkout' ) {
941 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
944 $issuingimpossible{NO_MORE_RENEWALS} = 1;
948 $needsconfirmation{RENEW_ISSUE} = 1;
954 # issued to someone else
956 my $patron = Koha::Patrons->find( $issue->borrowernumber );
958 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
960 unless ( $can_be_returned ) {
961 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
962 $issuingimpossible{branch_to_return} = $message;
964 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
965 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
967 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
968 $needsconfirmation{issued_firstname} = $patron->firstname;
969 $needsconfirmation{issued_surname} = $patron->surname;
970 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
971 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
976 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
978 my $switch_onsite_checkout = (
979 C4::Context->preference('SwitchOnSiteCheckouts')
981 and $issue->onsite_checkout
982 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
983 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
984 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
985 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
986 if ( $toomany->{max_allowed} == 0 ) {
987 $needsconfirmation{PATRON_CANT} = 1;
989 if ( C4::Context->preference("AllowTooManyOverride") ) {
990 $needsconfirmation{TOO_MANY} = $toomany->{reason};
991 $needsconfirmation{current_loan_count} = $toomany->{count};
992 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
994 $issuingimpossible{TOO_MANY} = $toomany->{reason};
995 $issuingimpossible{current_loan_count} = $toomany->{count};
996 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1001 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1003 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1004 my $wants_check = $patron->wants_check_for_previous_checkout;
1005 $needsconfirmation{PREVISSUE} = 1
1006 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
1011 if ( $item_object->notforloan )
1013 if(!C4::Context->preference("AllowNotForLoanOverride")){
1014 $issuingimpossible{NOT_FOR_LOAN} = 1;
1015 $issuingimpossible{item_notforloan} = $item_object->notforloan;
1017 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1018 $needsconfirmation{item_notforloan} = $item_object->notforloan;
1022 # we have to check itemtypes.notforloan also
1023 if (C4::Context->preference('item-level_itypes')){
1024 # this should probably be a subroutine
1025 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1026 $sth->execute($effective_itemtype);
1027 my $notforloan=$sth->fetchrow_hashref();
1028 if ($notforloan->{'notforloan'}) {
1029 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1030 $issuingimpossible{NOT_FOR_LOAN} = 1;
1031 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1033 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1034 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1039 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1040 if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1041 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1042 $issuingimpossible{NOT_FOR_LOAN} = 1;
1043 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1045 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1046 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1051 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1053 $issuingimpossible{WTHDRAWN} = 1;
1055 if ( $item_object->restricted
1056 && $item_object->restricted == 1 )
1058 $issuingimpossible{RESTRICTED} = 1;
1060 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1061 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1062 my $code = $av->count ? $av->next->lib : '';
1063 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1064 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1066 if ( C4::Context->preference("IndependentBranches") ) {
1067 my $userenv = C4::Context->userenv;
1068 unless ( C4::Context->IsSuperLibrarian() ) {
1069 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1070 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1071 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1072 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1074 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1075 if ( $patron->branchcode ne $userenv->{branch} );
1080 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1082 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1083 if ($rentalConfirmation) {
1084 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1086 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1087 if ($itemtype_object) {
1088 my $accumulate_charge = $fees->accumulate_rentalcharge();
1089 if ( $accumulate_charge > 0 ) {
1090 $rentalCharge += $accumulate_charge;
1094 if ( $rentalCharge > 0 ) {
1095 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1099 unless ( $ignore_reserves ) {
1100 # See if the item is on reserve.
1101 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1103 my $resbor = $res->{'borrowernumber'};
1104 if ( $resbor ne $patron->borrowernumber ) {
1105 my $patron = Koha::Patrons->find( $resbor );
1106 if ( $restype eq "Waiting" )
1108 # The item is on reserve and waiting, but has been
1109 # reserved by some other patron.
1110 $needsconfirmation{RESERVE_WAITING} = 1;
1111 $needsconfirmation{'resfirstname'} = $patron->firstname;
1112 $needsconfirmation{'ressurname'} = $patron->surname;
1113 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1114 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1115 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1116 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1117 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1119 elsif ( $restype eq "Reserved" ) {
1120 # The item is on reserve for someone else.
1121 $needsconfirmation{RESERVED} = 1;
1122 $needsconfirmation{'resfirstname'} = $patron->firstname;
1123 $needsconfirmation{'ressurname'} = $patron->surname;
1124 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1125 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1126 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1127 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1128 $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1134 ## CHECK AGE RESTRICTION
1135 my $agerestriction = $biblioitem->agerestriction;
1136 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1137 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1138 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1139 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1142 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1146 ## check for high holds decreasing loan period
1147 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1148 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1150 if ( $check->{exceeded} ) {
1151 if ($override_high_holds) {
1152 $alerts{HIGHHOLDS} = {
1153 num_holds => $check->{outstanding},
1154 duration => $check->{duration},
1155 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1159 $needsconfirmation{HIGHHOLDS} = {
1160 num_holds => $check->{outstanding},
1161 duration => $check->{duration},
1162 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1169 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1170 # don't do the multiple loans per bib check if we've
1171 # already determined that we've got a loan on the same item
1172 !$issuingimpossible{NO_MORE_RENEWALS} &&
1173 !$needsconfirmation{RENEW_ISSUE}
1175 # Check if borrower has already issued an item from the same biblio
1176 # Only if it's not a subscription
1177 my $biblionumber = $item_object->biblionumber;
1178 require C4::Serials;
1179 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1180 unless ($is_a_subscription) {
1181 # FIXME Should be $patron->checkouts($args);
1182 my $checkouts = Koha::Checkouts->search(
1184 borrowernumber => $patron->borrowernumber,
1185 biblionumber => $biblionumber,
1191 # if we get here, we don't already have a loan on this item,
1192 # so if there are any loans on this bib, ask for confirmation
1193 if ( $checkouts->count ) {
1194 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1199 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1202 =head2 CanBookBeReturned
1204 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1206 Check whether the item can be returned to the provided branch
1210 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1212 =item C<$branch> is the branchcode where the return is taking place
1220 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1222 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1228 sub CanBookBeReturned {
1229 my ($item, $branch) = @_;
1230 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1232 # assume return is allowed to start
1236 # identify all cases where return is forbidden
1237 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1239 $message = $item->{'homebranch'};
1240 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1242 $message = $item->{'holdingbranch'};
1243 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1245 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1248 return ($allowed, $message);
1251 =head2 CheckHighHolds
1253 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1254 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1255 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1259 sub checkHighHolds {
1260 my ( $item, $borrower ) = @_;
1261 my $branchcode = _GetCircControlBranch( $item, $borrower );
1262 my $item_object = Koha::Items->find( $item->{itemnumber} );
1271 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1273 if ( $holds->count() ) {
1274 $return_data->{outstanding} = $holds->count();
1276 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1277 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1278 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1280 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1282 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1284 # static means just more than a given number of holds on the record
1286 # If the number of holds is less than the threshold, we can stop here
1287 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1288 return $return_data;
1291 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1293 # dynamic means X more than the number of holdable items on the record
1295 # let's get the items
1296 my @items = $holds->next()->biblio()->items()->as_list;
1298 # Remove any items with status defined to be ignored even if the would not make item unholdable
1299 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1300 @items = grep { !$_->$status } @items;
1303 # Remove any items that are not holdable for this patron
1304 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1306 my $items_count = scalar @items;
1308 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1310 # If the number of holds is less than the count of items we have
1311 # plus the number of holds allowed above that count, we can stop here
1312 if ( $holds->count() <= $threshold ) {
1313 return $return_data;
1317 my $issuedate = dt_from_string();
1319 my $itype = $item_object->effective_itemtype;
1320 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1322 categorycode => $borrower->{categorycode},
1324 branchcode => $branchcode,
1327 my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1329 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1331 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1333 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1334 $reduced_datedue->set_hour($orig_due->hour);
1335 $reduced_datedue->set_minute($orig_due->minute);
1336 $reduced_datedue->truncate( to => 'minute' );
1338 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1339 $return_data->{exceeded} = 1;
1340 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1341 $return_data->{due_date} = $reduced_datedue;
1345 return $return_data;
1350 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1352 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1356 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1358 =item C<$barcode> is the barcode of the item being issued.
1360 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1361 Calculated if empty.
1363 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1365 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1366 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1368 AddIssue does the following things :
1370 - step 01: check that there is a borrowernumber & a barcode provided
1371 - check for RENEWAL (book issued & being issued to the same patron)
1372 - renewal YES = Calculate Charge & renew
1374 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1376 - fill reserve if reserve to this patron
1377 - cancel reserve or not, otherwise
1378 * TRANSFERT PENDING ?
1379 - complete the transfert
1387 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1389 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1390 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1391 my $auto_renew = $params && $params->{auto_renew};
1392 my $dbh = C4::Context->dbh;
1393 my $barcodecheck = CheckValidBarcode($barcode);
1397 if ( $datedue && ref $datedue ne 'DateTime' ) {
1398 $datedue = dt_from_string($datedue);
1401 # $issuedate defaults to today.
1402 if ( !defined $issuedate ) {
1403 $issuedate = dt_from_string();
1406 if ( ref $issuedate ne 'DateTime' ) {
1407 $issuedate = dt_from_string($issuedate);
1412 # Stop here if the patron or barcode doesn't exist
1413 if ( $borrower && $barcode && $barcodecheck ) {
1414 # find which item we issue
1415 my $item_object = Koha::Items->find({ barcode => $barcode })
1416 or return; # if we don't get an Item, abort.
1417 my $item_unblessed = $item_object->unblessed;
1419 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1421 # get actual issuing if there is one
1422 my $actualissue = $item_object->checkout;
1424 # check if we just renew the issue.
1425 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1426 and not $switch_onsite_checkout ) {
1427 $datedue = AddRenewal(
1428 $borrower->{'borrowernumber'},
1429 $item_object->itemnumber,
1432 $issuedate, # here interpreted as the renewal date
1437 my $itype = $item_object->effective_itemtype;
1438 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1441 $datedue->truncate( to => 'minute' );
1443 my $patron = Koha::Patrons->find( $borrower );
1444 my $library = Koha::Libraries->find( $branchcode );
1445 my $fees = Koha::Charges::Fees->new(
1448 library => $library,
1449 item => $item_object,
1450 to_date => $datedue,
1454 # it's NOT a renewal
1455 if ( $actualissue and not $switch_onsite_checkout ) {
1456 # This book is currently on loan, but not to the person
1457 # who wants to borrow it now. mark it returned before issuing to the new borrower
1458 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1459 return unless $allowed;
1460 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1463 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1465 # Starting process for transfer job (checking transfert and validate it if we have one)
1466 my ($datesent) = GetTransfers( $item_object->itemnumber );
1468 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1469 my $sth = $dbh->prepare(
1470 "UPDATE branchtransfers
1471 SET datearrived = now(),
1473 comments = 'Forced branchtransfer'
1474 WHERE itemnumber= ? AND datearrived IS NULL"
1476 $sth->execute( C4::Context->userenv->{'branch'},
1477 $item_object->itemnumber );
1480 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1481 unless ($auto_renew) {
1482 my $rule = Koha::CirculationRules->get_effective_rule(
1484 categorycode => $borrower->{categorycode},
1485 itemtype => $item_object->effective_itemtype,
1486 branchcode => $branchcode,
1487 rule_name => 'auto_renew'
1491 $auto_renew = $rule->rule_value if $rule;
1494 # Record in the database the fact that the book was issued.
1496 my $itype = $item_object->effective_itemtype;
1497 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1500 $datedue->truncate( to => 'minute' );
1502 my $issue_attributes = {
1503 borrowernumber => $borrower->{'borrowernumber'},
1504 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1505 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1506 branchcode => C4::Context->userenv->{'branch'},
1507 onsite_checkout => $onsite_checkout,
1508 auto_renew => $auto_renew ? 1 : 0,
1511 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1513 $issue->set($issue_attributes)->store;
1516 $issue = Koha::Checkout->new(
1518 itemnumber => $item_object->itemnumber,
1523 if ( $item_object->location && $item_object->location eq 'CART'
1524 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1525 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1526 CartToShelf( $item_object->itemnumber );
1529 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1530 UpdateTotalIssues( $item_object->biblionumber, 1 );
1533 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1534 if ( $item_object->itemlost ) {
1536 my $no_refund_after_days = C4::Context->preference('NoRefundOnLostReturnedItemsAge');
1537 if ($no_refund_after_days) {
1538 my $today = dt_from_string();
1539 my $lost_age_in_days =
1540 dt_from_string( $item_object->itemlost_on )
1541 ->delta_days($today)
1544 $refund = 0 unless ( $lost_age_in_days < $no_refund_after_days );
1548 $refund && Koha::CirculationRules->get_lostreturn_policy(
1550 return_branch => C4::Context->userenv->{branch},
1551 item => $item_object
1556 _FixAccountForLostAndFound( $item_object->itemnumber, undef,
1557 $item_object->barcode );
1561 $item_object->issues( ( $item_object->issues || 0 ) + 1);
1562 $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1563 $item_object->itemlost(0);
1564 $item_object->onloan($datedue->ymd());
1565 $item_object->datelastborrowed( dt_from_string()->ymd() );
1566 $item_object->store({log_action => 0});
1567 ModDateLastSeen( $item_object->itemnumber );
1569 # If it costs to borrow this book, charge it to the patron's account.
1570 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1571 if ( $charge && $charge > 0 ) {
1572 AddIssuingCharge( $issue, $charge, 'RENT' );
1575 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1576 if ( $itemtype_object ) {
1577 my $accumulate_charge = $fees->accumulate_rentalcharge();
1578 if ( $accumulate_charge > 0 ) {
1579 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1580 $charge += $accumulate_charge;
1581 $item_unblessed->{charge} = $charge;
1585 # Record the fact that this book was issued.
1588 branch => C4::Context->userenv->{'branch'},
1589 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1591 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1592 itemnumber => $item_object->itemnumber,
1593 itemtype => $item_object->effective_itemtype,
1594 location => $item_object->location,
1595 borrowernumber => $borrower->{'borrowernumber'},
1596 ccode => $item_object->ccode,
1600 # Send a checkout slip.
1601 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1603 branchcode => $branchcode,
1604 categorycode => $borrower->{categorycode},
1605 item_type => $item_object->effective_itemtype,
1606 notification => 'CHECKOUT',
1608 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1609 SendCirculationAlert(
1612 item => $item_object->unblessed,
1613 borrower => $borrower,
1614 branch => $branchcode,
1619 "CIRCULATION", "ISSUE",
1620 $borrower->{'borrowernumber'},
1621 $item_object->itemnumber,
1622 ) if C4::Context->preference("IssueLog");
1624 Koha::Plugins->call('after_circ_action', {
1625 action => 'checkout',
1627 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1628 checkout => $issue->get_from_storage
1636 =head2 GetLoanLength
1638 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1640 Get loan length for an itemtype, a borrower type and a branch
1645 my ( $categorycode, $itemtype, $branchcode ) = @_;
1647 # Set search precedences
1650 categorycode => $categorycode,
1651 itemtype => $itemtype,
1652 branchcode => $branchcode,
1655 categorycode => $categorycode,
1657 branchcode => $branchcode,
1660 categorycode => undef,
1661 itemtype => $itemtype,
1662 branchcode => $branchcode,
1665 categorycode => undef,
1667 branchcode => $branchcode,
1670 categorycode => $categorycode,
1671 itemtype => $itemtype,
1672 branchcode => undef,
1675 categorycode => $categorycode,
1677 branchcode => undef,
1680 categorycode => undef,
1681 itemtype => $itemtype,
1682 branchcode => undef,
1685 categorycode => undef,
1687 branchcode => undef,
1691 # Initialize default values
1695 lengthunit => 'days',
1699 foreach my $rule_name (qw( issuelength renewalperiod lengthunit )) {
1700 foreach my $params (@params) {
1701 my $rule = Koha::CirculationRules->search(
1703 rule_name => $rule_name,
1709 $rules->{$rule_name} = $rule->rule_value;
1719 =head2 GetHardDueDate
1721 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1723 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1727 sub GetHardDueDate {
1728 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1730 my $rules = Koha::CirculationRules->get_effective_rules(
1732 categorycode => $borrowertype,
1733 itemtype => $itemtype,
1734 branchcode => $branchcode,
1735 rules => [ 'hardduedate', 'hardduedatecompare' ],
1739 if ( defined( $rules->{hardduedate} ) ) {
1740 if ( $rules->{hardduedate} ) {
1741 return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1744 return ( undef, undef );
1749 =head2 GetBranchBorrowerCircRule
1751 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1753 Retrieves circulation rule attributes that apply to the given
1754 branch and patron category, regardless of item type.
1755 The return value is a hashref containing the following key:
1757 patron_maxissueqty - maximum number of loans that a
1758 patron of the given category can have at the given
1759 branch. If the value is undef, no limit.
1761 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1762 patron of the given category can have at the given
1763 branch. If the value is undef, no limit.
1765 This will check for different branch/category combinations in the following order:
1769 default branch and category
1771 If no rule has been found in the database, it will default to
1774 patron_maxissueqty - undef
1775 patron_maxonsiteissueqty - undef
1777 C<$branchcode> and C<$categorycode> should contain the
1778 literal branch code and patron category code, respectively - no
1783 sub GetBranchBorrowerCircRule {
1784 my ( $branchcode, $categorycode ) = @_;
1786 # Initialize default values
1788 patron_maxissueqty => undef,
1789 patron_maxonsiteissueqty => undef,
1793 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1794 my $rule = Koha::CirculationRules->get_effective_rule(
1796 categorycode => $categorycode,
1798 branchcode => $branchcode,
1799 rule_name => $rule_name,
1803 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1809 =head2 GetBranchItemRule
1811 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1813 Retrieves circulation rule attributes that apply to the given
1814 branch and item type, regardless of patron category.
1816 The return value is a hashref containing the following keys:
1818 holdallowed => Hold policy for this branch and itemtype. Possible values:
1819 0: No holds allowed.
1820 1: Holds allowed only by patrons that have the same homebranch as the item.
1821 2: Holds allowed from any patron.
1823 returnbranch => branch to which to return item. Possible values:
1824 noreturn: do not return, let item remain where checked in (floating collections)
1825 homebranch: return to item's home branch
1826 holdingbranch: return to issuer branch
1828 This searches branchitemrules in the following order:
1830 * Same branchcode and itemtype
1831 * Same branchcode, itemtype '*'
1832 * branchcode '*', same itemtype
1833 * branchcode and itemtype '*'
1835 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1839 sub GetBranchItemRule {
1840 my ( $branchcode, $itemtype ) = @_;
1843 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1845 branchcode => $branchcode,
1846 itemtype => $itemtype,
1847 rule_name => 'holdallowed',
1850 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1852 branchcode => $branchcode,
1853 itemtype => $itemtype,
1854 rule_name => 'hold_fulfillment_policy',
1857 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1859 branchcode => $branchcode,
1860 itemtype => $itemtype,
1861 rule_name => 'returnbranch',
1865 # built-in default circulation rule
1867 $rules->{holdallowed} = defined $holdallowed_rule
1868 ? $holdallowed_rule->rule_value
1870 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1871 ? $hold_fulfillment_policy_rule->rule_value
1873 $rules->{returnbranch} = defined $returnbranch_rule
1874 ? $returnbranch_rule->rule_value
1882 ($doreturn, $messages, $iteminformation, $borrower) =
1883 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1889 =item C<$barcode> is the bar code of the book being returned.
1891 =item C<$branch> is the code of the branch where the book is being returned.
1893 =item C<$exemptfine> indicates that overdue charges for the item will be
1896 =item C<$return_date> allows the default return date to be overridden
1897 by the given return date. Optional.
1901 C<&AddReturn> returns a list of four items:
1903 C<$doreturn> is true iff the return succeeded.
1905 C<$messages> is a reference-to-hash giving feedback on the operation.
1906 The keys of the hash are:
1912 No item with this barcode exists. The value is C<$barcode>.
1916 The book is not currently on loan. The value is C<$barcode>.
1920 This book has been withdrawn/cancelled. The value should be ignored.
1922 =item C<Wrongbranch>
1924 This book has was returned to the wrong branch. The value is a hashref
1925 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1926 contain the branchcode of the incorrect and correct return library, respectively.
1930 The item was reserved. The value is a reference-to-hash whose keys are
1931 fields from the reserves table of the Koha database, and
1932 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1933 either C<Waiting>, C<Reserved>, or 0.
1935 =item C<WasReturned>
1937 Value 1 if return is successful.
1939 =item C<NeedsTransfer>
1941 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1945 C<$iteminformation> is a reference-to-hash, giving information about the
1946 returned item from the issues table.
1948 C<$borrower> is a reference-to-hash, giving information about the
1949 patron who last borrowed the book.
1954 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1956 if ($branch and not Koha::Libraries->find($branch)) {
1957 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1960 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1961 my $return_date_specified = !!$return_date;
1962 $return_date //= dt_from_string();
1966 my $validTransfert = 0;
1967 my $stat_type = 'return';
1969 # get information on item
1970 my $item = Koha::Items->find({ barcode => $barcode });
1972 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1975 my $itemnumber = $item->itemnumber;
1976 my $itemtype = $item->effective_itemtype;
1978 my $issue = $item->checkout;
1980 $patron = $issue->patron
1981 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1982 . Dumper($issue->unblessed) . "\n";
1984 $messages->{'NotIssued'} = $barcode;
1985 $item->onloan(undef)->store if defined $item->onloan;
1987 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1989 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1990 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1991 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1992 $messages->{'LocalUse'} = 1;
1993 $stat_type = 'localuse';
1997 # full item data, but no borrowernumber or checkout info (no issue)
1998 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1999 # get the proper branch to which to return the item
2000 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2001 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2002 my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2004 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
2005 my $patron_unblessed = $patron ? $patron->unblessed : {};
2007 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
2008 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2009 if ($update_loc_rules) {
2010 if (defined $update_loc_rules->{_ALL_}) {
2011 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2012 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2013 if ( $item->location ne $update_loc_rules->{_ALL_}) {
2014 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2015 $item->location($update_loc_rules->{_ALL_})->store;
2019 foreach my $key ( keys %$update_loc_rules ) {
2020 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2021 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2022 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2023 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2024 $item->location($update_loc_rules->{$key})->store;
2031 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2033 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
2035 eval { $rules = YAML::Load($yaml); };
2037 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2040 foreach my $key ( keys %$rules ) {
2041 if ( $item->notforloan eq $key ) {
2042 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2043 $item->notforloan($rules->{$key})->store({ log_action => 0 });
2050 # check if the return is allowed at this branch
2051 my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2052 unless ($returnallowed){
2053 $messages->{'Wrongbranch'} = {
2054 Wrongbranch => $branch,
2055 Rightbranch => $message
2058 return ( $doreturn, $messages, $issue, $patron_unblessed);
2061 if ( $item->withdrawn ) { # book has been cancelled
2062 $messages->{'withdrawn'} = 1;
2063 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2066 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2070 # case of a return of document (deal with issues and holdingbranch)
2072 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2073 $patron or warn "AddReturn without current borrower";
2077 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
2082 C4::Context->preference('CalculateFinesOnReturn')
2083 || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2088 _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2091 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 );
2093 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2096 # FIXME is the "= 1" right? This could be the borrower hash.
2097 $messages->{'WasReturned'} = 1;
2101 $item->onloan(undef)->store({ log_action => 0 });
2104 # the holdingbranch is updated if the document is returned to another location.
2105 # this is always done regardless of whether the item was on loan or not
2106 my $item_holding_branch = $item->holdingbranch;
2107 if ($item->holdingbranch ne $branch) {
2108 $item->holdingbranch($branch)->store;
2111 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2112 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
2114 # check if we have a transfer for this document
2115 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2117 # if we have a transfer to do, we update the line of transfers with the datearrived
2118 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2120 if ( $tobranch eq $branch ) {
2121 my $sth = C4::Context->dbh->prepare(
2122 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2124 $sth->execute( $item->itemnumber );
2126 $messages->{'WrongTransfer'} = $tobranch;
2127 $messages->{'WrongTransferItem'} = $item->itemnumber;
2129 $validTransfert = 1;
2132 # fix up the accounts.....
2133 if ( $item->itemlost ) {
2134 $messages->{'WasLost'} = 1;
2135 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2137 my $no_refund_after_days = C4::Context->preference('NoRefundOnLostReturnedItemsAge');
2138 if ($no_refund_after_days) {
2139 my $today = dt_from_string();
2140 my $lost_age_in_days =
2141 dt_from_string( $item->itemlost_on )
2142 ->delta_days($today)
2145 $refund = 0 unless ( $lost_age_in_days < $no_refund_after_days );
2150 Koha::CirculationRules->get_lostreturn_policy(
2152 return_branch => C4::Context->userenv->{branch},
2158 _FixAccountForLostAndFound( $item->itemnumber,
2159 $borrowernumber, $barcode );
2160 $messages->{'LostItemFeeRefunded'} = 1;
2165 # fix up the overdues in accounts...
2166 if ($borrowernumber) {
2167 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2168 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!"; # zero is OK, check defined
2170 if ( $issue and $issue->is_overdue($return_date) ) {
2172 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2174 $messages->{'PrevDebarred'} = $debardate;
2176 $messages->{'Debarred'} = $debardate if $debardate;
2178 # there's no overdue on the item but borrower had been previously debarred
2179 } elsif ( $issue->date_due and $patron->debarred ) {
2180 if ( $patron->debarred eq "9999-12-31") {
2181 $messages->{'ForeverDebarred'} = $patron->debarred;
2183 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2184 $borrower_debar_dt->truncate(to => 'day');
2185 my $today_dt = $return_date->clone()->truncate(to => 'day');
2186 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2187 $messages->{'PrevDebarred'} = $patron->debarred;
2193 # find reserves.....
2194 # launch the Checkreserves routine to find any holds
2195 my ($resfound, $resrec);
2196 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2197 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2198 # if a hold is found and is waiting at another branch, change the priority back to 1 and trigger the hold (this will trigger a transfer and update the hold status properly)
2199 if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2200 my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2201 $resfound = 'Reserved';
2202 $resrec = $hold->unblessed;
2205 $resrec->{'ResFound'} = $resfound;
2206 $messages->{'ResFound'} = $resrec;
2209 # Record the fact that this book was returned.
2213 itemnumber => $itemnumber,
2214 itemtype => $itemtype,
2215 location => $item->location,
2216 borrowernumber => $borrowernumber,
2217 ccode => $item->ccode,
2220 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2222 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2224 branchcode => $branch,
2225 categorycode => $patron->categorycode,
2226 item_type => $itemtype,
2227 notification => 'CHECKIN',
2229 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2230 SendCirculationAlert({
2232 item => $item->unblessed,
2233 borrower => $patron->unblessed,
2238 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2239 if C4::Context->preference("ReturnLog");
2242 # Check if this item belongs to a biblio record that is attached to an
2243 # ILL request, if it is we need to update the ILL request's status
2244 if (C4::Context->preference('CirculateILL')) {
2245 my $request = Koha::Illrequests->find(
2246 { biblio_id => $item->biblio->biblionumber }
2248 $request->status('RET') if $request;
2251 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2252 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2253 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2254 if (C4::Context->preference("AutomaticItemReturn" ) or
2255 (C4::Context->preference("UseBranchTransferLimits") and
2256 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2258 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2259 $debug and warn "item: " . Dumper($item->unblessed);
2260 ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger);
2261 $messages->{'WasTransfered'} = 1;
2263 $messages->{'NeedsTransfer'} = $returnbranch;
2264 $messages->{'TransferTrigger'} = $transfer_trigger;
2268 if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2269 my $claims = Koha::Checkouts::ReturnClaims->search(
2271 itemnumber => $item->id,
2272 resolution => undef,
2276 if ( $claims->count ) {
2277 $messages->{ReturnClaims} = $claims;
2281 if ( $doreturn and $issue ) {
2282 my $checkin = Koha::Old::Checkouts->find($issue->id);
2284 Koha::Plugins->call('after_circ_action', {
2285 action => 'checkin',
2292 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2295 =head2 MarkIssueReturned
2297 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2299 Unconditionally marks an issue as being returned by
2300 moving the C<issues> row to C<old_issues> and
2301 setting C<returndate> to the current date.
2303 if C<$returndate> is specified (in iso format), it is used as the date
2306 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2307 the old_issue is immediately anonymised
2309 Ideally, this function would be internal to C<C4::Circulation>,
2310 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2311 and offline_circ/process_koc.pl.
2315 sub MarkIssueReturned {
2316 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2318 # Retrieve the issue
2319 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2321 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2323 my $issue_id = $issue->issue_id;
2325 my $anonymouspatron;
2326 if ( $privacy && $privacy == 2 ) {
2327 # The default of 0 will not work due to foreign key constraints
2328 # The anonymisation will fail if AnonymousPatron is not a valid entry
2329 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2330 # Note that a warning should appear on the about page (System information tab).
2331 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2332 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."
2333 unless Koha::Patrons->find( $anonymouspatron );
2336 my $schema = Koha::Database->schema;
2338 # FIXME Improve the return value and handle it from callers
2339 $schema->txn_do(sub {
2341 my $patron = Koha::Patrons->find( $borrowernumber );
2343 # Update the returndate value
2344 if ( $returndate ) {
2345 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2348 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2351 # Create the old_issues entry
2352 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2354 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2355 if ( $privacy && $privacy == 2) {
2356 $old_checkout->borrowernumber($anonymouspatron)->store;
2359 # And finally delete the issue
2362 $issue->item->onloan(undef)->store({ log_action => 0 });
2364 if ( C4::Context->preference('StoreLastBorrower') ) {
2365 my $item = Koha::Items->find( $itemnumber );
2366 $item->last_returned_by( $patron );
2369 # Remove any OVERDUES related debarment if the borrower has no overdues
2370 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2371 && $patron->debarred
2372 && !$patron->has_overdues
2373 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2375 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2383 =head2 _debar_user_on_return
2385 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2387 C<$borrower> borrower hashref
2389 C<$item> item hashref
2391 C<$datedue> date due DateTime object
2393 C<$returndate> DateTime object representing the return time
2395 Internal function, called only by AddReturn that calculates and updates
2396 the user fine days, and debars them if necessary.
2398 Should only be called for overdue returns
2400 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2405 sub _calculate_new_debar_dt {
2406 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2408 my $branchcode = _GetCircControlBranch( $item, $borrower );
2409 my $circcontrol = C4::Context->preference('CircControl');
2410 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2411 { categorycode => $borrower->{categorycode},
2412 itemtype => $item->{itype},
2413 branchcode => $branchcode,
2418 'maxsuspensiondays',
2419 'suspension_chargeperiod',
2423 my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2424 my $unit = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2425 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2427 return unless $finedays;
2429 # finedays is in days, so hourly loans must multiply by 24
2430 # thus 1 hour late equals 1 day suspension * finedays rate
2431 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2433 # grace period is measured in the same units as the loan
2435 DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2437 my $deltadays = DateTime::Duration->new(
2438 days => $chargeable_units
2441 if ( $deltadays->subtract($grace)->is_positive() ) {
2442 my $suspension_days = $deltadays * $finedays;
2444 if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2445 # No need to / 1 and do not consider / 0
2446 $suspension_days = DateTime::Duration->new(
2447 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2451 # If the max suspension days is < than the suspension days
2452 # the suspension days is limited to this maximum period.
2453 my $max_sd = $issuing_rule->{maxsuspensiondays};
2454 if ( defined $max_sd && $max_sd ne '' ) {
2455 $max_sd = DateTime::Duration->new( days => $max_sd );
2456 $suspension_days = $max_sd
2457 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2460 my ( $has_been_extended );
2461 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2462 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2464 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2465 $has_been_extended = 1;
2470 # Use the calendar or not to calculate the debarment date
2471 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2472 my $calendar = Koha::Calendar->new(
2473 branchcode => $branchcode,
2474 days_mode => 'Calendar'
2476 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2479 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2481 return $new_debar_dt;
2486 sub _debar_user_on_return {
2487 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2489 $return_date //= dt_from_string();
2491 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2493 return unless $new_debar_dt;
2495 Koha::Patron::Debarments::AddUniqueDebarment({
2496 borrowernumber => $borrower->{borrowernumber},
2497 expiration => $new_debar_dt->ymd(),
2498 type => 'SUSPENSION',
2500 # if borrower was already debarred but does not get an extra debarment
2501 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2502 my ($new_debarment_str, $is_a_reminder);
2503 if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2505 $new_debarment_str = $borrower->{debarred};
2507 $new_debarment_str = $new_debar_dt->ymd();
2509 # FIXME Should return a DateTime object
2510 return $new_debarment_str, $is_a_reminder;
2513 =head2 _FixOverduesOnReturn
2515 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2517 C<$borrowernumber> borrowernumber
2519 C<$itemnumber> itemnumber
2521 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2523 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2529 sub _FixOverduesOnReturn {
2530 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2531 unless( $borrowernumber ) {
2532 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2536 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2540 warn "_FixOverduesOnReturn() not supplied valid status";
2544 my $schema = Koha::Database->schema;
2546 my $result = $schema->txn_do(
2548 # check for overdue fine
2549 my $accountlines = Koha::Account::Lines->search(
2551 borrowernumber => $borrowernumber,
2552 itemnumber => $item,
2553 debit_type_code => 'OVERDUE',
2554 status => 'UNRETURNED'
2557 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2559 my $accountline = $accountlines->next;
2560 my $payments = $accountline->credits;
2562 my $amountoutstanding = $accountline->amountoutstanding;
2563 if ( $accountline->amount == 0 && $payments->count == 0 ) {
2564 $accountline->delete;
2565 } elsif ($exemptfine && ($amountoutstanding != 0)) {
2566 my $account = Koha::Account->new({patron_id => $borrowernumber});
2567 my $credit = $account->add_credit(
2569 amount => $amountoutstanding,
2570 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2571 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2572 interface => C4::Context->interface,
2578 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2580 if (C4::Context->preference("FinesLog")) {
2581 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2584 $accountline->status('FORGIVEN');
2585 $accountline->store();
2587 $accountline->status($status);
2588 $accountline->store();
2597 =head2 _FixAccountForLostAndFound
2599 &_FixAccountForLostAndFound($itemnumber, [$borrowernumber, $barcode]);
2601 Finds the most recent lost item charge for this item and refunds the borrower
2602 appropriatly, taking into account any payments or writeoffs already applied
2605 Internal function, not exported, called only by AddReturn.
2609 sub _FixAccountForLostAndFound {
2610 my $itemnumber = shift or return;
2611 my $borrowernumber = @_ ? shift : undef;
2612 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2616 # check for charge made for lost book
2617 my $accountlines = Koha::Account::Lines->search(
2619 itemnumber => $itemnumber,
2620 debit_type_code => 'LOST',
2621 status => [ undef, { '<>' => 'FOUND' } ]
2624 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2628 return unless $accountlines->count > 0;
2629 my $accountline = $accountlines->next;
2630 my $total_to_refund = 0;
2632 return unless $accountline->borrowernumber;
2633 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2634 return unless $patron; # Patron has been deleted, nobody to credit the return to
2636 my $account = $patron->account;
2639 if ( $accountline->amount > $accountline->amountoutstanding ) {
2640 # some amount has been cancelled. collect the offsets that are not writeoffs
2641 # this works because the only way to subtract from this kind of a debt is
2642 # using the UI buttons 'Pay' and 'Write off'
2643 my $credits_offsets = Koha::Account::Offsets->search({
2644 debit_id => $accountline->id,
2645 credit_id => { '!=' => undef }, # it is not the debit itself
2646 type => { '!=' => 'Writeoff' },
2647 amount => { '<' => 0 } # credits are negative on the DB
2650 $total_to_refund = ( $credits_offsets->count > 0 )
2651 ? $credits_offsets->total * -1 # credits are negative on the DB
2655 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2657 if ( $credit_total > 0 ) {
2658 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2659 $credit = $account->add_credit(
2661 amount => $credit_total,
2662 description => 'Item found ' . $item_id,
2663 type => 'LOST_FOUND',
2664 interface => C4::Context->interface,
2665 library_id => $branchcode,
2666 item_id => $itemnumber
2670 $credit->apply( { debits => [ $accountline ] } );
2673 # Update the account status
2674 $accountline->discard_changes->status('FOUND');
2675 $accountline->store;
2677 $accountline->item->paidfor('')->store({ log_action => 0 });
2679 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2680 $account->reconcile_balance;
2683 return ($credit) ? $credit->id : undef;
2686 =head2 _GetCircControlBranch
2688 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2692 Return the library code to be used to determine which circulation
2693 policy applies to a transaction. Looks up the CircControl and
2694 HomeOrHoldingBranch system preferences.
2696 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2698 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2702 sub _GetCircControlBranch {
2703 my ($item, $borrower) = @_;
2704 my $circcontrol = C4::Context->preference('CircControl');
2707 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2708 $branch= C4::Context->userenv->{'branch'};
2709 } elsif ($circcontrol eq 'PatronLibrary') {
2710 $branch=$borrower->{branchcode};
2712 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2713 $branch = $item->{$branchfield};
2714 # default to item home branch if holdingbranch is used
2715 # and is not defined
2716 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2717 $branch = $item->{homebranch};
2725 $issue = GetOpenIssue( $itemnumber );
2727 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2729 C<$itemnumber> is the item's itemnumber
2736 my ( $itemnumber ) = @_;
2737 return unless $itemnumber;
2738 my $dbh = C4::Context->dbh;
2739 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2740 $sth->execute( $itemnumber );
2741 return $sth->fetchrow_hashref();
2745 =head2 GetBiblioIssues
2747 $issues = GetBiblioIssues($biblionumber);
2749 this function get all issues from a biblionumber.
2752 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2753 tables issues and the firstname,surname & cardnumber from borrowers.
2757 sub GetBiblioIssues {
2758 my $biblionumber = shift;
2759 return unless $biblionumber;
2760 my $dbh = C4::Context->dbh;
2762 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2764 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2765 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2766 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2767 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2768 WHERE biblio.biblionumber = ?
2770 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2772 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2773 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2774 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2775 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2776 WHERE biblio.biblionumber = ?
2779 my $sth = $dbh->prepare($query);
2780 $sth->execute($biblionumber, $biblionumber);
2783 while ( my $data = $sth->fetchrow_hashref ) {
2784 push @issues, $data;
2789 =head2 GetUpcomingDueIssues
2791 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2795 sub GetUpcomingDueIssues {
2798 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2799 my $dbh = C4::Context->dbh;
2801 my $statement = <<END_SQL;
2804 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2806 LEFT JOIN items USING (itemnumber)
2807 LEFT OUTER JOIN branches USING (branchcode)
2808 WHERE returndate is NULL
2810 WHERE days_until_due >= 0 AND days_until_due <= ?
2813 my @bind_parameters = ( $params->{'days_in_advance'} );
2815 my $sth = $dbh->prepare( $statement );
2816 $sth->execute( @bind_parameters );
2817 my $upcoming_dues = $sth->fetchall_arrayref({});
2819 return $upcoming_dues;
2822 =head2 CanBookBeRenewed
2824 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2826 Find out whether a borrowed item may be renewed.
2828 C<$borrowernumber> is the borrower number of the patron who currently
2829 has the item on loan.
2831 C<$itemnumber> is the number of the item to renew.
2833 C<$override_limit>, if supplied with a true value, causes
2834 the limit on the number of times that the loan can be renewed
2835 (as controlled by the item type) to be ignored. Overriding also allows
2836 to renew sooner than "No renewal before" and to manually renew loans
2837 that are automatically renewed.
2839 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2840 item must currently be on loan to the specified borrower; renewals
2841 must be allowed for the item's type; and the borrower must not have
2842 already renewed the loan. $error will contain the reason the renewal can not proceed
2846 sub CanBookBeRenewed {
2847 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2849 my $dbh = C4::Context->dbh;
2853 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2854 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2855 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2856 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2858 my $patron = $issue->patron or return;
2860 # override_limit will override anything else except on_reserve
2861 unless ( $override_limit ){
2862 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2863 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2865 categorycode => $patron->categorycode,
2866 itemtype => $item->effective_itemtype,
2867 branchcode => $branchcode,
2870 'no_auto_renewal_after',
2871 'no_auto_renewal_after_hard_limit',
2878 return ( 0, "too_many" )
2879 if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2881 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2882 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2883 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2884 my $restricted = $patron->is_debarred;
2885 my $hasoverdues = $patron->has_overdues;
2887 if ( $restricted and $restrictionblockrenewing ) {
2888 return ( 0, 'restriction');
2889 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2890 return ( 0, 'overdue');
2893 if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2895 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2896 return ( 0, 'auto_account_expired' );
2899 if ( defined $issuing_rule->{no_auto_renewal_after}
2900 and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2901 # Get issue_date and add no_auto_renewal_after
2902 # If this is greater than today, it's too late for renewal.
2903 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2904 $maximum_renewal_date->add(
2905 $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2907 my $now = dt_from_string;
2908 if ( $now >= $maximum_renewal_date ) {
2909 return ( 0, "auto_too_late" );
2912 if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2913 and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2914 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2915 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2916 return ( 0, "auto_too_late" );
2920 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2921 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2922 my $amountoutstanding =
2923 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2924 ? $patron->account->balance
2925 : $patron->account->outstanding_debits->total_outstanding;
2926 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2927 return ( 0, "auto_too_much_oweing" );
2932 if ( defined $issuing_rule->{norenewalbefore}
2933 and $issuing_rule->{norenewalbefore} ne "" )
2936 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2937 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2938 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2940 # Depending on syspref reset the exact time, only check the date
2941 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2942 and $issuing_rule->{lengthunit} eq 'days' )
2944 $soonestrenewal->truncate( to => 'day' );
2947 if ( $soonestrenewal > dt_from_string() )
2949 return ( 0, "auto_too_soon" ) if $issue->auto_renew && $patron->autorenew_checkouts;
2950 return ( 0, "too_soon" );
2952 elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2957 # Fallback for automatic renewals:
2958 # If norenewalbefore is undef, don't renew before due date.
2959 if ( $issue->auto_renew && !$auto_renew && $patron->autorenew_checkouts ) {
2960 my $now = dt_from_string;
2961 if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2964 return ( 0, "auto_too_soon" );
2969 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2971 # This item can fill one or more unfilled reserve, can those unfilled reserves
2972 # all be filled by other available items?
2974 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2976 my $schema = Koha::Database->new()->schema();
2978 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2980 # There is an item level hold on this item, no other item can fill the hold
2985 # Get all other items that could possibly fill reserves
2986 my @itemnumbers = $schema->resultset('Item')->search(
2988 biblionumber => $resrec->{biblionumber},
2991 -not => { itemnumber => $itemnumber }
2993 { columns => 'itemnumber' }
2994 )->get_column('itemnumber')->all();
2996 # Get all other reserves that could have been filled by this item
2997 my @borrowernumbers;
2999 my ( $reserve_found, $reserve, undef ) =
3000 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
3002 if ($reserve_found) {
3003 push( @borrowernumbers, $reserve->{borrowernumber} );
3010 # If the count of the union of the lists of reservable items for each borrower
3011 # is equal or greater than the number of borrowers, we know that all reserves
3012 # can be filled with available items. We can get the union of the sets simply
3013 # by pushing all the elements onto an array and removing the duplicates.
3016 ITEM: foreach my $itemnumber (@itemnumbers) {
3017 my $item = Koha::Items->find( $itemnumber );
3018 next if IsItemOnHoldAndFound( $itemnumber );
3019 for my $borrowernumber (@borrowernumbers) {
3020 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
3021 next unless IsAvailableForItemLevelRequest($item, $patron);
3022 next unless CanItemBeReserved($borrowernumber,$itemnumber);
3024 push @reservable, $itemnumber;
3025 if (@reservable >= @borrowernumbers) {
3034 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
3035 return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
3037 return ( 1, undef );
3042 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
3046 C<$borrowernumber> is the borrower number of the patron who currently
3049 C<$itemnumber> is the number of the item to renew.
3051 C<$branch> is the library where the renewal took place (if any).
3052 The library that controls the circ policies for the renewal is retrieved from the issues record.
3054 C<$datedue> can be a DateTime object used to set the due date.
3056 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
3057 this parameter is not supplied, lastreneweddate is set to the current date.
3059 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3060 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3061 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3064 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3065 from the book's item type.
3070 my $borrowernumber = shift;
3071 my $itemnumber = shift or return;
3073 my $datedue = shift;
3074 my $lastreneweddate = shift || dt_from_string();
3075 my $skipfinecalc = shift;
3077 my $item_object = Koha::Items->find($itemnumber) or return;
3078 my $biblio = $item_object->biblio;
3079 my $issue = $item_object->checkout;
3080 my $item_unblessed = $item_object->unblessed;
3082 my $dbh = C4::Context->dbh;
3084 return unless $issue;
3086 $borrowernumber ||= $issue->borrowernumber;
3088 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3089 carp 'Invalid date passed to AddRenewal.';
3093 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3094 my $patron_unblessed = $patron->unblessed;
3096 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3098 my $schema = Koha::Database->schema;
3099 $schema->txn_do(sub{
3101 if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3102 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3104 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3106 # If the due date wasn't specified, calculate it by adding the
3107 # book's loan length to today's date or the current due date
3108 # based on the value of the RenewalPeriodBase syspref.
3109 my $itemtype = $item_object->effective_itemtype;
3112 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3113 dt_from_string( $issue->date_due, 'sql' ) :
3115 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3118 my $fees = Koha::Charges::Fees->new(
3121 library => $circ_library,
3122 item => $item_object,
3123 from_date => dt_from_string( $issue->date_due, 'sql' ),
3124 to_date => dt_from_string($datedue),
3128 # Update the issues record to have the new due date, and a new count
3129 # of how many times it has been renewed.
3130 my $renews = ( $issue->renewals || 0 ) + 1;
3131 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3132 WHERE borrowernumber=?
3136 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3138 # Update the renewal count on the item, and tell zebra to reindex
3139 $renews = ( $item_object->renewals || 0 ) + 1;
3140 $item_object->renewals($renews);
3141 $item_object->onloan($datedue);
3142 $item_object->store({ log_action => 0 });
3144 # Charge a new rental fee, if applicable
3145 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3146 if ( $charge > 0 ) {
3147 AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3150 # Charge a new accumulate rental fee, if applicable
3151 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3152 if ( $itemtype_object ) {
3153 my $accumulate_charge = $fees->accumulate_rentalcharge();
3154 if ( $accumulate_charge > 0 ) {
3155 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3157 $charge += $accumulate_charge;
3160 # Send a renewal slip according to checkout alert preferencei
3161 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3162 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3164 branchcode => $branch,
3165 categorycode => $patron->categorycode,
3166 item_type => $itemtype,
3167 notification => 'CHECKOUT',
3169 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3170 SendCirculationAlert(
3173 item => $item_unblessed,
3174 borrower => $patron->unblessed,
3181 # Remove any OVERDUES related debarment if the borrower has no overdues
3183 && $patron->is_debarred
3184 && ! $patron->has_overdues
3185 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3187 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3190 # Add the renewal to stats
3193 branch => $item_object->renewal_branchcode({branch => $branch}),
3196 itemnumber => $itemnumber,
3197 itemtype => $itemtype,
3198 location => $item_object->location,
3199 borrowernumber => $borrowernumber,
3200 ccode => $item_object->ccode,
3205 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3207 Koha::Plugins->call('after_circ_action', {
3208 action => 'renewal',
3210 checkout => $issue->get_from_storage
3219 # check renewal status
3220 my ( $bornum, $itemno ) = @_;
3221 my $dbh = C4::Context->dbh;
3223 my $renewsallowed = 0;
3226 my $patron = Koha::Patrons->find( $bornum );
3227 my $item = Koha::Items->find($itemno);
3229 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3231 # Look in the issues table for this item, lent to this borrower,
3232 # and not yet returned.
3234 # FIXME - I think this function could be redone to use only one SQL call.
3235 my $sth = $dbh->prepare(
3236 "select * from issues
3237 where (borrowernumber = ?)
3238 and (itemnumber = ?)"
3240 $sth->execute( $bornum, $itemno );
3241 my $data = $sth->fetchrow_hashref;
3242 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3243 # $item and $borrower should be calculated
3244 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3246 my $rule = Koha::CirculationRules->get_effective_rule(
3248 categorycode => $patron->categorycode,
3249 itemtype => $item->effective_itemtype,
3250 branchcode => $branchcode,
3251 rule_name => 'renewalsallowed',
3255 $renewsallowed = $rule ? $rule->rule_value : 0;
3256 $renewsleft = $renewsallowed - $renewcount;
3257 if($renewsleft < 0){ $renewsleft = 0; }
3258 return ( $renewcount, $renewsallowed, $renewsleft );
3261 =head2 GetSoonestRenewDate
3263 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3265 Find out the soonest possible renew date of a borrowed item.
3267 C<$borrowernumber> is the borrower number of the patron who currently
3268 has the item on loan.
3270 C<$itemnumber> is the number of the item to renew.
3272 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3273 renew date, based on the value "No renewal before" of the applicable
3274 issuing rule. Returns the current date if the item can already be
3275 renewed, and returns undefined if the borrower, loan, or item
3280 sub GetSoonestRenewDate {
3281 my ( $borrowernumber, $itemnumber ) = @_;
3283 my $dbh = C4::Context->dbh;
3285 my $item = Koha::Items->find($itemnumber) or return;
3286 my $itemissue = $item->checkout or return;
3288 $borrowernumber ||= $itemissue->borrowernumber;
3289 my $patron = Koha::Patrons->find( $borrowernumber )
3292 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3293 my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3294 { categorycode => $patron->categorycode,
3295 itemtype => $item->effective_itemtype,
3296 branchcode => $branchcode,
3304 my $now = dt_from_string;
3305 return $now unless $issuing_rule;
3307 if ( defined $issuing_rule->{norenewalbefore}
3308 and $issuing_rule->{norenewalbefore} ne "" )
3310 my $soonestrenewal =
3311 dt_from_string( $itemissue->date_due )->subtract(
3312 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3314 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3315 and $issuing_rule->{lengthunit} eq 'days' )
3317 $soonestrenewal->truncate( to => 'day' );
3319 return $soonestrenewal if $now < $soonestrenewal;
3324 =head2 GetLatestAutoRenewDate
3326 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3328 Find out the latest possible auto renew date of a borrowed item.
3330 C<$borrowernumber> is the borrower number of the patron who currently
3331 has the item on loan.
3333 C<$itemnumber> is the number of the item to renew.
3335 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3336 auto renew date, based on the value "No auto renewal after" and the "No auto
3337 renewal after (hard limit) of the applicable issuing rule.
3338 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3339 or item cannot be found.
3343 sub GetLatestAutoRenewDate {
3344 my ( $borrowernumber, $itemnumber ) = @_;
3346 my $dbh = C4::Context->dbh;
3348 my $item = Koha::Items->find($itemnumber) or return;
3349 my $itemissue = $item->checkout or return;
3351 $borrowernumber ||= $itemissue->borrowernumber;
3352 my $patron = Koha::Patrons->find( $borrowernumber )
3355 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3356 my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3358 categorycode => $patron->categorycode,
3359 itemtype => $item->effective_itemtype,
3360 branchcode => $branchcode,
3362 'no_auto_renewal_after',
3363 'no_auto_renewal_after_hard_limit',
3369 return unless $circulation_rules;
3371 if ( not $circulation_rules->{no_auto_renewal_after}
3372 or $circulation_rules->{no_auto_renewal_after} eq '' )
3373 and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3374 or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3376 my $maximum_renewal_date;
3377 if ( $circulation_rules->{no_auto_renewal_after} ) {
3378 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3379 $maximum_renewal_date->add(
3380 $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3384 if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3385 my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3386 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3388 return $maximum_renewal_date;
3392 =head2 GetIssuingCharges
3394 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3396 Calculate how much it would cost for a given patron to borrow a given
3397 item, including any applicable discounts.
3399 C<$itemnumber> is the item number of item the patron wishes to borrow.
3401 C<$borrowernumber> is the patron's borrower number.
3403 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3404 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3409 sub GetIssuingCharges {
3411 # calculate charges due
3412 my ( $itemnumber, $borrowernumber ) = @_;
3414 my $dbh = C4::Context->dbh;
3417 # Get the book's item type and rental charge (via its biblioitem).
3418 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3419 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3420 $charge_query .= (C4::Context->preference('item-level_itypes'))
3421 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3422 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3424 $charge_query .= ' WHERE items.itemnumber =?';
3426 my $sth = $dbh->prepare($charge_query);
3427 $sth->execute($itemnumber);
3428 if ( my $item_data = $sth->fetchrow_hashref ) {
3429 $item_type = $item_data->{itemtype};
3430 $charge = $item_data->{rentalcharge};
3431 my $branch = C4::Context::mybranch();
3432 my $patron = Koha::Patrons->find( $borrowernumber );
3433 my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3435 # We may have multiple rules so get the most specific
3436 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3439 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3443 return ( $charge, $item_type );
3446 # Select most appropriate discount rule from those returned
3447 sub _get_discount_from_rule {
3448 my ($categorycode, $branchcode, $itemtype) = @_;
3450 # Set search precedences
3453 branchcode => $branchcode,
3454 itemtype => $itemtype,
3455 categorycode => $categorycode,
3458 branchcode => undef,
3459 categorycode => $categorycode,
3460 itemtype => $itemtype,
3463 branchcode => $branchcode,
3464 categorycode => $categorycode,
3468 branchcode => undef,
3469 categorycode => $categorycode,
3474 foreach my $params (@params) {
3475 my $rule = Koha::CirculationRules->search(
3477 rule_name => 'rentaldiscount',
3482 return $rule->rule_value if $rule;
3489 =head2 AddIssuingCharge
3491 &AddIssuingCharge( $checkout, $charge, $type )
3495 sub AddIssuingCharge {
3496 my ( $checkout, $charge, $type ) = @_;
3498 # FIXME What if checkout does not exist?
3500 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3501 my $accountline = $account->add_debit(
3505 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3506 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3507 interface => C4::Context->interface,
3509 item_id => $checkout->itemnumber,
3510 issue_id => $checkout->issue_id,
3517 GetTransfers($itemnumber);
3522 my ($itemnumber) = @_;
3524 my $dbh = C4::Context->dbh;
3531 FROM branchtransfers
3532 WHERE itemnumber = ?
3533 AND datearrived IS NULL
3535 my $sth = $dbh->prepare($query);
3536 $sth->execute($itemnumber);
3537 my @row = $sth->fetchrow_array();
3541 =head2 GetTransfersFromTo
3543 @results = GetTransfersFromTo($frombranch,$tobranch);
3545 Returns the list of pending transfers between $from and $to branch
3549 sub GetTransfersFromTo {
3550 my ( $frombranch, $tobranch ) = @_;
3551 return unless ( $frombranch && $tobranch );
3552 my $dbh = C4::Context->dbh;
3554 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3555 FROM branchtransfers
3558 AND datearrived IS NULL
3560 my $sth = $dbh->prepare($query);
3561 $sth->execute( $frombranch, $tobranch );
3564 while ( my $data = $sth->fetchrow_hashref ) {
3565 push @gettransfers, $data;
3567 return (@gettransfers);
3570 =head2 DeleteTransfer
3572 &DeleteTransfer($itemnumber);
3576 sub DeleteTransfer {
3577 my ($itemnumber) = @_;
3578 return unless $itemnumber;
3579 my $dbh = C4::Context->dbh;
3580 my $sth = $dbh->prepare(
3581 "DELETE FROM branchtransfers
3583 AND datearrived IS NULL "
3585 return $sth->execute($itemnumber);
3588 =head2 SendCirculationAlert
3590 Send out a C<check-in> or C<checkout> alert using the messaging system.
3598 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3602 Hashref of information about the item being checked in or out.
3606 Hashref of information about the borrower of the item.
3610 The branchcode from where the checkout or check-in took place.
3616 SendCirculationAlert({
3619 borrower => $borrower,
3625 sub SendCirculationAlert {
3627 my ($type, $item, $borrower, $branch) =
3628 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3629 my %message_name = (
3630 CHECKIN => 'Item_Check_in',
3631 CHECKOUT => 'Item_Checkout',
3632 RENEWAL => 'Item_Checkout',
3634 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3635 borrowernumber => $borrower->{borrowernumber},
3636 message_name => $message_name{$type},
3638 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3640 my $schema = Koha::Database->new->schema;
3641 my @transports = keys %{ $borrower_preferences->{transports} };
3643 # From the MySQL doc:
3644 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3645 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3646 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3647 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3649 for my $mtt (@transports) {
3650 my $letter = C4::Letters::GetPreparedLetter (
3651 module => 'circulation',
3652 letter_code => $type,
3653 branchcode => $branch,
3654 message_transport_type => $mtt,
3655 lang => $borrower->{lang},
3657 $issues_table => $item->{itemnumber},
3658 'items' => $item->{itemnumber},
3659 'biblio' => $item->{biblionumber},
3660 'biblioitems' => $item->{biblionumber},
3661 'borrowers' => $borrower,
3662 'branches' => $branch,
3666 $schema->storage->txn_begin;
3667 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3668 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3669 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3670 unless ( $message ) {
3671 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3672 C4::Message->enqueue($letter, $borrower, $mtt);
3674 $message->append($letter);
3677 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3678 $schema->storage->txn_commit;
3684 =head2 updateWrongTransfer
3686 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3688 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
3692 sub updateWrongTransfer {
3693 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3694 my $dbh = C4::Context->dbh;
3695 # first step validate the actual line of transfert .
3698 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3700 $sth->execute($FromLibrary,$itemNumber);
3702 # second step create a new line of branchtransfer to the right location .
3703 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3705 #third step changing holdingbranch of item
3706 my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3711 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3713 this function calculates the due date given the start date and configured circulation rules,
3714 checking against the holidays calendar as per the daysmode circulation rule.
3715 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3716 C<$itemtype> = itemtype code of item in question
3717 C<$branch> = location whose calendar to use
3718 C<$borrower> = Borrower object
3719 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3724 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3728 # loanlength now a href
3730 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3732 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3738 if (ref $startdate ne 'DateTime' ) {
3739 $datedue = dt_from_string($datedue);
3741 $datedue = $startdate->clone;
3744 $datedue = dt_from_string()->truncate( to => 'minute' );
3748 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3750 categorycode => $borrower->{categorycode},
3751 itemtype => $itemtype,
3752 branchcode => $branch,
3756 # calculate the datedue as normal
3757 if ( $daysmode eq 'Days' )
3758 { # ignoring calendar
3759 if ( $loanlength->{lengthunit} eq 'hours' ) {
3760 $datedue->add( hours => $loanlength->{$length_key} );
3762 $datedue->add( days => $loanlength->{$length_key} );
3763 $datedue->set_hour(23);
3764 $datedue->set_minute(59);
3768 if ($loanlength->{lengthunit} eq 'hours') {
3769 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3772 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3774 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3775 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3776 if ($loanlength->{lengthunit} eq 'days') {
3777 $datedue->set_hour(23);
3778 $datedue->set_minute(59);
3782 # if Hard Due Dates are used, retrieve them and apply as necessary
3783 my ( $hardduedate, $hardduedatecompare ) =
3784 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3785 if ($hardduedate) { # hardduedates are currently dates
3786 $hardduedate->truncate( to => 'minute' );
3787 $hardduedate->set_hour(23);
3788 $hardduedate->set_minute(59);
3789 my $cmp = DateTime->compare( $hardduedate, $datedue );
3791 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3792 # if the calculated date is before the 'after' Hard Due Date (floor), override
3793 # if the hard due date is set to 'exactly', overrride
3794 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3795 $datedue = $hardduedate->clone;
3798 # in all other cases, keep the date due as it is
3802 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3803 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3804 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3805 if( $expiry_dt ) { #skip empty expiry date..
3806 $expiry_dt->set( hour => 23, minute => 59);
3807 my $d1= $datedue->clone->set_time_zone('floating');
3808 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3809 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3812 if ( $daysmode ne 'Days' ) {
3813 my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3814 if ( $calendar->is_holiday($datedue) ) {
3815 # Don't return on a closed day
3816 $datedue = $calendar->prev_open_days( $datedue, 1 );
3825 sub CheckValidBarcode{
3827 my $dbh = C4::Context->dbh;
3828 my $query=qq|SELECT count(*)
3832 my $sth = $dbh->prepare($query);
3833 $sth->execute($barcode);
3834 my $exist=$sth->fetchrow ;
3838 =head2 IsBranchTransferAllowed
3840 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3842 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3844 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3845 Koha::Item->can_be_transferred.
3849 sub IsBranchTransferAllowed {
3850 my ( $toBranch, $fromBranch, $code ) = @_;
3852 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3854 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3855 my $dbh = C4::Context->dbh;
3857 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3858 $sth->execute( $toBranch, $fromBranch, $code );
3859 my $limit = $sth->fetchrow_hashref();
3861 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3862 if ( $limit->{'limitId'} ) {
3869 =head2 CreateBranchTransferLimit
3871 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3873 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3875 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3879 sub CreateBranchTransferLimit {
3880 my ( $toBranch, $fromBranch, $code ) = @_;
3881 return unless defined($toBranch) && defined($fromBranch);
3882 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3884 my $dbh = C4::Context->dbh;
3886 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3887 return $sth->execute( $code, $toBranch, $fromBranch );
3890 =head2 DeleteBranchTransferLimits
3892 my $result = DeleteBranchTransferLimits($frombranch);
3894 Deletes all the library transfer limits for one library. Returns the
3895 number of limits deleted, 0e0 if no limits were deleted, or undef if
3896 no arguments are supplied.
3898 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3899 fromBranch => $fromBranch
3904 sub DeleteBranchTransferLimits {
3906 return unless defined $branch;
3907 my $dbh = C4::Context->dbh;
3908 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3909 return $sth->execute($branch);
3913 my ( $borrowernumber, $itemnum ) = @_;
3914 MarkIssueReturned( $borrowernumber, $itemnum );
3919 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3921 unless ( $mark_lost_from ) {
3922 # Temporary check to avoid regressions
3923 die q|LostItem called without $mark_lost_from, check the API.|;
3927 if ( $force_mark_returned ) {
3930 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3931 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3934 my $dbh = C4::Context->dbh();
3935 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3937 JOIN items USING (itemnumber)
3938 JOIN biblio USING (biblionumber)
3939 WHERE issues.itemnumber=?");
3940 $sth->execute($itemnumber);
3941 my $issues=$sth->fetchrow_hashref();
3943 # If a borrower lost the item, add a replacement cost to the their record
3944 if ( my $borrowernumber = $issues->{borrowernumber} ){
3945 my $patron = Koha::Patrons->find( $borrowernumber );
3947 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3948 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3950 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3951 C4::Accounts::chargelostitem(
3954 $issues->{'replacementprice'},
3955 sprintf( "%s %s %s",
3956 $issues->{'title'} || q{},
3957 $issues->{'barcode'} || q{},
3958 $issues->{'itemcallnumber'} || q{},
3961 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3962 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3965 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3968 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3969 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3970 Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store;
3972 my $transferdeleted = DeleteTransfer($itemnumber);
3975 sub GetOfflineOperations {
3976 my $dbh = C4::Context->dbh;
3977 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3978 $sth->execute(C4::Context->userenv->{'branch'});
3979 my $results = $sth->fetchall_arrayref({});
3983 sub GetOfflineOperation {
3984 my $operationid = shift;
3985 return unless $operationid;
3986 my $dbh = C4::Context->dbh;
3987 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3988 $sth->execute( $operationid );
3989 return $sth->fetchrow_hashref;
3992 sub AddOfflineOperation {
3993 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3994 my $dbh = C4::Context->dbh;
3995 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3996 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4000 sub DeleteOfflineOperation {
4001 my $dbh = C4::Context->dbh;
4002 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4003 $sth->execute( shift );
4007 sub ProcessOfflineOperation {
4008 my $operation = shift;
4011 if ( $operation->{action} eq 'return' ) {
4012 $report = ProcessOfflineReturn( $operation );
4013 } elsif ( $operation->{action} eq 'issue' ) {
4014 $report = ProcessOfflineIssue( $operation );
4015 } elsif ( $operation->{action} eq 'payment' ) {
4016 $report = ProcessOfflinePayment( $operation );
4019 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4024 sub ProcessOfflineReturn {
4025 my $operation = shift;
4027 my $item = Koha::Items->find({barcode => $operation->{barcode}});
4030 my $itemnumber = $item->itemnumber;
4031 my $issue = GetOpenIssue( $itemnumber );
4033 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4034 ModDateLastSeen( $itemnumber, $leave_item_lost );
4036 $issue->{borrowernumber},
4038 $operation->{timestamp},
4041 $item->onloan(undef);
4042 $item->store({ log_action => 0 });
4045 return "Item not issued.";
4048 return "Item not found.";
4052 sub ProcessOfflineIssue {
4053 my $operation = shift;
4055 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4058 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4060 return "Barcode not found.";
4062 my $itemnumber = $item->itemnumber;
4063 my $issue = GetOpenIssue( $itemnumber );
4065 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4067 $issue->{borrowernumber},
4069 $operation->{timestamp},
4074 $operation->{'barcode'},
4077 $operation->{timestamp},
4082 return "Borrower not found.";
4086 sub ProcessOfflinePayment {
4087 my $operation = shift;
4089 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4091 $patron->account->pay(
4093 amount => $operation->{amount},
4094 library_id => $operation->{branchcode},
4104 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4106 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4111 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4115 ? Koha::Items->find($itemnumber)
4116 : Koha::Items->find( { barcode => $barcode } );
4120 return C4::Letters::GetPreparedLetter (
4121 module => 'circulation',
4122 letter_code => 'TRANSFERSLIP',
4123 branchcode => $branch,
4125 'branches' => $to_branch,
4126 'biblio' => $item->biblionumber,
4127 'items' => $item->unblessed,
4132 =head2 CheckIfIssuedToPatron
4134 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4136 Return 1 if any record item is issued to patron, otherwise return 0
4140 sub CheckIfIssuedToPatron {
4141 my ($borrowernumber, $biblionumber) = @_;
4143 my $dbh = C4::Context->dbh;
4145 SELECT COUNT(*) FROM issues
4146 LEFT JOIN items ON items.itemnumber = issues.itemnumber
4147 WHERE items.biblionumber = ?
4148 AND issues.borrowernumber = ?
4150 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4151 return 1 if $is_issued;
4157 IsItemIssued( $itemnumber )
4159 Return 1 if the item is on loan, otherwise return 0
4164 my $itemnumber = shift;
4165 my $dbh = C4::Context->dbh;
4166 my $sth = $dbh->prepare(q{
4169 WHERE itemnumber = ?
4171 $sth->execute($itemnumber);
4172 return $sth->fetchrow;
4175 =head2 GetAgeRestriction
4177 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4178 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4180 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4181 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4183 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4184 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4185 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4186 Negative days mean the borrower has gone past the age restriction age.
4190 sub GetAgeRestriction {
4191 my ($record_restrictions, $borrower) = @_;
4192 my $markers = C4::Context->preference('AgeRestrictionMarker');
4194 return unless $record_restrictions;
4195 # Split $record_restrictions to something like FSK 16 or PEGI 6
4196 my @values = split ' ', uc($record_restrictions);
4197 return unless @values;
4199 # Search first occurrence of one of the markers
4200 my @markers = split /\|/, uc($markers);
4201 return unless @markers;
4204 my $restriction_year = 0;
4205 for my $value (@values) {
4207 for my $marker (@markers) {
4208 $marker =~ s/^\s+//; #remove leading spaces
4209 $marker =~ s/\s+$//; #remove trailing spaces
4210 if ( $marker eq $value ) {
4211 if ( $index <= $#values ) {
4212 $restriction_year += $values[$index];
4216 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4218 # Perhaps it is something like "K16" (as in Finland)
4219 $restriction_year += $1;
4223 last if ( $restriction_year > 0 );
4226 #Check if the borrower is age restricted for this material and for how long.
4227 if ($restriction_year && $borrower) {
4228 if ( $borrower->{'dateofbirth'} ) {
4229 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4230 $alloweddate[0] += $restriction_year;
4232 #Prevent runime eror on leap year (invalid date)
4233 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4234 $alloweddate[2] = 28;
4237 #Get how many days the borrower has to reach the age restriction
4238 my @Today = split /-/, dt_from_string()->ymd();
4239 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4240 #Negative days means the borrower went past the age restriction age
4241 return ($restriction_year, $daysToAgeRestriction);
4245 return ($restriction_year);
4249 =head2 GetPendingOnSiteCheckouts
4253 sub GetPendingOnSiteCheckouts {
4254 my $dbh = C4::Context->dbh;
4255 return $dbh->selectall_arrayref(q|
4261 items.itemcallnumber,
4265 issues.date_due < NOW() AS is_overdue,
4268 borrowers.firstname,
4270 borrowers.cardnumber,
4271 borrowers.borrowernumber
4273 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4274 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4275 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4276 WHERE issues.onsite_checkout = 1
4277 |, { Slice => {} } );
4283 my ($count, $branch, $itemtype, $ccode, $newness)
4284 = @$params{qw(count branch itemtype ccode newness)};
4286 my $dbh = C4::Context->dbh;
4289 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4290 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4291 i.ccode, SUM(i.issues) AS count
4293 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4294 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4297 my (@where_strs, @where_args);
4300 push @where_strs, 'i.homebranch = ?';
4301 push @where_args, $branch;
4304 if (C4::Context->preference('item-level_itypes')){
4305 push @where_strs, 'i.itype = ?';
4306 push @where_args, $itemtype;
4308 push @where_strs, 'bi.itemtype = ?';
4309 push @where_args, $itemtype;
4313 push @where_strs, 'i.ccode = ?';
4314 push @where_args, $ccode;
4317 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4318 push @where_args, $newness;
4322 $query .= 'WHERE ' . join(' AND ', @where_strs);
4326 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4327 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4332 $query .= q{ ) xxx WHERE count > 0 };
4333 $count = int($count);
4335 $query .= "LIMIT $count";
4338 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4343 =head2 Internal methods
4347 sub _CalculateAndUpdateFine {
4350 my $borrower = $params->{borrower};
4351 my $item = $params->{item};
4352 my $issue = $params->{issue};
4353 my $return_date = $params->{return_date};
4355 unless ($borrower) { carp "No borrower passed in!" && return; }
4356 unless ($item) { carp "No item passed in!" && return; }
4357 unless ($issue) { carp "No issue passed in!" && return; }
4359 my $datedue = dt_from_string( $issue->date_due );
4361 # we only need to calculate and change the fines if we want to do that on return
4362 # Should be on for hourly loans
4363 my $control = C4::Context->preference('CircControl');
4364 my $control_branchcode =
4365 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4366 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4367 : $issue->branchcode;
4369 my $date_returned = $return_date ? $return_date : dt_from_string();
4371 my ( $amount, $unitcounttotal, $unitcount ) =
4372 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4374 if ( C4::Context->preference('finesMode') eq 'production' ) {
4375 if ( $amount > 0 ) {
4376 C4::Overdues::UpdateFine({
4377 issue_id => $issue->issue_id,
4378 itemnumber => $issue->itemnumber,
4379 borrowernumber => $issue->borrowernumber,
4381 due => output_pref($datedue),
4384 elsif ($return_date) {
4386 # Backdated returns may have fines that shouldn't exist,
4387 # so in this case, we need to drop those fines to 0
4389 C4::Overdues::UpdateFine({
4390 issue_id => $issue->issue_id,
4391 itemnumber => $issue->itemnumber,
4392 borrowernumber => $issue->borrowernumber,
4394 due => output_pref($datedue),
4400 sub _item_denied_renewal {
4403 my $item = $params->{item};
4404 return unless $item;
4406 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4407 return unless $denyingrules;
4408 foreach my $field (keys %$denyingrules) {
4409 my $val = $item->$field;
4410 if( !defined $val) {
4411 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4414 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4415 # If the results matches the values in the syspref
4416 # We return true if match found
4429 Koha Development Team <http://koha-community.org/>