1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 #use warnings; FIXME - Bug 2505
25 use POSIX qw( floor );
34 use C4::ItemCirculationAlertPreference;
37 use C4::Log; # logaction
38 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
39 use C4::RotatingCollections qw(GetCollectionItemBranches);
40 use Algorithm::CheckDigits;
44 use Koha::AuthorisedValues;
45 use Koha::Biblioitems;
49 use Koha::IssuingRules;
52 use Koha::Patron::Debarments;
55 use Koha::Account::Lines;
57 use Koha::RefundLostItemFeeRule;
58 use Koha::RefundLostItemFeeRules;
59 use Koha::Account::Lines;
60 use Koha::Account::Offsets;
61 use Koha::Config::SysPrefs;
62 use Koha::Charges::Fees;
64 use List::MoreUtils qw( uniq any );
65 use Scalar::Util qw( looks_like_number );
75 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
81 # FIXME subs that should probably be elsewhere
86 &GetPendingOnSiteCheckouts
89 # subs to deal with issuing a book
97 &GetLatestAutoRenewDate
99 &GetBranchBorrowerCircRule
103 &CheckIfIssuedToPatron
108 # subs to deal with returns
114 # subs to deal with transfers
121 &IsBranchTransferAllowed
122 &CreateBranchTransferLimit
123 &DeleteBranchTransferLimits
127 # subs to deal with offline circulation
129 &GetOfflineOperations
132 &DeleteOfflineOperation
133 &ProcessOfflineOperation
139 C4::Circulation - Koha circulation module
147 The functions in this module deal with circulation, issues, and
148 returns, as well as general information about the library.
149 Also deals with inventory.
155 $str = &barcodedecode($barcode, [$filter]);
157 Generic filter function for barcode string.
158 Called on every circ if the System Pref itemBarcodeInputFilter is set.
159 Will do some manipulation of the barcode for systems that deliver a barcode
160 to circulation.pl that differs from the barcode stored for the item.
161 For proper functioning of this filter, calling the function on the
162 correct barcode string (items.barcode) should return an unaltered barcode.
164 The optional $filter argument is to allow for testing or explicit
165 behavior that ignores the System Pref. Valid values are the same as the
170 # FIXME -- the &decode fcn below should be wrapped into this one.
171 # FIXME -- these plugins should be moved out of Circulation.pm
174 my ($barcode, $filter) = @_;
175 my $branch = C4::Context::mybranch();
176 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
177 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
178 if ($filter eq 'whitespace') {
180 } elsif ($filter eq 'cuecat') {
182 my @fields = split( /\./, $barcode );
183 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
184 ($#results == 2) and return $results[2];
185 } elsif ($filter eq 'T-prefix') {
186 if ($barcode =~ /^[Tt](\d)/) {
187 (defined($1) and $1 eq '0') and return $barcode;
188 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
190 return sprintf("T%07d", $barcode);
191 # FIXME: $barcode could be "T1", causing warning: substr outside of string
192 # Why drop the nonzero digit after the T?
193 # Why pass non-digits (or empty string) to "T%07d"?
194 } elsif ($filter eq 'libsuite8') {
195 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
196 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
197 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
199 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
202 } elsif ($filter eq 'EAN13') {
203 my $ean = CheckDigits('ean');
204 if ( $ean->is_valid($barcode) ) {
205 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
206 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
208 warn "# [$barcode] not valid EAN-13/UPC-A\n";
211 return $barcode; # return barcode, modified or not
216 $str = &decode($chunk);
218 Decodes a segment of a string emitted by a CueCat barcode scanner and
221 FIXME: Should be replaced with Barcode::Cuecat from CPAN
222 or Javascript based decoding on the client side.
229 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
230 my @s = map { index( $seq, $_ ); } split( //, $encoded );
231 my $l = ( $#s + 1 ) % 4;
234 # warn "Error: Cuecat decode parsing failed!";
242 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
244 chr( ( $n >> 16 ) ^ 67 )
245 .chr( ( $n >> 8 & 255 ) ^ 67 )
246 .chr( ( $n & 255 ) ^ 67 );
249 $r = substr( $r, 0, length($r) - $l );
255 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
256 $barcode, $ignore_reserves);
258 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
260 C<$newbranch> is the code for the branch to which the item should be transferred.
262 C<$barcode> is the barcode of the item to be transferred.
264 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
265 Otherwise, if an item is reserved, the transfer fails.
267 Returns three values:
273 is true if the transfer was successful.
277 is a reference-to-hash which may have any of the following keys:
283 There is no item in the catalog with the given barcode. The value is C<$barcode>.
285 =item C<DestinationEqualsHolding>
287 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.
291 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.
295 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>.
297 =item C<WasTransferred>
299 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
308 my ( $tbr, $barcode, $ignoreRs ) = @_;
311 my $item = Koha::Items->find( { barcode => $barcode } );
315 $messages->{'BadBarcode'} = $barcode;
319 my $itemnumber = $item->itemnumber;
320 my $issue = GetOpenIssue($itemnumber);
321 # get branches of book...
322 my $hbr = $item->homebranch;
323 my $fbr = $item->holdingbranch;
325 # if using Branch Transfer Limits
326 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
327 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
328 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
329 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
330 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
333 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
334 $messages->{'NotAllowed'} = $tbr . "::" . $code;
339 # can't transfer book if is already there....
340 if ( $fbr eq $tbr ) {
341 $messages->{'DestinationEqualsHolding'} = 1;
345 # check if it is still issued to someone, return it...
347 AddReturn( $barcode, $fbr );
348 $messages->{'WasReturned'} = $issue->borrowernumber;
352 # That'll save a database query.
353 my ( $resfound, $resrec, undef ) =
354 CheckReserves( $itemnumber );
355 if ( $resfound and not $ignoreRs ) {
356 $resrec->{'ResFound'} = $resfound;
358 # $messages->{'ResFound'} = $resrec;
362 #actually do the transfer....
364 ModItemTransfer( $itemnumber, $fbr, $tbr );
366 # don't need to update MARC anymore, we do it in batch now
367 $messages->{'WasTransfered'} = 1;
370 ModDateLastSeen( $itemnumber );
371 return ( $dotransfer, $messages );
376 my $borrower = shift;
377 my $biblionumber = 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,$borrower);
387 my $type = (C4::Context->preference('item-level_itypes'))
388 ? $item->{'itype'} # item-level
389 : $item->{'itemtype'}; # biblio-level
391 # given branch, patron category, and item type, determine
392 # applicable issuing rule
393 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
395 categorycode => $cat_borrower,
397 branchcode => $branch,
398 rule_name => 'maxissueqty',
401 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
403 categorycode => $cat_borrower,
405 branchcode => $branch,
406 rule_name => 'maxonsiteissueqty',
411 # if a rule is found and has a loan limit set, count
412 # how many loans the patron already has that meet that
414 if (defined($maxissueqty_rule) and defined($maxissueqty_rule->rule_value)) {
417 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
419 JOIN items USING (itemnumber)
422 my $rule_itemtype = $maxissueqty_rule->itemtype;
423 unless ($rule_itemtype) {
424 # matching rule has the default item type, so count only
425 # those existing loans that don't fall under a more
427 if (C4::Context->preference('item-level_itypes')) {
428 $count_query .= " WHERE items.itype NOT IN (
429 SELECT itemtype FROM issuingrules
431 AND (categorycode = ? OR categorycode = ?)
435 $count_query .= " JOIN biblioitems USING (biblionumber)
436 WHERE biblioitems.itemtype NOT IN (
437 SELECT itemtype FROM issuingrules
439 AND (categorycode = ? OR categorycode = ?)
443 push @bind_params, $maxissueqty_rule->branchcode;
444 push @bind_params, $maxissueqty_rule->categorycode;
445 push @bind_params, $cat_borrower;
447 # rule has specific item type, so count loans of that
449 if (C4::Context->preference('item-level_itypes')) {
450 $count_query .= " WHERE items.itype = ? ";
452 $count_query .= " JOIN biblioitems USING (biblionumber)
453 WHERE biblioitems.itemtype= ? ";
455 push @bind_params, $type;
458 $count_query .= " AND borrowernumber = ? ";
459 push @bind_params, $borrower->{'borrowernumber'};
460 my $rule_branch = $maxissueqty_rule->branchcode;
461 unless ($rule_branch) {
462 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
463 $count_query .= " AND issues.branchcode = ? ";
464 push @bind_params, $branch;
465 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
466 ; # if branch is the patron's home branch, then count all loans by patron
468 $count_query .= " AND items.homebranch = ? ";
469 push @bind_params, $branch;
473 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
475 my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
476 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
478 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
479 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
481 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
482 count => $onsite_checkout_count,
483 max_allowed => $max_onsite_checkouts_allowed,
487 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
488 my $delta = $switch_onsite_checkout ? 1 : 0;
489 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
491 reason => 'TOO_MANY_CHECKOUTS',
492 count => $checkout_count,
493 max_allowed => $max_checkouts_allowed,
496 } elsif ( not $onsite_checkout ) {
497 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
499 reason => 'TOO_MANY_CHECKOUTS',
500 count => $checkout_count - $onsite_checkout_count,
501 max_allowed => $max_checkouts_allowed,
507 # Now count total loans against the limit for the branch
508 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
509 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
510 my @bind_params = ();
511 my $branch_count_query = q|
512 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
514 JOIN items USING (itemnumber)
515 WHERE borrowernumber = ?
517 push @bind_params, $borrower->{borrowernumber};
519 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
520 $branch_count_query .= " AND issues.branchcode = ? ";
521 push @bind_params, $branch;
522 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
523 ; # if branch is the patron's home branch, then count all loans by patron
525 $branch_count_query .= " AND items.homebranch = ? ";
526 push @bind_params, $branch;
528 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
529 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
530 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
532 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
533 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
535 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
536 count => $onsite_checkout_count,
537 max_allowed => $max_onsite_checkouts_allowed,
541 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
542 my $delta = $switch_onsite_checkout ? 1 : 0;
543 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
545 reason => 'TOO_MANY_CHECKOUTS',
546 count => $checkout_count,
547 max_allowed => $max_checkouts_allowed,
550 } elsif ( not $onsite_checkout ) {
551 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
553 reason => 'TOO_MANY_CHECKOUTS',
554 count => $checkout_count - $onsite_checkout_count,
555 max_allowed => $max_checkouts_allowed,
561 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
562 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
565 # OK, the patron can issue !!!
569 =head2 CanBookBeIssued
571 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
572 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
574 Check if a book can be issued.
576 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
578 IMPORTANT: The assumption by users of this routine is that causes blocking
579 the issue are keyed by uppercase labels and other returned
580 data is keyed in lower case!
584 =item C<$patron> is a Koha::Patron
586 =item C<$barcode> is the bar code of the book being issued.
588 =item C<$duedates> is a DateTime object.
590 =item C<$inprocess> boolean switch
592 =item C<$ignore_reserves> boolean switch
594 =item C<$params> Hashref of additional parameters
597 override_high_holds - Ignore high holds
598 onsite_checkout - Checkout is an onsite checkout that will not leave the library
606 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
607 Possible values are :
613 sticky due date is invalid
617 borrower gone with no address
621 borrower declared it's card lost
627 =head3 UNKNOWN_BARCODE
641 item is restricted (set by ??)
643 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
644 could be prevented, but ones that can be overriden by the operator.
646 Possible values are :
654 renewing, not issuing
656 =head3 ISSUED_TO_ANOTHER
658 issued to someone else.
662 reserved for someone else.
666 sticky due date is invalid or due date in the past
670 if the borrower borrows to much things
674 sub CanBookBeIssued {
675 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
676 my %needsconfirmation; # filled with problems that needs confirmations
677 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
678 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
679 my %messages; # filled with information messages that should be displayed.
681 my $onsite_checkout = $params->{onsite_checkout} || 0;
682 my $override_high_holds = $params->{override_high_holds} || 0;
684 my $item = Koha::Items->find({barcode => $barcode });
686 # MANDATORY CHECKS - unless item exists, nothing else matters
687 unless ( $item_object ) {
688 $issuingimpossible{UNKNOWN_BARCODE} = 1;
690 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
692 my $item_unblessed = $item->unblessed; # Transition...
693 my $issue = $item->checkout;
694 my $biblio = $item->biblio;
696 my $biblioitem = $biblio->biblioitem;
697 my $effective_itemtype = $item->effective_itemtype;
698 my $dbh = C4::Context->dbh;
699 my $patron_unblessed = $patron->unblessed;
701 my $library = Koha::Libraries->find( _GetCircControlBranch($item, $patron_unblessed) );
703 # DUE DATE is OK ? -- should already have checked.
705 if ($duedate && ref $duedate ne 'DateTime') {
706 $duedate = dt_from_string($duedate);
708 my $now = DateTime->now( time_zone => C4::Context->tz() );
709 unless ( $duedate ) {
710 my $issuedate = $now->clone();
712 my $branch = _GetCircControlBranch($item_unblessed, $patron_unblessed);
713 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $branch, $patron_unblessed );
715 # Offline circ calls AddIssue directly, doesn't run through here
716 # So issuingimpossible should be ok.
719 my $fees = Koha::Charges::Fees->new(
723 item => $item_object,
729 my $today = $now->clone();
730 $today->truncate( to => 'minute');
731 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
732 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
735 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
741 if ( $patron->category->category_type eq 'X' && ( $item->barcode )) {
742 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
744 branch => C4::Context->userenv->{'branch'},
746 itemnumber => $item->itemnumber,
747 itemtype => $effective_itemtype,
748 borrowernumber => $patron->borrowernumber,
749 ccode => $item->ccode}
751 ModDateLastSeen( $item->itemnumber ); # FIXME Move to Koha::Item
752 return( { STATS => 1 }, {});
755 if ( $patron->gonenoaddress == 1 ) {
756 $issuingimpossible{GNA} = 1;
759 if ( $patron->lost == 1 ) {
760 $issuingimpossible{CARD_LOST} = 1;
762 if ( $patron->is_debarred ) {
763 $issuingimpossible{DEBARRED} = 1;
766 if ( $patron->is_expired ) {
767 $issuingimpossible{EXPIRED} = 1;
775 my $account = $patron->account;
776 my $balance = $account->balance;
777 my $non_issues_charges = $account->non_issues_charges;
778 my $other_charges = $balance - $non_issues_charges;
780 my $amountlimit = C4::Context->preference("noissuescharge");
781 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
782 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
784 # Check the debt of this patrons guarantees
785 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
786 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
787 if ( defined $no_issues_charge_guarantees ) {
788 my @guarantees = $patron->guarantees();
789 my $guarantees_non_issues_charges;
790 foreach my $g ( @guarantees ) {
791 $guarantees_non_issues_charges += $g->account->non_issues_charges;
794 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
795 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
796 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
797 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
798 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
799 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
803 if ( C4::Context->preference("IssuingInProcess") ) {
804 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
805 $issuingimpossible{DEBT} = $non_issues_charges;
806 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
807 $needsconfirmation{DEBT} = $non_issues_charges;
808 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
809 $needsconfirmation{DEBT} = $non_issues_charges;
813 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
814 $needsconfirmation{DEBT} = $non_issues_charges;
815 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
816 $issuingimpossible{DEBT} = $non_issues_charges;
817 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
818 $needsconfirmation{DEBT} = $non_issues_charges;
822 if ($balance > 0 && $other_charges > 0) {
823 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
826 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
827 $patron_unblessed = $patron->unblessed;
829 if ( my $debarred_date = $patron->is_debarred ) {
830 # patron has accrued fine days or has a restriction. $count is a date
831 if ($debarred_date eq '9999-12-31') {
832 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
835 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
837 } elsif ( my $num_overdues = $patron->has_overdues ) {
838 ## patron has outstanding overdue loans
839 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
840 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
842 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
843 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
848 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
850 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
852 # Already issued to current borrower.
853 # If it is an on-site checkout if it can be switched to a normal checkout
854 # or ask whether the loan should be renewed
856 if ( $issue->onsite_checkout
857 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
858 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
860 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
861 $patron->borrowernumber,
864 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
865 if ( $renewerror eq 'onsite_checkout' ) {
866 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
869 $issuingimpossible{NO_MORE_RENEWALS} = 1;
873 $needsconfirmation{RENEW_ISSUE} = 1;
879 # issued to someone else
881 my $patron = Koha::Patrons->find( $issue->borrowernumber );
883 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
885 unless ( $can_be_returned ) {
886 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
887 $issuingimpossible{branch_to_return} = $message;
889 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
890 $needsconfirmation{issued_firstname} = $patron->firstname;
891 $needsconfirmation{issued_surname} = $patron->surname;
892 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
893 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
897 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
899 my $switch_onsite_checkout = (
900 C4::Context->preference('SwitchOnSiteCheckouts')
902 and $issue->onsite_checkout
903 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
904 my $toomany = TooMany( $patron_unblessed, $item->biblionumber, $item_unblessed, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
905 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
906 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
907 if ( $toomany->{max_allowed} == 0 ) {
908 $needsconfirmation{PATRON_CANT} = 1;
910 if ( C4::Context->preference("AllowTooManyOverride") ) {
911 $needsconfirmation{TOO_MANY} = $toomany->{reason};
912 $needsconfirmation{current_loan_count} = $toomany->{count};
913 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
915 $issuingimpossible{TOO_MANY} = $toomany->{reason};
916 $issuingimpossible{current_loan_count} = $toomany->{count};
917 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
922 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
924 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
925 my $wants_check = $patron->wants_check_for_previous_checkout;
926 $needsconfirmation{PREVISSUE} = 1
927 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
932 if ( $item->notforloan )
934 if(!C4::Context->preference("AllowNotForLoanOverride")){
935 $issuingimpossible{NOT_FOR_LOAN} = 1;
936 $issuingimpossible{item_notforloan} = $item->notforloan;
938 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
939 $needsconfirmation{item_notforloan} = $item->notforloan;
943 # we have to check itemtypes.notforloan also
944 if (C4::Context->preference('item-level_itypes')){
945 # this should probably be a subroutine
946 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
947 $sth->execute($effective_itemtype);
948 my $notforloan=$sth->fetchrow_hashref();
949 if ($notforloan->{'notforloan'}) {
950 if (!C4::Context->preference("AllowNotForLoanOverride")) {
951 $issuingimpossible{NOT_FOR_LOAN} = 1;
952 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
954 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
955 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
960 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
961 if ( $itemtype and $itemtype->notforloan == 1){
962 if (!C4::Context->preference("AllowNotForLoanOverride")) {
963 $issuingimpossible{NOT_FOR_LOAN} = 1;
964 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
966 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
967 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
972 if ( $item->withdrawn && $item->withdrawn > 0 )
974 $issuingimpossible{WTHDRAWN} = 1;
976 if ( $item->restricted
977 && $item->restricted == 1 )
979 $issuingimpossible{RESTRICTED} = 1;
981 if ( $item->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
982 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->itemlost });
983 my $code = $av->count ? $av->next->lib : '';
984 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
985 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
987 if ( C4::Context->preference("IndependentBranches") ) {
988 my $userenv = C4::Context->userenv;
989 unless ( C4::Context->IsSuperLibrarian() ) {
990 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
991 if ( $item->$HomeOrHoldingBranch ne $userenv->{branch} ){
992 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
993 $issuingimpossible{'itemhomebranch'} = $item->$HomeOrHoldingBranch;
995 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
996 if ( $patron->branchcode ne $userenv->{branch} );
1000 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1002 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1004 if ( $rentalConfirmation ){
1005 my ($rentalCharge) = GetIssuingCharges( $item->itemnumber, $patron->borrowernumber );
1006 my $itemtype = Koha::ItemTypes->find( $item->itype ); # GetItem sets effective itemtype
1007 $rentalCharge += $fees->accumulate_rentalcharge({ from => dt_from_string(), to => $duedate });
1008 if ( $rentalCharge > 0 ){
1009 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1013 unless ( $ignore_reserves ) {
1014 # See if the item is on reserve.
1015 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->itemnumber );
1017 my $resbor = $res->{'borrowernumber'};
1018 if ( $resbor ne $patron->borrowernumber ) {
1019 my $patron = Koha::Patrons->find( $resbor );
1020 if ( $restype eq "Waiting" )
1022 # The item is on reserve and waiting, but has been
1023 # reserved by some other patron.
1024 $needsconfirmation{RESERVE_WAITING} = 1;
1025 $needsconfirmation{'resfirstname'} = $patron->firstname;
1026 $needsconfirmation{'ressurname'} = $patron->surname;
1027 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1028 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1029 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1030 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1032 elsif ( $restype eq "Reserved" ) {
1033 # The item is on reserve for someone else.
1034 $needsconfirmation{RESERVED} = 1;
1035 $needsconfirmation{'resfirstname'} = $patron->firstname;
1036 $needsconfirmation{'ressurname'} = $patron->surname;
1037 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1038 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1039 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1040 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1046 ## CHECK AGE RESTRICTION
1047 my $agerestriction = $biblioitem->agerestriction;
1048 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1049 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1050 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1051 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1054 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1058 ## check for high holds decreasing loan period
1059 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1060 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1062 if ( $check->{exceeded} ) {
1063 if ($override_high_holds) {
1064 $alerts{HIGHHOLDS} = {
1065 num_holds => $check->{outstanding},
1066 duration => $check->{duration},
1067 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1071 $needsconfirmation{HIGHHOLDS} = {
1072 num_holds => $check->{outstanding},
1073 duration => $check->{duration},
1074 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1081 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1082 # don't do the multiple loans per bib check if we've
1083 # already determined that we've got a loan on the same item
1084 !$issuingimpossible{NO_MORE_RENEWALS} &&
1085 !$needsconfirmation{RENEW_ISSUE}
1087 # Check if borrower has already issued an item from the same biblio
1088 # Only if it's not a subscription
1089 my $biblionumber = $item->biblionumber;
1090 require C4::Serials;
1091 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1092 unless ($is_a_subscription) {
1093 # FIXME Should be $patron->checkouts($args);
1094 my $checkouts = Koha::Checkouts->search(
1096 borrowernumber => $patron->borrowernumber,
1097 biblionumber => $biblionumber,
1103 # if we get here, we don't already have a loan on this item,
1104 # so if there are any loans on this bib, ask for confirmation
1105 if ( $checkouts->count ) {
1106 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1111 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1114 =head2 CanBookBeReturned
1116 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1118 Check whether the item can be returned to the provided branch
1122 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1124 =item C<$branch> is the branchcode where the return is taking place
1132 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1134 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1140 sub CanBookBeReturned {
1141 my ($item, $branch) = @_;
1142 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1144 # assume return is allowed to start
1148 # identify all cases where return is forbidden
1149 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1151 $message = $item->{'homebranch'};
1152 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1154 $message = $item->{'holdingbranch'};
1155 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1157 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1160 return ($allowed, $message);
1163 =head2 CheckHighHolds
1165 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1166 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1167 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1171 sub checkHighHolds {
1172 my ( $item, $borrower ) = @_;
1173 my $branch = _GetCircControlBranch( $item, $borrower );
1174 my $item_object = Koha::Items->find( $item->{itemnumber} );
1183 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1185 if ( $holds->count() ) {
1186 $return_data->{outstanding} = $holds->count();
1188 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1189 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1190 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1192 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1194 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1196 # static means just more than a given number of holds on the record
1198 # If the number of holds is less than the threshold, we can stop here
1199 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1200 return $return_data;
1203 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1205 # dynamic means X more than the number of holdable items on the record
1207 # let's get the items
1208 my @items = $holds->next()->biblio()->items();
1210 # Remove any items with status defined to be ignored even if the would not make item unholdable
1211 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1212 @items = grep { !$_->$status } @items;
1215 # Remove any items that are not holdable for this patron
1216 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber )->{status} eq 'OK' } @items;
1218 my $items_count = scalar @items;
1220 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1222 # If the number of holds is less than the count of items we have
1223 # plus the number of holds allowed above that count, we can stop here
1224 if ( $holds->count() <= $threshold ) {
1225 return $return_data;
1229 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1231 my $calendar = Koha::Calendar->new( branchcode => $branch );
1233 my $itype = $item_object->effective_itemtype;
1234 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1236 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1238 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1239 $reduced_datedue->set_hour($orig_due->hour);
1240 $reduced_datedue->set_minute($orig_due->minute);
1241 $reduced_datedue->truncate( to => 'minute' );
1243 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1244 $return_data->{exceeded} = 1;
1245 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1246 $return_data->{due_date} = $reduced_datedue;
1250 return $return_data;
1255 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1257 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1261 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1263 =item C<$barcode> is the barcode of the item being issued.
1265 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1266 Calculated if empty.
1268 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1270 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1271 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1273 AddIssue does the following things :
1275 - step 01: check that there is a borrowernumber & a barcode provided
1276 - check for RENEWAL (book issued & being issued to the same patron)
1277 - renewal YES = Calculate Charge & renew
1279 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1281 - fill reserve if reserve to this patron
1282 - cancel reserve or not, otherwise
1283 * TRANSFERT PENDING ?
1284 - complete the transfert
1292 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1294 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1295 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1296 my $auto_renew = $params && $params->{auto_renew};
1297 my $dbh = C4::Context->dbh;
1298 my $barcodecheck = CheckValidBarcode($barcode);
1302 if ( $datedue && ref $datedue ne 'DateTime' ) {
1303 $datedue = dt_from_string($datedue);
1306 # $issuedate defaults to today.
1307 if ( !defined $issuedate ) {
1308 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1311 if ( ref $issuedate ne 'DateTime' ) {
1312 $issuedate = dt_from_string($issuedate);
1317 # Stop here if the patron or barcode doesn't exist
1318 if ( $borrower && $barcode && $barcodecheck ) {
1319 # find which item we issue
1320 my $item = Koha::Items->find({ barcode => $barcode })
1321 or return; # if we don't get an Item, abort.
1322 my $item_unblessed = $item->unblessed;
1324 my $branch = _GetCircControlBranch( $item_unblessed, $borrower );
1326 # get actual issuing if there is one
1327 my $actualissue = $item->checkout;
1329 # check if we just renew the issue.
1330 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1331 and not $switch_onsite_checkout ) {
1332 $datedue = AddRenewal(
1333 $borrower->{'borrowernumber'},
1337 $issuedate, # here interpreted as the renewal date
1342 my $itype = $item_object->effective_itemtype;
1343 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1346 $datedue->truncate( to => 'minute' );
1348 my $patron = Koha::Patrons->find( $borrower );
1349 my $library = Koha::Libraries->find( $branch );
1350 my $fees = Koha::Charges::Fees->new(
1353 library => $library,
1354 item => $item_object,
1355 to_date => $datedue,
1359 # it's NOT a renewal
1360 if ( $actualissue and not $switch_onsite_checkout ) {
1361 # This book is currently on loan, but not to the person
1362 # who wants to borrow it now. mark it returned before issuing to the new borrower
1363 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1364 return unless $allowed;
1365 AddReturn( $item->barcode, C4::Context->userenv->{'branch'} );
1368 C4::Reserves::MoveReserve( $item->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1370 # Starting process for transfer job (checking transfert and validate it if we have one)
1371 my ($datesent) = GetTransfers( $item->itemnumber );
1373 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1374 my $sth = $dbh->prepare(
1375 "UPDATE branchtransfers
1376 SET datearrived = now(),
1378 comments = 'Forced branchtransfer'
1379 WHERE itemnumber= ? AND datearrived IS NULL"
1381 $sth->execute( C4::Context->userenv->{'branch'},
1382 $item->itemnumber );
1385 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1386 unless ($auto_renew) {
1387 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1388 { categorycode => $borrower->{categorycode},
1389 itemtype => $item->effective_itemtype,
1390 branchcode => $branch
1394 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1397 # Record in the database the fact that the book was issued.
1399 my $itype = $item->effective_itemtype;
1400 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1403 $datedue->truncate( to => 'minute' );
1405 my $issue_attributes = {
1406 borrowernumber => $borrower->{'borrowernumber'},
1407 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1408 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1409 branchcode => C4::Context->userenv->{'branch'},
1410 onsite_checkout => $onsite_checkout,
1411 auto_renew => $auto_renew ? 1 : 0,
1414 $issue = Koha::Checkouts->find( { itemnumber => $item->itemnumber } );
1416 $issue->set($issue_attributes)->store;
1419 $issue = Koha::Checkout->new(
1421 itemnumber => $item->itemnumber,
1427 if ( C4::Context->preference('ReturnToShelvingCart') ) {
1428 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1429 CartToShelf( $item->itemnumber );
1432 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1433 UpdateTotalIssues( $item->biblionumber, 1 );
1436 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1437 if ( $item->itemlost ) {
1439 Koha::RefundLostItemFeeRules->should_refund(
1441 current_branch => C4::Context->userenv->{branch},
1442 item_home_branch => $item->homebranch,
1443 item_holding_branch => $item->holdingbranch,
1448 _FixAccountForLostAndReturned( $item->itemnumber, undef,
1455 issues => $item->issues + 1,
1456 holdingbranch => C4::Context->userenv->{'branch'},
1458 onloan => $datedue->ymd(),
1459 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1461 $item->biblionumber,
1465 ModDateLastSeen( $item->itemnumber );
1467 # If it costs to borrow this book, charge it to the patron's account.
1468 my ( $charge, $itemtype ) = GetIssuingCharges( $item->itemnumber, $borrower->{'borrowernumber'} );
1469 if ( $charge > 0 ) {
1470 my $description = "Rental";
1471 AddIssuingCharge( $issue, $charge, $description );
1474 my $itemtype = Koha::ItemTypes->find( $item_object->effective_itemtype );
1476 my $accumulate_charge = $fees->accumulate_rentalcharge();
1477 if ( $accumulate_charge > 0 ) {
1478 AddIssuingCharge( $issue, $accumulate_charge, 'Daily rental' ) if $accumulate_charge > 0;
1479 $charge += $accumulate_charge;
1480 $item->{charge} = $charge;
1484 # Record the fact that this book was issued.
1487 branch => C4::Context->userenv->{'branch'},
1488 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1490 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1491 itemnumber => $item->itemnumber,
1492 itemtype => $item->effective_itemtype,
1493 location => $item->location,
1494 borrowernumber => $borrower->{'borrowernumber'},
1495 ccode => $item->ccode,
1499 # Send a checkout slip.
1500 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1502 branchcode => $branch,
1503 categorycode => $borrower->{categorycode},
1504 item_type => $item->effective_itemtype,
1505 notification => 'CHECKOUT',
1507 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1508 SendCirculationAlert(
1511 item => $item->unblessed,
1512 borrower => $borrower,
1518 "CIRCULATION", "ISSUE",
1519 $borrower->{'borrowernumber'},
1521 ) if C4::Context->preference("IssueLog");
1527 =head2 GetLoanLength
1529 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1531 Get loan length for an itemtype, a borrower type and a branch
1536 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1537 my $dbh = C4::Context->dbh;
1538 my $sth = $dbh->prepare(qq{
1539 SELECT issuelength, lengthunit, renewalperiod
1541 WHERE categorycode=?
1544 AND issuelength IS NOT NULL
1547 # try to find issuelength & return the 1st available.
1548 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1549 $sth->execute( $borrowertype, $itemtype, $branchcode );
1550 my $loanlength = $sth->fetchrow_hashref;
1553 if defined($loanlength) && defined $loanlength->{issuelength};
1555 $sth->execute( $borrowertype, '*', $branchcode );
1556 $loanlength = $sth->fetchrow_hashref;
1558 if defined($loanlength) && defined $loanlength->{issuelength};
1560 $sth->execute( '*', $itemtype, $branchcode );
1561 $loanlength = $sth->fetchrow_hashref;
1563 if defined($loanlength) && defined $loanlength->{issuelength};
1565 $sth->execute( '*', '*', $branchcode );
1566 $loanlength = $sth->fetchrow_hashref;
1568 if defined($loanlength) && defined $loanlength->{issuelength};
1570 $sth->execute( $borrowertype, $itemtype, '*' );
1571 $loanlength = $sth->fetchrow_hashref;
1573 if defined($loanlength) && defined $loanlength->{issuelength};
1575 $sth->execute( $borrowertype, '*', '*' );
1576 $loanlength = $sth->fetchrow_hashref;
1578 if defined($loanlength) && defined $loanlength->{issuelength};
1580 $sth->execute( '*', $itemtype, '*' );
1581 $loanlength = $sth->fetchrow_hashref;
1583 if defined($loanlength) && defined $loanlength->{issuelength};
1585 $sth->execute( '*', '*', '*' );
1586 $loanlength = $sth->fetchrow_hashref;
1588 if defined($loanlength) && defined $loanlength->{issuelength};
1590 # if no rule is set => 0 day (hardcoded)
1594 lengthunit => 'days',
1600 =head2 GetHardDueDate
1602 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1604 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1608 sub GetHardDueDate {
1609 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1611 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1612 { categorycode => $borrowertype,
1613 itemtype => $itemtype,
1614 branchcode => $branchcode
1619 if ( defined( $issuing_rule ) ) {
1620 if ( $issuing_rule->hardduedate ) {
1621 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1623 return (undef, undef);
1628 =head2 GetBranchBorrowerCircRule
1630 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1632 Retrieves circulation rule attributes that apply to the given
1633 branch and patron category, regardless of item type.
1634 The return value is a hashref containing the following key:
1636 patron_maxissueqty - maximum number of loans that a
1637 patron of the given category can have at the given
1638 branch. If the value is undef, no limit.
1640 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1641 patron of the given category can have at the given
1642 branch. If the value is undef, no limit.
1644 This will check for different branch/category combinations in the following order:
1648 default branch and category
1650 If no rule has been found in the database, it will default to
1653 patron_maxissueqty - undef
1654 patron_maxonsiteissueqty - undef
1656 C<$branchcode> and C<$categorycode> should contain the
1657 literal branch code and patron category code, respectively - no
1662 sub GetBranchBorrowerCircRule {
1663 my ( $branchcode, $categorycode ) = @_;
1665 # Initialize default values
1667 patron_maxissueqty => undef,
1668 patron_maxonsiteissueqty => undef,
1672 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1673 my $rule = Koha::CirculationRules->get_effective_rule(
1675 categorycode => $categorycode,
1677 branchcode => $branchcode,
1678 rule_name => $rule_name,
1682 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1688 =head2 GetBranchItemRule
1690 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1692 Retrieves circulation rule attributes that apply to the given
1693 branch and item type, regardless of patron category.
1695 The return value is a hashref containing the following keys:
1697 holdallowed => Hold policy for this branch and itemtype. Possible values:
1698 0: No holds allowed.
1699 1: Holds allowed only by patrons that have the same homebranch as the item.
1700 2: Holds allowed from any patron.
1702 returnbranch => branch to which to return item. Possible values:
1703 noreturn: do not return, let item remain where checked in (floating collections)
1704 homebranch: return to item's home branch
1705 holdingbranch: return to issuer branch
1707 This searches branchitemrules in the following order:
1709 * Same branchcode and itemtype
1710 * Same branchcode, itemtype '*'
1711 * branchcode '*', same itemtype
1712 * branchcode and itemtype '*'
1714 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1718 sub GetBranchItemRule {
1719 my ( $branchcode, $itemtype ) = @_;
1720 my $dbh = C4::Context->dbh();
1724 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1725 FROM branch_item_rules
1726 WHERE branchcode = ?
1727 AND itemtype = ?', $branchcode, $itemtype],
1728 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1729 FROM default_branch_circ_rules
1730 WHERE branchcode = ?', $branchcode],
1731 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1732 FROM default_branch_item_rules
1733 WHERE itemtype = ?', $itemtype],
1734 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1735 FROM default_circ_rules'],
1738 foreach my $attempt (@attempts) {
1739 my ($query, @bind_params) = @{$attempt};
1740 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1743 # Since branch/category and branch/itemtype use the same per-branch
1744 # defaults tables, we have to check that the key we want is set, not
1745 # just that a row was returned
1746 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1747 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1748 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1751 # built-in default circulation rule
1752 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1753 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1754 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1761 ($doreturn, $messages, $iteminformation, $borrower) =
1762 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1768 =item C<$barcode> is the bar code of the book being returned.
1770 =item C<$branch> is the code of the branch where the book is being returned.
1772 =item C<$exemptfine> indicates that overdue charges for the item will be
1775 =item C<$dropbox> indicates that the check-in date is assumed to be
1776 yesterday, or the last non-holiday as defined in C4::Calendar . If
1777 overdue charges are applied and C<$dropbox> is true, the last charge
1778 will be removed. This assumes that the fines accrual script has run
1779 for _today_. Optional.
1781 =item C<$return_date> allows the default return date to be overridden
1782 by the given return date. Optional.
1786 C<&AddReturn> returns a list of four items:
1788 C<$doreturn> is true iff the return succeeded.
1790 C<$messages> is a reference-to-hash giving feedback on the operation.
1791 The keys of the hash are:
1797 No item with this barcode exists. The value is C<$barcode>.
1801 The book is not currently on loan. The value is C<$barcode>.
1805 This book has been withdrawn/cancelled. The value should be ignored.
1807 =item C<Wrongbranch>
1809 This book has was returned to the wrong branch. The value is a hashref
1810 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1811 contain the branchcode of the incorrect and correct return library, respectively.
1815 The item was reserved. The value is a reference-to-hash whose keys are
1816 fields from the reserves table of the Koha database, and
1817 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1818 either C<Waiting>, C<Reserved>, or 0.
1820 =item C<WasReturned>
1822 Value 1 if return is successful.
1824 =item C<NeedsTransfer>
1826 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1830 C<$iteminformation> is a reference-to-hash, giving information about the
1831 returned item from the issues table.
1833 C<$borrower> is a reference-to-hash, giving information about the
1834 patron who last borrowed the book.
1839 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1841 if ($branch and not Koha::Libraries->find($branch)) {
1842 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1845 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1849 my $validTransfert = 0;
1850 my $stat_type = 'return';
1852 # get information on item
1853 my $item = Koha::Items->find({ barcode => $barcode });
1855 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1858 my $itemnumber = $item->itemnumber;
1859 my $itemtype = $item->effective_itemtype;
1861 my $issue = $item->checkout;
1863 $patron = $issue->patron
1864 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1865 . Dumper($issue->unblessed) . "\n";
1867 $messages->{'NotIssued'} = $barcode;
1868 ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1869 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1871 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1872 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1873 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1874 $messages->{'LocalUse'} = 1;
1875 $stat_type = 'localuse';
1879 my $item_unblessed = $item->unblessed;
1880 if ( $item->location eq 'PROC' ) {
1881 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1882 $item_unblessed->{location} = 'CART';
1885 $item_unblessed->{location} = $item->permanent_location;
1888 ModItem( $item_unblessed, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1891 # full item data, but no borrowernumber or checkout info (no issue)
1892 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1893 # get the proper branch to which to return the item
1894 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1895 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1897 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1898 my $patron_unblessed = $patron ? $patron->unblessed : {};
1900 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1902 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1904 eval { $rules = YAML::Load($yaml); };
1906 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1909 foreach my $key ( keys %$rules ) {
1910 if ( $item->notforloan eq $key ) {
1911 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1912 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1919 # check if the return is allowed at this branch
1920 my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1921 unless ($returnallowed){
1922 $messages->{'Wrongbranch'} = {
1923 Wrongbranch => $branch,
1924 Rightbranch => $message
1927 return ( $doreturn, $messages, $issue, $patron_unblessed);
1930 if ( $item->withdrawn ) { # book has been cancelled
1931 $messages->{'withdrawn'} = 1;
1932 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1935 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1939 # case of a return of document (deal with issues and holdingbranch)
1940 my $today = DateTime->now( time_zone => C4::Context->tz() );
1944 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1945 $patron or warn "AddReturn without current borrower";
1947 $is_overdue = $issue->is_overdue( $dropboxdate );
1949 $is_overdue = $issue->is_overdue;
1955 MarkIssueReturned( $borrowernumber, $item->itemnumber,
1956 $dropboxdate, $patron->privacy );
1959 MarkIssueReturned( $borrowernumber, $item->itemnumber,
1960 $return_date, $patron->privacy );
1964 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1965 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1968 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 );
1970 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1973 # FIXME is the "= 1" right? This could be the borrower hash.
1974 $messages->{'WasReturned'} = 1;
1978 ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1981 # the holdingbranch is updated if the document is returned to another location.
1982 # this is always done regardless of whether the item was on loan or not
1983 my $item_holding_branch = $item->holdingbranch;
1984 if ($item->holdingbranch ne $branch) {
1985 UpdateHoldingbranch($branch, $item->itemnumber);
1986 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1989 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1990 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
1992 # check if we have a transfer for this document
1993 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
1995 # if we have a transfer to do, we update the line of transfers with the datearrived
1996 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
1998 if ( $tobranch eq $branch ) {
1999 my $sth = C4::Context->dbh->prepare(
2000 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2002 $sth->execute( $item->itemnumber );
2003 # if we have a reservation with valid transfer, we can set it's status to 'W'
2004 ShelfToCart( $item->itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
2005 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2007 $messages->{'WrongTransfer'} = $tobranch;
2008 $messages->{'WrongTransferItem'} = $item->itemnumber;
2010 $validTransfert = 1;
2012 ShelfToCart( $item->itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
2015 # fix up the accounts.....
2016 if ( $item->itemlost ) {
2017 $messages->{'WasLost'} = 1;
2018 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2020 Koha::RefundLostItemFeeRules->should_refund(
2022 current_branch => C4::Context->userenv->{branch},
2023 item_home_branch => $item->homebranch,
2024 item_holding_branch => $item_holding_branch
2029 _FixAccountForLostAndReturned( $item->itemnumber,
2030 $borrowernumber, $barcode );
2031 $messages->{'LostItemFeeRefunded'} = 1;
2036 # fix up the overdues in accounts...
2037 if ($borrowernumber) {
2038 my $fix = _FixOverduesOnReturn($borrowernumber, $item->itemnumber, $exemptfine, $dropbox);
2039 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2041 if ( $issue and $issue->is_overdue ) {
2043 $today = dt_from_string($return_date) if $return_date;
2044 $today = $dropboxdate if $dropbox;
2045 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $today );
2047 $messages->{'PrevDebarred'} = $debardate;
2049 $messages->{'Debarred'} = $debardate if $debardate;
2051 # there's no overdue on the item but borrower had been previously debarred
2052 } elsif ( $issue->date_due and $patron->debarred ) {
2053 if ( $patron->debarred eq "9999-12-31") {
2054 $messages->{'ForeverDebarred'} = $patron->debarred;
2056 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2057 $borrower_debar_dt->truncate(to => 'day');
2058 my $today_dt = $today->clone()->truncate(to => 'day');
2059 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2060 $messages->{'PrevDebarred'} = $patron->debarred;
2066 # find reserves.....
2067 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2068 my ($resfound, $resrec);
2069 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2070 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2072 $resrec->{'ResFound'} = $resfound;
2073 $messages->{'ResFound'} = $resrec;
2076 # Record the fact that this book was returned.
2080 itemnumber => $itemnumber,
2081 itemtype => $itemtype,
2082 borrowernumber => $borrowernumber,
2083 ccode => $item->ccode,
2086 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2088 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2090 branchcode => $branch,
2091 categorycode => $patron->categorycode,
2092 item_type => $itemtype,
2093 notification => 'CHECKIN',
2095 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2096 SendCirculationAlert({
2098 item => $item_unblessed,
2099 borrower => $patron->unblessed,
2104 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2105 if C4::Context->preference("ReturnLog");
2108 # Remove any OVERDUES related debarment if the borrower has no overdues
2109 if ( $borrowernumber
2110 && $patron->debarred
2111 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2112 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2113 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2115 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2118 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2119 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2120 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType");
2121 if (C4::Context->preference("AutomaticItemReturn" ) or
2122 (C4::Context->preference("UseBranchTransferLimits") and
2123 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2125 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2126 $debug and warn "item: " . Dumper($item_unblessed);
2127 ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2128 $messages->{'WasTransfered'} = 1;
2130 $messages->{'NeedsTransfer'} = $returnbranch;
2134 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2137 =head2 MarkIssueReturned
2139 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2141 Unconditionally marks an issue as being returned by
2142 moving the C<issues> row to C<old_issues> and
2143 setting C<returndate> to the current date.
2145 if C<$returndate> is specified (in iso format), it is used as the date
2148 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2149 the old_issue is immediately anonymised
2151 Ideally, this function would be internal to C<C4::Circulation>,
2152 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2153 and offline_circ/process_koc.pl.
2157 sub MarkIssueReturned {
2158 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2160 # Retrieve the issue
2161 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2162 my $issue_id = $issue->issue_id;
2164 my $anonymouspatron;
2165 if ( $privacy == 2 ) {
2166 # The default of 0 will not work due to foreign key constraints
2167 # The anonymisation will fail if AnonymousPatron is not a valid entry
2168 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2169 # Note that a warning should appear on the about page (System information tab).
2170 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2171 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."
2172 unless Koha::Patrons->find( $anonymouspatron );
2175 my $schema = Koha::Database->schema;
2177 # FIXME Improve the return value and handle it from callers
2178 $schema->txn_do(sub {
2180 # Update the returndate value
2181 if ( $returndate ) {
2182 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2185 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2188 # Create the old_issues entry
2189 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2191 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2192 if ( $privacy == 2) {
2193 $old_checkout->borrowernumber($anonymouspatron)->store;
2196 # And finally delete the issue
2199 ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2201 if ( C4::Context->preference('StoreLastBorrower') ) {
2202 my $item = Koha::Items->find( $itemnumber );
2203 my $patron = Koha::Patrons->find( $borrowernumber );
2204 $item->last_returned_by( $patron );
2211 =head2 _debar_user_on_return
2213 _debar_user_on_return($borrower, $item, $datedue, today);
2215 C<$borrower> borrower hashref
2217 C<$item> item hashref
2219 C<$datedue> date due DateTime object
2221 C<$return_date> DateTime object representing the return time
2223 Internal function, called only by AddReturn that calculates and updates
2224 the user fine days, and debars them if necessary.
2226 Should only be called for overdue returns
2230 sub _debar_user_on_return {
2231 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2233 my $branchcode = _GetCircControlBranch( $item, $borrower );
2235 my $circcontrol = C4::Context->preference('CircControl');
2236 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2237 { categorycode => $borrower->{categorycode},
2238 itemtype => $item->{itype},
2239 branchcode => $branchcode
2242 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2243 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2244 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2248 # finedays is in days, so hourly loans must multiply by 24
2249 # thus 1 hour late equals 1 day suspension * finedays rate
2250 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2252 # grace period is measured in the same units as the loan
2254 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2256 my $deltadays = DateTime::Duration->new(
2257 days => $chargeable_units
2259 if ( $deltadays->subtract($grace)->is_positive() ) {
2260 my $suspension_days = $deltadays * $finedays;
2262 # If the max suspension days is < than the suspension days
2263 # the suspension days is limited to this maximum period.
2264 my $max_sd = $issuing_rule->maxsuspensiondays;
2265 if ( defined $max_sd ) {
2266 $max_sd = DateTime::Duration->new( days => $max_sd );
2267 $suspension_days = $max_sd
2268 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2271 my ( $has_been_extended, $is_a_reminder );
2272 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2273 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2275 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2276 $has_been_extended = 1;
2280 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2281 # No need to / 1 and do not consider / 0
2282 $suspension_days = DateTime::Duration->new(
2283 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2288 # Use the calendar or not to calculate the debarment date
2289 if ( C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed' ) {
2290 my $calendar = Koha::Calendar->new(
2291 branchcode => $branchcode,
2292 days_mode => 'Calendar'
2294 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2297 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2300 Koha::Patron::Debarments::AddUniqueDebarment({
2301 borrowernumber => $borrower->{borrowernumber},
2302 expiration => $new_debar_dt->ymd(),
2303 type => 'SUSPENSION',
2305 # if borrower was already debarred but does not get an extra debarment
2306 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2307 my $new_debarment_str;
2308 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2310 $new_debarment_str = $borrower->{debarred};
2312 $new_debarment_str = $new_debar_dt->ymd();
2314 # FIXME Should return a DateTime object
2315 return $new_debarment_str, $is_a_reminder;
2321 =head2 _FixOverduesOnReturn
2323 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2325 C<$brn> borrowernumber
2329 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2330 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2336 sub _FixOverduesOnReturn {
2337 my ($borrowernumber, $item, $exemptfine, $dropbox ) = @_;
2338 unless( $borrowernumber ) {
2339 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2343 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2347 # check for overdue fine
2348 my $accountline = Koha::Account::Lines->search(
2350 borrowernumber => $borrowernumber,
2351 itemnumber => $item,
2353 accounttype => 'FU',
2358 return 0 unless $accountline; # no warning, there's just nothing to fix
2361 my $amountoutstanding = $accountline->amountoutstanding;
2363 $accountline->accounttype('FFOR');
2364 $accountline->amountoutstanding(0);
2366 Koha::Account::Offset->new(
2368 debit_id => $accountline->id,
2370 amount => $amountoutstanding * -1,
2374 if (C4::Context->preference("FinesLog")) {
2375 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2377 } elsif ($dropbox && $accountline->lastincrement) {
2378 my $outstanding = $accountline->amountoutstanding - $accountline->lastincrement;
2379 my $amt = $accountline->amount - $accountline->lastincrement;
2381 Koha::Account::Offset->new(
2383 debit_id => $accountline->id,
2385 amount => $accountline->lastincrement * -1,
2389 if ( C4::Context->preference("FinesLog") ) {
2390 &logaction( "FINES", 'MODIFY', $borrowernumber,
2391 "Dropbox adjustment $amt, item $item" );
2394 $accountline->accounttype('F');
2396 if ( $outstanding >= 0 && $amt >= 0 ) {
2397 $accountline->amount($amt);
2398 $accountline->amountoutstanding($outstanding);
2402 $accountline->accounttype('F');
2405 return $accountline->store();
2408 =head2 _FixAccountForLostAndReturned
2410 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2412 Calculates the charge for a book lost and returned.
2414 Internal function, not exported, called only by AddReturn.
2418 sub _FixAccountForLostAndReturned {
2419 my $itemnumber = shift or return;
2420 my $borrowernumber = @_ ? shift : undef;
2421 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2425 # check for charge made for lost book
2426 my $accountlines = Koha::Account::Lines->search(
2428 itemnumber => $itemnumber,
2429 accounttype => { -in => [ 'L', 'Rep', 'W' ] },
2432 order_by => { -desc => [ 'date', 'accountno' ] }
2436 return unless $accountlines->count > 0;
2437 my $accountline = $accountlines->next;
2438 my $total_to_refund = 0;
2439 my $account = Koha::Patrons->find( $accountline->borrowernumber )->account;
2442 if ( $accountline->amount > $accountline->amountoutstanding ) {
2443 # some amount has been cancelled. collect the offsets that are not writeoffs
2444 # this works because the only way to subtract from this kind of a debt is
2445 # using the UI buttons 'Pay' and 'Write off'
2446 my $credits_offsets = Koha::Account::Offsets->search({
2447 debit_id => $accountline->id,
2448 credit_id => { '!=' => undef }, # it is not the debit itself
2449 type => { '!=' => 'Writeoff' },
2450 amount => { '<' => 0 } # credits are negative on the DB
2453 $total_to_refund = ( $credits_offsets->count > 0 )
2454 ? $credits_offsets->total * -1 # credits are negative on the DB
2458 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2460 if ( $credit_total > 0 ) {
2461 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2462 $credit = $account->add_credit(
2463 { amount => $credit_total,
2464 description => 'Item Returned ' . $item_id,
2465 type => 'lost_item_return',
2466 library_id => $branchcode
2470 # TODO: ->apply should just accept the accountline
2471 $credit->apply( { debits => $accountlines->reset } );
2474 # Manually set the accounttype
2475 $accountline->discard_changes->accounttype('LR');
2476 $accountline->store;
2478 ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2480 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2481 $account->reconcile_balance;
2484 return ($credit) ? $credit->id : undef;
2487 =head2 _GetCircControlBranch
2489 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2493 Return the library code to be used to determine which circulation
2494 policy applies to a transaction. Looks up the CircControl and
2495 HomeOrHoldingBranch system preferences.
2497 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2499 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2503 sub _GetCircControlBranch {
2504 my ($item, $borrower) = @_;
2505 my $circcontrol = C4::Context->preference('CircControl');
2508 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2509 $branch= C4::Context->userenv->{'branch'};
2510 } elsif ($circcontrol eq 'PatronLibrary') {
2511 $branch=$borrower->{branchcode};
2513 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2514 $branch = $item->{$branchfield};
2515 # default to item home branch if holdingbranch is used
2516 # and is not defined
2517 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2518 $branch = $item->{homebranch};
2526 $issue = GetOpenIssue( $itemnumber );
2528 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2530 C<$itemnumber> is the item's itemnumber
2537 my ( $itemnumber ) = @_;
2538 return unless $itemnumber;
2539 my $dbh = C4::Context->dbh;
2540 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2541 $sth->execute( $itemnumber );
2542 return $sth->fetchrow_hashref();
2546 =head2 GetBiblioIssues
2548 $issues = GetBiblioIssues($biblionumber);
2550 this function get all issues from a biblionumber.
2553 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2554 tables issues and the firstname,surname & cardnumber from borrowers.
2558 sub GetBiblioIssues {
2559 my $biblionumber = shift;
2560 return unless $biblionumber;
2561 my $dbh = C4::Context->dbh;
2563 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2565 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2566 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2567 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2568 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2569 WHERE biblio.biblionumber = ?
2571 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2573 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2574 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2575 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2576 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2577 WHERE biblio.biblionumber = ?
2580 my $sth = $dbh->prepare($query);
2581 $sth->execute($biblionumber, $biblionumber);
2584 while ( my $data = $sth->fetchrow_hashref ) {
2585 push @issues, $data;
2590 =head2 GetUpcomingDueIssues
2592 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2596 sub GetUpcomingDueIssues {
2599 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2600 my $dbh = C4::Context->dbh;
2602 my $statement = <<END_SQL;
2605 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2607 LEFT JOIN items USING (itemnumber)
2608 LEFT OUTER JOIN branches USING (branchcode)
2609 WHERE returndate is NULL
2611 WHERE days_until_due >= 0 AND days_until_due <= ?
2614 my @bind_parameters = ( $params->{'days_in_advance'} );
2616 my $sth = $dbh->prepare( $statement );
2617 $sth->execute( @bind_parameters );
2618 my $upcoming_dues = $sth->fetchall_arrayref({});
2620 return $upcoming_dues;
2623 =head2 CanBookBeRenewed
2625 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2627 Find out whether a borrowed item may be renewed.
2629 C<$borrowernumber> is the borrower number of the patron who currently
2630 has the item on loan.
2632 C<$itemnumber> is the number of the item to renew.
2634 C<$override_limit>, if supplied with a true value, causes
2635 the limit on the number of times that the loan can be renewed
2636 (as controlled by the item type) to be ignored. Overriding also allows
2637 to renew sooner than "No renewal before" and to manually renew loans
2638 that are automatically renewed.
2640 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2641 item must currently be on loan to the specified borrower; renewals
2642 must be allowed for the item's type; and the borrower must not have
2643 already renewed the loan. $error will contain the reason the renewal can not proceed
2647 sub CanBookBeRenewed {
2648 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2650 my $dbh = C4::Context->dbh;
2653 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2654 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2655 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2656 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2658 my $patron = $issue->patron or return;
2660 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2662 # This item can fill one or more unfilled reserve, can those unfilled reserves
2663 # all be filled by other available items?
2665 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2667 my $schema = Koha::Database->new()->schema();
2669 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2671 # There is an item level hold on this item, no other item can fill the hold
2676 # Get all other items that could possibly fill reserves
2677 my @itemnumbers = $schema->resultset('Item')->search(
2679 biblionumber => $resrec->{biblionumber},
2682 -not => { itemnumber => $itemnumber }
2684 { columns => 'itemnumber' }
2685 )->get_column('itemnumber')->all();
2687 # Get all other reserves that could have been filled by this item
2688 my @borrowernumbers;
2690 my ( $reserve_found, $reserve, undef ) =
2691 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2693 if ($reserve_found) {
2694 push( @borrowernumbers, $reserve->{borrowernumber} );
2701 # If the count of the union of the lists of reservable items for each borrower
2702 # is equal or greater than the number of borrowers, we know that all reserves
2703 # can be filled with available items. We can get the union of the sets simply
2704 # by pushing all the elements onto an array and removing the duplicates.
2707 ITEM: foreach my $i (@itemnumbers) {
2708 my $item = Koha::Items->find($i)->unblessed;
2709 next if IsItemOnHoldAndFound($i);
2710 for my $b (@borrowernumbers) {
2711 my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2712 next unless IsAvailableForItemLevelRequest($item, $borr);
2713 next unless CanItemBeReserved($b,$i);
2715 push @reservable, $i;
2716 if (@reservable >= @borrowernumbers) {
2725 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2727 return ( 1, undef ) if $override_limit;
2729 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2730 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2731 { categorycode => $patron->categorycode,
2732 itemtype => $item->effective_itemtype,
2733 branchcode => $branchcode
2737 return ( 0, "too_many" )
2738 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2740 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2741 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2742 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2743 my $restricted = $patron->is_debarred;
2744 my $hasoverdues = $patron->has_overdues;
2746 if ( $restricted and $restrictionblockrenewing ) {
2747 return ( 0, 'restriction');
2748 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2749 return ( 0, 'overdue');
2752 if ( $issue->auto_renew ) {
2754 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2755 return ( 0, 'auto_account_expired' );
2758 if ( defined $issuing_rule->no_auto_renewal_after
2759 and $issuing_rule->no_auto_renewal_after ne "" ) {
2760 # Get issue_date and add no_auto_renewal_after
2761 # If this is greater than today, it's too late for renewal.
2762 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2763 $maximum_renewal_date->add(
2764 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2766 my $now = dt_from_string;
2767 if ( $now >= $maximum_renewal_date ) {
2768 return ( 0, "auto_too_late" );
2771 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2772 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2773 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2774 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2775 return ( 0, "auto_too_late" );
2779 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2780 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2781 my $amountoutstanding = $patron->account->balance;
2782 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2783 return ( 0, "auto_too_much_oweing" );
2788 if ( defined $issuing_rule->norenewalbefore
2789 and $issuing_rule->norenewalbefore ne "" )
2792 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2793 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2794 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2796 # Depending on syspref reset the exact time, only check the date
2797 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2798 and $issuing_rule->lengthunit eq 'days' )
2800 $soonestrenewal->truncate( to => 'day' );
2803 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2805 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2806 return ( 0, "too_soon" );
2808 elsif ( $issue->auto_renew ) {
2809 return ( 0, "auto_renew" );
2813 # Fallback for automatic renewals:
2814 # If norenewalbefore is undef, don't renew before due date.
2815 if ( $issue->auto_renew ) {
2816 my $now = dt_from_string;
2817 return ( 0, "auto_renew" )
2818 if $now >= dt_from_string( $issue->date_due, 'sql' );
2819 return ( 0, "auto_too_soon" );
2822 return ( 1, undef );
2827 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2831 C<$borrowernumber> is the borrower number of the patron who currently
2834 C<$itemnumber> is the number of the item to renew.
2836 C<$branch> is the library where the renewal took place (if any).
2837 The library that controls the circ policies for the renewal is retrieved from the issues record.
2839 C<$datedue> can be a DateTime object used to set the due date.
2841 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2842 this parameter is not supplied, lastreneweddate is set to the current date.
2844 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2845 from the book's item type.
2850 my $borrowernumber = shift;
2851 my $itemnumber = shift or return;
2853 my $datedue = shift;
2854 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2856 my $item = Koha::Items->find($itemnumber) or return;
2857 my $biblio = $item->biblio;
2858 my $issue = $item->checkout;
2859 my $item_unblessed = $item->unblessed;
2861 my $dbh = C4::Context->dbh;
2863 return unless $issue;
2865 $borrowernumber ||= $issue->borrowernumber;
2867 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2868 carp 'Invalid date passed to AddRenewal.';
2872 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2873 my $patron_unblessed = $patron->unblessed;
2875 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item, $patron_unblessed) );
2877 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2878 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2880 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2882 # If the due date wasn't specified, calculate it by adding the
2883 # book's loan length to today's date or the current due date
2884 # based on the value of the RenewalPeriodBase syspref.
2887 my $itemtype = $item->effective_itemtype;
2888 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2889 dt_from_string( $issue->date_due, 'sql' ) :
2890 DateTime->now( time_zone => C4::Context->tz());
2891 $datedue = CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item_unblessed, $patron_unblessed), $patron_unblessed, 'is a renewal');
2894 my $fees = Koha::Charges::Fees->new(
2897 library => $circ_library,
2898 item => $item_object,
2899 to_date => dt_from_string( $datedue ),
2903 # Update the issues record to have the new due date, and a new count
2904 # of how many times it has been renewed.
2905 my $renews = $issue->renewals + 1;
2906 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2907 WHERE borrowernumber=?
2911 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2913 # Update the renewal count on the item, and tell zebra to reindex
2914 $renews = $item->renewals + 1;
2915 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item->biblionumber, $itemnumber, { log_action => 0 } );
2917 # Charge a new rental fee, if applicable
2918 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2919 if ( $charge > 0 ) {
2920 my $description = "Renewal of Rental Item " . $biblio->title . " " .$item->barcode;
2921 AddIssuingCharge($issue, $charge, $description);
2924 # Charge a new accumulate rental fee, if applicable
2925 my $itemtype = Koha::ItemTypes->find( $item_object->effective_itemtype );
2927 my $accumulate_charge = $fees->accumulate_rentalcharge();
2928 if ( $accumulate_charge > 0 ) {
2929 my $type_desc = "Renewal of Daily Rental Item " . $biblio->title . " $item->{'barcode'}";
2930 AddIssuingCharge( $issue, $accumulate_charge, $type_desc )
2932 $charge += $accumulate_charge;
2935 # Send a renewal slip according to checkout alert preferencei
2936 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2937 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2939 branchcode => $branch,
2940 categorycode => $patron->categorycode,
2941 item_type => $item->effective_itemtype,
2942 notification => 'CHECKOUT',
2944 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2945 SendCirculationAlert(
2948 item => $item_unblessed,
2949 borrower => $patron->unblessed,
2956 # Remove any OVERDUES related debarment if the borrower has no overdues
2958 && $patron->is_debarred
2959 && ! $patron->has_overdues
2960 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2962 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2965 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2966 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2969 # Add the renewal to stats
2975 itemnumber => $itemnumber,
2976 itemtype => $item->effective_itemtype,
2977 location => $item->location,
2978 borrowernumber => $borrowernumber,
2979 ccode => $item->ccode,
2984 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2989 # check renewal status
2990 my ( $bornum, $itemno ) = @_;
2991 my $dbh = C4::Context->dbh;
2993 my $renewsallowed = 0;
2996 my $patron = Koha::Patrons->find( $bornum );
2997 my $item = Koha::Items->find($itemno);
2999 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3001 # Look in the issues table for this item, lent to this borrower,
3002 # and not yet returned.
3004 # FIXME - I think this function could be redone to use only one SQL call.
3005 my $sth = $dbh->prepare(
3006 "select * from issues
3007 where (borrowernumber = ?)
3008 and (itemnumber = ?)"
3010 $sth->execute( $bornum, $itemno );
3011 my $data = $sth->fetchrow_hashref;
3012 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3013 # $item and $borrower should be calculated
3014 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3016 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3017 { categorycode => $patron->categorycode,
3018 itemtype => $item->effective_itemtype,
3019 branchcode => $branchcode
3023 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3024 $renewsleft = $renewsallowed - $renewcount;
3025 if($renewsleft < 0){ $renewsleft = 0; }
3026 return ( $renewcount, $renewsallowed, $renewsleft );
3029 =head2 GetSoonestRenewDate
3031 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3033 Find out the soonest possible renew date of a borrowed item.
3035 C<$borrowernumber> is the borrower number of the patron who currently
3036 has the item on loan.
3038 C<$itemnumber> is the number of the item to renew.
3040 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3041 renew date, based on the value "No renewal before" of the applicable
3042 issuing rule. Returns the current date if the item can already be
3043 renewed, and returns undefined if the borrower, loan, or item
3048 sub GetSoonestRenewDate {
3049 my ( $borrowernumber, $itemnumber ) = @_;
3051 my $dbh = C4::Context->dbh;
3053 my $item = Koha::Items->find($itemnumber) or return;
3054 my $itemissue = $item->checkout or return;
3056 $borrowernumber ||= $itemissue->borrowernumber;
3057 my $patron = Koha::Patrons->find( $borrowernumber )
3060 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3061 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3062 { categorycode => $patron->categorycode,
3063 itemtype => $item->effective_itemtype,
3064 branchcode => $branchcode
3068 my $now = dt_from_string;
3069 return $now unless $issuing_rule;
3071 if ( defined $issuing_rule->norenewalbefore
3072 and $issuing_rule->norenewalbefore ne "" )
3074 my $soonestrenewal =
3075 dt_from_string( $itemissue->date_due )->subtract(
3076 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3078 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3079 and $issuing_rule->lengthunit eq 'days' )
3081 $soonestrenewal->truncate( to => 'day' );
3083 return $soonestrenewal if $now < $soonestrenewal;
3088 =head2 GetLatestAutoRenewDate
3090 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3092 Find out the latest possible auto renew date of a borrowed item.
3094 C<$borrowernumber> is the borrower number of the patron who currently
3095 has the item on loan.
3097 C<$itemnumber> is the number of the item to renew.
3099 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3100 auto renew date, based on the value "No auto renewal after" and the "No auto
3101 renewal after (hard limit) of the applicable issuing rule.
3102 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3103 or item cannot be found.
3107 sub GetLatestAutoRenewDate {
3108 my ( $borrowernumber, $itemnumber ) = @_;
3110 my $dbh = C4::Context->dbh;
3112 my $item = Koha::Items->find($itemnumber) or return;
3113 my $itemissue = $item->checkout or return;
3115 $borrowernumber ||= $itemissue->borrowernumber;
3116 my $patron = Koha::Patrons->find( $borrowernumber )
3119 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3120 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3121 { categorycode => $patron->categorycode,
3122 itemtype => $item->effective_itemtype,
3123 branchcode => $branchcode
3127 return unless $issuing_rule;
3129 if ( not $issuing_rule->no_auto_renewal_after
3130 or $issuing_rule->no_auto_renewal_after eq '' )
3131 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3132 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3134 my $maximum_renewal_date;
3135 if ( $issuing_rule->no_auto_renewal_after ) {
3136 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3137 $maximum_renewal_date->add(
3138 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3142 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3143 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3144 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3146 return $maximum_renewal_date;
3150 =head2 GetIssuingCharges
3152 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3154 Calculate how much it would cost for a given patron to borrow a given
3155 item, including any applicable discounts.
3157 C<$itemnumber> is the item number of item the patron wishes to borrow.
3159 C<$borrowernumber> is the patron's borrower number.
3161 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3162 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3167 sub GetIssuingCharges {
3169 # calculate charges due
3170 my ( $itemnumber, $borrowernumber ) = @_;
3172 my $dbh = C4::Context->dbh;
3175 # Get the book's item type and rental charge (via its biblioitem).
3176 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3177 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3178 $charge_query .= (C4::Context->preference('item-level_itypes'))
3179 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3180 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3182 $charge_query .= ' WHERE items.itemnumber =?';
3184 my $sth = $dbh->prepare($charge_query);
3185 $sth->execute($itemnumber);
3186 if ( my $item_data = $sth->fetchrow_hashref ) {
3187 $item_type = $item_data->{itemtype};
3188 $charge = $item_data->{rentalcharge};
3189 my $branch = C4::Context::mybranch();
3190 my $discount_query = q|SELECT rentaldiscount,
3191 issuingrules.itemtype, issuingrules.branchcode
3193 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3194 WHERE borrowers.borrowernumber = ?
3195 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3196 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3197 my $discount_sth = $dbh->prepare($discount_query);
3198 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3199 my $discount_rules = $discount_sth->fetchall_arrayref({});
3200 if (@{$discount_rules}) {
3201 # We may have multiple rules so get the most specific
3202 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3203 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3206 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3210 return ( $charge, $item_type );
3213 # Select most appropriate discount rule from those returned
3214 sub _get_discount_from_rule {
3215 my ($rules_ref, $branch, $itemtype) = @_;
3218 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3219 $discount = $rules_ref->[0]->{rentaldiscount};
3220 return (defined $discount) ? $discount : 0;
3222 # could have up to 4 does one match $branch and $itemtype
3223 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3225 $discount = $d[0]->{rentaldiscount};
3226 return (defined $discount) ? $discount : 0;
3228 # do we have item type + all branches
3229 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3231 $discount = $d[0]->{rentaldiscount};
3232 return (defined $discount) ? $discount : 0;
3234 # do we all item types + this branch
3235 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3237 $discount = $d[0]->{rentaldiscount};
3238 return (defined $discount) ? $discount : 0;
3240 # so all and all (surely we wont get here)
3241 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3243 $discount = $d[0]->{rentaldiscount};
3244 return (defined $discount) ? $discount : 0;
3250 =head2 AddIssuingCharge
3252 &AddIssuingCharge( $checkout, $charge, [$description] )
3256 sub AddIssuingCharge {
3257 my ( $checkout, $charge, $description ) = @_;
3259 # FIXME What if checkout does not exist?
3261 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3262 my $accountline = $account->add_debit(
3265 description => $description,
3267 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
3268 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3270 item_id => $checkout->itemnumber,
3271 issue_id => $checkout->issue_id,
3278 GetTransfers($itemnumber);
3283 my ($itemnumber) = @_;
3285 my $dbh = C4::Context->dbh;
3292 FROM branchtransfers
3293 WHERE itemnumber = ?
3294 AND datearrived IS NULL
3296 my $sth = $dbh->prepare($query);
3297 $sth->execute($itemnumber);
3298 my @row = $sth->fetchrow_array();
3302 =head2 GetTransfersFromTo
3304 @results = GetTransfersFromTo($frombranch,$tobranch);
3306 Returns the list of pending transfers between $from and $to branch
3310 sub GetTransfersFromTo {
3311 my ( $frombranch, $tobranch ) = @_;
3312 return unless ( $frombranch && $tobranch );
3313 my $dbh = C4::Context->dbh;
3315 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3316 FROM branchtransfers
3319 AND datearrived IS NULL
3321 my $sth = $dbh->prepare($query);
3322 $sth->execute( $frombranch, $tobranch );
3325 while ( my $data = $sth->fetchrow_hashref ) {
3326 push @gettransfers, $data;
3328 return (@gettransfers);
3331 =head2 DeleteTransfer
3333 &DeleteTransfer($itemnumber);
3337 sub DeleteTransfer {
3338 my ($itemnumber) = @_;
3339 return unless $itemnumber;
3340 my $dbh = C4::Context->dbh;
3341 my $sth = $dbh->prepare(
3342 "DELETE FROM branchtransfers
3344 AND datearrived IS NULL "
3346 return $sth->execute($itemnumber);
3349 =head2 SendCirculationAlert
3351 Send out a C<check-in> or C<checkout> alert using the messaging system.
3359 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3363 Hashref of information about the item being checked in or out.
3367 Hashref of information about the borrower of the item.
3371 The branchcode from where the checkout or check-in took place.
3377 SendCirculationAlert({
3380 borrower => $borrower,
3386 sub SendCirculationAlert {
3388 my ($type, $item, $borrower, $branch) =
3389 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3390 my %message_name = (
3391 CHECKIN => 'Item_Check_in',
3392 CHECKOUT => 'Item_Checkout',
3393 RENEWAL => 'Item_Checkout',
3395 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3396 borrowernumber => $borrower->{borrowernumber},
3397 message_name => $message_name{$type},
3399 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3401 my $schema = Koha::Database->new->schema;
3402 my @transports = keys %{ $borrower_preferences->{transports} };
3404 # From the MySQL doc:
3405 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3406 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3407 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3408 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3410 for my $mtt (@transports) {
3411 my $letter = C4::Letters::GetPreparedLetter (
3412 module => 'circulation',
3413 letter_code => $type,
3414 branchcode => $branch,
3415 message_transport_type => $mtt,
3416 lang => $borrower->{lang},
3418 $issues_table => $item->{itemnumber},
3419 'items' => $item->{itemnumber},
3420 'biblio' => $item->{biblionumber},
3421 'biblioitems' => $item->{biblionumber},
3422 'borrowers' => $borrower,
3423 'branches' => $branch,
3427 $schema->storage->txn_begin;
3428 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3429 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3430 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3431 unless ( $message ) {
3432 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3433 C4::Message->enqueue($letter, $borrower, $mtt);
3435 $message->append($letter);
3438 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3439 $schema->storage->txn_commit;
3445 =head2 updateWrongTransfer
3447 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3449 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
3453 sub updateWrongTransfer {
3454 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3455 my $dbh = C4::Context->dbh;
3456 # first step validate the actual line of transfert .
3459 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3461 $sth->execute($FromLibrary,$itemNumber);
3463 # second step create a new line of branchtransfer to the right location .
3464 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3466 #third step changing holdingbranch of item
3467 UpdateHoldingbranch($FromLibrary,$itemNumber);
3470 =head2 UpdateHoldingbranch
3472 $items = UpdateHoldingbranch($branch,$itmenumber);
3474 Simple methode for updating hodlingbranch in items BDD line
3478 sub UpdateHoldingbranch {
3479 my ( $branch,$itemnumber ) = @_;
3480 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3485 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3487 this function calculates the due date given the start date and configured circulation rules,
3488 checking against the holidays calendar as per the 'useDaysMode' syspref.
3489 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3490 C<$itemtype> = itemtype code of item in question
3491 C<$branch> = location whose calendar to use
3492 C<$borrower> = Borrower object
3493 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3498 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3502 # loanlength now a href
3504 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3506 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3512 if (ref $startdate ne 'DateTime' ) {
3513 $datedue = dt_from_string($datedue);
3515 $datedue = $startdate->clone;
3519 DateTime->now( time_zone => C4::Context->tz() )
3520 ->truncate( to => 'minute' );
3524 # calculate the datedue as normal
3525 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3526 { # ignoring calendar
3527 if ( $loanlength->{lengthunit} eq 'hours' ) {
3528 $datedue->add( hours => $loanlength->{$length_key} );
3530 $datedue->add( days => $loanlength->{$length_key} );
3531 $datedue->set_hour(23);
3532 $datedue->set_minute(59);
3536 if ($loanlength->{lengthunit} eq 'hours') {
3537 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3540 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3542 my $calendar = Koha::Calendar->new( branchcode => $branch );
3543 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3544 if ($loanlength->{lengthunit} eq 'days') {
3545 $datedue->set_hour(23);
3546 $datedue->set_minute(59);
3550 # if Hard Due Dates are used, retrieve them and apply as necessary
3551 my ( $hardduedate, $hardduedatecompare ) =
3552 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3553 if ($hardduedate) { # hardduedates are currently dates
3554 $hardduedate->truncate( to => 'minute' );
3555 $hardduedate->set_hour(23);
3556 $hardduedate->set_minute(59);
3557 my $cmp = DateTime->compare( $hardduedate, $datedue );
3559 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3560 # if the calculated date is before the 'after' Hard Due Date (floor), override
3561 # if the hard due date is set to 'exactly', overrride
3562 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3563 $datedue = $hardduedate->clone;
3566 # in all other cases, keep the date due as it is
3570 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3571 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3572 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3573 if( $expiry_dt ) { #skip empty expiry date..
3574 $expiry_dt->set( hour => 23, minute => 59);
3575 my $d1= $datedue->clone->set_time_zone('floating');
3576 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3577 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3580 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3581 my $calendar = Koha::Calendar->new( branchcode => $branch );
3582 if ( $calendar->is_holiday($datedue) ) {
3583 # Don't return on a closed day
3584 $datedue = $calendar->prev_open_day( $datedue );
3593 sub CheckValidBarcode{
3595 my $dbh = C4::Context->dbh;
3596 my $query=qq|SELECT count(*)
3600 my $sth = $dbh->prepare($query);
3601 $sth->execute($barcode);
3602 my $exist=$sth->fetchrow ;
3606 =head2 IsBranchTransferAllowed
3608 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3610 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3612 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3613 Koha::Item->can_be_transferred.
3617 sub IsBranchTransferAllowed {
3618 my ( $toBranch, $fromBranch, $code ) = @_;
3620 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3622 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3623 my $dbh = C4::Context->dbh;
3625 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3626 $sth->execute( $toBranch, $fromBranch, $code );
3627 my $limit = $sth->fetchrow_hashref();
3629 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3630 if ( $limit->{'limitId'} ) {
3637 =head2 CreateBranchTransferLimit
3639 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3641 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3643 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3647 sub CreateBranchTransferLimit {
3648 my ( $toBranch, $fromBranch, $code ) = @_;
3649 return unless defined($toBranch) && defined($fromBranch);
3650 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3652 my $dbh = C4::Context->dbh;
3654 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3655 return $sth->execute( $code, $toBranch, $fromBranch );
3658 =head2 DeleteBranchTransferLimits
3660 my $result = DeleteBranchTransferLimits($frombranch);
3662 Deletes all the library transfer limits for one library. Returns the
3663 number of limits deleted, 0e0 if no limits were deleted, or undef if
3664 no arguments are supplied.
3666 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3667 fromBranch => $fromBranch
3672 sub DeleteBranchTransferLimits {
3674 return unless defined $branch;
3675 my $dbh = C4::Context->dbh;
3676 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3677 return $sth->execute($branch);
3681 my ( $borrowernumber, $itemnum ) = @_;
3683 MarkIssueReturned( $borrowernumber, $itemnum );
3684 my $patron = Koha::Patrons->find( $borrowernumber );
3685 my $item = Koha::Items->find($itemnum);
3686 my $old_note = ($item->paidfor && ($item->paidfor ne q{})) ? $item->paidfor.' / ' : q{};
3687 my @datearr = localtime(time);
3688 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3689 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3690 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3695 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3697 unless ( $mark_lost_from ) {
3698 # Temporary check to avoid regressions
3699 die q|LostItem called without $mark_lost_from, check the API.|;
3703 if ( $force_mark_returned ) {
3706 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3707 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3710 my $dbh = C4::Context->dbh();
3711 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3713 JOIN items USING (itemnumber)
3714 JOIN biblio USING (biblionumber)
3715 WHERE issues.itemnumber=?");
3716 $sth->execute($itemnumber);
3717 my $issues=$sth->fetchrow_hashref();
3719 # If a borrower lost the item, add a replacement cost to the their record
3720 if ( my $borrowernumber = $issues->{borrowernumber} ){
3721 my $patron = Koha::Patrons->find( $borrowernumber );
3723 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 0); # 1, 0 = exemptfine, no-dropbox
3724 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3726 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3727 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3728 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3729 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3732 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3735 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3736 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3737 ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3739 my $transferdeleted = DeleteTransfer($itemnumber);
3742 sub GetOfflineOperations {
3743 my $dbh = C4::Context->dbh;
3744 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3745 $sth->execute(C4::Context->userenv->{'branch'});
3746 my $results = $sth->fetchall_arrayref({});
3750 sub GetOfflineOperation {
3751 my $operationid = shift;
3752 return unless $operationid;
3753 my $dbh = C4::Context->dbh;
3754 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3755 $sth->execute( $operationid );
3756 return $sth->fetchrow_hashref;
3759 sub AddOfflineOperation {
3760 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3761 my $dbh = C4::Context->dbh;
3762 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3763 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3767 sub DeleteOfflineOperation {
3768 my $dbh = C4::Context->dbh;
3769 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3770 $sth->execute( shift );
3774 sub ProcessOfflineOperation {
3775 my $operation = shift;
3778 if ( $operation->{action} eq 'return' ) {
3779 $report = ProcessOfflineReturn( $operation );
3780 } elsif ( $operation->{action} eq 'issue' ) {
3781 $report = ProcessOfflineIssue( $operation );
3782 } elsif ( $operation->{action} eq 'payment' ) {
3783 $report = ProcessOfflinePayment( $operation );
3786 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3791 sub ProcessOfflineReturn {
3792 my $operation = shift;
3794 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3797 my $itemnumber = $item->itemnumber;
3798 my $issue = GetOpenIssue( $itemnumber );
3801 $issue->{borrowernumber},
3803 $operation->{timestamp},
3806 { renewals => 0, onloan => undef },
3807 $issue->{'biblionumber'},
3813 return "Item not issued.";
3816 return "Item not found.";
3820 sub ProcessOfflineIssue {
3821 my $operation = shift;
3823 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3826 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3828 return "Barcode not found.";
3830 my $itemnumber = $item->itemnumber;
3831 my $issue = GetOpenIssue( $itemnumber );
3833 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3835 $issue->{borrowernumber},
3837 $operation->{timestamp},
3842 $operation->{'barcode'},
3845 $operation->{timestamp},
3850 return "Borrower not found.";
3854 sub ProcessOfflinePayment {
3855 my $operation = shift;
3857 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3859 $patron->account->pay({ amount => $operation->{amount}, library_id => $operation->{branchcode} });
3866 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3868 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3873 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3877 ? Koha::Items->find($itemnumber)
3878 : Koha::Items->find( { barcode => $barcode } );
3882 return C4::Letters::GetPreparedLetter (
3883 module => 'circulation',
3884 letter_code => 'TRANSFERSLIP',
3885 branchcode => $branch,
3887 'branches' => $to_branch,
3888 'biblio' => $item->biblionumber,
3889 'items' => $item->unblessed,
3894 =head2 CheckIfIssuedToPatron
3896 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3898 Return 1 if any record item is issued to patron, otherwise return 0
3902 sub CheckIfIssuedToPatron {
3903 my ($borrowernumber, $biblionumber) = @_;
3905 my $dbh = C4::Context->dbh;
3907 SELECT COUNT(*) FROM issues
3908 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3909 WHERE items.biblionumber = ?
3910 AND issues.borrowernumber = ?
3912 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3913 return 1 if $is_issued;
3919 IsItemIssued( $itemnumber )
3921 Return 1 if the item is on loan, otherwise return 0
3926 my $itemnumber = shift;
3927 my $dbh = C4::Context->dbh;
3928 my $sth = $dbh->prepare(q{
3931 WHERE itemnumber = ?
3933 $sth->execute($itemnumber);
3934 return $sth->fetchrow;
3937 =head2 GetAgeRestriction
3939 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3940 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3942 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3943 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3945 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3946 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3947 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3948 Negative days mean the borrower has gone past the age restriction age.
3952 sub GetAgeRestriction {
3953 my ($record_restrictions, $borrower) = @_;
3954 my $markers = C4::Context->preference('AgeRestrictionMarker');
3956 # Split $record_restrictions to something like FSK 16 or PEGI 6
3957 my @values = split ' ', uc($record_restrictions);
3958 return unless @values;
3960 # Search first occurrence of one of the markers
3961 my @markers = split /\|/, uc($markers);
3962 return unless @markers;
3965 my $restriction_year = 0;
3966 for my $value (@values) {
3968 for my $marker (@markers) {
3969 $marker =~ s/^\s+//; #remove leading spaces
3970 $marker =~ s/\s+$//; #remove trailing spaces
3971 if ( $marker eq $value ) {
3972 if ( $index <= $#values ) {
3973 $restriction_year += $values[$index];
3977 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3979 # Perhaps it is something like "K16" (as in Finland)
3980 $restriction_year += $1;
3984 last if ( $restriction_year > 0 );
3987 #Check if the borrower is age restricted for this material and for how long.
3988 if ($restriction_year && $borrower) {
3989 if ( $borrower->{'dateofbirth'} ) {
3990 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3991 $alloweddate[0] += $restriction_year;
3993 #Prevent runime eror on leap year (invalid date)
3994 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3995 $alloweddate[2] = 28;
3998 #Get how many days the borrower has to reach the age restriction
3999 my @Today = split /-/, DateTime->today->ymd();
4000 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4001 #Negative days means the borrower went past the age restriction age
4002 return ($restriction_year, $daysToAgeRestriction);
4006 return ($restriction_year);
4010 =head2 GetPendingOnSiteCheckouts
4014 sub GetPendingOnSiteCheckouts {
4015 my $dbh = C4::Context->dbh;
4016 return $dbh->selectall_arrayref(q|
4022 items.itemcallnumber,
4026 issues.date_due < NOW() AS is_overdue,
4029 borrowers.firstname,
4031 borrowers.cardnumber,
4032 borrowers.borrowernumber
4034 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4035 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4036 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4037 WHERE issues.onsite_checkout = 1
4038 |, { Slice => {} } );
4044 my ($count, $branch, $itemtype, $ccode, $newness)
4045 = @$params{qw(count branch itemtype ccode newness)};
4047 my $dbh = C4::Context->dbh;
4050 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4051 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4052 i.ccode, SUM(i.issues) AS count
4054 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4055 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4058 my (@where_strs, @where_args);
4061 push @where_strs, 'i.homebranch = ?';
4062 push @where_args, $branch;
4065 if (C4::Context->preference('item-level_itypes')){
4066 push @where_strs, 'i.itype = ?';
4067 push @where_args, $itemtype;
4069 push @where_strs, 'bi.itemtype = ?';
4070 push @where_args, $itemtype;
4074 push @where_strs, 'i.ccode = ?';
4075 push @where_args, $ccode;
4078 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4079 push @where_args, $newness;
4083 $query .= 'WHERE ' . join(' AND ', @where_strs);
4087 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4088 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4093 $query .= q{ ) xxx WHERE count > 0 };
4094 $count = int($count);
4096 $query .= "LIMIT $count";
4099 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4104 sub _CalculateAndUpdateFine {
4107 my $borrower = $params->{borrower};
4108 my $item = $params->{item};
4109 my $issue = $params->{issue};
4110 my $return_date = $params->{return_date};
4112 unless ($borrower) { carp "No borrower passed in!" && return; }
4113 unless ($item) { carp "No item passed in!" && return; }
4114 unless ($issue) { carp "No issue passed in!" && return; }
4116 my $datedue = dt_from_string( $issue->date_due );
4118 # we only need to calculate and change the fines if we want to do that on return
4119 # Should be on for hourly loans
4120 my $control = C4::Context->preference('CircControl');
4121 my $control_branchcode =
4122 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4123 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4124 : $issue->branchcode;
4126 my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4128 my ( $amount, $unitcounttotal, $unitcount ) =
4129 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4131 if ( C4::Context->preference('finesMode') eq 'production' ) {
4132 if ( $amount > 0 ) {
4133 C4::Overdues::UpdateFine({
4134 issue_id => $issue->issue_id,
4135 itemnumber => $issue->itemnumber,
4136 borrowernumber => $issue->borrowernumber,
4138 due => output_pref($datedue),
4141 elsif ($return_date) {
4143 # Backdated returns may have fines that shouldn't exist,
4144 # so in this case, we need to drop those fines to 0
4146 C4::Overdues::UpdateFine({
4147 issue_id => $issue->issue_id,
4148 itemnumber => $issue->itemnumber,
4149 borrowernumber => $issue->borrowernumber,
4151 due => output_pref($datedue),
4157 sub _item_denied_renewal {
4160 my $item = $params->{item};
4161 return unless $item;
4163 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4164 return unless $denyingrules;
4165 foreach my $field (keys %$denyingrules) {
4166 my $val = $item->$field;
4167 if( !defined $val) {
4168 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4171 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4172 # If the results matches the values in the syspref
4173 # We return true if match found
4187 Koha Development Team <http://koha-community.org/>