Bug 23624: Unit tests
[koha.git] / C4 / Circulation.pm
blob66993ea461edc2fe2bd2a06a0a8b630d65043dce
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>.
22 use strict;
23 #use warnings; FIXME - Bug 2505
24 use DateTime;
25 use POSIX qw( floor );
26 use Koha::DateUtils;
27 use C4::Context;
28 use C4::Stats;
29 use C4::Reserves;
30 use C4::Biblio;
31 use C4::Items;
32 use C4::Members;
33 use C4::Accounts;
34 use C4::ItemCirculationAlertPreference;
35 use C4::Message;
36 use C4::Debug;
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;
42 use Data::Dumper;
43 use Koha::Account;
44 use Koha::AuthorisedValues;
45 use Koha::Biblioitems;
46 use Koha::DateUtils;
47 use Koha::Calendar;
48 use Koha::Checkouts;
49 use Koha::IssuingRules;
50 use Koha::Items;
51 use Koha::Patrons;
52 use Koha::Patron::Debarments;
53 use Koha::Database;
54 use Koha::Libraries;
55 use Koha::Account::Lines;
56 use Koha::Holds;
57 use Koha::RefundLostItemFeeRules;
58 use Koha::Account::Lines;
59 use Koha::Account::Offsets;
60 use Koha::Config::SysPrefs;
61 use Koha::Charges::Fees;
62 use Koha::Util::SystemPreferences;
63 use Carp;
64 use List::MoreUtils qw( uniq any );
65 use Scalar::Util qw( looks_like_number );
66 use Date::Calc qw(
67 Today
68 Today_and_Now
69 Add_Delta_YM
70 Add_Delta_DHMS
71 Date_to_Days
72 Day_of_Week
73 Add_Delta_Days
75 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
77 BEGIN {
78 require Exporter;
79 @ISA = qw(Exporter);
81 # FIXME subs that should probably be elsewhere
82 push @EXPORT, qw(
83 &barcodedecode
84 &LostItem
85 &ReturnLostItem
86 &GetPendingOnSiteCheckouts
89 # subs to deal with issuing a book
90 push @EXPORT, qw(
91 &CanBookBeIssued
92 &CanBookBeRenewed
93 &AddIssue
94 &AddRenewal
95 &GetRenewCount
96 &GetSoonestRenewDate
97 &GetLatestAutoRenewDate
98 &GetIssuingCharges
99 &GetBranchBorrowerCircRule
100 &GetBranchItemRule
101 &GetBiblioIssues
102 &GetOpenIssue
103 &CheckIfIssuedToPatron
104 &IsItemIssued
105 GetTopIssues
108 # subs to deal with returns
109 push @EXPORT, qw(
110 &AddReturn
111 &MarkIssueReturned
114 # subs to deal with transfers
115 push @EXPORT, qw(
116 &transferbook
117 &GetTransfers
118 &GetTransfersFromTo
119 &updateWrongTransfer
120 &DeleteTransfer
121 &IsBranchTransferAllowed
122 &CreateBranchTransferLimit
123 &DeleteBranchTransferLimits
124 &TransferSlip
127 # subs to deal with offline circulation
128 push @EXPORT, qw(
129 &GetOfflineOperations
130 &GetOfflineOperation
131 &AddOfflineOperation
132 &DeleteOfflineOperation
133 &ProcessOfflineOperation
137 =head1 NAME
139 C4::Circulation - Koha circulation module
141 =head1 SYNOPSIS
143 use C4::Circulation;
145 =head1 DESCRIPTION
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.
151 =head1 FUNCTIONS
153 =head2 barcodedecode
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
166 System Pref options.
168 =cut
170 # FIXME -- the &decode fcn below should be wrapped into this one.
171 # FIXME -- these plugins should be moved out of Circulation.pm
173 sub barcodedecode {
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') {
179 $barcode =~ s/\s//g;
180 } elsif ($filter eq 'cuecat') {
181 chomp($barcode);
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;
198 }else{
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;
207 } else {
208 warn "# [$barcode] not valid EAN-13/UPC-A\n";
211 return $barcode; # return barcode, modified or not
214 =head2 decode
216 $str = &decode($chunk);
218 Decodes a segment of a string emitted by a CueCat barcode scanner and
219 returns it.
221 FIXME: Should be replaced with Barcode::Cuecat from CPAN
222 or Javascript based decoding on the client side.
224 =cut
226 sub decode {
227 my ($encoded) = @_;
228 my $seq =
229 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
230 my @s = map { index( $seq, $_ ); } split( //, $encoded );
231 my $l = ( $#s + 1 ) % 4;
232 if ($l) {
233 if ( $l == 1 ) {
234 # warn "Error: Cuecat decode parsing failed!";
235 return;
237 $l = 4 - $l;
238 $#s += $l;
240 my $r = '';
241 while ( $#s >= 0 ) {
242 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
243 $r .=
244 chr( ( $n >> 16 ) ^ 67 )
245 .chr( ( $n >> 8 & 255 ) ^ 67 )
246 .chr( ( $n & 255 ) ^ 67 );
247 @s = @s[ 4 .. $#s ];
249 $r = substr( $r, 0, length($r) - $l );
250 return $r;
253 =head2 transferbook
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:
269 =over
271 =item $dotransfer
273 is true if the transfer was successful.
275 =item $messages
277 is a reference-to-hash which may have any of the following keys:
279 =over
281 =item C<BadBarcode>
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.
289 =item C<WasReturned>
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.
293 =item C<ResFound>
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.
301 =back
303 =back
305 =cut
307 sub transferbook {
308 my ( $tbr, $barcode, $ignoreRs ) = @_;
309 my $messages;
310 my $dotransfer = 1;
311 my $item = Koha::Items->find( { barcode => $barcode } );
313 # bad barcode..
314 unless ( $item ) {
315 $messages->{'BadBarcode'} = $barcode;
316 $dotransfer = 0;
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;
331 $dotransfer = 0;
333 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
334 $messages->{'NotAllowed'} = $tbr . "::" . $code;
335 $dotransfer = 0;
339 # can't transfer book if is already there....
340 if ( $fbr eq $tbr ) {
341 $messages->{'DestinationEqualsHolding'} = 1;
342 $dotransfer = 0;
345 # check if it is still issued to someone, return it...
346 if ( $issue ) {
347 AddReturn( $barcode, $fbr );
348 $messages->{'WasReturned'} = $issue->borrowernumber;
351 # find reserves.....
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;
359 $dotransfer = 1;
362 #actually do the transfer....
363 if ($dotransfer) {
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 );
375 sub TooMany {
376 my $borrower = shift;
377 my $item_object = shift;
378 my $params = shift;
379 my $onsite_checkout = $params->{onsite_checkout} || 0;
380 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
381 my $cat_borrower = $borrower->{'categorycode'};
382 my $dbh = C4::Context->dbh;
383 my $branch;
384 # Get which branchcode we need
385 $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
386 my $type = $item_object->effective_itemtype;
388 # given branch, patron category, and item type, determine
389 # applicable issuing rule
390 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
392 categorycode => $cat_borrower,
393 itemtype => $type,
394 branchcode => $branch,
395 rule_name => 'maxissueqty',
398 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
400 categorycode => $cat_borrower,
401 itemtype => $type,
402 branchcode => $branch,
403 rule_name => 'maxonsiteissueqty',
408 # if a rule is found and has a loan limit set, count
409 # how many loans the patron already has that meet that
410 # rule
411 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne '') {
412 my @bind_params;
413 my $count_query = q|
414 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
415 FROM issues
416 JOIN items USING (itemnumber)
419 my $rule_itemtype = $maxissueqty_rule->itemtype;
420 unless ($rule_itemtype) {
421 # matching rule has the default item type, so count only
422 # those existing loans that don't fall under a more
423 # specific rule
424 if (C4::Context->preference('item-level_itypes')) {
425 $count_query .= " WHERE items.itype NOT IN (
426 SELECT itemtype FROM issuingrules
427 WHERE branchcode = ?
428 AND (categorycode = ? OR categorycode = ?)
429 AND itemtype <> '*'
430 ) ";
431 } else {
432 $count_query .= " JOIN biblioitems USING (biblionumber)
433 WHERE biblioitems.itemtype NOT IN (
434 SELECT itemtype FROM issuingrules
435 WHERE branchcode = ?
436 AND (categorycode = ? OR categorycode = ?)
437 AND itemtype <> '*'
438 ) ";
440 push @bind_params, $maxissueqty_rule->branchcode;
441 push @bind_params, $maxissueqty_rule->categorycode;
442 push @bind_params, $cat_borrower;
443 } else {
444 # rule has specific item type, so count loans of that
445 # specific item type
446 if (C4::Context->preference('item-level_itypes')) {
447 $count_query .= " WHERE items.itype = ? ";
448 } else {
449 $count_query .= " JOIN biblioitems USING (biblionumber)
450 WHERE biblioitems.itemtype= ? ";
452 push @bind_params, $type;
455 $count_query .= " AND borrowernumber = ? ";
456 push @bind_params, $borrower->{'borrowernumber'};
457 my $rule_branch = $maxissueqty_rule->branchcode;
458 if ($rule_branch) {
459 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
460 $count_query .= " AND issues.branchcode = ? ";
461 push @bind_params, $rule_branch;
462 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
463 ; # if branch is the patron's home branch, then count all loans by patron
464 } else {
465 $count_query .= " AND items.homebranch = ? ";
466 push @bind_params, $rule_branch;
470 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
472 my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
473 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
475 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
476 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
477 return {
478 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
479 count => $onsite_checkout_count,
480 max_allowed => $max_onsite_checkouts_allowed,
484 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
485 my $delta = $switch_onsite_checkout ? 1 : 0;
486 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
487 return {
488 reason => 'TOO_MANY_CHECKOUTS',
489 count => $checkout_count,
490 max_allowed => $max_checkouts_allowed,
493 } elsif ( not $onsite_checkout ) {
494 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
495 return {
496 reason => 'TOO_MANY_CHECKOUTS',
497 count => $checkout_count - $onsite_checkout_count,
498 max_allowed => $max_checkouts_allowed,
504 # Now count total loans against the limit for the branch
505 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
506 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
507 my @bind_params = ();
508 my $branch_count_query = q|
509 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
510 FROM issues
511 JOIN items USING (itemnumber)
512 WHERE borrowernumber = ?
514 push @bind_params, $borrower->{borrowernumber};
516 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
517 $branch_count_query .= " AND issues.branchcode = ? ";
518 push @bind_params, $branch;
519 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
520 ; # if branch is the patron's home branch, then count all loans by patron
521 } else {
522 $branch_count_query .= " AND items.homebranch = ? ";
523 push @bind_params, $branch;
525 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
526 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
527 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
529 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
530 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
531 return {
532 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
533 count => $onsite_checkout_count,
534 max_allowed => $max_onsite_checkouts_allowed,
538 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
539 my $delta = $switch_onsite_checkout ? 1 : 0;
540 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
541 return {
542 reason => 'TOO_MANY_CHECKOUTS',
543 count => $checkout_count,
544 max_allowed => $max_checkouts_allowed,
547 } elsif ( not $onsite_checkout ) {
548 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
549 return {
550 reason => 'TOO_MANY_CHECKOUTS',
551 count => $checkout_count - $onsite_checkout_count,
552 max_allowed => $max_checkouts_allowed,
558 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
559 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
562 # OK, the patron can issue !!!
563 return;
566 =head2 CanBookBeIssued
568 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
569 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
571 Check if a book can be issued.
573 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
575 IMPORTANT: The assumption by users of this routine is that causes blocking
576 the issue are keyed by uppercase labels and other returned
577 data is keyed in lower case!
579 =over 4
581 =item C<$patron> is a Koha::Patron
583 =item C<$barcode> is the bar code of the book being issued.
585 =item C<$duedates> is a DateTime object.
587 =item C<$inprocess> boolean switch
589 =item C<$ignore_reserves> boolean switch
591 =item C<$params> Hashref of additional parameters
593 Available keys:
594 override_high_holds - Ignore high holds
595 onsite_checkout - Checkout is an onsite checkout that will not leave the library
597 =back
599 Returns :
601 =over 4
603 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
604 Possible values are :
606 =back
608 =head3 INVALID_DATE
610 sticky due date is invalid
612 =head3 GNA
614 borrower gone with no address
616 =head3 CARD_LOST
618 borrower declared it's card lost
620 =head3 DEBARRED
622 borrower debarred
624 =head3 UNKNOWN_BARCODE
626 barcode unknown
628 =head3 NOT_FOR_LOAN
630 item is not for loan
632 =head3 WTHDRAWN
634 item withdrawn.
636 =head3 RESTRICTED
638 item is restricted (set by ??)
640 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
641 could be prevented, but ones that can be overriden by the operator.
643 Possible values are :
645 =head3 DEBT
647 borrower has debts.
649 =head3 RENEW_ISSUE
651 renewing, not issuing
653 =head3 ISSUED_TO_ANOTHER
655 issued to someone else.
657 =head3 RESERVED
659 reserved for someone else.
661 =head3 INVALID_DATE
663 sticky due date is invalid or due date in the past
665 =head3 TOO_MANY
667 if the borrower borrows to much things
669 =cut
671 sub CanBookBeIssued {
672 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
673 my %needsconfirmation; # filled with problems that needs confirmations
674 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
675 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
676 my %messages; # filled with information messages that should be displayed.
678 my $onsite_checkout = $params->{onsite_checkout} || 0;
679 my $override_high_holds = $params->{override_high_holds} || 0;
681 my $item_object = Koha::Items->find({barcode => $barcode });
683 # MANDATORY CHECKS - unless item exists, nothing else matters
684 unless ( $item_object ) {
685 $issuingimpossible{UNKNOWN_BARCODE} = 1;
687 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
689 my $item_unblessed = $item_object->unblessed; # Transition...
690 my $issue = $item_object->checkout;
691 my $biblio = $item_object->biblio;
693 my $biblioitem = $biblio->biblioitem;
694 my $effective_itemtype = $item_object->effective_itemtype;
695 my $dbh = C4::Context->dbh;
696 my $patron_unblessed = $patron->unblessed;
698 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
700 # DUE DATE is OK ? -- should already have checked.
702 if ($duedate && ref $duedate ne 'DateTime') {
703 $duedate = dt_from_string($duedate);
705 my $now = DateTime->now( time_zone => C4::Context->tz() );
706 unless ( $duedate ) {
707 my $issuedate = $now->clone();
709 my $branch = $circ_library;
710 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $branch, $patron_unblessed );
712 # Offline circ calls AddIssue directly, doesn't run through here
713 # So issuingimpossible should be ok.
716 my $fees = Koha::Charges::Fees->new(
718 patron => $patron,
719 library => $circ_library,
720 item => $item_object,
721 to_date => $duedate,
725 if ($duedate) {
726 my $today = $now->clone();
727 $today->truncate( to => 'minute');
728 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
729 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
731 } else {
732 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
736 # BORROWER STATUS
738 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
739 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
740 &UpdateStats({
741 branch => C4::Context->userenv->{'branch'},
742 type => 'localuse',
743 itemnumber => $item_object->itemnumber,
744 itemtype => $effective_itemtype,
745 borrowernumber => $patron->borrowernumber,
746 ccode => $item_object->ccode}
748 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
749 return( { STATS => 1 }, {});
752 if ( $patron->gonenoaddress == 1 ) {
753 $issuingimpossible{GNA} = 1;
756 if ( $patron->lost == 1 ) {
757 $issuingimpossible{CARD_LOST} = 1;
759 if ( $patron->is_debarred ) {
760 $issuingimpossible{DEBARRED} = 1;
763 if ( $patron->is_expired ) {
764 $issuingimpossible{EXPIRED} = 1;
768 # BORROWER STATUS
771 # DEBTS
772 my $account = $patron->account;
773 my $balance = $account->balance;
774 my $non_issues_charges = $account->non_issues_charges;
775 my $other_charges = $balance - $non_issues_charges;
777 my $amountlimit = C4::Context->preference("noissuescharge");
778 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
779 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
781 # Check the debt of this patrons guarantees
782 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
783 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
784 if ( defined $no_issues_charge_guarantees ) {
785 my @guarantees = map { $_->guarantee } $patron->guarantee_relationships();
786 my $guarantees_non_issues_charges;
787 foreach my $g ( @guarantees ) {
788 $guarantees_non_issues_charges += $g->account->non_issues_charges;
791 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
792 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
793 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
794 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
795 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
796 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
800 if ( C4::Context->preference("IssuingInProcess") ) {
801 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
802 $issuingimpossible{DEBT} = $non_issues_charges;
803 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
804 $needsconfirmation{DEBT} = $non_issues_charges;
805 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
806 $needsconfirmation{DEBT} = $non_issues_charges;
809 else {
810 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
811 $needsconfirmation{DEBT} = $non_issues_charges;
812 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
813 $issuingimpossible{DEBT} = $non_issues_charges;
814 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
815 $needsconfirmation{DEBT} = $non_issues_charges;
819 if ($balance > 0 && $other_charges > 0) {
820 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
823 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
824 $patron_unblessed = $patron->unblessed;
826 if ( my $debarred_date = $patron->is_debarred ) {
827 # patron has accrued fine days or has a restriction. $count is a date
828 if ($debarred_date eq '9999-12-31') {
829 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
831 else {
832 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
834 } elsif ( my $num_overdues = $patron->has_overdues ) {
835 ## patron has outstanding overdue loans
836 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
837 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
839 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
840 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
845 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
847 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
849 # Already issued to current borrower.
850 # If it is an on-site checkout if it can be switched to a normal checkout
851 # or ask whether the loan should be renewed
853 if ( $issue->onsite_checkout
854 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
855 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
856 } else {
857 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
858 $patron->borrowernumber,
859 $item_object->itemnumber,
861 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
862 if ( $renewerror eq 'onsite_checkout' ) {
863 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
865 else {
866 $issuingimpossible{NO_MORE_RENEWALS} = 1;
869 else {
870 $needsconfirmation{RENEW_ISSUE} = 1;
874 elsif ( $issue ) {
876 # issued to someone else
878 my $patron = Koha::Patrons->find( $issue->borrowernumber );
880 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
882 unless ( $can_be_returned ) {
883 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
884 $issuingimpossible{branch_to_return} = $message;
885 } else {
886 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
887 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
888 } else {
889 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
890 $needsconfirmation{issued_firstname} = $patron->firstname;
891 $needsconfirmation{issued_surname} = $patron->surname;
892 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
893 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
898 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
900 my $switch_onsite_checkout = (
901 C4::Context->preference('SwitchOnSiteCheckouts')
902 and $issue
903 and $issue->onsite_checkout
904 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
905 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
906 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
907 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
908 if ( $toomany->{max_allowed} == 0 ) {
909 $needsconfirmation{PATRON_CANT} = 1;
911 if ( C4::Context->preference("AllowTooManyOverride") ) {
912 $needsconfirmation{TOO_MANY} = $toomany->{reason};
913 $needsconfirmation{current_loan_count} = $toomany->{count};
914 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
915 } else {
916 $issuingimpossible{TOO_MANY} = $toomany->{reason};
917 $issuingimpossible{current_loan_count} = $toomany->{count};
918 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
923 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
925 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
926 my $wants_check = $patron->wants_check_for_previous_checkout;
927 $needsconfirmation{PREVISSUE} = 1
928 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
931 # ITEM CHECKING
933 if ( $item_object->notforloan )
935 if(!C4::Context->preference("AllowNotForLoanOverride")){
936 $issuingimpossible{NOT_FOR_LOAN} = 1;
937 $issuingimpossible{item_notforloan} = $item_object->notforloan;
938 }else{
939 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
940 $needsconfirmation{item_notforloan} = $item_object->notforloan;
943 else {
944 # we have to check itemtypes.notforloan also
945 if (C4::Context->preference('item-level_itypes')){
946 # this should probably be a subroutine
947 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
948 $sth->execute($effective_itemtype);
949 my $notforloan=$sth->fetchrow_hashref();
950 if ($notforloan->{'notforloan'}) {
951 if (!C4::Context->preference("AllowNotForLoanOverride")) {
952 $issuingimpossible{NOT_FOR_LOAN} = 1;
953 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
954 } else {
955 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
956 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
960 else {
961 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
962 if ( $itemtype and $itemtype->notforloan == 1){
963 if (!C4::Context->preference("AllowNotForLoanOverride")) {
964 $issuingimpossible{NOT_FOR_LOAN} = 1;
965 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
966 } else {
967 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
968 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
973 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
975 $issuingimpossible{WTHDRAWN} = 1;
977 if ( $item_object->restricted
978 && $item_object->restricted == 1 )
980 $issuingimpossible{RESTRICTED} = 1;
982 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
983 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
984 my $code = $av->count ? $av->next->lib : '';
985 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
986 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
988 if ( C4::Context->preference("IndependentBranches") ) {
989 my $userenv = C4::Context->userenv;
990 unless ( C4::Context->IsSuperLibrarian() ) {
991 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
992 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
993 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
994 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
996 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
997 if ( $patron->branchcode ne $userenv->{branch} );
1001 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1003 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1005 if ( $rentalConfirmation ){
1006 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1007 my $itemtype = Koha::ItemTypes->find( $item_object->itype ); # GetItem sets effective itemtype
1008 $rentalCharge += $fees->accumulate_rentalcharge({ from => dt_from_string(), to => $duedate });
1009 if ( $rentalCharge > 0 ){
1010 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1014 unless ( $ignore_reserves ) {
1015 # See if the item is on reserve.
1016 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1017 if ($restype) {
1018 my $resbor = $res->{'borrowernumber'};
1019 if ( $resbor ne $patron->borrowernumber ) {
1020 my $patron = Koha::Patrons->find( $resbor );
1021 if ( $restype eq "Waiting" )
1023 # The item is on reserve and waiting, but has been
1024 # reserved by some other patron.
1025 $needsconfirmation{RESERVE_WAITING} = 1;
1026 $needsconfirmation{'resfirstname'} = $patron->firstname;
1027 $needsconfirmation{'ressurname'} = $patron->surname;
1028 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1029 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1030 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1031 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1033 elsif ( $restype eq "Reserved" ) {
1034 # The item is on reserve for someone else.
1035 $needsconfirmation{RESERVED} = 1;
1036 $needsconfirmation{'resfirstname'} = $patron->firstname;
1037 $needsconfirmation{'ressurname'} = $patron->surname;
1038 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1039 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1040 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1041 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1047 ## CHECK AGE RESTRICTION
1048 my $agerestriction = $biblioitem->agerestriction;
1049 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1050 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1051 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1052 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1054 else {
1055 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1059 ## check for high holds decreasing loan period
1060 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1061 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1063 if ( $check->{exceeded} ) {
1064 if ($override_high_holds) {
1065 $alerts{HIGHHOLDS} = {
1066 num_holds => $check->{outstanding},
1067 duration => $check->{duration},
1068 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1071 else {
1072 $needsconfirmation{HIGHHOLDS} = {
1073 num_holds => $check->{outstanding},
1074 duration => $check->{duration},
1075 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1081 if (
1082 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1083 # don't do the multiple loans per bib check if we've
1084 # already determined that we've got a loan on the same item
1085 !$issuingimpossible{NO_MORE_RENEWALS} &&
1086 !$needsconfirmation{RENEW_ISSUE}
1088 # Check if borrower has already issued an item from the same biblio
1089 # Only if it's not a subscription
1090 my $biblionumber = $item_object->biblionumber;
1091 require C4::Serials;
1092 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1093 unless ($is_a_subscription) {
1094 # FIXME Should be $patron->checkouts($args);
1095 my $checkouts = Koha::Checkouts->search(
1097 borrowernumber => $patron->borrowernumber,
1098 biblionumber => $biblionumber,
1101 join => 'item',
1104 # if we get here, we don't already have a loan on this item,
1105 # so if there are any loans on this bib, ask for confirmation
1106 if ( $checkouts->count ) {
1107 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1112 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1115 =head2 CanBookBeReturned
1117 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1119 Check whether the item can be returned to the provided branch
1121 =over 4
1123 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1125 =item C<$branch> is the branchcode where the return is taking place
1127 =back
1129 Returns:
1131 =over 4
1133 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1135 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1137 =back
1139 =cut
1141 sub CanBookBeReturned {
1142 my ($item, $branch) = @_;
1143 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1145 # assume return is allowed to start
1146 my $allowed = 1;
1147 my $message;
1149 # identify all cases where return is forbidden
1150 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1151 $allowed = 0;
1152 $message = $item->{'homebranch'};
1153 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1154 $allowed = 0;
1155 $message = $item->{'holdingbranch'};
1156 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1157 $allowed = 0;
1158 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1161 return ($allowed, $message);
1164 =head2 CheckHighHolds
1166 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1167 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1168 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1170 =cut
1172 sub checkHighHolds {
1173 my ( $item, $borrower ) = @_;
1174 my $branch = _GetCircControlBranch( $item, $borrower );
1175 my $item_object = Koha::Items->find( $item->{itemnumber} );
1177 my $return_data = {
1178 exceeded => 0,
1179 outstanding => 0,
1180 duration => 0,
1181 due_date => undef,
1184 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1186 if ( $holds->count() ) {
1187 $return_data->{outstanding} = $holds->count();
1189 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1190 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1191 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1193 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1195 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1197 # static means just more than a given number of holds on the record
1199 # If the number of holds is less than the threshold, we can stop here
1200 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1201 return $return_data;
1204 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1206 # dynamic means X more than the number of holdable items on the record
1208 # let's get the items
1209 my @items = $holds->next()->biblio()->items()->as_list;
1211 # Remove any items with status defined to be ignored even if the would not make item unholdable
1212 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1213 @items = grep { !$_->$status } @items;
1216 # Remove any items that are not holdable for this patron
1217 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber )->{status} eq 'OK' } @items;
1219 my $items_count = scalar @items;
1221 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1223 # If the number of holds is less than the count of items we have
1224 # plus the number of holds allowed above that count, we can stop here
1225 if ( $holds->count() <= $threshold ) {
1226 return $return_data;
1230 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1232 my $calendar = Koha::Calendar->new( branchcode => $branch );
1234 my $itype = $item_object->effective_itemtype;
1235 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1237 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1239 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1240 $reduced_datedue->set_hour($orig_due->hour);
1241 $reduced_datedue->set_minute($orig_due->minute);
1242 $reduced_datedue->truncate( to => 'minute' );
1244 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1245 $return_data->{exceeded} = 1;
1246 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1247 $return_data->{due_date} = $reduced_datedue;
1251 return $return_data;
1254 =head2 AddIssue
1256 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1258 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1260 =over 4
1262 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1264 =item C<$barcode> is the barcode of the item being issued.
1266 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1267 Calculated if empty.
1269 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1271 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1272 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1274 AddIssue does the following things :
1276 - step 01: check that there is a borrowernumber & a barcode provided
1277 - check for RENEWAL (book issued & being issued to the same patron)
1278 - renewal YES = Calculate Charge & renew
1279 - renewal NO =
1280 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1281 * RESERVE PLACED ?
1282 - fill reserve if reserve to this patron
1283 - cancel reserve or not, otherwise
1284 * TRANSFERT PENDING ?
1285 - complete the transfert
1286 * ISSUE THE BOOK
1288 =back
1290 =cut
1292 sub AddIssue {
1293 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1295 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1296 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1297 my $auto_renew = $params && $params->{auto_renew};
1298 my $dbh = C4::Context->dbh;
1299 my $barcodecheck = CheckValidBarcode($barcode);
1301 my $issue;
1303 if ( $datedue && ref $datedue ne 'DateTime' ) {
1304 $datedue = dt_from_string($datedue);
1307 # $issuedate defaults to today.
1308 if ( !defined $issuedate ) {
1309 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1311 else {
1312 if ( ref $issuedate ne 'DateTime' ) {
1313 $issuedate = dt_from_string($issuedate);
1318 # Stop here if the patron or barcode doesn't exist
1319 if ( $borrower && $barcode && $barcodecheck ) {
1320 # find which item we issue
1321 my $item_object = Koha::Items->find({ barcode => $barcode })
1322 or return; # if we don't get an Item, abort.
1323 my $item_unblessed = $item_object->unblessed;
1325 my $branch = _GetCircControlBranch( $item_unblessed, $borrower );
1327 # get actual issuing if there is one
1328 my $actualissue = $item_object->checkout;
1330 # check if we just renew the issue.
1331 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1332 and not $switch_onsite_checkout ) {
1333 $datedue = AddRenewal(
1334 $borrower->{'borrowernumber'},
1335 $item_object->itemnumber,
1336 $branch,
1337 $datedue,
1338 $issuedate, # here interpreted as the renewal date
1341 else {
1342 unless ($datedue) {
1343 my $itype = $item_object->effective_itemtype;
1344 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1347 $datedue->truncate( to => 'minute' );
1349 my $patron = Koha::Patrons->find( $borrower );
1350 my $library = Koha::Libraries->find( $branch );
1351 my $fees = Koha::Charges::Fees->new(
1353 patron => $patron,
1354 library => $library,
1355 item => $item_object,
1356 to_date => $datedue,
1360 # it's NOT a renewal
1361 if ( $actualissue and not $switch_onsite_checkout ) {
1362 # This book is currently on loan, but not to the person
1363 # who wants to borrow it now. mark it returned before issuing to the new borrower
1364 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1365 return unless $allowed;
1366 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1369 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1371 # Starting process for transfer job (checking transfert and validate it if we have one)
1372 my ($datesent) = GetTransfers( $item_object->itemnumber );
1373 if ($datesent) {
1374 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1375 my $sth = $dbh->prepare(
1376 "UPDATE branchtransfers
1377 SET datearrived = now(),
1378 tobranch = ?,
1379 comments = 'Forced branchtransfer'
1380 WHERE itemnumber= ? AND datearrived IS NULL"
1382 $sth->execute( C4::Context->userenv->{'branch'},
1383 $item_object->itemnumber );
1386 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1387 unless ($auto_renew) {
1388 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1389 { categorycode => $borrower->{categorycode},
1390 itemtype => $item_object->effective_itemtype,
1391 branchcode => $branch
1395 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1398 # Record in the database the fact that the book was issued.
1399 unless ($datedue) {
1400 my $itype = $item_object->effective_itemtype;
1401 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1404 $datedue->truncate( to => 'minute' );
1406 my $issue_attributes = {
1407 borrowernumber => $borrower->{'borrowernumber'},
1408 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1409 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1410 branchcode => C4::Context->userenv->{'branch'},
1411 onsite_checkout => $onsite_checkout,
1412 auto_renew => $auto_renew ? 1 : 0,
1415 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1416 if ($issue) {
1417 $issue->set($issue_attributes)->store;
1419 else {
1420 $issue = Koha::Checkout->new(
1422 itemnumber => $item_object->itemnumber,
1423 %$issue_attributes,
1425 )->store;
1427 if ( $item_object->location eq 'CART' && $item_object->permanent_location ne 'CART' ) {
1428 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1429 CartToShelf( $item_object->itemnumber );
1432 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1433 UpdateTotalIssues( $item_object->biblionumber, 1 );
1436 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1437 if ( $item_object->itemlost ) {
1438 if (
1439 Koha::RefundLostItemFeeRules->should_refund(
1441 current_branch => C4::Context->userenv->{branch},
1442 item_home_branch => $item_object->homebranch,
1443 item_holding_branch => $item_object->holdingbranch,
1448 _FixAccountForLostAndReturned( $item_object->itemnumber, undef,
1449 $item_object->barcode );
1453 ModItem(
1455 issues => $item_object->issues + 1,
1456 holdingbranch => C4::Context->userenv->{'branch'},
1457 itemlost => 0,
1458 onloan => $datedue->ymd(),
1459 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1461 $item_object->biblionumber,
1462 $item_object->itemnumber,
1463 { log_action => 0 }
1465 ModDateLastSeen( $item_object->itemnumber );
1467 # If it costs to borrow this book, charge it to the patron's account.
1468 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1469 if ( $charge > 0 ) {
1470 AddIssuingCharge( $issue, $charge, 'rent' );
1473 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1474 if ( $itemtype_object ) {
1475 my $accumulate_charge = $fees->accumulate_rentalcharge();
1476 if ( $accumulate_charge > 0 ) {
1477 AddIssuingCharge( $issue, $accumulate_charge, 'rent_daily' ) if $accumulate_charge > 0;
1478 $charge += $accumulate_charge;
1479 $item_unblessed->{charge} = $charge;
1483 # Record the fact that this book was issued.
1484 &UpdateStats(
1486 branch => C4::Context->userenv->{'branch'},
1487 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1488 amount => $charge,
1489 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1490 itemnumber => $item_object->itemnumber,
1491 itemtype => $item_object->effective_itemtype,
1492 location => $item_object->location,
1493 borrowernumber => $borrower->{'borrowernumber'},
1494 ccode => $item_object->ccode,
1498 # Send a checkout slip.
1499 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1500 my %conditions = (
1501 branchcode => $branch,
1502 categorycode => $borrower->{categorycode},
1503 item_type => $item_object->effective_itemtype,
1504 notification => 'CHECKOUT',
1506 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1507 SendCirculationAlert(
1509 type => 'CHECKOUT',
1510 item => $item_object->unblessed,
1511 borrower => $borrower,
1512 branch => $branch,
1516 logaction(
1517 "CIRCULATION", "ISSUE",
1518 $borrower->{'borrowernumber'},
1519 $item_object->itemnumber,
1520 ) if C4::Context->preference("IssueLog");
1523 return $issue;
1526 =head2 GetLoanLength
1528 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1530 Get loan length for an itemtype, a borrower type and a branch
1532 =cut
1534 sub GetLoanLength {
1535 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1536 my $dbh = C4::Context->dbh;
1537 my $sth = $dbh->prepare(qq{
1538 SELECT issuelength, lengthunit, renewalperiod
1539 FROM issuingrules
1540 WHERE categorycode=?
1541 AND itemtype=?
1542 AND branchcode=?
1543 AND issuelength IS NOT NULL
1546 # try to find issuelength & return the 1st available.
1547 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1548 $sth->execute( $borrowertype, $itemtype, $branchcode );
1549 my $loanlength = $sth->fetchrow_hashref;
1551 return $loanlength
1552 if defined($loanlength) && defined $loanlength->{issuelength};
1554 $sth->execute( $borrowertype, '*', $branchcode );
1555 $loanlength = $sth->fetchrow_hashref;
1556 return $loanlength
1557 if defined($loanlength) && defined $loanlength->{issuelength};
1559 $sth->execute( '*', $itemtype, $branchcode );
1560 $loanlength = $sth->fetchrow_hashref;
1561 return $loanlength
1562 if defined($loanlength) && defined $loanlength->{issuelength};
1564 $sth->execute( '*', '*', $branchcode );
1565 $loanlength = $sth->fetchrow_hashref;
1566 return $loanlength
1567 if defined($loanlength) && defined $loanlength->{issuelength};
1569 $sth->execute( $borrowertype, $itemtype, '*' );
1570 $loanlength = $sth->fetchrow_hashref;
1571 return $loanlength
1572 if defined($loanlength) && defined $loanlength->{issuelength};
1574 $sth->execute( $borrowertype, '*', '*' );
1575 $loanlength = $sth->fetchrow_hashref;
1576 return $loanlength
1577 if defined($loanlength) && defined $loanlength->{issuelength};
1579 $sth->execute( '*', $itemtype, '*' );
1580 $loanlength = $sth->fetchrow_hashref;
1581 return $loanlength
1582 if defined($loanlength) && defined $loanlength->{issuelength};
1584 $sth->execute( '*', '*', '*' );
1585 $loanlength = $sth->fetchrow_hashref;
1586 return $loanlength
1587 if defined($loanlength) && defined $loanlength->{issuelength};
1589 # if no rule is set => 0 day (hardcoded)
1590 return {
1591 issuelength => 0,
1592 renewalperiod => 0,
1593 lengthunit => 'days',
1599 =head2 GetHardDueDate
1601 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1603 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1605 =cut
1607 sub GetHardDueDate {
1608 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1610 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1611 { categorycode => $borrowertype,
1612 itemtype => $itemtype,
1613 branchcode => $branchcode
1618 if ( defined( $issuing_rule ) ) {
1619 if ( $issuing_rule->hardduedate ) {
1620 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1621 } else {
1622 return (undef, undef);
1627 =head2 GetBranchBorrowerCircRule
1629 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1631 Retrieves circulation rule attributes that apply to the given
1632 branch and patron category, regardless of item type.
1633 The return value is a hashref containing the following key:
1635 patron_maxissueqty - maximum number of loans that a
1636 patron of the given category can have at the given
1637 branch. If the value is undef, no limit.
1639 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1640 patron of the given category can have at the given
1641 branch. If the value is undef, no limit.
1643 This will check for different branch/category combinations in the following order:
1644 branch and category
1645 branch only
1646 category only
1647 default branch and category
1649 If no rule has been found in the database, it will default to
1650 the buillt in rule:
1652 patron_maxissueqty - undef
1653 patron_maxonsiteissueqty - undef
1655 C<$branchcode> and C<$categorycode> should contain the
1656 literal branch code and patron category code, respectively - no
1657 wildcards.
1659 =cut
1661 sub GetBranchBorrowerCircRule {
1662 my ( $branchcode, $categorycode ) = @_;
1664 # Initialize default values
1665 my $rules = {
1666 patron_maxissueqty => undef,
1667 patron_maxonsiteissueqty => undef,
1670 # Search for rules!
1671 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1672 my $rule = Koha::CirculationRules->get_effective_rule(
1674 categorycode => $categorycode,
1675 itemtype => undef,
1676 branchcode => $branchcode,
1677 rule_name => $rule_name,
1681 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1684 return $rules;
1687 =head2 GetBranchItemRule
1689 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1691 Retrieves circulation rule attributes that apply to the given
1692 branch and item type, regardless of patron category.
1694 The return value is a hashref containing the following keys:
1696 holdallowed => Hold policy for this branch and itemtype. Possible values:
1697 0: No holds allowed.
1698 1: Holds allowed only by patrons that have the same homebranch as the item.
1699 2: Holds allowed from any patron.
1701 returnbranch => branch to which to return item. Possible values:
1702 noreturn: do not return, let item remain where checked in (floating collections)
1703 homebranch: return to item's home branch
1704 holdingbranch: return to issuer branch
1706 This searches branchitemrules in the following order:
1708 * Same branchcode and itemtype
1709 * Same branchcode, itemtype '*'
1710 * branchcode '*', same itemtype
1711 * branchcode and itemtype '*'
1713 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1715 =cut
1717 sub GetBranchItemRule {
1718 my ( $branchcode, $itemtype ) = @_;
1720 # Search for rules!
1721 my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1723 branchcode => $branchcode,
1724 itemtype => $itemtype,
1725 rule_name => 'holdallowed',
1728 my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1730 branchcode => $branchcode,
1731 itemtype => $itemtype,
1732 rule_name => 'hold_fulfillment_policy',
1735 my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1737 branchcode => $branchcode,
1738 itemtype => $itemtype,
1739 rule_name => 'returnbranch',
1743 # built-in default circulation rule
1744 my $rules;
1745 $rules->{holdallowed} = defined $holdallowed_rule
1746 ? $holdallowed_rule->rule_value
1747 : 2;
1748 $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1749 ? $hold_fulfillment_policy_rule->rule_value
1750 : 'any';
1751 $rules->{returnbranch} = defined $returnbranch_rule
1752 ? $returnbranch_rule->rule_value
1753 : 'homebranch';
1755 return $rules;
1758 =head2 AddReturn
1760 ($doreturn, $messages, $iteminformation, $borrower) =
1761 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1763 Returns a book.
1765 =over 4
1767 =item C<$barcode> is the bar code of the book being returned.
1769 =item C<$branch> is the code of the branch where the book is being returned.
1771 =item C<$exemptfine> indicates that overdue charges for the item will be
1772 removed. Optional.
1774 =item C<$return_date> allows the default return date to be overridden
1775 by the given return date. Optional.
1777 =back
1779 C<&AddReturn> returns a list of four items:
1781 C<$doreturn> is true iff the return succeeded.
1783 C<$messages> is a reference-to-hash giving feedback on the operation.
1784 The keys of the hash are:
1786 =over 4
1788 =item C<BadBarcode>
1790 No item with this barcode exists. The value is C<$barcode>.
1792 =item C<NotIssued>
1794 The book is not currently on loan. The value is C<$barcode>.
1796 =item C<withdrawn>
1798 This book has been withdrawn/cancelled. The value should be ignored.
1800 =item C<Wrongbranch>
1802 This book has was returned to the wrong branch. The value is a hashref
1803 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1804 contain the branchcode of the incorrect and correct return library, respectively.
1806 =item C<ResFound>
1808 The item was reserved. The value is a reference-to-hash whose keys are
1809 fields from the reserves table of the Koha database, and
1810 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1811 either C<Waiting>, C<Reserved>, or 0.
1813 =item C<WasReturned>
1815 Value 1 if return is successful.
1817 =item C<NeedsTransfer>
1819 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1821 =back
1823 C<$iteminformation> is a reference-to-hash, giving information about the
1824 returned item from the issues table.
1826 C<$borrower> is a reference-to-hash, giving information about the
1827 patron who last borrowed the book.
1829 =cut
1831 sub AddReturn {
1832 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1834 if ($branch and not Koha::Libraries->find($branch)) {
1835 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1836 undef $branch;
1838 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1839 $return_date //= dt_from_string();
1840 my $messages;
1841 my $patron;
1842 my $doreturn = 1;
1843 my $validTransfert = 0;
1844 my $stat_type = 'return';
1846 # get information on item
1847 my $item = Koha::Items->find({ barcode => $barcode });
1848 unless ($item) {
1849 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1852 my $itemnumber = $item->itemnumber;
1853 my $itemtype = $item->effective_itemtype;
1855 my $issue = $item->checkout;
1856 if ( $issue ) {
1857 $patron = $issue->patron
1858 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1859 . Dumper($issue->unblessed) . "\n";
1860 } else {
1861 $messages->{'NotIssued'} = $barcode;
1862 ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1863 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1864 $doreturn = 0;
1865 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1866 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1867 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1868 $messages->{'LocalUse'} = 1;
1869 $stat_type = 'localuse';
1873 my $item_unblessed = $item->unblessed;
1874 # full item data, but no borrowernumber or checkout info (no issue)
1875 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1876 # get the proper branch to which to return the item
1877 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1878 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1880 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1881 my $patron_unblessed = $patron ? $patron->unblessed : {};
1883 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1884 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1885 if ($update_loc_rules) {
1886 if (defined $update_loc_rules->{_ALL_}) {
1887 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1888 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1889 if ( $item->location ne $update_loc_rules->{_ALL_}) {
1890 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1891 ModItem( { location => $update_loc_rules->{_ALL_} }, undef, $itemnumber );
1894 else {
1895 foreach my $key ( keys %$update_loc_rules ) {
1896 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1897 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1898 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1899 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1900 ModItem( { location => $update_loc_rules->{$key} }, undef, $itemnumber );
1901 last;
1907 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1908 if ($yaml) {
1909 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1910 my $rules;
1911 eval { $rules = YAML::Load($yaml); };
1912 if ($@) {
1913 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1915 else {
1916 foreach my $key ( keys %$rules ) {
1917 if ( $item->notforloan eq $key ) {
1918 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1919 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1920 last;
1926 # check if the return is allowed at this branch
1927 my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1928 unless ($returnallowed){
1929 $messages->{'Wrongbranch'} = {
1930 Wrongbranch => $branch,
1931 Rightbranch => $message
1933 $doreturn = 0;
1934 return ( $doreturn, $messages, $issue, $patron_unblessed);
1937 if ( $item->withdrawn ) { # book has been cancelled
1938 $messages->{'withdrawn'} = 1;
1939 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1942 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1943 $doreturn = 0;
1946 # case of a return of document (deal with issues and holdingbranch)
1947 if ($doreturn) {
1948 my $is_overdue;
1949 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1950 $patron or warn "AddReturn without current borrower";
1951 $is_overdue = $issue->is_overdue( $return_date );
1953 if ($patron) {
1954 eval {
1955 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1957 unless ( $@ ) {
1958 if ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue && !$item->itemlost ) {
1959 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1961 } else {
1962 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 );
1964 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1967 # FIXME is the "= 1" right? This could be the borrower hash.
1968 $messages->{'WasReturned'} = 1;
1972 ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1975 # the holdingbranch is updated if the document is returned to another location.
1976 # this is always done regardless of whether the item was on loan or not
1977 my $item_holding_branch = $item->holdingbranch;
1978 if ($item->holdingbranch ne $branch) {
1979 UpdateHoldingbranch($branch, $item->itemnumber);
1980 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1983 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1984 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
1986 # check if we have a transfer for this document
1987 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
1989 # if we have a transfer to do, we update the line of transfers with the datearrived
1990 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
1991 if ($datesent) {
1992 if ( $tobranch eq $branch ) {
1993 my $sth = C4::Context->dbh->prepare(
1994 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1996 $sth->execute( $item->itemnumber );
1997 # if we have a reservation with valid transfer, we can set it's status to 'W'
1998 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
1999 } else {
2000 $messages->{'WrongTransfer'} = $tobranch;
2001 $messages->{'WrongTransferItem'} = $item->itemnumber;
2003 $validTransfert = 1;
2006 # fix up the accounts.....
2007 if ( $item->itemlost ) {
2008 $messages->{'WasLost'} = 1;
2009 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2010 if (
2011 Koha::RefundLostItemFeeRules->should_refund(
2013 current_branch => C4::Context->userenv->{branch},
2014 item_home_branch => $item->homebranch,
2015 item_holding_branch => $item_holding_branch
2020 _FixAccountForLostAndReturned( $item->itemnumber,
2021 $borrowernumber, $barcode );
2022 $messages->{'LostItemFeeRefunded'} = 1;
2027 # fix up the overdues in accounts...
2028 if ($borrowernumber) {
2029 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2030 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2032 if ( $issue and $issue->is_overdue ) {
2033 # fix fine days
2034 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $return_date );
2035 if ($reminder){
2036 $messages->{'PrevDebarred'} = $debardate;
2037 } else {
2038 $messages->{'Debarred'} = $debardate if $debardate;
2040 # there's no overdue on the item but borrower had been previously debarred
2041 } elsif ( $issue->date_due and $patron->debarred ) {
2042 if ( $patron->debarred eq "9999-12-31") {
2043 $messages->{'ForeverDebarred'} = $patron->debarred;
2044 } else {
2045 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2046 $borrower_debar_dt->truncate(to => 'day');
2047 my $today_dt = $return_date->clone()->truncate(to => 'day');
2048 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2049 $messages->{'PrevDebarred'} = $patron->debarred;
2055 # find reserves.....
2056 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2057 my ($resfound, $resrec);
2058 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2059 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2060 if ($resfound) {
2061 $resrec->{'ResFound'} = $resfound;
2062 $messages->{'ResFound'} = $resrec;
2065 # Record the fact that this book was returned.
2066 UpdateStats({
2067 branch => $branch,
2068 type => $stat_type,
2069 itemnumber => $itemnumber,
2070 itemtype => $itemtype,
2071 borrowernumber => $borrowernumber,
2072 ccode => $item->ccode,
2075 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2076 if ( $patron ) {
2077 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2078 my %conditions = (
2079 branchcode => $branch,
2080 categorycode => $patron->categorycode,
2081 item_type => $itemtype,
2082 notification => 'CHECKIN',
2084 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2085 SendCirculationAlert({
2086 type => 'CHECKIN',
2087 item => $item_unblessed,
2088 borrower => $patron->unblessed,
2089 branch => $branch,
2093 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2094 if C4::Context->preference("ReturnLog");
2097 # Remove any OVERDUES related debarment if the borrower has no overdues
2098 if ( $borrowernumber
2099 && $patron->debarred
2100 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2101 && !Koha::Patrons->find( $borrowernumber )->has_overdues
2102 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2104 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2107 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2108 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2109 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType");
2110 if (C4::Context->preference("AutomaticItemReturn" ) or
2111 (C4::Context->preference("UseBranchTransferLimits") and
2112 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2113 )) {
2114 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2115 $debug and warn "item: " . Dumper($item_unblessed);
2116 ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2117 $messages->{'WasTransfered'} = 1;
2118 } else {
2119 $messages->{'NeedsTransfer'} = $returnbranch;
2123 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2126 =head2 MarkIssueReturned
2128 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2130 Unconditionally marks an issue as being returned by
2131 moving the C<issues> row to C<old_issues> and
2132 setting C<returndate> to the current date.
2134 if C<$returndate> is specified (in iso format), it is used as the date
2135 of the return.
2137 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2138 the old_issue is immediately anonymised
2140 Ideally, this function would be internal to C<C4::Circulation>,
2141 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2142 and offline_circ/process_koc.pl.
2144 =cut
2146 sub MarkIssueReturned {
2147 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2149 # Retrieve the issue
2150 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2151 my $issue_id = $issue->issue_id;
2153 my $anonymouspatron;
2154 if ( $privacy == 2 ) {
2155 # The default of 0 will not work due to foreign key constraints
2156 # The anonymisation will fail if AnonymousPatron is not a valid entry
2157 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2158 # Note that a warning should appear on the about page (System information tab).
2159 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2160 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."
2161 unless Koha::Patrons->find( $anonymouspatron );
2164 my $schema = Koha::Database->schema;
2166 # FIXME Improve the return value and handle it from callers
2167 $schema->txn_do(sub {
2169 # Update the returndate value
2170 if ( $returndate ) {
2171 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2173 else {
2174 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2177 # Create the old_issues entry
2178 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2180 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2181 if ( $privacy == 2) {
2182 $old_checkout->borrowernumber($anonymouspatron)->store;
2185 # And finally delete the issue
2186 $issue->delete;
2188 ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2190 if ( C4::Context->preference('StoreLastBorrower') ) {
2191 my $item = Koha::Items->find( $itemnumber );
2192 my $patron = Koha::Patrons->find( $borrowernumber );
2193 $item->last_returned_by( $patron );
2197 return $issue_id;
2200 =head2 _debar_user_on_return
2202 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2204 C<$borrower> borrower hashref
2206 C<$item> item hashref
2208 C<$datedue> date due DateTime object
2210 C<$returndate> DateTime object representing the return time
2212 Internal function, called only by AddReturn that calculates and updates
2213 the user fine days, and debars them if necessary.
2215 Should only be called for overdue returns
2217 =cut
2219 sub _debar_user_on_return {
2220 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2222 my $branchcode = _GetCircControlBranch( $item, $borrower );
2223 $return_date //= dt_from_string();
2225 my $circcontrol = C4::Context->preference('CircControl');
2226 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2227 { categorycode => $borrower->{categorycode},
2228 itemtype => $item->{itype},
2229 branchcode => $branchcode
2232 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2233 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2234 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2236 if ($finedays) {
2238 # finedays is in days, so hourly loans must multiply by 24
2239 # thus 1 hour late equals 1 day suspension * finedays rate
2240 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2242 # grace period is measured in the same units as the loan
2243 my $grace =
2244 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2246 my $deltadays = DateTime::Duration->new(
2247 days => $chargeable_units
2249 if ( $deltadays->subtract($grace)->is_positive() ) {
2250 my $suspension_days = $deltadays * $finedays;
2252 # If the max suspension days is < than the suspension days
2253 # the suspension days is limited to this maximum period.
2254 my $max_sd = $issuing_rule->maxsuspensiondays;
2255 if ( defined $max_sd ) {
2256 $max_sd = DateTime::Duration->new( days => $max_sd );
2257 $suspension_days = $max_sd
2258 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2261 my ( $has_been_extended, $is_a_reminder );
2262 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2263 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2264 if ( $debarment ) {
2265 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2266 $has_been_extended = 1;
2270 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2271 # No need to / 1 and do not consider / 0
2272 $suspension_days = DateTime::Duration->new(
2273 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2277 my $new_debar_dt;
2278 # Use the calendar or not to calculate the debarment date
2279 if ( C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed' ) {
2280 my $calendar = Koha::Calendar->new(
2281 branchcode => $branchcode,
2282 days_mode => 'Calendar'
2284 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2286 else {
2287 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2290 Koha::Patron::Debarments::AddUniqueDebarment({
2291 borrowernumber => $borrower->{borrowernumber},
2292 expiration => $new_debar_dt->ymd(),
2293 type => 'SUSPENSION',
2295 # if borrower was already debarred but does not get an extra debarment
2296 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2297 my $new_debarment_str;
2298 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2299 $is_a_reminder = 1;
2300 $new_debarment_str = $borrower->{debarred};
2301 } else {
2302 $new_debarment_str = $new_debar_dt->ymd();
2304 # FIXME Should return a DateTime object
2305 return $new_debarment_str, $is_a_reminder;
2308 return;
2311 =head2 _FixOverduesOnReturn
2313 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2315 C<$borrowernumber> borrowernumber
2317 C<$itemnumber> itemnumber
2319 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2321 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2323 Internal function
2325 =cut
2327 sub _FixOverduesOnReturn {
2328 my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2329 unless( $borrowernumber ) {
2330 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2331 return;
2333 unless( $item ) {
2334 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2335 return;
2337 unless( $status ) {
2338 warn "_FixOverduesOnReturn() not supplied valid status";
2339 return;
2342 my $schema = Koha::Database->schema;
2344 my $result = $schema->txn_do(
2345 sub {
2346 # check for overdue fine
2347 my $accountlines = Koha::Account::Lines->search(
2349 borrowernumber => $borrowernumber,
2350 itemnumber => $item,
2351 accounttype => 'OVERDUE',
2352 status => 'UNRETURNED'
2355 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2357 my $accountline = $accountlines->next;
2358 if ($exemptfine) {
2359 my $amountoutstanding = $accountline->amountoutstanding;
2361 my $account = Koha::Account->new({patron_id => $borrowernumber});
2362 my $credit = $account->add_credit(
2364 amount => $amountoutstanding,
2365 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2366 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2367 interface => C4::Context->interface,
2368 type => 'forgiven',
2369 item_id => $item
2373 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2375 $accountline->status('FORGIVEN');
2377 if (C4::Context->preference("FinesLog")) {
2378 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2380 } else {
2381 $accountline->status($status);
2384 return $accountline->store();
2388 return $result;
2391 =head2 _FixAccountForLostAndReturned
2393 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2395 Finds the most recent lost item charge for this item and refunds the borrower
2396 appropriatly, taking into account any payments or writeoffs already applied
2397 against the charge.
2399 Internal function, not exported, called only by AddReturn.
2401 =cut
2403 sub _FixAccountForLostAndReturned {
2404 my $itemnumber = shift or return;
2405 my $borrowernumber = @_ ? shift : undef;
2406 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2408 my $credit;
2410 # check for charge made for lost book
2411 my $accountlines = Koha::Account::Lines->search(
2413 itemnumber => $itemnumber,
2414 accounttype => 'LOST',
2415 status => [ undef, { '<>' => 'RETURNED' } ]
2418 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2422 return unless $accountlines->count > 0;
2423 my $accountline = $accountlines->next;
2424 my $total_to_refund = 0;
2426 return unless $accountline->borrowernumber;
2427 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2428 return unless $patron; # Patron has been deleted, nobody to credit the return to
2430 my $account = $patron->account;
2432 # Use cases
2433 if ( $accountline->amount > $accountline->amountoutstanding ) {
2434 # some amount has been cancelled. collect the offsets that are not writeoffs
2435 # this works because the only way to subtract from this kind of a debt is
2436 # using the UI buttons 'Pay' and 'Write off'
2437 my $credits_offsets = Koha::Account::Offsets->search({
2438 debit_id => $accountline->id,
2439 credit_id => { '!=' => undef }, # it is not the debit itself
2440 type => { '!=' => 'Writeoff' },
2441 amount => { '<' => 0 } # credits are negative on the DB
2444 $total_to_refund = ( $credits_offsets->count > 0 )
2445 ? $credits_offsets->total * -1 # credits are negative on the DB
2446 : 0;
2449 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2451 if ( $credit_total > 0 ) {
2452 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2453 $credit = $account->add_credit(
2454 { amount => $credit_total,
2455 description => 'Item Returned ' . $item_id,
2456 type => 'lost_item_return',
2457 interface => C4::Context->interface,
2458 library_id => $branchcode
2462 $credit->apply( { debits => [ $accountline ] } );
2465 # Update the account status
2466 $accountline->discard_changes->status('RETURNED');
2467 $accountline->store;
2469 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2470 $account->reconcile_balance;
2473 return ($credit) ? $credit->id : undef;
2476 =head2 _GetCircControlBranch
2478 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2480 Internal function :
2482 Return the library code to be used to determine which circulation
2483 policy applies to a transaction. Looks up the CircControl and
2484 HomeOrHoldingBranch system preferences.
2486 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2488 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2490 =cut
2492 sub _GetCircControlBranch {
2493 my ($item, $borrower) = @_;
2494 my $circcontrol = C4::Context->preference('CircControl');
2495 my $branch;
2497 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2498 $branch= C4::Context->userenv->{'branch'};
2499 } elsif ($circcontrol eq 'PatronLibrary') {
2500 $branch=$borrower->{branchcode};
2501 } else {
2502 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2503 $branch = $item->{$branchfield};
2504 # default to item home branch if holdingbranch is used
2505 # and is not defined
2506 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2507 $branch = $item->{homebranch};
2510 return $branch;
2513 =head2 GetOpenIssue
2515 $issue = GetOpenIssue( $itemnumber );
2517 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2519 C<$itemnumber> is the item's itemnumber
2521 Returns a hashref
2523 =cut
2525 sub GetOpenIssue {
2526 my ( $itemnumber ) = @_;
2527 return unless $itemnumber;
2528 my $dbh = C4::Context->dbh;
2529 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2530 $sth->execute( $itemnumber );
2531 return $sth->fetchrow_hashref();
2535 =head2 GetBiblioIssues
2537 $issues = GetBiblioIssues($biblionumber);
2539 this function get all issues from a biblionumber.
2541 Return:
2542 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2543 tables issues and the firstname,surname & cardnumber from borrowers.
2545 =cut
2547 sub GetBiblioIssues {
2548 my $biblionumber = shift;
2549 return unless $biblionumber;
2550 my $dbh = C4::Context->dbh;
2551 my $query = "
2552 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2553 FROM issues
2554 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2555 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2556 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2557 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2558 WHERE biblio.biblionumber = ?
2559 UNION ALL
2560 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2561 FROM old_issues
2562 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2563 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2564 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2565 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2566 WHERE biblio.biblionumber = ?
2567 ORDER BY timestamp
2569 my $sth = $dbh->prepare($query);
2570 $sth->execute($biblionumber, $biblionumber);
2572 my @issues;
2573 while ( my $data = $sth->fetchrow_hashref ) {
2574 push @issues, $data;
2576 return \@issues;
2579 =head2 GetUpcomingDueIssues
2581 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2583 =cut
2585 sub GetUpcomingDueIssues {
2586 my $params = shift;
2588 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2589 my $dbh = C4::Context->dbh;
2591 my $statement = <<END_SQL;
2592 SELECT *
2593 FROM (
2594 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2595 FROM issues
2596 LEFT JOIN items USING (itemnumber)
2597 LEFT OUTER JOIN branches USING (branchcode)
2598 WHERE returndate is NULL
2599 ) tmp
2600 WHERE days_until_due >= 0 AND days_until_due <= ?
2601 END_SQL
2603 my @bind_parameters = ( $params->{'days_in_advance'} );
2605 my $sth = $dbh->prepare( $statement );
2606 $sth->execute( @bind_parameters );
2607 my $upcoming_dues = $sth->fetchall_arrayref({});
2609 return $upcoming_dues;
2612 =head2 CanBookBeRenewed
2614 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2616 Find out whether a borrowed item may be renewed.
2618 C<$borrowernumber> is the borrower number of the patron who currently
2619 has the item on loan.
2621 C<$itemnumber> is the number of the item to renew.
2623 C<$override_limit>, if supplied with a true value, causes
2624 the limit on the number of times that the loan can be renewed
2625 (as controlled by the item type) to be ignored. Overriding also allows
2626 to renew sooner than "No renewal before" and to manually renew loans
2627 that are automatically renewed.
2629 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2630 item must currently be on loan to the specified borrower; renewals
2631 must be allowed for the item's type; and the borrower must not have
2632 already renewed the loan. $error will contain the reason the renewal can not proceed
2634 =cut
2636 sub CanBookBeRenewed {
2637 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2639 my $dbh = C4::Context->dbh;
2640 my $renews = 1;
2642 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2643 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2644 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2645 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2647 my $patron = $issue->patron or return;
2649 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2651 # This item can fill one or more unfilled reserve, can those unfilled reserves
2652 # all be filled by other available items?
2653 if ( $resfound
2654 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2656 my $schema = Koha::Database->new()->schema();
2658 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2659 if ($item_holds) {
2660 # There is an item level hold on this item, no other item can fill the hold
2661 $resfound = 1;
2663 else {
2665 # Get all other items that could possibly fill reserves
2666 my @itemnumbers = $schema->resultset('Item')->search(
2668 biblionumber => $resrec->{biblionumber},
2669 onloan => undef,
2670 notforloan => 0,
2671 -not => { itemnumber => $itemnumber }
2673 { columns => 'itemnumber' }
2674 )->get_column('itemnumber')->all();
2676 # Get all other reserves that could have been filled by this item
2677 my @borrowernumbers;
2678 while (1) {
2679 my ( $reserve_found, $reserve, undef ) =
2680 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2682 if ($reserve_found) {
2683 push( @borrowernumbers, $reserve->{borrowernumber} );
2685 else {
2686 last;
2690 # If the count of the union of the lists of reservable items for each borrower
2691 # is equal or greater than the number of borrowers, we know that all reserves
2692 # can be filled with available items. We can get the union of the sets simply
2693 # by pushing all the elements onto an array and removing the duplicates.
2694 my @reservable;
2695 my %patrons;
2696 ITEM: foreach my $itemnumber (@itemnumbers) {
2697 my $item = Koha::Items->find( $itemnumber );
2698 next if IsItemOnHoldAndFound( $itemnumber );
2699 for my $borrowernumber (@borrowernumbers) {
2700 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2701 next unless IsAvailableForItemLevelRequest($item, $patron);
2702 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2704 push @reservable, $itemnumber;
2705 if (@reservable >= @borrowernumbers) {
2706 $resfound = 0;
2707 last ITEM;
2709 last;
2714 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2716 return ( 1, undef ) if $override_limit;
2718 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2719 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2720 { categorycode => $patron->categorycode,
2721 itemtype => $item->effective_itemtype,
2722 branchcode => $branchcode
2726 return ( 0, "too_many" )
2727 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2729 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2730 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2731 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2732 my $restricted = $patron->is_debarred;
2733 my $hasoverdues = $patron->has_overdues;
2735 if ( $restricted and $restrictionblockrenewing ) {
2736 return ( 0, 'restriction');
2737 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2738 return ( 0, 'overdue');
2741 if ( $issue->auto_renew ) {
2743 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2744 return ( 0, 'auto_account_expired' );
2747 if ( defined $issuing_rule->no_auto_renewal_after
2748 and $issuing_rule->no_auto_renewal_after ne "" ) {
2749 # Get issue_date and add no_auto_renewal_after
2750 # If this is greater than today, it's too late for renewal.
2751 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2752 $maximum_renewal_date->add(
2753 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2755 my $now = dt_from_string;
2756 if ( $now >= $maximum_renewal_date ) {
2757 return ( 0, "auto_too_late" );
2760 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2761 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2762 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2763 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2764 return ( 0, "auto_too_late" );
2768 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2769 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2770 my $amountoutstanding = $patron->account->balance;
2771 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2772 return ( 0, "auto_too_much_oweing" );
2777 if ( defined $issuing_rule->norenewalbefore
2778 and $issuing_rule->norenewalbefore ne "" )
2781 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2782 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2783 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2785 # Depending on syspref reset the exact time, only check the date
2786 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2787 and $issuing_rule->lengthunit eq 'days' )
2789 $soonestrenewal->truncate( to => 'day' );
2792 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2794 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2795 return ( 0, "too_soon" );
2797 elsif ( $issue->auto_renew ) {
2798 return ( 0, "auto_renew" );
2802 # Fallback for automatic renewals:
2803 # If norenewalbefore is undef, don't renew before due date.
2804 if ( $issue->auto_renew ) {
2805 my $now = dt_from_string;
2806 return ( 0, "auto_renew" )
2807 if $now >= dt_from_string( $issue->date_due, 'sql' );
2808 return ( 0, "auto_too_soon" );
2811 return ( 1, undef );
2814 =head2 AddRenewal
2816 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2818 Renews a loan.
2820 C<$borrowernumber> is the borrower number of the patron who currently
2821 has the item.
2823 C<$itemnumber> is the number of the item to renew.
2825 C<$branch> is the library where the renewal took place (if any).
2826 The library that controls the circ policies for the renewal is retrieved from the issues record.
2828 C<$datedue> can be a DateTime object used to set the due date.
2830 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2831 this parameter is not supplied, lastreneweddate is set to the current date.
2833 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2834 from the book's item type.
2836 =cut
2838 sub AddRenewal {
2839 my $borrowernumber = shift;
2840 my $itemnumber = shift or return;
2841 my $branch = shift;
2842 my $datedue = shift;
2843 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2845 my $item_object = Koha::Items->find($itemnumber) or return;
2846 my $biblio = $item_object->biblio;
2847 my $issue = $item_object->checkout;
2848 my $item_unblessed = $item_object->unblessed;
2850 my $dbh = C4::Context->dbh;
2852 return unless $issue;
2854 $borrowernumber ||= $issue->borrowernumber;
2856 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2857 carp 'Invalid date passed to AddRenewal.';
2858 return;
2861 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2862 my $patron_unblessed = $patron->unblessed;
2864 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2866 if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2867 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2869 _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2871 # If the due date wasn't specified, calculate it by adding the
2872 # book's loan length to today's date or the current due date
2873 # based on the value of the RenewalPeriodBase syspref.
2874 my $itemtype = $item_object->effective_itemtype;
2875 unless ($datedue) {
2877 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2878 dt_from_string( $issue->date_due, 'sql' ) :
2879 DateTime->now( time_zone => C4::Context->tz());
2880 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2883 my $fees = Koha::Charges::Fees->new(
2885 patron => $patron,
2886 library => $circ_library,
2887 item => $item_object,
2888 from_date => dt_from_string( $issue->date_due, 'sql' ),
2889 to_date => dt_from_string($datedue),
2893 # Update the issues record to have the new due date, and a new count
2894 # of how many times it has been renewed.
2895 my $renews = $issue->renewals + 1;
2896 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2897 WHERE borrowernumber=?
2898 AND itemnumber=?"
2901 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2903 # Update the renewal count on the item, and tell zebra to reindex
2904 $renews = $item_object->renewals + 1;
2905 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2907 # Charge a new rental fee, if applicable
2908 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2909 if ( $charge > 0 ) {
2910 AddIssuingCharge($issue, $charge, 'rent_renew');
2913 # Charge a new accumulate rental fee, if applicable
2914 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2915 if ( $itemtype_object ) {
2916 my $accumulate_charge = $fees->accumulate_rentalcharge();
2917 if ( $accumulate_charge > 0 ) {
2918 AddIssuingCharge( $issue, $accumulate_charge, 'rent_daily_renew' )
2920 $charge += $accumulate_charge;
2923 # Send a renewal slip according to checkout alert preferencei
2924 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2925 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2926 my %conditions = (
2927 branchcode => $branch,
2928 categorycode => $patron->categorycode,
2929 item_type => $itemtype,
2930 notification => 'CHECKOUT',
2932 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2933 SendCirculationAlert(
2935 type => 'RENEWAL',
2936 item => $item_unblessed,
2937 borrower => $patron->unblessed,
2938 branch => $branch,
2944 # Remove any OVERDUES related debarment if the borrower has no overdues
2945 if ( $patron
2946 && $patron->is_debarred
2947 && ! $patron->has_overdues
2948 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2950 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2953 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2954 $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2957 # Add the renewal to stats
2958 UpdateStats(
2960 branch => $branch,
2961 type => 'renew',
2962 amount => $charge,
2963 itemnumber => $itemnumber,
2964 itemtype => $itemtype,
2965 location => $item_object->location,
2966 borrowernumber => $borrowernumber,
2967 ccode => $item_object->ccode,
2971 #Log the renewal
2972 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2973 return $datedue;
2976 sub GetRenewCount {
2977 # check renewal status
2978 my ( $bornum, $itemno ) = @_;
2979 my $dbh = C4::Context->dbh;
2980 my $renewcount = 0;
2981 my $renewsallowed = 0;
2982 my $renewsleft = 0;
2984 my $patron = Koha::Patrons->find( $bornum );
2985 my $item = Koha::Items->find($itemno);
2987 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2989 # Look in the issues table for this item, lent to this borrower,
2990 # and not yet returned.
2992 # FIXME - I think this function could be redone to use only one SQL call.
2993 my $sth = $dbh->prepare(
2994 "select * from issues
2995 where (borrowernumber = ?)
2996 and (itemnumber = ?)"
2998 $sth->execute( $bornum, $itemno );
2999 my $data = $sth->fetchrow_hashref;
3000 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3001 # $item and $borrower should be calculated
3002 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3004 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3005 { categorycode => $patron->categorycode,
3006 itemtype => $item->effective_itemtype,
3007 branchcode => $branchcode
3011 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3012 $renewsleft = $renewsallowed - $renewcount;
3013 if($renewsleft < 0){ $renewsleft = 0; }
3014 return ( $renewcount, $renewsallowed, $renewsleft );
3017 =head2 GetSoonestRenewDate
3019 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3021 Find out the soonest possible renew date of a borrowed item.
3023 C<$borrowernumber> is the borrower number of the patron who currently
3024 has the item on loan.
3026 C<$itemnumber> is the number of the item to renew.
3028 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3029 renew date, based on the value "No renewal before" of the applicable
3030 issuing rule. Returns the current date if the item can already be
3031 renewed, and returns undefined if the borrower, loan, or item
3032 cannot be found.
3034 =cut
3036 sub GetSoonestRenewDate {
3037 my ( $borrowernumber, $itemnumber ) = @_;
3039 my $dbh = C4::Context->dbh;
3041 my $item = Koha::Items->find($itemnumber) or return;
3042 my $itemissue = $item->checkout or return;
3044 $borrowernumber ||= $itemissue->borrowernumber;
3045 my $patron = Koha::Patrons->find( $borrowernumber )
3046 or return;
3048 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3049 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3050 { categorycode => $patron->categorycode,
3051 itemtype => $item->effective_itemtype,
3052 branchcode => $branchcode
3056 my $now = dt_from_string;
3057 return $now unless $issuing_rule;
3059 if ( defined $issuing_rule->norenewalbefore
3060 and $issuing_rule->norenewalbefore ne "" )
3062 my $soonestrenewal =
3063 dt_from_string( $itemissue->date_due )->subtract(
3064 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3066 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3067 and $issuing_rule->lengthunit eq 'days' )
3069 $soonestrenewal->truncate( to => 'day' );
3071 return $soonestrenewal if $now < $soonestrenewal;
3073 return $now;
3076 =head2 GetLatestAutoRenewDate
3078 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3080 Find out the latest possible auto renew date of a borrowed item.
3082 C<$borrowernumber> is the borrower number of the patron who currently
3083 has the item on loan.
3085 C<$itemnumber> is the number of the item to renew.
3087 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3088 auto renew date, based on the value "No auto renewal after" and the "No auto
3089 renewal after (hard limit) of the applicable issuing rule.
3090 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3091 or item cannot be found.
3093 =cut
3095 sub GetLatestAutoRenewDate {
3096 my ( $borrowernumber, $itemnumber ) = @_;
3098 my $dbh = C4::Context->dbh;
3100 my $item = Koha::Items->find($itemnumber) or return;
3101 my $itemissue = $item->checkout or return;
3103 $borrowernumber ||= $itemissue->borrowernumber;
3104 my $patron = Koha::Patrons->find( $borrowernumber )
3105 or return;
3107 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3108 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3109 { categorycode => $patron->categorycode,
3110 itemtype => $item->effective_itemtype,
3111 branchcode => $branchcode
3115 return unless $issuing_rule;
3116 return
3117 if ( not $issuing_rule->no_auto_renewal_after
3118 or $issuing_rule->no_auto_renewal_after eq '' )
3119 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3120 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3122 my $maximum_renewal_date;
3123 if ( $issuing_rule->no_auto_renewal_after ) {
3124 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3125 $maximum_renewal_date->add(
3126 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3130 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3131 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3132 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3134 return $maximum_renewal_date;
3138 =head2 GetIssuingCharges
3140 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3142 Calculate how much it would cost for a given patron to borrow a given
3143 item, including any applicable discounts.
3145 C<$itemnumber> is the item number of item the patron wishes to borrow.
3147 C<$borrowernumber> is the patron's borrower number.
3149 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3150 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3151 if it's a video).
3153 =cut
3155 sub GetIssuingCharges {
3157 # calculate charges due
3158 my ( $itemnumber, $borrowernumber ) = @_;
3159 my $charge = 0;
3160 my $dbh = C4::Context->dbh;
3161 my $item_type;
3163 # Get the book's item type and rental charge (via its biblioitem).
3164 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3165 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3166 $charge_query .= (C4::Context->preference('item-level_itypes'))
3167 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3168 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3170 $charge_query .= ' WHERE items.itemnumber =?';
3172 my $sth = $dbh->prepare($charge_query);
3173 $sth->execute($itemnumber);
3174 if ( my $item_data = $sth->fetchrow_hashref ) {
3175 $item_type = $item_data->{itemtype};
3176 $charge = $item_data->{rentalcharge};
3177 my $branch = C4::Context::mybranch();
3178 my $discount_query = q|SELECT rentaldiscount,
3179 issuingrules.itemtype, issuingrules.branchcode
3180 FROM borrowers
3181 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3182 WHERE borrowers.borrowernumber = ?
3183 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3184 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3185 my $discount_sth = $dbh->prepare($discount_query);
3186 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3187 my $discount_rules = $discount_sth->fetchall_arrayref({});
3188 if (@{$discount_rules}) {
3189 # We may have multiple rules so get the most specific
3190 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3191 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3193 if ($charge) {
3194 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3198 return ( $charge, $item_type );
3201 # Select most appropriate discount rule from those returned
3202 sub _get_discount_from_rule {
3203 my ($rules_ref, $branch, $itemtype) = @_;
3204 my $discount;
3206 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3207 $discount = $rules_ref->[0]->{rentaldiscount};
3208 return (defined $discount) ? $discount : 0;
3210 # could have up to 4 does one match $branch and $itemtype
3211 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3212 if (@d) {
3213 $discount = $d[0]->{rentaldiscount};
3214 return (defined $discount) ? $discount : 0;
3216 # do we have item type + all branches
3217 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3218 if (@d) {
3219 $discount = $d[0]->{rentaldiscount};
3220 return (defined $discount) ? $discount : 0;
3222 # do we all item types + this branch
3223 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3224 if (@d) {
3225 $discount = $d[0]->{rentaldiscount};
3226 return (defined $discount) ? $discount : 0;
3228 # so all and all (surely we wont get here)
3229 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3230 if (@d) {
3231 $discount = $d[0]->{rentaldiscount};
3232 return (defined $discount) ? $discount : 0;
3234 # none of the above
3235 return 0;
3238 =head2 AddIssuingCharge
3240 &AddIssuingCharge( $checkout, $charge, $type )
3242 =cut
3244 sub AddIssuingCharge {
3245 my ( $checkout, $charge, $type ) = @_;
3247 # FIXME What if checkout does not exist?
3249 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3250 my $accountline = $account->add_debit(
3252 amount => $charge,
3253 note => undef,
3254 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3255 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3256 interface => C4::Context->interface,
3257 type => $type,
3258 item_id => $checkout->itemnumber,
3259 issue_id => $checkout->issue_id,
3264 =head2 GetTransfers
3266 GetTransfers($itemnumber);
3268 =cut
3270 sub GetTransfers {
3271 my ($itemnumber) = @_;
3273 my $dbh = C4::Context->dbh;
3275 my $query = '
3276 SELECT datesent,
3277 frombranch,
3278 tobranch,
3279 branchtransfer_id
3280 FROM branchtransfers
3281 WHERE itemnumber = ?
3282 AND datearrived IS NULL
3284 my $sth = $dbh->prepare($query);
3285 $sth->execute($itemnumber);
3286 my @row = $sth->fetchrow_array();
3287 return @row;
3290 =head2 GetTransfersFromTo
3292 @results = GetTransfersFromTo($frombranch,$tobranch);
3294 Returns the list of pending transfers between $from and $to branch
3296 =cut
3298 sub GetTransfersFromTo {
3299 my ( $frombranch, $tobranch ) = @_;
3300 return unless ( $frombranch && $tobranch );
3301 my $dbh = C4::Context->dbh;
3302 my $query = "
3303 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3304 FROM branchtransfers
3305 WHERE frombranch=?
3306 AND tobranch=?
3307 AND datearrived IS NULL
3309 my $sth = $dbh->prepare($query);
3310 $sth->execute( $frombranch, $tobranch );
3311 my @gettransfers;
3313 while ( my $data = $sth->fetchrow_hashref ) {
3314 push @gettransfers, $data;
3316 return (@gettransfers);
3319 =head2 DeleteTransfer
3321 &DeleteTransfer($itemnumber);
3323 =cut
3325 sub DeleteTransfer {
3326 my ($itemnumber) = @_;
3327 return unless $itemnumber;
3328 my $dbh = C4::Context->dbh;
3329 my $sth = $dbh->prepare(
3330 "DELETE FROM branchtransfers
3331 WHERE itemnumber=?
3332 AND datearrived IS NULL "
3334 return $sth->execute($itemnumber);
3337 =head2 SendCirculationAlert
3339 Send out a C<check-in> or C<checkout> alert using the messaging system.
3341 B<Parameters>:
3343 =over 4
3345 =item type
3347 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3349 =item item
3351 Hashref of information about the item being checked in or out.
3353 =item borrower
3355 Hashref of information about the borrower of the item.
3357 =item branch
3359 The branchcode from where the checkout or check-in took place.
3361 =back
3363 B<Example>:
3365 SendCirculationAlert({
3366 type => 'CHECKOUT',
3367 item => $item,
3368 borrower => $borrower,
3369 branch => $branch,
3372 =cut
3374 sub SendCirculationAlert {
3375 my ($opts) = @_;
3376 my ($type, $item, $borrower, $branch) =
3377 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3378 my %message_name = (
3379 CHECKIN => 'Item_Check_in',
3380 CHECKOUT => 'Item_Checkout',
3381 RENEWAL => 'Item_Checkout',
3383 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3384 borrowernumber => $borrower->{borrowernumber},
3385 message_name => $message_name{$type},
3387 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3389 my $schema = Koha::Database->new->schema;
3390 my @transports = keys %{ $borrower_preferences->{transports} };
3392 # From the MySQL doc:
3393 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3394 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3395 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3396 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3398 for my $mtt (@transports) {
3399 my $letter = C4::Letters::GetPreparedLetter (
3400 module => 'circulation',
3401 letter_code => $type,
3402 branchcode => $branch,
3403 message_transport_type => $mtt,
3404 lang => $borrower->{lang},
3405 tables => {
3406 $issues_table => $item->{itemnumber},
3407 'items' => $item->{itemnumber},
3408 'biblio' => $item->{biblionumber},
3409 'biblioitems' => $item->{biblionumber},
3410 'borrowers' => $borrower,
3411 'branches' => $branch,
3413 ) or next;
3415 $schema->storage->txn_begin;
3416 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3417 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3418 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3419 unless ( $message ) {
3420 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3421 C4::Message->enqueue($letter, $borrower, $mtt);
3422 } else {
3423 $message->append($letter);
3424 $message->update;
3426 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3427 $schema->storage->txn_commit;
3430 return;
3433 =head2 updateWrongTransfer
3435 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3437 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
3439 =cut
3441 sub updateWrongTransfer {
3442 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3443 my $dbh = C4::Context->dbh;
3444 # first step validate the actual line of transfert .
3445 my $sth =
3446 $dbh->prepare(
3447 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3449 $sth->execute($FromLibrary,$itemNumber);
3451 # second step create a new line of branchtransfer to the right location .
3452 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3454 #third step changing holdingbranch of item
3455 UpdateHoldingbranch($FromLibrary,$itemNumber);
3458 =head2 UpdateHoldingbranch
3460 $items = UpdateHoldingbranch($branch,$itmenumber);
3462 Simple methode for updating hodlingbranch in items BDD line
3464 =cut
3466 sub UpdateHoldingbranch {
3467 my ( $branch,$itemnumber ) = @_;
3468 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3471 =head2 CalcDateDue
3473 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3475 this function calculates the due date given the start date and configured circulation rules,
3476 checking against the holidays calendar as per the 'useDaysMode' syspref.
3477 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3478 C<$itemtype> = itemtype code of item in question
3479 C<$branch> = location whose calendar to use
3480 C<$borrower> = Borrower object
3481 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3483 =cut
3485 sub CalcDateDue {
3486 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3488 $isrenewal ||= 0;
3490 # loanlength now a href
3491 my $loanlength =
3492 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3494 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3495 ? qq{renewalperiod}
3496 : qq{issuelength};
3498 my $datedue;
3499 if ( $startdate ) {
3500 if (ref $startdate ne 'DateTime' ) {
3501 $datedue = dt_from_string($datedue);
3502 } else {
3503 $datedue = $startdate->clone;
3505 } else {
3506 $datedue =
3507 DateTime->now( time_zone => C4::Context->tz() )
3508 ->truncate( to => 'minute' );
3512 # calculate the datedue as normal
3513 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3514 { # ignoring calendar
3515 if ( $loanlength->{lengthunit} eq 'hours' ) {
3516 $datedue->add( hours => $loanlength->{$length_key} );
3517 } else { # days
3518 $datedue->add( days => $loanlength->{$length_key} );
3519 $datedue->set_hour(23);
3520 $datedue->set_minute(59);
3522 } else {
3523 my $dur;
3524 if ($loanlength->{lengthunit} eq 'hours') {
3525 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3527 else { # days
3528 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3530 my $calendar = Koha::Calendar->new( branchcode => $branch );
3531 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3532 if ($loanlength->{lengthunit} eq 'days') {
3533 $datedue->set_hour(23);
3534 $datedue->set_minute(59);
3538 # if Hard Due Dates are used, retrieve them and apply as necessary
3539 my ( $hardduedate, $hardduedatecompare ) =
3540 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3541 if ($hardduedate) { # hardduedates are currently dates
3542 $hardduedate->truncate( to => 'minute' );
3543 $hardduedate->set_hour(23);
3544 $hardduedate->set_minute(59);
3545 my $cmp = DateTime->compare( $hardduedate, $datedue );
3547 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3548 # if the calculated date is before the 'after' Hard Due Date (floor), override
3549 # if the hard due date is set to 'exactly', overrride
3550 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3551 $datedue = $hardduedate->clone;
3554 # in all other cases, keep the date due as it is
3558 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3559 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3560 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3561 if( $expiry_dt ) { #skip empty expiry date..
3562 $expiry_dt->set( hour => 23, minute => 59);
3563 my $d1= $datedue->clone->set_time_zone('floating');
3564 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3565 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3568 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3569 my $calendar = Koha::Calendar->new( branchcode => $branch );
3570 if ( $calendar->is_holiday($datedue) ) {
3571 # Don't return on a closed day
3572 $datedue = $calendar->prev_open_day( $datedue );
3577 return $datedue;
3581 sub CheckValidBarcode{
3582 my ($barcode) = @_;
3583 my $dbh = C4::Context->dbh;
3584 my $query=qq|SELECT count(*)
3585 FROM items
3586 WHERE barcode=?
3588 my $sth = $dbh->prepare($query);
3589 $sth->execute($barcode);
3590 my $exist=$sth->fetchrow ;
3591 return $exist;
3594 =head2 IsBranchTransferAllowed
3596 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3598 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3600 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3601 Koha::Item->can_be_transferred.
3603 =cut
3605 sub IsBranchTransferAllowed {
3606 my ( $toBranch, $fromBranch, $code ) = @_;
3608 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3610 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3611 my $dbh = C4::Context->dbh;
3613 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3614 $sth->execute( $toBranch, $fromBranch, $code );
3615 my $limit = $sth->fetchrow_hashref();
3617 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3618 if ( $limit->{'limitId'} ) {
3619 return 0;
3620 } else {
3621 return 1;
3625 =head2 CreateBranchTransferLimit
3627 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3629 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3631 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3633 =cut
3635 sub CreateBranchTransferLimit {
3636 my ( $toBranch, $fromBranch, $code ) = @_;
3637 return unless defined($toBranch) && defined($fromBranch);
3638 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3640 my $dbh = C4::Context->dbh;
3642 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3643 return $sth->execute( $code, $toBranch, $fromBranch );
3646 =head2 DeleteBranchTransferLimits
3648 my $result = DeleteBranchTransferLimits($frombranch);
3650 Deletes all the library transfer limits for one library. Returns the
3651 number of limits deleted, 0e0 if no limits were deleted, or undef if
3652 no arguments are supplied.
3654 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3655 fromBranch => $fromBranch
3656 })->delete.
3658 =cut
3660 sub DeleteBranchTransferLimits {
3661 my $branch = shift;
3662 return unless defined $branch;
3663 my $dbh = C4::Context->dbh;
3664 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3665 return $sth->execute($branch);
3668 sub ReturnLostItem{
3669 my ( $borrowernumber, $itemnum ) = @_;
3670 MarkIssueReturned( $borrowernumber, $itemnum );
3674 sub LostItem{
3675 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3677 unless ( $mark_lost_from ) {
3678 # Temporary check to avoid regressions
3679 die q|LostItem called without $mark_lost_from, check the API.|;
3682 my $mark_returned;
3683 if ( $force_mark_returned ) {
3684 $mark_returned = 1;
3685 } else {
3686 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3687 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3690 my $dbh = C4::Context->dbh();
3691 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3692 FROM issues
3693 JOIN items USING (itemnumber)
3694 JOIN biblio USING (biblionumber)
3695 WHERE issues.itemnumber=?");
3696 $sth->execute($itemnumber);
3697 my $issues=$sth->fetchrow_hashref();
3699 # If a borrower lost the item, add a replacement cost to the their record
3700 if ( my $borrowernumber = $issues->{borrowernumber} ){
3701 my $patron = Koha::Patrons->find( $borrowernumber );
3703 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3704 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3706 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3707 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "$issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3708 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3709 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3712 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3715 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3716 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3717 ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3719 my $transferdeleted = DeleteTransfer($itemnumber);
3722 sub GetOfflineOperations {
3723 my $dbh = C4::Context->dbh;
3724 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3725 $sth->execute(C4::Context->userenv->{'branch'});
3726 my $results = $sth->fetchall_arrayref({});
3727 return $results;
3730 sub GetOfflineOperation {
3731 my $operationid = shift;
3732 return unless $operationid;
3733 my $dbh = C4::Context->dbh;
3734 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3735 $sth->execute( $operationid );
3736 return $sth->fetchrow_hashref;
3739 sub AddOfflineOperation {
3740 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3741 my $dbh = C4::Context->dbh;
3742 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3743 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3744 return "Added.";
3747 sub DeleteOfflineOperation {
3748 my $dbh = C4::Context->dbh;
3749 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3750 $sth->execute( shift );
3751 return "Deleted.";
3754 sub ProcessOfflineOperation {
3755 my $operation = shift;
3757 my $report;
3758 if ( $operation->{action} eq 'return' ) {
3759 $report = ProcessOfflineReturn( $operation );
3760 } elsif ( $operation->{action} eq 'issue' ) {
3761 $report = ProcessOfflineIssue( $operation );
3762 } elsif ( $operation->{action} eq 'payment' ) {
3763 $report = ProcessOfflinePayment( $operation );
3766 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3768 return $report;
3771 sub ProcessOfflineReturn {
3772 my $operation = shift;
3774 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3776 if ( $item ) {
3777 my $itemnumber = $item->itemnumber;
3778 my $issue = GetOpenIssue( $itemnumber );
3779 if ( $issue ) {
3780 MarkIssueReturned(
3781 $issue->{borrowernumber},
3782 $itemnumber,
3783 $operation->{timestamp},
3785 ModItem(
3786 { renewals => 0, onloan => undef },
3787 $issue->{'biblionumber'},
3788 $itemnumber,
3789 { log_action => 0 }
3791 return "Success.";
3792 } else {
3793 return "Item not issued.";
3795 } else {
3796 return "Item not found.";
3800 sub ProcessOfflineIssue {
3801 my $operation = shift;
3803 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3805 if ( $patron ) {
3806 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3807 unless ($item) {
3808 return "Barcode not found.";
3810 my $itemnumber = $item->itemnumber;
3811 my $issue = GetOpenIssue( $itemnumber );
3813 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3814 MarkIssueReturned(
3815 $issue->{borrowernumber},
3816 $itemnumber,
3817 $operation->{timestamp},
3820 AddIssue(
3821 $patron->unblessed,
3822 $operation->{'barcode'},
3823 undef,
3825 $operation->{timestamp},
3826 undef,
3828 return "Success.";
3829 } else {
3830 return "Borrower not found.";
3834 sub ProcessOfflinePayment {
3835 my $operation = shift;
3837 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3839 $patron->account->pay(
3841 amount => $operation->{amount},
3842 library_id => $operation->{branchcode},
3843 interface => 'koc'
3847 return "Success.";
3850 =head2 TransferSlip
3852 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3854 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3856 =cut
3858 sub TransferSlip {
3859 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3861 my $item =
3862 $itemnumber
3863 ? Koha::Items->find($itemnumber)
3864 : Koha::Items->find( { barcode => $barcode } );
3866 $item or return;
3868 return C4::Letters::GetPreparedLetter (
3869 module => 'circulation',
3870 letter_code => 'TRANSFERSLIP',
3871 branchcode => $branch,
3872 tables => {
3873 'branches' => $to_branch,
3874 'biblio' => $item->biblionumber,
3875 'items' => $item->unblessed,
3880 =head2 CheckIfIssuedToPatron
3882 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3884 Return 1 if any record item is issued to patron, otherwise return 0
3886 =cut
3888 sub CheckIfIssuedToPatron {
3889 my ($borrowernumber, $biblionumber) = @_;
3891 my $dbh = C4::Context->dbh;
3892 my $query = q|
3893 SELECT COUNT(*) FROM issues
3894 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3895 WHERE items.biblionumber = ?
3896 AND issues.borrowernumber = ?
3898 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3899 return 1 if $is_issued;
3900 return;
3903 =head2 IsItemIssued
3905 IsItemIssued( $itemnumber )
3907 Return 1 if the item is on loan, otherwise return 0
3909 =cut
3911 sub IsItemIssued {
3912 my $itemnumber = shift;
3913 my $dbh = C4::Context->dbh;
3914 my $sth = $dbh->prepare(q{
3915 SELECT COUNT(*)
3916 FROM issues
3917 WHERE itemnumber = ?
3919 $sth->execute($itemnumber);
3920 return $sth->fetchrow;
3923 =head2 GetAgeRestriction
3925 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3926 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3928 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3929 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3931 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3932 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3933 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3934 Negative days mean the borrower has gone past the age restriction age.
3936 =cut
3938 sub GetAgeRestriction {
3939 my ($record_restrictions, $borrower) = @_;
3940 my $markers = C4::Context->preference('AgeRestrictionMarker');
3942 # Split $record_restrictions to something like FSK 16 or PEGI 6
3943 my @values = split ' ', uc($record_restrictions);
3944 return unless @values;
3946 # Search first occurrence of one of the markers
3947 my @markers = split /\|/, uc($markers);
3948 return unless @markers;
3950 my $index = 0;
3951 my $restriction_year = 0;
3952 for my $value (@values) {
3953 $index++;
3954 for my $marker (@markers) {
3955 $marker =~ s/^\s+//; #remove leading spaces
3956 $marker =~ s/\s+$//; #remove trailing spaces
3957 if ( $marker eq $value ) {
3958 if ( $index <= $#values ) {
3959 $restriction_year += $values[$index];
3961 last;
3963 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3965 # Perhaps it is something like "K16" (as in Finland)
3966 $restriction_year += $1;
3967 last;
3970 last if ( $restriction_year > 0 );
3973 #Check if the borrower is age restricted for this material and for how long.
3974 if ($restriction_year && $borrower) {
3975 if ( $borrower->{'dateofbirth'} ) {
3976 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3977 $alloweddate[0] += $restriction_year;
3979 #Prevent runime eror on leap year (invalid date)
3980 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3981 $alloweddate[2] = 28;
3984 #Get how many days the borrower has to reach the age restriction
3985 my @Today = split /-/, DateTime->today->ymd();
3986 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3987 #Negative days means the borrower went past the age restriction age
3988 return ($restriction_year, $daysToAgeRestriction);
3992 return ($restriction_year);
3996 =head2 GetPendingOnSiteCheckouts
3998 =cut
4000 sub GetPendingOnSiteCheckouts {
4001 my $dbh = C4::Context->dbh;
4002 return $dbh->selectall_arrayref(q|
4003 SELECT
4004 items.barcode,
4005 items.biblionumber,
4006 items.itemnumber,
4007 items.itemnotes,
4008 items.itemcallnumber,
4009 items.location,
4010 issues.date_due,
4011 issues.branchcode,
4012 issues.date_due < NOW() AS is_overdue,
4013 biblio.author,
4014 biblio.title,
4015 borrowers.firstname,
4016 borrowers.surname,
4017 borrowers.cardnumber,
4018 borrowers.borrowernumber
4019 FROM items
4020 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4021 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4022 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4023 WHERE issues.onsite_checkout = 1
4024 |, { Slice => {} } );
4027 sub GetTopIssues {
4028 my ($params) = @_;
4030 my ($count, $branch, $itemtype, $ccode, $newness)
4031 = @$params{qw(count branch itemtype ccode newness)};
4033 my $dbh = C4::Context->dbh;
4034 my $query = q{
4035 SELECT * FROM (
4036 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4037 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4038 i.ccode, SUM(i.issues) AS count
4039 FROM biblio b
4040 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4041 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4044 my (@where_strs, @where_args);
4046 if ($branch) {
4047 push @where_strs, 'i.homebranch = ?';
4048 push @where_args, $branch;
4050 if ($itemtype) {
4051 if (C4::Context->preference('item-level_itypes')){
4052 push @where_strs, 'i.itype = ?';
4053 push @where_args, $itemtype;
4054 } else {
4055 push @where_strs, 'bi.itemtype = ?';
4056 push @where_args, $itemtype;
4059 if ($ccode) {
4060 push @where_strs, 'i.ccode = ?';
4061 push @where_args, $ccode;
4063 if ($newness) {
4064 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4065 push @where_args, $newness;
4068 if (@where_strs) {
4069 $query .= 'WHERE ' . join(' AND ', @where_strs);
4072 $query .= q{
4073 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4074 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4075 i.ccode
4076 ORDER BY count DESC
4079 $query .= q{ ) xxx WHERE count > 0 };
4080 $count = int($count);
4081 if ($count > 0) {
4082 $query .= "LIMIT $count";
4085 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4087 return @$rows;
4090 sub _CalculateAndUpdateFine {
4091 my ($params) = @_;
4093 my $borrower = $params->{borrower};
4094 my $item = $params->{item};
4095 my $issue = $params->{issue};
4096 my $return_date = $params->{return_date};
4098 unless ($borrower) { carp "No borrower passed in!" && return; }
4099 unless ($item) { carp "No item passed in!" && return; }
4100 unless ($issue) { carp "No issue passed in!" && return; }
4102 my $datedue = dt_from_string( $issue->date_due );
4104 # we only need to calculate and change the fines if we want to do that on return
4105 # Should be on for hourly loans
4106 my $control = C4::Context->preference('CircControl');
4107 my $control_branchcode =
4108 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4109 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4110 : $issue->branchcode;
4112 my $date_returned = $return_date ? $return_date : dt_from_string();
4114 my ( $amount, $unitcounttotal, $unitcount ) =
4115 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4117 if ( C4::Context->preference('finesMode') eq 'production' ) {
4118 if ( $amount > 0 ) {
4119 C4::Overdues::UpdateFine({
4120 issue_id => $issue->issue_id,
4121 itemnumber => $issue->itemnumber,
4122 borrowernumber => $issue->borrowernumber,
4123 amount => $amount,
4124 due => output_pref($datedue),
4127 elsif ($return_date) {
4129 # Backdated returns may have fines that shouldn't exist,
4130 # so in this case, we need to drop those fines to 0
4132 C4::Overdues::UpdateFine({
4133 issue_id => $issue->issue_id,
4134 itemnumber => $issue->itemnumber,
4135 borrowernumber => $issue->borrowernumber,
4136 amount => 0,
4137 due => output_pref($datedue),
4143 sub _item_denied_renewal {
4144 my ($params) = @_;
4146 my $item = $params->{item};
4147 return unless $item;
4149 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4150 return unless $denyingrules;
4151 foreach my $field (keys %$denyingrules) {
4152 my $val = $item->$field;
4153 if( !defined $val) {
4154 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4155 return 1;
4157 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4158 # If the results matches the values in the syspref
4159 # We return true if match found
4160 return 1;
4163 return 0;
4169 __END__
4171 =head1 AUTHOR
4173 Koha Development Team <http://koha-community.org/>
4175 =cut