Revert "Bug 17232: Make sure all fields are copies when creating a new framework...
[koha.git] / C4 / Circulation.pm
blob8b3f111063975955f646cd88b8b89c7cdc57ab64
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::RefundLostItemFeeRule;
58 use Koha::RefundLostItemFeeRules;
59 use Koha::Account::Lines;
60 use Koha::Account::Offsets;
61 use Koha::Config::SysPrefs;
62 use Koha::Charges::Fees;
63 use Koha::Util::SystemPreferences;
64 use Carp;
65 use List::MoreUtils qw( uniq any );
66 use Scalar::Util qw( looks_like_number );
67 use Date::Calc qw(
68 Today
69 Today_and_Now
70 Add_Delta_YM
71 Add_Delta_DHMS
72 Date_to_Days
73 Day_of_Week
74 Add_Delta_Days
76 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
78 BEGIN {
79 require Exporter;
80 @ISA = qw(Exporter);
82 # FIXME subs that should probably be elsewhere
83 push @EXPORT, qw(
84 &barcodedecode
85 &LostItem
86 &ReturnLostItem
87 &GetPendingOnSiteCheckouts
90 # subs to deal with issuing a book
91 push @EXPORT, qw(
92 &CanBookBeIssued
93 &CanBookBeRenewed
94 &AddIssue
95 &AddRenewal
96 &GetRenewCount
97 &GetSoonestRenewDate
98 &GetLatestAutoRenewDate
99 &GetIssuingCharges
100 &GetBranchBorrowerCircRule
101 &GetBranchItemRule
102 &GetBiblioIssues
103 &GetOpenIssue
104 &CheckIfIssuedToPatron
105 &IsItemIssued
106 GetTopIssues
109 # subs to deal with returns
110 push @EXPORT, qw(
111 &AddReturn
112 &MarkIssueReturned
115 # subs to deal with transfers
116 push @EXPORT, qw(
117 &transferbook
118 &GetTransfers
119 &GetTransfersFromTo
120 &updateWrongTransfer
121 &DeleteTransfer
122 &IsBranchTransferAllowed
123 &CreateBranchTransferLimit
124 &DeleteBranchTransferLimits
125 &TransferSlip
128 # subs to deal with offline circulation
129 push @EXPORT, qw(
130 &GetOfflineOperations
131 &GetOfflineOperation
132 &AddOfflineOperation
133 &DeleteOfflineOperation
134 &ProcessOfflineOperation
138 =head1 NAME
140 C4::Circulation - Koha circulation module
142 =head1 SYNOPSIS
144 use C4::Circulation;
146 =head1 DESCRIPTION
148 The functions in this module deal with circulation, issues, and
149 returns, as well as general information about the library.
150 Also deals with inventory.
152 =head1 FUNCTIONS
154 =head2 barcodedecode
156 $str = &barcodedecode($barcode, [$filter]);
158 Generic filter function for barcode string.
159 Called on every circ if the System Pref itemBarcodeInputFilter is set.
160 Will do some manipulation of the barcode for systems that deliver a barcode
161 to circulation.pl that differs from the barcode stored for the item.
162 For proper functioning of this filter, calling the function on the
163 correct barcode string (items.barcode) should return an unaltered barcode.
165 The optional $filter argument is to allow for testing or explicit
166 behavior that ignores the System Pref. Valid values are the same as the
167 System Pref options.
169 =cut
171 # FIXME -- the &decode fcn below should be wrapped into this one.
172 # FIXME -- these plugins should be moved out of Circulation.pm
174 sub barcodedecode {
175 my ($barcode, $filter) = @_;
176 my $branch = C4::Context::mybranch();
177 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
178 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
179 if ($filter eq 'whitespace') {
180 $barcode =~ s/\s//g;
181 } elsif ($filter eq 'cuecat') {
182 chomp($barcode);
183 my @fields = split( /\./, $barcode );
184 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
185 ($#results == 2) and return $results[2];
186 } elsif ($filter eq 'T-prefix') {
187 if ($barcode =~ /^[Tt](\d)/) {
188 (defined($1) and $1 eq '0') and return $barcode;
189 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
191 return sprintf("T%07d", $barcode);
192 # FIXME: $barcode could be "T1", causing warning: substr outside of string
193 # Why drop the nonzero digit after the T?
194 # Why pass non-digits (or empty string) to "T%07d"?
195 } elsif ($filter eq 'libsuite8') {
196 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
197 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
198 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
199 }else{
200 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
203 } elsif ($filter eq 'EAN13') {
204 my $ean = CheckDigits('ean');
205 if ( $ean->is_valid($barcode) ) {
206 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
207 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
208 } else {
209 warn "# [$barcode] not valid EAN-13/UPC-A\n";
212 return $barcode; # return barcode, modified or not
215 =head2 decode
217 $str = &decode($chunk);
219 Decodes a segment of a string emitted by a CueCat barcode scanner and
220 returns it.
222 FIXME: Should be replaced with Barcode::Cuecat from CPAN
223 or Javascript based decoding on the client side.
225 =cut
227 sub decode {
228 my ($encoded) = @_;
229 my $seq =
230 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
231 my @s = map { index( $seq, $_ ); } split( //, $encoded );
232 my $l = ( $#s + 1 ) % 4;
233 if ($l) {
234 if ( $l == 1 ) {
235 # warn "Error: Cuecat decode parsing failed!";
236 return;
238 $l = 4 - $l;
239 $#s += $l;
241 my $r = '';
242 while ( $#s >= 0 ) {
243 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
244 $r .=
245 chr( ( $n >> 16 ) ^ 67 )
246 .chr( ( $n >> 8 & 255 ) ^ 67 )
247 .chr( ( $n & 255 ) ^ 67 );
248 @s = @s[ 4 .. $#s ];
250 $r = substr( $r, 0, length($r) - $l );
251 return $r;
254 =head2 transferbook
256 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
257 $barcode, $ignore_reserves);
259 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
261 C<$newbranch> is the code for the branch to which the item should be transferred.
263 C<$barcode> is the barcode of the item to be transferred.
265 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
266 Otherwise, if an item is reserved, the transfer fails.
268 Returns three values:
270 =over
272 =item $dotransfer
274 is true if the transfer was successful.
276 =item $messages
278 is a reference-to-hash which may have any of the following keys:
280 =over
282 =item C<BadBarcode>
284 There is no item in the catalog with the given barcode. The value is C<$barcode>.
286 =item C<DestinationEqualsHolding>
288 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
290 =item C<WasReturned>
292 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
294 =item C<ResFound>
296 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
298 =item C<WasTransferred>
300 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
302 =back
304 =back
306 =cut
308 sub transferbook {
309 my ( $tbr, $barcode, $ignoreRs ) = @_;
310 my $messages;
311 my $dotransfer = 1;
312 my $item = Koha::Items->find( { barcode => $barcode } );
314 # bad barcode..
315 unless ( $item ) {
316 $messages->{'BadBarcode'} = $barcode;
317 $dotransfer = 0;
318 return ( $dotransfer, $messages );
321 my $itemnumber = $item->itemnumber;
322 # get branches of book...
323 my $hbr = $item->homebranch;
324 my $fbr = $item->holdingbranch;
326 # if using Branch Transfer Limits
327 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
328 my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
329 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
330 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
331 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
332 $dotransfer = 0;
334 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
335 $messages->{'NotAllowed'} = $tbr . "::" . $code;
336 $dotransfer = 0;
340 # can't transfer book if is already there....
341 if ( $fbr eq $tbr ) {
342 $messages->{'DestinationEqualsHolding'} = 1;
343 $dotransfer = 0;
346 # check if it is still issued to someone, return it...
347 my $issue = Koha::Checkouts->find({ itemnumber => $itemnumber });
348 if ( $issue ) {
349 AddReturn( $barcode, $fbr );
350 $messages->{'WasReturned'} = $issue->borrowernumber;
353 # find reserves.....
354 # That'll save a database query.
355 my ( $resfound, $resrec, undef ) =
356 CheckReserves( $itemnumber );
357 if ( $resfound and not $ignoreRs ) {
358 $resrec->{'ResFound'} = $resfound;
360 # $messages->{'ResFound'} = $resrec;
361 $dotransfer = 1;
364 #actually do the transfer....
365 if ($dotransfer) {
366 ModItemTransfer( $itemnumber, $fbr, $tbr );
368 # don't need to update MARC anymore, we do it in batch now
369 $messages->{'WasTransfered'} = 1;
372 ModDateLastSeen( $itemnumber );
373 return ( $dotransfer, $messages );
377 sub TooMany {
378 my $borrower = shift;
379 my $item_object = shift;
380 my $params = shift;
381 my $onsite_checkout = $params->{onsite_checkout} || 0;
382 my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
383 my $cat_borrower = $borrower->{'categorycode'};
384 my $dbh = C4::Context->dbh;
385 my $branch;
386 # Get which branchcode we need
387 $branch = _GetCircControlBranch($item_object->unblessed,$borrower);
388 my $type = $item_object->effective_itemtype;
390 # given branch, patron category, and item type, determine
391 # applicable issuing rule
392 my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
394 categorycode => $cat_borrower,
395 itemtype => $type,
396 branchcode => $branch,
397 rule_name => 'maxissueqty',
400 my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
402 categorycode => $cat_borrower,
403 itemtype => $type,
404 branchcode => $branch,
405 rule_name => 'maxonsiteissueqty',
410 # if a rule is found and has a loan limit set, count
411 # how many loans the patron already has that meet that
412 # rule
413 if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne '') {
414 my @bind_params;
415 my $count_query = q|
416 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
417 FROM issues
418 JOIN items USING (itemnumber)
421 my $rule_itemtype = $maxissueqty_rule->itemtype;
422 unless ($rule_itemtype) {
423 # matching rule has the default item type, so count only
424 # those existing loans that don't fall under a more
425 # specific rule
426 if (C4::Context->preference('item-level_itypes')) {
427 $count_query .= " WHERE items.itype NOT IN (
428 SELECT itemtype FROM issuingrules
429 WHERE branchcode = ?
430 AND (categorycode = ? OR categorycode = ?)
431 AND itemtype <> '*'
432 ) ";
433 } else {
434 $count_query .= " JOIN biblioitems USING (biblionumber)
435 WHERE biblioitems.itemtype NOT IN (
436 SELECT itemtype FROM issuingrules
437 WHERE branchcode = ?
438 AND (categorycode = ? OR categorycode = ?)
439 AND itemtype <> '*'
440 ) ";
442 push @bind_params, $maxissueqty_rule->branchcode;
443 push @bind_params, $maxissueqty_rule->categorycode;
444 push @bind_params, $cat_borrower;
445 } else {
446 # rule has specific item type, so count loans of that
447 # specific item type
448 if (C4::Context->preference('item-level_itypes')) {
449 $count_query .= " WHERE items.itype = ? ";
450 } else {
451 $count_query .= " JOIN biblioitems USING (biblionumber)
452 WHERE biblioitems.itemtype= ? ";
454 push @bind_params, $type;
457 $count_query .= " AND borrowernumber = ? ";
458 push @bind_params, $borrower->{'borrowernumber'};
459 my $rule_branch = $maxissueqty_rule->branchcode;
460 if ($rule_branch) {
461 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
462 $count_query .= " AND issues.branchcode = ? ";
463 push @bind_params, $rule_branch;
464 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
465 ; # if branch is the patron's home branch, then count all loans by patron
466 } else {
467 $count_query .= " AND items.homebranch = ? ";
468 push @bind_params, $rule_branch;
472 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
474 my $max_checkouts_allowed = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
475 my $max_onsite_checkouts_allowed = $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef;
477 if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
478 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
479 return {
480 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
481 count => $onsite_checkout_count,
482 max_allowed => $max_onsite_checkouts_allowed,
486 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
487 my $delta = $switch_onsite_checkout ? 1 : 0;
488 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
489 return {
490 reason => 'TOO_MANY_CHECKOUTS',
491 count => $checkout_count,
492 max_allowed => $max_checkouts_allowed,
495 } elsif ( not $onsite_checkout ) {
496 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
497 return {
498 reason => 'TOO_MANY_CHECKOUTS',
499 count => $checkout_count - $onsite_checkout_count,
500 max_allowed => $max_checkouts_allowed,
506 # Now count total loans against the limit for the branch
507 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
508 if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
509 my @bind_params = ();
510 my $branch_count_query = q|
511 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
512 FROM issues
513 JOIN items USING (itemnumber)
514 WHERE borrowernumber = ?
516 push @bind_params, $borrower->{borrowernumber};
518 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
519 $branch_count_query .= " AND issues.branchcode = ? ";
520 push @bind_params, $branch;
521 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
522 ; # if branch is the patron's home branch, then count all loans by patron
523 } else {
524 $branch_count_query .= " AND items.homebranch = ? ";
525 push @bind_params, $branch;
527 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
528 my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
529 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty};
531 if ( $onsite_checkout and $max_onsite_checkouts_allowed ne '' ) {
532 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
533 return {
534 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
535 count => $onsite_checkout_count,
536 max_allowed => $max_onsite_checkouts_allowed,
540 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
541 my $delta = $switch_onsite_checkout ? 1 : 0;
542 if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
543 return {
544 reason => 'TOO_MANY_CHECKOUTS',
545 count => $checkout_count,
546 max_allowed => $max_checkouts_allowed,
549 } elsif ( not $onsite_checkout ) {
550 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
551 return {
552 reason => 'TOO_MANY_CHECKOUTS',
553 count => $checkout_count - $onsite_checkout_count,
554 max_allowed => $max_checkouts_allowed,
560 if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
561 return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
564 # OK, the patron can issue !!!
565 return;
568 =head2 CanBookBeIssued
570 ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) = CanBookBeIssued( $patron,
571 $barcode, $duedate, $inprocess, $ignore_reserves, $params );
573 Check if a book can be issued.
575 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
577 IMPORTANT: The assumption by users of this routine is that causes blocking
578 the issue are keyed by uppercase labels and other returned
579 data is keyed in lower case!
581 =over 4
583 =item C<$patron> is a Koha::Patron
585 =item C<$barcode> is the bar code of the book being issued.
587 =item C<$duedates> is a DateTime object.
589 =item C<$inprocess> boolean switch
591 =item C<$ignore_reserves> boolean switch
593 =item C<$params> Hashref of additional parameters
595 Available keys:
596 override_high_holds - Ignore high holds
597 onsite_checkout - Checkout is an onsite checkout that will not leave the library
599 =back
601 Returns :
603 =over 4
605 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
606 Possible values are :
608 =back
610 =head3 INVALID_DATE
612 sticky due date is invalid
614 =head3 GNA
616 borrower gone with no address
618 =head3 CARD_LOST
620 borrower declared it's card lost
622 =head3 DEBARRED
624 borrower debarred
626 =head3 UNKNOWN_BARCODE
628 barcode unknown
630 =head3 NOT_FOR_LOAN
632 item is not for loan
634 =head3 WTHDRAWN
636 item withdrawn.
638 =head3 RESTRICTED
640 item is restricted (set by ??)
642 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
643 could be prevented, but ones that can be overriden by the operator.
645 Possible values are :
647 =head3 DEBT
649 borrower has debts.
651 =head3 RENEW_ISSUE
653 renewing, not issuing
655 =head3 ISSUED_TO_ANOTHER
657 issued to someone else.
659 =head3 RESERVED
661 reserved for someone else.
663 =head3 INVALID_DATE
665 sticky due date is invalid or due date in the past
667 =head3 TOO_MANY
669 if the borrower borrows to much things
671 =cut
673 sub CanBookBeIssued {
674 my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
675 my %needsconfirmation; # filled with problems that needs confirmations
676 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
677 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
678 my %messages; # filled with information messages that should be displayed.
680 my $onsite_checkout = $params->{onsite_checkout} || 0;
681 my $override_high_holds = $params->{override_high_holds} || 0;
683 my $item_object = Koha::Items->find({barcode => $barcode });
685 # MANDATORY CHECKS - unless item exists, nothing else matters
686 unless ( $item_object ) {
687 $issuingimpossible{UNKNOWN_BARCODE} = 1;
689 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
691 my $item_unblessed = $item_object->unblessed; # Transition...
692 my $issue = $item_object->checkout;
693 my $biblio = $item_object->biblio;
695 my $biblioitem = $biblio->biblioitem;
696 my $effective_itemtype = $item_object->effective_itemtype;
697 my $dbh = C4::Context->dbh;
698 my $patron_unblessed = $patron->unblessed;
700 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
702 # DUE DATE is OK ? -- should already have checked.
704 if ($duedate && ref $duedate ne 'DateTime') {
705 $duedate = dt_from_string($duedate);
707 my $now = DateTime->now( time_zone => C4::Context->tz() );
708 unless ( $duedate ) {
709 my $issuedate = $now->clone();
711 $duedate = CalcDateDue( $issuedate, $effective_itemtype, $circ_library->branchcode, $patron_unblessed );
713 # Offline circ calls AddIssue directly, doesn't run through here
714 # So issuingimpossible should be ok.
717 my $fees = Koha::Charges::Fees->new(
719 patron => $patron,
720 library => $circ_library,
721 item => $item_object,
722 to_date => $duedate,
726 if ($duedate) {
727 my $today = $now->clone();
728 $today->truncate( to => 'minute');
729 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
730 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
732 } else {
733 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
737 # BORROWER STATUS
739 if ( $patron->category->category_type eq 'X' && ( $item_object->barcode )) {
740 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
741 &UpdateStats({
742 branch => C4::Context->userenv->{'branch'},
743 type => 'localuse',
744 itemnumber => $item_object->itemnumber,
745 itemtype => $effective_itemtype,
746 borrowernumber => $patron->borrowernumber,
747 ccode => $item_object->ccode}
749 ModDateLastSeen( $item_object->itemnumber ); # FIXME Move to Koha::Item
750 return( { STATS => 1 }, {});
753 if ( $patron->gonenoaddress == 1 ) {
754 $issuingimpossible{GNA} = 1;
757 if ( $patron->lost == 1 ) {
758 $issuingimpossible{CARD_LOST} = 1;
760 if ( $patron->is_debarred ) {
761 $issuingimpossible{DEBARRED} = 1;
764 if ( $patron->is_expired ) {
765 $issuingimpossible{EXPIRED} = 1;
769 # BORROWER STATUS
772 # DEBTS
773 my $account = $patron->account;
774 my $balance = $account->balance;
775 my $non_issues_charges = $account->non_issues_charges;
776 my $other_charges = $balance - $non_issues_charges;
778 my $amountlimit = C4::Context->preference("noissuescharge");
779 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
780 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
782 # Check the debt of this patrons guarantees
783 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
784 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
785 if ( defined $no_issues_charge_guarantees ) {
786 my @guarantees = $patron->guarantees();
787 my $guarantees_non_issues_charges;
788 foreach my $g ( @guarantees ) {
789 $guarantees_non_issues_charges += $g->account->non_issues_charges;
792 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
793 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
794 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
795 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
796 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
797 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
801 if ( C4::Context->preference("IssuingInProcess") ) {
802 if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
803 $issuingimpossible{DEBT} = $non_issues_charges;
804 } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
805 $needsconfirmation{DEBT} = $non_issues_charges;
806 } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
807 $needsconfirmation{DEBT} = $non_issues_charges;
810 else {
811 if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
812 $needsconfirmation{DEBT} = $non_issues_charges;
813 } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
814 $issuingimpossible{DEBT} = $non_issues_charges;
815 } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
816 $needsconfirmation{DEBT} = $non_issues_charges;
820 if ($balance > 0 && $other_charges > 0) {
821 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
824 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
825 $patron_unblessed = $patron->unblessed;
827 if ( my $debarred_date = $patron->is_debarred ) {
828 # patron has accrued fine days or has a restriction. $count is a date
829 if ($debarred_date eq '9999-12-31') {
830 $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
832 else {
833 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
835 } elsif ( my $num_overdues = $patron->has_overdues ) {
836 ## patron has outstanding overdue loans
837 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
838 $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
840 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
841 $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
846 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
848 if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
850 # Already issued to current borrower.
851 # If it is an on-site checkout if it can be switched to a normal checkout
852 # or ask whether the loan should be renewed
854 if ( $issue->onsite_checkout
855 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
856 $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
857 } else {
858 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
859 $patron->borrowernumber,
860 $item_object->itemnumber,
862 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
863 if ( $renewerror eq 'onsite_checkout' ) {
864 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
866 else {
867 $issuingimpossible{NO_MORE_RENEWALS} = 1;
870 else {
871 $needsconfirmation{RENEW_ISSUE} = 1;
875 elsif ( $issue ) {
877 # issued to someone else
879 my $patron = Koha::Patrons->find( $issue->borrowernumber );
881 my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
883 unless ( $can_be_returned ) {
884 $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
885 $issuingimpossible{branch_to_return} = $message;
886 } else {
887 if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
888 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
889 } else {
890 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
891 $needsconfirmation{issued_firstname} = $patron->firstname;
892 $needsconfirmation{issued_surname} = $patron->surname;
893 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
894 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
899 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
901 my $switch_onsite_checkout = (
902 C4::Context->preference('SwitchOnSiteCheckouts')
903 and $issue
904 and $issue->onsite_checkout
905 and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
906 my $toomany = TooMany( $patron_unblessed, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
907 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
908 if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
909 if ( $toomany->{max_allowed} == 0 ) {
910 $needsconfirmation{PATRON_CANT} = 1;
912 if ( C4::Context->preference("AllowTooManyOverride") ) {
913 $needsconfirmation{TOO_MANY} = $toomany->{reason};
914 $needsconfirmation{current_loan_count} = $toomany->{count};
915 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
916 } else {
917 $issuingimpossible{TOO_MANY} = $toomany->{reason};
918 $issuingimpossible{current_loan_count} = $toomany->{count};
919 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
924 # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
926 $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
927 my $wants_check = $patron->wants_check_for_previous_checkout;
928 $needsconfirmation{PREVISSUE} = 1
929 if ($wants_check and $patron->do_check_for_previous_checkout($item_unblessed));
932 # ITEM CHECKING
934 if ( $item_object->notforloan )
936 if(!C4::Context->preference("AllowNotForLoanOverride")){
937 $issuingimpossible{NOT_FOR_LOAN} = 1;
938 $issuingimpossible{item_notforloan} = $item_object->notforloan;
939 }else{
940 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
941 $needsconfirmation{item_notforloan} = $item_object->notforloan;
944 else {
945 # we have to check itemtypes.notforloan also
946 if (C4::Context->preference('item-level_itypes')){
947 # this should probably be a subroutine
948 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
949 $sth->execute($effective_itemtype);
950 my $notforloan=$sth->fetchrow_hashref();
951 if ($notforloan->{'notforloan'}) {
952 if (!C4::Context->preference("AllowNotForLoanOverride")) {
953 $issuingimpossible{NOT_FOR_LOAN} = 1;
954 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
955 } else {
956 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
957 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
961 else {
962 my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
963 if ( $itemtype and $itemtype->notforloan == 1){
964 if (!C4::Context->preference("AllowNotForLoanOverride")) {
965 $issuingimpossible{NOT_FOR_LOAN} = 1;
966 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
967 } else {
968 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
969 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
974 if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
976 $issuingimpossible{WTHDRAWN} = 1;
978 if ( $item_object->restricted
979 && $item_object->restricted == 1 )
981 $issuingimpossible{RESTRICTED} = 1;
983 if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
984 my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
985 my $code = $av->count ? $av->next->lib : '';
986 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
987 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
989 if ( C4::Context->preference("IndependentBranches") ) {
990 my $userenv = C4::Context->userenv;
991 unless ( C4::Context->IsSuperLibrarian() ) {
992 my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
993 if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
994 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
995 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
997 $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
998 if ( $patron->branchcode ne $userenv->{branch} );
1003 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1005 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1006 if ($rentalConfirmation) {
1007 my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1009 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1010 if ($itemtype_object) {
1011 my $accumulate_charge = $fees->accumulate_rentalcharge();
1012 if ( $accumulate_charge > 0 ) {
1013 $rentalCharge += $accumulate_charge;
1017 if ( $rentalCharge > 0 ) {
1018 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1022 unless ( $ignore_reserves ) {
1023 # See if the item is on reserve.
1024 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item_object->itemnumber );
1025 if ($restype) {
1026 my $resbor = $res->{'borrowernumber'};
1027 if ( $resbor ne $patron->borrowernumber ) {
1028 my $patron = Koha::Patrons->find( $resbor );
1029 if ( $restype eq "Waiting" )
1031 # The item is on reserve and waiting, but has been
1032 # reserved by some other patron.
1033 $needsconfirmation{RESERVE_WAITING} = 1;
1034 $needsconfirmation{'resfirstname'} = $patron->firstname;
1035 $needsconfirmation{'ressurname'} = $patron->surname;
1036 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1037 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1038 $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1039 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1041 elsif ( $restype eq "Reserved" ) {
1042 # The item is on reserve for someone else.
1043 $needsconfirmation{RESERVED} = 1;
1044 $needsconfirmation{'resfirstname'} = $patron->firstname;
1045 $needsconfirmation{'ressurname'} = $patron->surname;
1046 $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1047 $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1048 $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1049 $needsconfirmation{'resreservedate'} = $res->{reservedate};
1055 ## CHECK AGE RESTRICTION
1056 my $agerestriction = $biblioitem->agerestriction;
1057 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1058 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1059 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1060 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1062 else {
1063 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1067 ## check for high holds decreasing loan period
1068 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1069 my $check = checkHighHolds( $item_unblessed, $patron_unblessed );
1071 if ( $check->{exceeded} ) {
1072 if ($override_high_holds) {
1073 $alerts{HIGHHOLDS} = {
1074 num_holds => $check->{outstanding},
1075 duration => $check->{duration},
1076 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1079 else {
1080 $needsconfirmation{HIGHHOLDS} = {
1081 num_holds => $check->{outstanding},
1082 duration => $check->{duration},
1083 returndate => output_pref( { dt => dt_from_string($check->{due_date}), dateformat => 'iso', timeformat => '24hr' }),
1089 if (
1090 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1091 # don't do the multiple loans per bib check if we've
1092 # already determined that we've got a loan on the same item
1093 !$issuingimpossible{NO_MORE_RENEWALS} &&
1094 !$needsconfirmation{RENEW_ISSUE}
1096 # Check if borrower has already issued an item from the same biblio
1097 # Only if it's not a subscription
1098 my $biblionumber = $item_object->biblionumber;
1099 require C4::Serials;
1100 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1101 unless ($is_a_subscription) {
1102 # FIXME Should be $patron->checkouts($args);
1103 my $checkouts = Koha::Checkouts->search(
1105 borrowernumber => $patron->borrowernumber,
1106 biblionumber => $biblionumber,
1109 join => 'item',
1112 # if we get here, we don't already have a loan on this item,
1113 # so if there are any loans on this bib, ask for confirmation
1114 if ( $checkouts->count ) {
1115 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1120 return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1123 =head2 CanBookBeReturned
1125 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1127 Check whether the item can be returned to the provided branch
1129 =over 4
1131 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1133 =item C<$branch> is the branchcode where the return is taking place
1135 =back
1137 Returns:
1139 =over 4
1141 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1143 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1145 =back
1147 =cut
1149 sub CanBookBeReturned {
1150 my ($item, $branch) = @_;
1151 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1153 # assume return is allowed to start
1154 my $allowed = 1;
1155 my $message;
1157 # identify all cases where return is forbidden
1158 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1159 $allowed = 0;
1160 $message = $item->{'homebranch'};
1161 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1162 $allowed = 0;
1163 $message = $item->{'holdingbranch'};
1164 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1165 $allowed = 0;
1166 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1169 return ($allowed, $message);
1172 =head2 CheckHighHolds
1174 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1175 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1176 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1178 =cut
1180 sub checkHighHolds {
1181 my ( $item, $borrower ) = @_;
1182 my $branchcode = _GetCircControlBranch( $item, $borrower );
1183 my $item_object = Koha::Items->find( $item->{itemnumber} );
1185 my $return_data = {
1186 exceeded => 0,
1187 outstanding => 0,
1188 duration => 0,
1189 due_date => undef,
1192 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1194 if ( $holds->count() ) {
1195 $return_data->{outstanding} = $holds->count();
1197 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1198 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1199 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1201 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1203 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1205 # static means just more than a given number of holds on the record
1207 # If the number of holds is less than the threshold, we can stop here
1208 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1209 return $return_data;
1212 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1214 # dynamic means X more than the number of holdable items on the record
1216 # let's get the items
1217 my @items = $holds->next()->biblio()->items()->as_list;
1219 # Remove any items with status defined to be ignored even if the would not make item unholdable
1220 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1221 @items = grep { !$_->$status } @items;
1224 # Remove any items that are not holdable for this patron
1225 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber )->{status} eq 'OK' } @items;
1227 my $items_count = scalar @items;
1229 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1231 # If the number of holds is less than the count of items we have
1232 # plus the number of holds allowed above that count, we can stop here
1233 if ( $holds->count() <= $threshold ) {
1234 return $return_data;
1238 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1240 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
1242 my $itype = $item_object->effective_itemtype;
1243 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1245 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1247 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1248 $reduced_datedue->set_hour($orig_due->hour);
1249 $reduced_datedue->set_minute($orig_due->minute);
1250 $reduced_datedue->truncate( to => 'minute' );
1252 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1253 $return_data->{exceeded} = 1;
1254 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1255 $return_data->{due_date} = $reduced_datedue;
1259 return $return_data;
1262 =head2 AddIssue
1264 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1266 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1268 =over 4
1270 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1272 =item C<$barcode> is the barcode of the item being issued.
1274 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1275 Calculated if empty.
1277 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1279 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1280 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1282 AddIssue does the following things :
1284 - step 01: check that there is a borrowernumber & a barcode provided
1285 - check for RENEWAL (book issued & being issued to the same patron)
1286 - renewal YES = Calculate Charge & renew
1287 - renewal NO =
1288 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1289 * RESERVE PLACED ?
1290 - fill reserve if reserve to this patron
1291 - cancel reserve or not, otherwise
1292 * TRANSFERT PENDING ?
1293 - complete the transfert
1294 * ISSUE THE BOOK
1296 =back
1298 =cut
1300 sub AddIssue {
1301 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1303 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1304 my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1305 my $auto_renew = $params && $params->{auto_renew};
1306 my $dbh = C4::Context->dbh;
1307 my $barcodecheck = CheckValidBarcode($barcode);
1309 my $issue;
1311 if ( $datedue && ref $datedue ne 'DateTime' ) {
1312 $datedue = dt_from_string($datedue);
1315 # $issuedate defaults to today.
1316 if ( !defined $issuedate ) {
1317 $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1319 else {
1320 if ( ref $issuedate ne 'DateTime' ) {
1321 $issuedate = dt_from_string($issuedate);
1326 # Stop here if the patron or barcode doesn't exist
1327 if ( $borrower && $barcode && $barcodecheck ) {
1328 # find which item we issue
1329 my $item_object = Koha::Items->find({ barcode => $barcode })
1330 or return; # if we don't get an Item, abort.
1331 my $item_unblessed = $item_object->unblessed;
1333 my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1335 # get actual issuing if there is one
1336 my $actualissue = $item_object->checkout;
1338 # check if we just renew the issue.
1339 if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1340 and not $switch_onsite_checkout ) {
1341 $datedue = AddRenewal(
1342 $borrower->{'borrowernumber'},
1343 $item_object->itemnumber,
1344 $branchcode,
1345 $datedue,
1346 $issuedate, # here interpreted as the renewal date
1349 else {
1350 unless ($datedue) {
1351 my $itype = $item_object->effective_itemtype;
1352 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1355 $datedue->truncate( to => 'minute' );
1357 my $patron = Koha::Patrons->find( $borrower );
1358 my $library = Koha::Libraries->find( $branchcode );
1359 my $fees = Koha::Charges::Fees->new(
1361 patron => $patron,
1362 library => $library,
1363 item => $item_object,
1364 to_date => $datedue,
1368 # it's NOT a renewal
1369 if ( $actualissue and not $switch_onsite_checkout ) {
1370 # This book is currently on loan, but not to the person
1371 # who wants to borrow it now. mark it returned before issuing to the new borrower
1372 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1373 return unless $allowed;
1374 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1377 C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1379 # Starting process for transfer job (checking transfert and validate it if we have one)
1380 my ($datesent) = GetTransfers( $item_object->itemnumber );
1381 if ($datesent) {
1382 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1383 my $sth = $dbh->prepare(
1384 "UPDATE branchtransfers
1385 SET datearrived = now(),
1386 tobranch = ?,
1387 comments = 'Forced branchtransfer'
1388 WHERE itemnumber= ? AND datearrived IS NULL"
1390 $sth->execute( C4::Context->userenv->{'branch'},
1391 $item_object->itemnumber );
1394 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1395 unless ($auto_renew) {
1396 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1397 { categorycode => $borrower->{categorycode},
1398 itemtype => $item_object->effective_itemtype,
1399 branchcode => $branchcode
1403 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1406 # Record in the database the fact that the book was issued.
1407 unless ($datedue) {
1408 my $itype = $item_object->effective_itemtype;
1409 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1412 $datedue->truncate( to => 'minute' );
1414 my $issue_attributes = {
1415 borrowernumber => $borrower->{'borrowernumber'},
1416 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1417 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1418 branchcode => C4::Context->userenv->{'branch'},
1419 onsite_checkout => $onsite_checkout,
1420 auto_renew => $auto_renew ? 1 : 0,
1423 $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1424 if ($issue) {
1425 $issue->set($issue_attributes)->store;
1427 else {
1428 $issue = Koha::Checkout->new(
1430 itemnumber => $item_object->itemnumber,
1431 %$issue_attributes,
1433 )->store;
1435 if ( $item_object->location eq 'CART' && $item_object->permanent_location ne 'CART' ) {
1436 ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1437 CartToShelf( $item_object->itemnumber );
1440 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1441 UpdateTotalIssues( $item_object->biblionumber, 1 );
1444 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1445 if ( $item_object->itemlost ) {
1446 if (
1447 Koha::RefundLostItemFeeRules->should_refund(
1449 current_branch => C4::Context->userenv->{branch},
1450 item_home_branch => $item_object->homebranch,
1451 item_holding_branch => $item_object->holdingbranch,
1456 _FixAccountForLostAndReturned( $item_object->itemnumber, undef,
1457 $item_object->barcode );
1461 ModItem(
1463 issues => $item_object->issues + 1,
1464 holdingbranch => C4::Context->userenv->{'branch'},
1465 itemlost => 0,
1466 onloan => $datedue->ymd(),
1467 datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1469 $item_object->biblionumber,
1470 $item_object->itemnumber,
1471 { log_action => 0 }
1473 ModDateLastSeen( $item_object->itemnumber );
1475 # If it costs to borrow this book, charge it to the patron's account.
1476 my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1477 if ( $charge > 0 ) {
1478 my $description = "Rental";
1479 AddIssuingCharge( $issue, $charge, $description );
1482 my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1483 if ( $itemtype_object ) {
1484 my $accumulate_charge = $fees->accumulate_rentalcharge();
1485 if ( $accumulate_charge > 0 ) {
1486 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1487 $charge += $accumulate_charge;
1488 $item_unblessed->{charge} = $charge;
1492 # Record the fact that this book was issued.
1493 &UpdateStats(
1495 branch => C4::Context->userenv->{'branch'},
1496 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1497 amount => $charge,
1498 other => ( $sipmode ? "SIP-$sipmode" : '' ),
1499 itemnumber => $item_object->itemnumber,
1500 itemtype => $item_object->effective_itemtype,
1501 location => $item_object->location,
1502 borrowernumber => $borrower->{'borrowernumber'},
1503 ccode => $item_object->ccode,
1507 # Send a checkout slip.
1508 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1509 my %conditions = (
1510 branchcode => $branchcode,
1511 categorycode => $borrower->{categorycode},
1512 item_type => $item_object->effective_itemtype,
1513 notification => 'CHECKOUT',
1515 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1516 SendCirculationAlert(
1518 type => 'CHECKOUT',
1519 item => $item_object->unblessed,
1520 borrower => $borrower,
1521 branch => $branchcode,
1525 logaction(
1526 "CIRCULATION", "ISSUE",
1527 $borrower->{'borrowernumber'},
1528 $item_object->itemnumber,
1529 ) if C4::Context->preference("IssueLog");
1532 return $issue;
1535 =head2 GetLoanLength
1537 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1539 Get loan length for an itemtype, a borrower type and a branch
1541 =cut
1543 sub GetLoanLength {
1544 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1545 my $dbh = C4::Context->dbh;
1546 my $sth = $dbh->prepare(qq{
1547 SELECT issuelength, lengthunit, renewalperiod
1548 FROM issuingrules
1549 WHERE categorycode=?
1550 AND itemtype=?
1551 AND branchcode=?
1552 AND issuelength IS NOT NULL
1555 # try to find issuelength & return the 1st available.
1556 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1557 $sth->execute( $borrowertype, $itemtype, $branchcode );
1558 my $loanlength = $sth->fetchrow_hashref;
1560 return $loanlength
1561 if defined($loanlength) && defined $loanlength->{issuelength};
1563 $sth->execute( $borrowertype, '*', $branchcode );
1564 $loanlength = $sth->fetchrow_hashref;
1565 return $loanlength
1566 if defined($loanlength) && defined $loanlength->{issuelength};
1568 $sth->execute( '*', $itemtype, $branchcode );
1569 $loanlength = $sth->fetchrow_hashref;
1570 return $loanlength
1571 if defined($loanlength) && defined $loanlength->{issuelength};
1573 $sth->execute( '*', '*', $branchcode );
1574 $loanlength = $sth->fetchrow_hashref;
1575 return $loanlength
1576 if defined($loanlength) && defined $loanlength->{issuelength};
1578 $sth->execute( $borrowertype, $itemtype, '*' );
1579 $loanlength = $sth->fetchrow_hashref;
1580 return $loanlength
1581 if defined($loanlength) && defined $loanlength->{issuelength};
1583 $sth->execute( $borrowertype, '*', '*' );
1584 $loanlength = $sth->fetchrow_hashref;
1585 return $loanlength
1586 if defined($loanlength) && defined $loanlength->{issuelength};
1588 $sth->execute( '*', $itemtype, '*' );
1589 $loanlength = $sth->fetchrow_hashref;
1590 return $loanlength
1591 if defined($loanlength) && defined $loanlength->{issuelength};
1593 $sth->execute( '*', '*', '*' );
1594 $loanlength = $sth->fetchrow_hashref;
1595 return $loanlength
1596 if defined($loanlength) && defined $loanlength->{issuelength};
1598 # if no rule is set => 0 day (hardcoded)
1599 return {
1600 issuelength => 0,
1601 renewalperiod => 0,
1602 lengthunit => 'days',
1608 =head2 GetHardDueDate
1610 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1612 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1614 =cut
1616 sub GetHardDueDate {
1617 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1619 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1620 { categorycode => $borrowertype,
1621 itemtype => $itemtype,
1622 branchcode => $branchcode
1627 if ( defined( $issuing_rule ) ) {
1628 if ( $issuing_rule->hardduedate ) {
1629 return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1630 } else {
1631 return (undef, undef);
1636 =head2 GetBranchBorrowerCircRule
1638 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1640 Retrieves circulation rule attributes that apply to the given
1641 branch and patron category, regardless of item type.
1642 The return value is a hashref containing the following key:
1644 patron_maxissueqty - maximum number of loans that a
1645 patron of the given category can have at the given
1646 branch. If the value is undef, no limit.
1648 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1649 patron of the given category can have at the given
1650 branch. If the value is undef, no limit.
1652 This will check for different branch/category combinations in the following order:
1653 branch and category
1654 branch only
1655 category only
1656 default branch and category
1658 If no rule has been found in the database, it will default to
1659 the buillt in rule:
1661 patron_maxissueqty - undef
1662 patron_maxonsiteissueqty - undef
1664 C<$branchcode> and C<$categorycode> should contain the
1665 literal branch code and patron category code, respectively - no
1666 wildcards.
1668 =cut
1670 sub GetBranchBorrowerCircRule {
1671 my ( $branchcode, $categorycode ) = @_;
1673 # Initialize default values
1674 my $rules = {
1675 patron_maxissueqty => undef,
1676 patron_maxonsiteissueqty => undef,
1679 # Search for rules!
1680 foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1681 my $rule = Koha::CirculationRules->get_effective_rule(
1683 categorycode => $categorycode,
1684 itemtype => undef,
1685 branchcode => $branchcode,
1686 rule_name => $rule_name,
1690 $rules->{$rule_name} = $rule->rule_value if defined $rule;
1693 return $rules;
1696 =head2 GetBranchItemRule
1698 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1700 Retrieves circulation rule attributes that apply to the given
1701 branch and item type, regardless of patron category.
1703 The return value is a hashref containing the following keys:
1705 holdallowed => Hold policy for this branch and itemtype. Possible values:
1706 0: No holds allowed.
1707 1: Holds allowed only by patrons that have the same homebranch as the item.
1708 2: Holds allowed from any patron.
1710 returnbranch => branch to which to return item. Possible values:
1711 noreturn: do not return, let item remain where checked in (floating collections)
1712 homebranch: return to item's home branch
1713 holdingbranch: return to issuer branch
1715 This searches branchitemrules in the following order:
1717 * Same branchcode and itemtype
1718 * Same branchcode, itemtype '*'
1719 * branchcode '*', same itemtype
1720 * branchcode and itemtype '*'
1722 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1724 =cut
1726 sub GetBranchItemRule {
1727 my ( $branchcode, $itemtype ) = @_;
1728 my $dbh = C4::Context->dbh();
1729 my $result = {};
1731 my @attempts = (
1732 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1733 FROM branch_item_rules
1734 WHERE branchcode = ?
1735 AND itemtype = ?', $branchcode, $itemtype],
1736 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1737 FROM default_branch_circ_rules
1738 WHERE branchcode = ?', $branchcode],
1739 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1740 FROM default_branch_item_rules
1741 WHERE itemtype = ?', $itemtype],
1742 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1743 FROM default_circ_rules'],
1746 foreach my $attempt (@attempts) {
1747 my ($query, @bind_params) = @{$attempt};
1748 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1749 or next;
1751 # Since branch/category and branch/itemtype use the same per-branch
1752 # defaults tables, we have to check that the key we want is set, not
1753 # just that a row was returned
1754 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1755 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1756 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1759 # built-in default circulation rule
1760 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1761 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1762 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1764 return $result;
1767 =head2 AddReturn
1769 ($doreturn, $messages, $iteminformation, $borrower) =
1770 &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1772 Returns a book.
1774 =over 4
1776 =item C<$barcode> is the bar code of the book being returned.
1778 =item C<$branch> is the code of the branch where the book is being returned.
1780 =item C<$exemptfine> indicates that overdue charges for the item will be
1781 removed. Optional.
1783 =item C<$return_date> allows the default return date to be overridden
1784 by the given return date. Optional.
1786 =back
1788 C<&AddReturn> returns a list of four items:
1790 C<$doreturn> is true iff the return succeeded.
1792 C<$messages> is a reference-to-hash giving feedback on the operation.
1793 The keys of the hash are:
1795 =over 4
1797 =item C<BadBarcode>
1799 No item with this barcode exists. The value is C<$barcode>.
1801 =item C<NotIssued>
1803 The book is not currently on loan. The value is C<$barcode>.
1805 =item C<withdrawn>
1807 This book has been withdrawn/cancelled. The value should be ignored.
1809 =item C<Wrongbranch>
1811 This book has was returned to the wrong branch. The value is a hashref
1812 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1813 contain the branchcode of the incorrect and correct return library, respectively.
1815 =item C<ResFound>
1817 The item was reserved. The value is a reference-to-hash whose keys are
1818 fields from the reserves table of the Koha database, and
1819 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1820 either C<Waiting>, C<Reserved>, or 0.
1822 =item C<WasReturned>
1824 Value 1 if return is successful.
1826 =item C<NeedsTransfer>
1828 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1830 =back
1832 C<$iteminformation> is a reference-to-hash, giving information about the
1833 returned item from the issues table.
1835 C<$borrower> is a reference-to-hash, giving information about the
1836 patron who last borrowed the book.
1838 =cut
1840 sub AddReturn {
1841 my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1843 if ($branch and not Koha::Libraries->find($branch)) {
1844 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1845 undef $branch;
1847 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1848 $return_date //= dt_from_string();
1849 my $messages;
1850 my $patron;
1851 my $doreturn = 1;
1852 my $validTransfert = 0;
1853 my $stat_type = 'return';
1855 # get information on item
1856 my $item = Koha::Items->find({ barcode => $barcode });
1857 unless ($item) {
1858 return ( 0, { BadBarcode => $barcode } ); # no barcode means no item or borrower. bail out.
1861 my $itemnumber = $item->itemnumber;
1862 my $itemtype = $item->effective_itemtype;
1864 my $issue = $item->checkout;
1865 if ( $issue ) {
1866 $patron = $issue->patron
1867 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1868 . Dumper($issue->unblessed) . "\n";
1869 } else {
1870 $messages->{'NotIssued'} = $barcode;
1871 ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1872 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1873 $doreturn = 0;
1874 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1875 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1876 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1877 $messages->{'LocalUse'} = 1;
1878 $stat_type = 'localuse';
1882 my $item_unblessed = $item->unblessed;
1883 # full item data, but no borrowernumber or checkout info (no issue)
1884 my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1885 # get the proper branch to which to return the item
1886 my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1887 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1889 my $borrowernumber = $patron ? $patron->borrowernumber : undef; # we don't know if we had a borrower or not
1890 my $patron_unblessed = $patron ? $patron->unblessed : {};
1892 my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1893 map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1894 if ($update_loc_rules) {
1895 if (defined $update_loc_rules->{_ALL_}) {
1896 if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1897 if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1898 if ( $item->location ne $update_loc_rules->{_ALL_}) {
1899 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1900 ModItem( { location => $update_loc_rules->{_ALL_} }, undef, $itemnumber );
1903 else {
1904 foreach my $key ( keys %$update_loc_rules ) {
1905 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1906 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1907 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1908 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1909 ModItem( { location => $update_loc_rules->{$key} }, undef, $itemnumber );
1910 last;
1916 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1917 if ($yaml) {
1918 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1919 my $rules;
1920 eval { $rules = YAML::Load($yaml); };
1921 if ($@) {
1922 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1924 else {
1925 foreach my $key ( keys %$rules ) {
1926 if ( $item->notforloan eq $key ) {
1927 $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1928 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1929 last;
1935 # check if the return is allowed at this branch
1936 my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1937 unless ($returnallowed){
1938 $messages->{'Wrongbranch'} = {
1939 Wrongbranch => $branch,
1940 Rightbranch => $message
1942 $doreturn = 0;
1943 return ( $doreturn, $messages, $issue, $patron_unblessed);
1946 if ( $item->withdrawn ) { # book has been cancelled
1947 $messages->{'withdrawn'} = 1;
1948 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1951 if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1952 $doreturn = 0;
1955 # case of a return of document (deal with issues and holdingbranch)
1956 if ($doreturn) {
1957 die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1958 $patron or warn "AddReturn without current borrower";
1960 if ($patron) {
1961 eval {
1962 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1964 unless ( $@ ) {
1965 if ( C4::Context->preference('CalculateFinesOnReturn') && !$item->itemlost ) {
1966 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1968 } else {
1969 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 );
1971 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1974 # FIXME is the "= 1" right? This could be the borrower hash.
1975 $messages->{'WasReturned'} = 1;
1979 ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1982 # the holdingbranch is updated if the document is returned to another location.
1983 # this is always done regardless of whether the item was on loan or not
1984 my $item_holding_branch = $item->holdingbranch;
1985 if ($item->holdingbranch ne $branch) {
1986 UpdateHoldingbranch($branch, $item->itemnumber);
1987 $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1990 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1991 ModDateLastSeen( $item->itemnumber, $leave_item_lost );
1993 # check if we have a transfer for this document
1994 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
1996 # if we have a transfer to do, we update the line of transfers with the datearrived
1997 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
1998 if ($datesent) {
1999 if ( $tobranch eq $branch ) {
2000 my $sth = C4::Context->dbh->prepare(
2001 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2003 $sth->execute( $item->itemnumber );
2004 # if we have a reservation with valid transfer, we can set it's status to 'W'
2005 C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2006 } else {
2007 $messages->{'WrongTransfer'} = $tobranch;
2008 $messages->{'WrongTransferItem'} = $item->itemnumber;
2010 $validTransfert = 1;
2013 # fix up the accounts.....
2014 if ( $item->itemlost ) {
2015 $messages->{'WasLost'} = 1;
2016 unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2017 if (
2018 Koha::RefundLostItemFeeRules->should_refund(
2020 current_branch => C4::Context->userenv->{branch},
2021 item_home_branch => $item->homebranch,
2022 item_holding_branch => $item_holding_branch
2027 _FixAccountForLostAndReturned( $item->itemnumber,
2028 $borrowernumber, $barcode );
2029 $messages->{'LostItemFeeRefunded'} = 1;
2034 # fix up the overdues in accounts...
2035 if ($borrowernumber) {
2036 my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine );
2037 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!"; # zero is OK, check defined
2039 if ( $issue and $issue->is_overdue($return_date) ) {
2040 # fix fine days
2041 my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $return_date );
2042 if ($reminder){
2043 $messages->{'PrevDebarred'} = $debardate;
2044 } else {
2045 $messages->{'Debarred'} = $debardate if $debardate;
2047 # there's no overdue on the item but borrower had been previously debarred
2048 } elsif ( $issue->date_due and $patron->debarred ) {
2049 if ( $patron->debarred eq "9999-12-31") {
2050 $messages->{'ForeverDebarred'} = $patron->debarred;
2051 } else {
2052 my $borrower_debar_dt = dt_from_string( $patron->debarred );
2053 $borrower_debar_dt->truncate(to => 'day');
2054 my $today_dt = $return_date->clone()->truncate(to => 'day');
2055 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2056 $messages->{'PrevDebarred'} = $patron->debarred;
2062 # find reserves.....
2063 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2064 my ($resfound, $resrec);
2065 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2066 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2067 if ($resfound) {
2068 $resrec->{'ResFound'} = $resfound;
2069 $messages->{'ResFound'} = $resrec;
2072 # Record the fact that this book was returned.
2073 UpdateStats({
2074 branch => $branch,
2075 type => $stat_type,
2076 itemnumber => $itemnumber,
2077 itemtype => $itemtype,
2078 borrowernumber => $borrowernumber,
2079 ccode => $item->ccode,
2082 # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2083 if ( $patron ) {
2084 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2085 my %conditions = (
2086 branchcode => $branch,
2087 categorycode => $patron->categorycode,
2088 item_type => $itemtype,
2089 notification => 'CHECKIN',
2091 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2092 SendCirculationAlert({
2093 type => 'CHECKIN',
2094 item => $item_unblessed,
2095 borrower => $patron->unblessed,
2096 branch => $branch,
2100 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2101 if C4::Context->preference("ReturnLog");
2104 # Check if this item belongs to a biblio record that is attached to an
2105 # ILL request, if it is we need to update the ILL request's status
2106 if (C4::Context->preference('CirculateILL')) {
2107 my $request = Koha::Illrequests->find(
2108 { biblio_id => $item->biblio->biblionumber }
2110 $request->status('RET') if $request;
2113 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2114 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2115 my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType");
2116 if (C4::Context->preference("AutomaticItemReturn" ) or
2117 (C4::Context->preference("UseBranchTransferLimits") and
2118 ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2119 )) {
2120 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2121 $debug and warn "item: " . Dumper($item_unblessed);
2122 ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2123 $messages->{'WasTransfered'} = 1;
2124 } else {
2125 $messages->{'NeedsTransfer'} = $returnbranch;
2129 return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2132 =head2 MarkIssueReturned
2134 MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2136 Unconditionally marks an issue as being returned by
2137 moving the C<issues> row to C<old_issues> and
2138 setting C<returndate> to the current date.
2140 if C<$returndate> is specified (in iso format), it is used as the date
2141 of the return.
2143 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2144 the old_issue is immediately anonymised
2146 Ideally, this function would be internal to C<C4::Circulation>,
2147 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2148 and offline_circ/process_koc.pl.
2150 =cut
2152 sub MarkIssueReturned {
2153 my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2155 # Retrieve the issue
2156 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2158 return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2160 my $issue_id = $issue->issue_id;
2162 my $anonymouspatron;
2163 if ( $privacy == 2 ) {
2164 # The default of 0 will not work due to foreign key constraints
2165 # The anonymisation will fail if AnonymousPatron is not a valid entry
2166 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2167 # Note that a warning should appear on the about page (System information tab).
2168 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2169 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."
2170 unless Koha::Patrons->find( $anonymouspatron );
2173 my $schema = Koha::Database->schema;
2175 # FIXME Improve the return value and handle it from callers
2176 $schema->txn_do(sub {
2178 my $patron = Koha::Patrons->find( $borrowernumber );
2180 # Update the returndate value
2181 if ( $returndate ) {
2182 $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2184 else {
2185 $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2188 # Create the old_issues entry
2189 my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2191 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2192 if ( $privacy == 2) {
2193 $old_checkout->borrowernumber($anonymouspatron)->store;
2196 # And finally delete the issue
2197 $issue->delete;
2199 ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2201 if ( C4::Context->preference('StoreLastBorrower') ) {
2202 my $item = Koha::Items->find( $itemnumber );
2203 $item->last_returned_by( $patron );
2206 # Remove any OVERDUES related debarment if the borrower has no overdues
2207 if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2208 && $patron->debarred
2209 && !$patron->has_overdues
2210 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2212 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2217 return $issue_id;
2220 =head2 _debar_user_on_return
2222 _debar_user_on_return($borrower, $item, $datedue, $returndate);
2224 C<$borrower> borrower hashref
2226 C<$item> item hashref
2228 C<$datedue> date due DateTime object
2230 C<$returndate> DateTime object representing the return time
2232 Internal function, called only by AddReturn that calculates and updates
2233 the user fine days, and debars them if necessary.
2235 Should only be called for overdue returns
2237 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2238 to ease testing.
2240 =cut
2242 sub _calculate_new_debar_dt {
2243 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2245 my $branchcode = _GetCircControlBranch( $item, $borrower );
2246 my $circcontrol = C4::Context->preference('CircControl');
2247 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2248 { categorycode => $borrower->{categorycode},
2249 itemtype => $item->{itype},
2250 branchcode => $branchcode
2253 my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2254 my $unit = $issuing_rule ? $issuing_rule->lengthunit : undef;
2255 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2257 return unless $finedays;
2259 # finedays is in days, so hourly loans must multiply by 24
2260 # thus 1 hour late equals 1 day suspension * finedays rate
2261 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2263 # grace period is measured in the same units as the loan
2264 my $grace =
2265 DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2267 my $deltadays = DateTime::Duration->new(
2268 days => $chargeable_units
2271 if ( $deltadays->subtract($grace)->is_positive() ) {
2272 my $suspension_days = $deltadays * $finedays;
2274 if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2275 # No need to / 1 and do not consider / 0
2276 $suspension_days = DateTime::Duration->new(
2277 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2281 # If the max suspension days is < than the suspension days
2282 # the suspension days is limited to this maximum period.
2283 my $max_sd = $issuing_rule->maxsuspensiondays;
2284 if ( defined $max_sd ) {
2285 $max_sd = DateTime::Duration->new( days => $max_sd );
2286 $suspension_days = $max_sd
2287 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2290 my ( $has_been_extended );
2291 if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2292 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2293 if ( $debarment ) {
2294 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2295 $has_been_extended = 1;
2299 my $new_debar_dt;
2300 # Use the calendar or not to calculate the debarment date
2301 if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2302 my $calendar = Koha::Calendar->new(
2303 branchcode => $branchcode,
2304 days_mode => 'Calendar'
2306 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2308 else {
2309 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2311 return $new_debar_dt;
2313 return;
2316 sub _debar_user_on_return {
2317 my ( $borrower, $item, $dt_due, $return_date ) = @_;
2319 $return_date //= dt_from_string();
2321 my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2323 return unless $new_debar_dt;
2325 Koha::Patron::Debarments::AddUniqueDebarment({
2326 borrowernumber => $borrower->{borrowernumber},
2327 expiration => $new_debar_dt->ymd(),
2328 type => 'SUSPENSION',
2330 # if borrower was already debarred but does not get an extra debarment
2331 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2332 my ($new_debarment_str, $is_a_reminder);
2333 if ( $borrower->{debarred} eq $patron->is_debarred ) {
2334 $is_a_reminder = 1;
2335 $new_debarment_str = $borrower->{debarred};
2336 } else {
2337 $new_debarment_str = $new_debar_dt->ymd();
2339 # FIXME Should return a DateTime object
2340 return $new_debarment_str, $is_a_reminder;
2343 =head2 _FixOverduesOnReturn
2345 &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine);
2347 C<$borrowernumber> borrowernumber
2349 C<$itemnumber> itemnumber
2351 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2353 Internal function
2355 =cut
2357 sub _FixOverduesOnReturn {
2358 my ( $borrowernumber, $item, $exemptfine ) = @_;
2359 unless( $borrowernumber ) {
2360 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2361 return;
2363 unless( $item ) {
2364 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2365 return;
2368 my $schema = Koha::Database->schema;
2370 my $result = $schema->txn_do(
2371 sub {
2372 # check for overdue fine
2373 my $accountlines = Koha::Account::Lines->search(
2375 borrowernumber => $borrowernumber,
2376 itemnumber => $item,
2377 accounttype => 'OVERDUE',
2378 status => 'UNRETURNED'
2381 return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2383 my $accountline = $accountlines->next;
2384 if ($exemptfine) {
2385 my $amountoutstanding = $accountline->amountoutstanding;
2387 my $account = Koha::Account->new({patron_id => $borrowernumber});
2388 my $credit = $account->add_credit(
2390 amount => $amountoutstanding,
2391 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2392 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2393 interface => C4::Context->interface,
2394 type => 'forgiven',
2395 item_id => $item
2399 $credit->apply({ debits => $accountlines->reset, offset_type => 'Forgiven' });
2401 $accountline->status('FORGIVEN');
2403 if (C4::Context->preference("FinesLog")) {
2404 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2406 } else {
2407 $accountline->status('RETURNED');
2410 return $accountline->store();
2414 return $result;
2417 =head2 _FixAccountForLostAndReturned
2419 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2421 Calculates the charge for a book lost and returned.
2423 Internal function, not exported, called only by AddReturn.
2425 =cut
2427 sub _FixAccountForLostAndReturned {
2428 my $itemnumber = shift or return;
2429 my $borrowernumber = @_ ? shift : undef;
2430 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2432 my $credit;
2434 # check for charge made for lost book
2435 my $accountlines = Koha::Account::Lines->search(
2437 itemnumber => $itemnumber,
2438 accounttype => 'L',
2441 order_by => { -desc => [ 'date', 'accountlines_id' ] }
2445 return unless $accountlines->count > 0;
2446 my $accountline = $accountlines->next;
2447 my $total_to_refund = 0;
2449 return unless $accountline->borrowernumber;
2450 my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2451 return unless $patron; # Patron has been deleted, nobody to credit the return to
2453 my $account = $patron->account;
2455 # Use cases
2456 if ( $accountline->amount > $accountline->amountoutstanding ) {
2457 # some amount has been cancelled. collect the offsets that are not writeoffs
2458 # this works because the only way to subtract from this kind of a debt is
2459 # using the UI buttons 'Pay' and 'Write off'
2460 my $credits_offsets = Koha::Account::Offsets->search({
2461 debit_id => $accountline->id,
2462 credit_id => { '!=' => undef }, # it is not the debit itself
2463 type => { '!=' => 'Writeoff' },
2464 amount => { '<' => 0 } # credits are negative on the DB
2467 $total_to_refund = ( $credits_offsets->count > 0 )
2468 ? $credits_offsets->total * -1 # credits are negative on the DB
2469 : 0;
2472 my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2474 if ( $credit_total > 0 ) {
2475 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2476 $credit = $account->add_credit(
2477 { amount => $credit_total,
2478 description => 'Item Returned ' . $item_id,
2479 type => 'lost_item_return',
2480 interface => C4::Context->interface,
2481 library_id => $branchcode
2485 # TODO: ->apply should just accept the accountline
2486 $credit->apply( { debits => $accountlines->reset } );
2489 # Manually set the accounttype
2490 $accountline->discard_changes->accounttype('LR');
2491 $accountline->store;
2493 ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2495 if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2496 $account->reconcile_balance;
2499 return ($credit) ? $credit->id : undef;
2502 =head2 _GetCircControlBranch
2504 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2506 Internal function :
2508 Return the library code to be used to determine which circulation
2509 policy applies to a transaction. Looks up the CircControl and
2510 HomeOrHoldingBranch system preferences.
2512 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2514 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2516 =cut
2518 sub _GetCircControlBranch {
2519 my ($item, $borrower) = @_;
2520 my $circcontrol = C4::Context->preference('CircControl');
2521 my $branch;
2523 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2524 $branch= C4::Context->userenv->{'branch'};
2525 } elsif ($circcontrol eq 'PatronLibrary') {
2526 $branch=$borrower->{branchcode};
2527 } else {
2528 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2529 $branch = $item->{$branchfield};
2530 # default to item home branch if holdingbranch is used
2531 # and is not defined
2532 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2533 $branch = $item->{homebranch};
2536 return $branch;
2539 =head2 GetOpenIssue
2541 $issue = GetOpenIssue( $itemnumber );
2543 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2545 C<$itemnumber> is the item's itemnumber
2547 Returns a hashref
2549 =cut
2551 sub GetOpenIssue {
2552 my ( $itemnumber ) = @_;
2553 return unless $itemnumber;
2554 my $dbh = C4::Context->dbh;
2555 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2556 $sth->execute( $itemnumber );
2557 return $sth->fetchrow_hashref();
2561 =head2 GetBiblioIssues
2563 $issues = GetBiblioIssues($biblionumber);
2565 this function get all issues from a biblionumber.
2567 Return:
2568 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2569 tables issues and the firstname,surname & cardnumber from borrowers.
2571 =cut
2573 sub GetBiblioIssues {
2574 my $biblionumber = shift;
2575 return unless $biblionumber;
2576 my $dbh = C4::Context->dbh;
2577 my $query = "
2578 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2579 FROM issues
2580 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2581 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2582 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2583 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2584 WHERE biblio.biblionumber = ?
2585 UNION ALL
2586 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2587 FROM old_issues
2588 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2589 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2590 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2591 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2592 WHERE biblio.biblionumber = ?
2593 ORDER BY timestamp
2595 my $sth = $dbh->prepare($query);
2596 $sth->execute($biblionumber, $biblionumber);
2598 my @issues;
2599 while ( my $data = $sth->fetchrow_hashref ) {
2600 push @issues, $data;
2602 return \@issues;
2605 =head2 GetUpcomingDueIssues
2607 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2609 =cut
2611 sub GetUpcomingDueIssues {
2612 my $params = shift;
2614 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2615 my $dbh = C4::Context->dbh;
2617 my $statement = <<END_SQL;
2618 SELECT *
2619 FROM (
2620 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2621 FROM issues
2622 LEFT JOIN items USING (itemnumber)
2623 LEFT OUTER JOIN branches USING (branchcode)
2624 WHERE returndate is NULL
2625 ) tmp
2626 WHERE days_until_due >= 0 AND days_until_due <= ?
2627 END_SQL
2629 my @bind_parameters = ( $params->{'days_in_advance'} );
2631 my $sth = $dbh->prepare( $statement );
2632 $sth->execute( @bind_parameters );
2633 my $upcoming_dues = $sth->fetchall_arrayref({});
2635 return $upcoming_dues;
2638 =head2 CanBookBeRenewed
2640 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2642 Find out whether a borrowed item may be renewed.
2644 C<$borrowernumber> is the borrower number of the patron who currently
2645 has the item on loan.
2647 C<$itemnumber> is the number of the item to renew.
2649 C<$override_limit>, if supplied with a true value, causes
2650 the limit on the number of times that the loan can be renewed
2651 (as controlled by the item type) to be ignored. Overriding also allows
2652 to renew sooner than "No renewal before" and to manually renew loans
2653 that are automatically renewed.
2655 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2656 item must currently be on loan to the specified borrower; renewals
2657 must be allowed for the item's type; and the borrower must not have
2658 already renewed the loan. $error will contain the reason the renewal can not proceed
2660 =cut
2662 sub CanBookBeRenewed {
2663 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2665 my $dbh = C4::Context->dbh;
2666 my $renews = 1;
2668 my $item = Koha::Items->find($itemnumber) or return ( 0, 'no_item' );
2669 my $issue = $item->checkout or return ( 0, 'no_checkout' );
2670 return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2671 return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2673 my $patron = $issue->patron or return;
2675 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2677 # This item can fill one or more unfilled reserve, can those unfilled reserves
2678 # all be filled by other available items?
2679 if ( $resfound
2680 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2682 my $schema = Koha::Database->new()->schema();
2684 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2685 if ($item_holds) {
2686 # There is an item level hold on this item, no other item can fill the hold
2687 $resfound = 1;
2689 else {
2691 # Get all other items that could possibly fill reserves
2692 my @itemnumbers = $schema->resultset('Item')->search(
2694 biblionumber => $resrec->{biblionumber},
2695 onloan => undef,
2696 notforloan => 0,
2697 -not => { itemnumber => $itemnumber }
2699 { columns => 'itemnumber' }
2700 )->get_column('itemnumber')->all();
2702 # Get all other reserves that could have been filled by this item
2703 my @borrowernumbers;
2704 while (1) {
2705 my ( $reserve_found, $reserve, undef ) =
2706 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2708 if ($reserve_found) {
2709 push( @borrowernumbers, $reserve->{borrowernumber} );
2711 else {
2712 last;
2716 # If the count of the union of the lists of reservable items for each borrower
2717 # is equal or greater than the number of borrowers, we know that all reserves
2718 # can be filled with available items. We can get the union of the sets simply
2719 # by pushing all the elements onto an array and removing the duplicates.
2720 my @reservable;
2721 my %patrons;
2722 ITEM: foreach my $itemnumber (@itemnumbers) {
2723 my $item = Koha::Items->find( $itemnumber );
2724 next if IsItemOnHoldAndFound( $itemnumber );
2725 for my $borrowernumber (@borrowernumbers) {
2726 my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2727 next unless IsAvailableForItemLevelRequest($item, $patron);
2728 next unless CanItemBeReserved($borrowernumber,$itemnumber);
2730 push @reservable, $itemnumber;
2731 if (@reservable >= @borrowernumbers) {
2732 $resfound = 0;
2733 last ITEM;
2735 last;
2740 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2742 return ( 1, undef ) if $override_limit;
2744 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2745 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2746 { categorycode => $patron->categorycode,
2747 itemtype => $item->effective_itemtype,
2748 branchcode => $branchcode
2752 return ( 0, "too_many" )
2753 if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2755 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2756 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2757 $patron = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2758 my $restricted = $patron->is_debarred;
2759 my $hasoverdues = $patron->has_overdues;
2761 if ( $restricted and $restrictionblockrenewing ) {
2762 return ( 0, 'restriction');
2763 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2764 return ( 0, 'overdue');
2767 if ( $issue->auto_renew ) {
2769 if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2770 return ( 0, 'auto_account_expired' );
2773 if ( defined $issuing_rule->no_auto_renewal_after
2774 and $issuing_rule->no_auto_renewal_after ne "" ) {
2775 # Get issue_date and add no_auto_renewal_after
2776 # If this is greater than today, it's too late for renewal.
2777 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2778 $maximum_renewal_date->add(
2779 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2781 my $now = dt_from_string;
2782 if ( $now >= $maximum_renewal_date ) {
2783 return ( 0, "auto_too_late" );
2786 if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2787 and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2788 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2789 if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2790 return ( 0, "auto_too_late" );
2794 if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2795 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2796 my $amountoutstanding = $patron->account->balance;
2797 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2798 return ( 0, "auto_too_much_oweing" );
2803 if ( defined $issuing_rule->norenewalbefore
2804 and $issuing_rule->norenewalbefore ne "" )
2807 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2808 my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2809 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2811 # Depending on syspref reset the exact time, only check the date
2812 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2813 and $issuing_rule->lengthunit eq 'days' )
2815 $soonestrenewal->truncate( to => 'day' );
2818 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2820 return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2821 return ( 0, "too_soon" );
2823 elsif ( $issue->auto_renew ) {
2824 return ( 0, "auto_renew" );
2828 # Fallback for automatic renewals:
2829 # If norenewalbefore is undef, don't renew before due date.
2830 if ( $issue->auto_renew ) {
2831 my $now = dt_from_string;
2832 return ( 0, "auto_renew" )
2833 if $now >= dt_from_string( $issue->date_due, 'sql' );
2834 return ( 0, "auto_too_soon" );
2837 return ( 1, undef );
2840 =head2 AddRenewal
2842 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2844 Renews a loan.
2846 C<$borrowernumber> is the borrower number of the patron who currently
2847 has the item.
2849 C<$itemnumber> is the number of the item to renew.
2851 C<$branch> is the library where the renewal took place (if any).
2852 The library that controls the circ policies for the renewal is retrieved from the issues record.
2854 C<$datedue> can be a DateTime object used to set the due date.
2856 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2857 this parameter is not supplied, lastreneweddate is set to the current date.
2859 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2860 from the book's item type.
2862 =cut
2864 sub AddRenewal {
2865 my $borrowernumber = shift;
2866 my $itemnumber = shift or return;
2867 my $branch = shift;
2868 my $datedue = shift;
2869 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2871 my $item_object = Koha::Items->find($itemnumber) or return;
2872 my $biblio = $item_object->biblio;
2873 my $issue = $item_object->checkout;
2874 my $item_unblessed = $item_object->unblessed;
2876 my $dbh = C4::Context->dbh;
2878 return unless $issue;
2880 $borrowernumber ||= $issue->borrowernumber;
2882 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2883 carp 'Invalid date passed to AddRenewal.';
2884 return;
2887 my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2888 my $patron_unblessed = $patron->unblessed;
2890 my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2892 if ( C4::Context->preference('CalculateFinesOnReturn') ) {
2893 _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2895 _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2897 # If the due date wasn't specified, calculate it by adding the
2898 # book's loan length to today's date or the current due date
2899 # based on the value of the RenewalPeriodBase syspref.
2900 my $itemtype = $item_object->effective_itemtype;
2901 unless ($datedue) {
2903 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2904 dt_from_string( $issue->date_due, 'sql' ) :
2905 DateTime->now( time_zone => C4::Context->tz());
2906 $datedue = CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2909 my $fees = Koha::Charges::Fees->new(
2911 patron => $patron,
2912 library => $circ_library,
2913 item => $item_object,
2914 from_date => dt_from_string( $issue->date_due, 'sql' ),
2915 to_date => dt_from_string($datedue),
2919 # Update the issues record to have the new due date, and a new count
2920 # of how many times it has been renewed.
2921 my $renews = $issue->renewals + 1;
2922 my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2923 WHERE borrowernumber=?
2924 AND itemnumber=?"
2927 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2929 # Update the renewal count on the item, and tell zebra to reindex
2930 $renews = $item_object->renewals + 1;
2931 ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2933 # Charge a new rental fee, if applicable
2934 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2935 if ( $charge > 0 ) {
2936 my $description = "Renewal of Rental Item " . $biblio->title . " " .$item_object->barcode;
2937 AddIssuingCharge($issue, $charge, $description);
2940 # Charge a new accumulate rental fee, if applicable
2941 my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2942 if ( $itemtype_object ) {
2943 my $accumulate_charge = $fees->accumulate_rentalcharge();
2944 if ( $accumulate_charge > 0 ) {
2945 my $type_desc = "Renewal of Daily Rental Item " . $biblio->title . " $item_unblessed->{'barcode'}";
2946 AddIssuingCharge( $issue, $accumulate_charge, $type_desc )
2948 $charge += $accumulate_charge;
2951 # Send a renewal slip according to checkout alert preferencei
2952 if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2953 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2954 my %conditions = (
2955 branchcode => $branch,
2956 categorycode => $patron->categorycode,
2957 item_type => $itemtype,
2958 notification => 'CHECKOUT',
2960 if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2961 SendCirculationAlert(
2963 type => 'RENEWAL',
2964 item => $item_unblessed,
2965 borrower => $patron->unblessed,
2966 branch => $branch,
2972 # Remove any OVERDUES related debarment if the borrower has no overdues
2973 if ( $patron
2974 && $patron->is_debarred
2975 && ! $patron->has_overdues
2976 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2978 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2980 unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2981 $branch = ( C4::Context->userenv && defined C4::Context->userenv->{branch} ) ? C4::Context->userenv->{branch} : $branch;
2984 # Add the renewal to stats
2985 UpdateStats(
2987 branch => $branch,
2988 type => 'renew',
2989 amount => $charge,
2990 itemnumber => $itemnumber,
2991 itemtype => $itemtype,
2992 location => $item_object->location,
2993 borrowernumber => $borrowernumber,
2994 ccode => $item_object->ccode,
2998 #Log the renewal
2999 logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3000 return $datedue;
3003 sub GetRenewCount {
3004 # check renewal status
3005 my ( $bornum, $itemno ) = @_;
3006 my $dbh = C4::Context->dbh;
3007 my $renewcount = 0;
3008 my $renewsallowed = 0;
3009 my $renewsleft = 0;
3011 my $patron = Koha::Patrons->find( $bornum );
3012 my $item = Koha::Items->find($itemno);
3014 return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3016 # Look in the issues table for this item, lent to this borrower,
3017 # and not yet returned.
3019 # FIXME - I think this function could be redone to use only one SQL call.
3020 my $sth = $dbh->prepare(
3021 "select * from issues
3022 where (borrowernumber = ?)
3023 and (itemnumber = ?)"
3025 $sth->execute( $bornum, $itemno );
3026 my $data = $sth->fetchrow_hashref;
3027 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3028 # $item and $borrower should be calculated
3029 my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3031 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3032 { categorycode => $patron->categorycode,
3033 itemtype => $item->effective_itemtype,
3034 branchcode => $branchcode
3038 $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3039 $renewsleft = $renewsallowed - $renewcount;
3040 if($renewsleft < 0){ $renewsleft = 0; }
3041 return ( $renewcount, $renewsallowed, $renewsleft );
3044 =head2 GetSoonestRenewDate
3046 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3048 Find out the soonest possible renew date of a borrowed item.
3050 C<$borrowernumber> is the borrower number of the patron who currently
3051 has the item on loan.
3053 C<$itemnumber> is the number of the item to renew.
3055 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3056 renew date, based on the value "No renewal before" of the applicable
3057 issuing rule. Returns the current date if the item can already be
3058 renewed, and returns undefined if the borrower, loan, or item
3059 cannot be found.
3061 =cut
3063 sub GetSoonestRenewDate {
3064 my ( $borrowernumber, $itemnumber ) = @_;
3066 my $dbh = C4::Context->dbh;
3068 my $item = Koha::Items->find($itemnumber) or return;
3069 my $itemissue = $item->checkout or return;
3071 $borrowernumber ||= $itemissue->borrowernumber;
3072 my $patron = Koha::Patrons->find( $borrowernumber )
3073 or return;
3075 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3076 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3077 { categorycode => $patron->categorycode,
3078 itemtype => $item->effective_itemtype,
3079 branchcode => $branchcode
3083 my $now = dt_from_string;
3084 return $now unless $issuing_rule;
3086 if ( defined $issuing_rule->norenewalbefore
3087 and $issuing_rule->norenewalbefore ne "" )
3089 my $soonestrenewal =
3090 dt_from_string( $itemissue->date_due )->subtract(
3091 $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3093 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3094 and $issuing_rule->lengthunit eq 'days' )
3096 $soonestrenewal->truncate( to => 'day' );
3098 return $soonestrenewal if $now < $soonestrenewal;
3100 return $now;
3103 =head2 GetLatestAutoRenewDate
3105 $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3107 Find out the latest possible auto renew date of a borrowed item.
3109 C<$borrowernumber> is the borrower number of the patron who currently
3110 has the item on loan.
3112 C<$itemnumber> is the number of the item to renew.
3114 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3115 auto renew date, based on the value "No auto renewal after" and the "No auto
3116 renewal after (hard limit) of the applicable issuing rule.
3117 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3118 or item cannot be found.
3120 =cut
3122 sub GetLatestAutoRenewDate {
3123 my ( $borrowernumber, $itemnumber ) = @_;
3125 my $dbh = C4::Context->dbh;
3127 my $item = Koha::Items->find($itemnumber) or return;
3128 my $itemissue = $item->checkout or return;
3130 $borrowernumber ||= $itemissue->borrowernumber;
3131 my $patron = Koha::Patrons->find( $borrowernumber )
3132 or return;
3134 my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3135 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3136 { categorycode => $patron->categorycode,
3137 itemtype => $item->effective_itemtype,
3138 branchcode => $branchcode
3142 return unless $issuing_rule;
3143 return
3144 if ( not $issuing_rule->no_auto_renewal_after
3145 or $issuing_rule->no_auto_renewal_after eq '' )
3146 and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3147 or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3149 my $maximum_renewal_date;
3150 if ( $issuing_rule->no_auto_renewal_after ) {
3151 $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3152 $maximum_renewal_date->add(
3153 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3157 if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3158 my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3159 $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3161 return $maximum_renewal_date;
3165 =head2 GetIssuingCharges
3167 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3169 Calculate how much it would cost for a given patron to borrow a given
3170 item, including any applicable discounts.
3172 C<$itemnumber> is the item number of item the patron wishes to borrow.
3174 C<$borrowernumber> is the patron's borrower number.
3176 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3177 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3178 if it's a video).
3180 =cut
3182 sub GetIssuingCharges {
3184 # calculate charges due
3185 my ( $itemnumber, $borrowernumber ) = @_;
3186 my $charge = 0;
3187 my $dbh = C4::Context->dbh;
3188 my $item_type;
3190 # Get the book's item type and rental charge (via its biblioitem).
3191 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3192 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3193 $charge_query .= (C4::Context->preference('item-level_itypes'))
3194 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3195 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3197 $charge_query .= ' WHERE items.itemnumber =?';
3199 my $sth = $dbh->prepare($charge_query);
3200 $sth->execute($itemnumber);
3201 if ( my $item_data = $sth->fetchrow_hashref ) {
3202 $item_type = $item_data->{itemtype};
3203 $charge = $item_data->{rentalcharge};
3204 my $branch = C4::Context::mybranch();
3205 my $discount_query = q|SELECT rentaldiscount,
3206 issuingrules.itemtype, issuingrules.branchcode
3207 FROM borrowers
3208 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3209 WHERE borrowers.borrowernumber = ?
3210 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3211 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3212 my $discount_sth = $dbh->prepare($discount_query);
3213 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3214 my $discount_rules = $discount_sth->fetchall_arrayref({});
3215 if (@{$discount_rules}) {
3216 # We may have multiple rules so get the most specific
3217 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3218 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3220 if ($charge) {
3221 $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3225 return ( $charge, $item_type );
3228 # Select most appropriate discount rule from those returned
3229 sub _get_discount_from_rule {
3230 my ($rules_ref, $branch, $itemtype) = @_;
3231 my $discount;
3233 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3234 $discount = $rules_ref->[0]->{rentaldiscount};
3235 return (defined $discount) ? $discount : 0;
3237 # could have up to 4 does one match $branch and $itemtype
3238 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3239 if (@d) {
3240 $discount = $d[0]->{rentaldiscount};
3241 return (defined $discount) ? $discount : 0;
3243 # do we have item type + all branches
3244 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3245 if (@d) {
3246 $discount = $d[0]->{rentaldiscount};
3247 return (defined $discount) ? $discount : 0;
3249 # do we all item types + this branch
3250 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3251 if (@d) {
3252 $discount = $d[0]->{rentaldiscount};
3253 return (defined $discount) ? $discount : 0;
3255 # so all and all (surely we wont get here)
3256 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3257 if (@d) {
3258 $discount = $d[0]->{rentaldiscount};
3259 return (defined $discount) ? $discount : 0;
3261 # none of the above
3262 return 0;
3265 =head2 AddIssuingCharge
3267 &AddIssuingCharge( $checkout, $charge, [$description] )
3269 =cut
3271 sub AddIssuingCharge {
3272 my ( $checkout, $charge, $description ) = @_;
3274 # FIXME What if checkout does not exist?
3276 my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3277 my $accountline = $account->add_debit(
3279 amount => $charge,
3280 description => $description,
3281 note => undef,
3282 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3283 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3284 interface => C4::Context->interface,
3285 type => 'rent',
3286 item_id => $checkout->itemnumber,
3287 issue_id => $checkout->issue_id,
3292 =head2 GetTransfers
3294 GetTransfers($itemnumber);
3296 =cut
3298 sub GetTransfers {
3299 my ($itemnumber) = @_;
3301 my $dbh = C4::Context->dbh;
3303 my $query = '
3304 SELECT datesent,
3305 frombranch,
3306 tobranch,
3307 branchtransfer_id
3308 FROM branchtransfers
3309 WHERE itemnumber = ?
3310 AND datearrived IS NULL
3312 my $sth = $dbh->prepare($query);
3313 $sth->execute($itemnumber);
3314 my @row = $sth->fetchrow_array();
3315 return @row;
3318 =head2 GetTransfersFromTo
3320 @results = GetTransfersFromTo($frombranch,$tobranch);
3322 Returns the list of pending transfers between $from and $to branch
3324 =cut
3326 sub GetTransfersFromTo {
3327 my ( $frombranch, $tobranch ) = @_;
3328 return unless ( $frombranch && $tobranch );
3329 my $dbh = C4::Context->dbh;
3330 my $query = "
3331 SELECT branchtransfer_id,itemnumber,datesent,frombranch
3332 FROM branchtransfers
3333 WHERE frombranch=?
3334 AND tobranch=?
3335 AND datearrived IS NULL
3337 my $sth = $dbh->prepare($query);
3338 $sth->execute( $frombranch, $tobranch );
3339 my @gettransfers;
3341 while ( my $data = $sth->fetchrow_hashref ) {
3342 push @gettransfers, $data;
3344 return (@gettransfers);
3347 =head2 DeleteTransfer
3349 &DeleteTransfer($itemnumber);
3351 =cut
3353 sub DeleteTransfer {
3354 my ($itemnumber) = @_;
3355 return unless $itemnumber;
3356 my $dbh = C4::Context->dbh;
3357 my $sth = $dbh->prepare(
3358 "DELETE FROM branchtransfers
3359 WHERE itemnumber=?
3360 AND datearrived IS NULL "
3362 return $sth->execute($itemnumber);
3365 =head2 SendCirculationAlert
3367 Send out a C<check-in> or C<checkout> alert using the messaging system.
3369 B<Parameters>:
3371 =over 4
3373 =item type
3375 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3377 =item item
3379 Hashref of information about the item being checked in or out.
3381 =item borrower
3383 Hashref of information about the borrower of the item.
3385 =item branch
3387 The branchcode from where the checkout or check-in took place.
3389 =back
3391 B<Example>:
3393 SendCirculationAlert({
3394 type => 'CHECKOUT',
3395 item => $item,
3396 borrower => $borrower,
3397 branch => $branch,
3400 =cut
3402 sub SendCirculationAlert {
3403 my ($opts) = @_;
3404 my ($type, $item, $borrower, $branch) =
3405 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3406 my %message_name = (
3407 CHECKIN => 'Item_Check_in',
3408 CHECKOUT => 'Item_Checkout',
3409 RENEWAL => 'Item_Checkout',
3411 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3412 borrowernumber => $borrower->{borrowernumber},
3413 message_name => $message_name{$type},
3415 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3417 my $schema = Koha::Database->new->schema;
3418 my @transports = keys %{ $borrower_preferences->{transports} };
3420 # From the MySQL doc:
3421 # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3422 # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3423 # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3424 my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3426 for my $mtt (@transports) {
3427 my $letter = C4::Letters::GetPreparedLetter (
3428 module => 'circulation',
3429 letter_code => $type,
3430 branchcode => $branch,
3431 message_transport_type => $mtt,
3432 lang => $borrower->{lang},
3433 tables => {
3434 $issues_table => $item->{itemnumber},
3435 'items' => $item->{itemnumber},
3436 'biblio' => $item->{biblionumber},
3437 'biblioitems' => $item->{biblionumber},
3438 'borrowers' => $borrower,
3439 'branches' => $branch,
3441 ) or next;
3443 $schema->storage->txn_begin;
3444 C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3445 C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3446 my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3447 unless ( $message ) {
3448 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3449 C4::Message->enqueue($letter, $borrower, $mtt);
3450 } else {
3451 $message->append($letter);
3452 $message->update;
3454 C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3455 $schema->storage->txn_commit;
3458 return;
3461 =head2 updateWrongTransfer
3463 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3465 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
3467 =cut
3469 sub updateWrongTransfer {
3470 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3471 my $dbh = C4::Context->dbh;
3472 # first step validate the actual line of transfert .
3473 my $sth =
3474 $dbh->prepare(
3475 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3477 $sth->execute($FromLibrary,$itemNumber);
3479 # second step create a new line of branchtransfer to the right location .
3480 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3482 #third step changing holdingbranch of item
3483 UpdateHoldingbranch($FromLibrary,$itemNumber);
3486 =head2 UpdateHoldingbranch
3488 $items = UpdateHoldingbranch($branch,$itmenumber);
3490 Simple methode for updating hodlingbranch in items BDD line
3492 =cut
3494 sub UpdateHoldingbranch {
3495 my ( $branch,$itemnumber ) = @_;
3496 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3499 =head2 CalcDateDue
3501 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3503 this function calculates the due date given the start date and configured circulation rules,
3504 checking against the holidays calendar as per the 'useDaysMode' syspref.
3505 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3506 C<$itemtype> = itemtype code of item in question
3507 C<$branch> = location whose calendar to use
3508 C<$borrower> = Borrower object
3509 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3511 =cut
3513 sub CalcDateDue {
3514 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3516 $isrenewal ||= 0;
3518 # loanlength now a href
3519 my $loanlength =
3520 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3522 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3523 ? qq{renewalperiod}
3524 : qq{issuelength};
3526 my $datedue;
3527 if ( $startdate ) {
3528 if (ref $startdate ne 'DateTime' ) {
3529 $datedue = dt_from_string($datedue);
3530 } else {
3531 $datedue = $startdate->clone;
3533 } else {
3534 $datedue =
3535 DateTime->now( time_zone => C4::Context->tz() )
3536 ->truncate( to => 'minute' );
3540 # calculate the datedue as normal
3541 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3542 { # ignoring calendar
3543 if ( $loanlength->{lengthunit} eq 'hours' ) {
3544 $datedue->add( hours => $loanlength->{$length_key} );
3545 } else { # days
3546 $datedue->add( days => $loanlength->{$length_key} );
3547 $datedue->set_hour(23);
3548 $datedue->set_minute(59);
3550 } else {
3551 my $dur;
3552 if ($loanlength->{lengthunit} eq 'hours') {
3553 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3555 else { # days
3556 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3558 my $calendar = Koha::Calendar->new( branchcode => $branch );
3559 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3560 if ($loanlength->{lengthunit} eq 'days') {
3561 $datedue->set_hour(23);
3562 $datedue->set_minute(59);
3566 # if Hard Due Dates are used, retrieve them and apply as necessary
3567 my ( $hardduedate, $hardduedatecompare ) =
3568 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3569 if ($hardduedate) { # hardduedates are currently dates
3570 $hardduedate->truncate( to => 'minute' );
3571 $hardduedate->set_hour(23);
3572 $hardduedate->set_minute(59);
3573 my $cmp = DateTime->compare( $hardduedate, $datedue );
3575 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3576 # if the calculated date is before the 'after' Hard Due Date (floor), override
3577 # if the hard due date is set to 'exactly', overrride
3578 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3579 $datedue = $hardduedate->clone;
3582 # in all other cases, keep the date due as it is
3586 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3587 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3588 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3589 if( $expiry_dt ) { #skip empty expiry date..
3590 $expiry_dt->set( hour => 23, minute => 59);
3591 my $d1= $datedue->clone->set_time_zone('floating');
3592 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3593 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3596 if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3597 my $calendar = Koha::Calendar->new( branchcode => $branch );
3598 if ( $calendar->is_holiday($datedue) ) {
3599 # Don't return on a closed day
3600 $datedue = $calendar->prev_open_day( $datedue );
3605 return $datedue;
3609 sub CheckValidBarcode{
3610 my ($barcode) = @_;
3611 my $dbh = C4::Context->dbh;
3612 my $query=qq|SELECT count(*)
3613 FROM items
3614 WHERE barcode=?
3616 my $sth = $dbh->prepare($query);
3617 $sth->execute($barcode);
3618 my $exist=$sth->fetchrow ;
3619 return $exist;
3622 =head2 IsBranchTransferAllowed
3624 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3626 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3628 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3629 Koha::Item->can_be_transferred.
3631 =cut
3633 sub IsBranchTransferAllowed {
3634 my ( $toBranch, $fromBranch, $code ) = @_;
3636 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3638 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3639 my $dbh = C4::Context->dbh;
3641 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3642 $sth->execute( $toBranch, $fromBranch, $code );
3643 my $limit = $sth->fetchrow_hashref();
3645 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3646 if ( $limit->{'limitId'} ) {
3647 return 0;
3648 } else {
3649 return 1;
3653 =head2 CreateBranchTransferLimit
3655 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3657 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3659 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3661 =cut
3663 sub CreateBranchTransferLimit {
3664 my ( $toBranch, $fromBranch, $code ) = @_;
3665 return unless defined($toBranch) && defined($fromBranch);
3666 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3668 my $dbh = C4::Context->dbh;
3670 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3671 return $sth->execute( $code, $toBranch, $fromBranch );
3674 =head2 DeleteBranchTransferLimits
3676 my $result = DeleteBranchTransferLimits($frombranch);
3678 Deletes all the library transfer limits for one library. Returns the
3679 number of limits deleted, 0e0 if no limits were deleted, or undef if
3680 no arguments are supplied.
3682 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3683 fromBranch => $fromBranch
3684 })->delete.
3686 =cut
3688 sub DeleteBranchTransferLimits {
3689 my $branch = shift;
3690 return unless defined $branch;
3691 my $dbh = C4::Context->dbh;
3692 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3693 return $sth->execute($branch);
3696 sub ReturnLostItem{
3697 my ( $borrowernumber, $itemnum ) = @_;
3699 MarkIssueReturned( $borrowernumber, $itemnum );
3700 my $patron = Koha::Patrons->find( $borrowernumber );
3701 my $item = Koha::Items->find($itemnum);
3702 my $old_note = ($item->paidfor && ($item->paidfor ne q{})) ? $item->paidfor.' / ' : q{};
3703 my @datearr = localtime(time);
3704 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3705 my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3706 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3710 sub LostItem{
3711 my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3713 unless ( $mark_lost_from ) {
3714 # Temporary check to avoid regressions
3715 die q|LostItem called without $mark_lost_from, check the API.|;
3718 my $mark_returned;
3719 if ( $force_mark_returned ) {
3720 $mark_returned = 1;
3721 } else {
3722 my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3723 $mark_returned = ( $pref =~ m|$mark_lost_from| );
3726 my $dbh = C4::Context->dbh();
3727 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3728 FROM issues
3729 JOIN items USING (itemnumber)
3730 JOIN biblio USING (biblionumber)
3731 WHERE issues.itemnumber=?");
3732 $sth->execute($itemnumber);
3733 my $issues=$sth->fetchrow_hashref();
3735 # If a borrower lost the item, add a replacement cost to the their record
3736 if ( my $borrowernumber = $issues->{borrowernumber} ){
3737 my $patron = Koha::Patrons->find( $borrowernumber );
3739 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 0); # 1, 0 = exemptfine, no-dropbox
3740 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3742 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3743 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "$issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3744 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3745 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3748 MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3751 #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3752 if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3753 ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3755 my $transferdeleted = DeleteTransfer($itemnumber);
3758 sub GetOfflineOperations {
3759 my $dbh = C4::Context->dbh;
3760 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3761 $sth->execute(C4::Context->userenv->{'branch'});
3762 my $results = $sth->fetchall_arrayref({});
3763 return $results;
3766 sub GetOfflineOperation {
3767 my $operationid = shift;
3768 return unless $operationid;
3769 my $dbh = C4::Context->dbh;
3770 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3771 $sth->execute( $operationid );
3772 return $sth->fetchrow_hashref;
3775 sub AddOfflineOperation {
3776 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3777 my $dbh = C4::Context->dbh;
3778 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3779 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3780 return "Added.";
3783 sub DeleteOfflineOperation {
3784 my $dbh = C4::Context->dbh;
3785 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3786 $sth->execute( shift );
3787 return "Deleted.";
3790 sub ProcessOfflineOperation {
3791 my $operation = shift;
3793 my $report;
3794 if ( $operation->{action} eq 'return' ) {
3795 $report = ProcessOfflineReturn( $operation );
3796 } elsif ( $operation->{action} eq 'issue' ) {
3797 $report = ProcessOfflineIssue( $operation );
3798 } elsif ( $operation->{action} eq 'payment' ) {
3799 $report = ProcessOfflinePayment( $operation );
3802 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3804 return $report;
3807 sub ProcessOfflineReturn {
3808 my $operation = shift;
3810 my $item = Koha::Items->find({barcode => $operation->{barcode}});
3812 if ( $item ) {
3813 my $itemnumber = $item->itemnumber;
3814 my $issue = GetOpenIssue( $itemnumber );
3815 if ( $issue ) {
3816 my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3817 ModDateLastSeen( $itemnumber, $leave_item_lost );
3818 MarkIssueReturned(
3819 $issue->{borrowernumber},
3820 $itemnumber,
3821 $operation->{timestamp},
3823 ModItem(
3824 { renewals => 0, onloan => undef },
3825 $issue->{'biblionumber'},
3826 $itemnumber,
3827 { log_action => 0 }
3829 return "Success.";
3830 } else {
3831 return "Item not issued.";
3833 } else {
3834 return "Item not found.";
3838 sub ProcessOfflineIssue {
3839 my $operation = shift;
3841 my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3843 if ( $patron ) {
3844 my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3845 unless ($item) {
3846 return "Barcode not found.";
3848 my $itemnumber = $item->itemnumber;
3849 my $issue = GetOpenIssue( $itemnumber );
3851 if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3852 MarkIssueReturned(
3853 $issue->{borrowernumber},
3854 $itemnumber,
3855 $operation->{timestamp},
3858 AddIssue(
3859 $patron->unblessed,
3860 $operation->{'barcode'},
3861 undef,
3863 $operation->{timestamp},
3864 undef,
3866 return "Success.";
3867 } else {
3868 return "Borrower not found.";
3872 sub ProcessOfflinePayment {
3873 my $operation = shift;
3875 my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3877 $patron->account->pay(
3879 amount => $operation->{amount},
3880 library_id => $operation->{branchcode},
3881 interface => 'koc'
3885 return "Success.";
3888 =head2 TransferSlip
3890 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3892 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3894 =cut
3896 sub TransferSlip {
3897 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3899 my $item =
3900 $itemnumber
3901 ? Koha::Items->find($itemnumber)
3902 : Koha::Items->find( { barcode => $barcode } );
3904 $item or return;
3906 return C4::Letters::GetPreparedLetter (
3907 module => 'circulation',
3908 letter_code => 'TRANSFERSLIP',
3909 branchcode => $branch,
3910 tables => {
3911 'branches' => $to_branch,
3912 'biblio' => $item->biblionumber,
3913 'items' => $item->unblessed,
3918 =head2 CheckIfIssuedToPatron
3920 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3922 Return 1 if any record item is issued to patron, otherwise return 0
3924 =cut
3926 sub CheckIfIssuedToPatron {
3927 my ($borrowernumber, $biblionumber) = @_;
3929 my $dbh = C4::Context->dbh;
3930 my $query = q|
3931 SELECT COUNT(*) FROM issues
3932 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3933 WHERE items.biblionumber = ?
3934 AND issues.borrowernumber = ?
3936 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3937 return 1 if $is_issued;
3938 return;
3941 =head2 IsItemIssued
3943 IsItemIssued( $itemnumber )
3945 Return 1 if the item is on loan, otherwise return 0
3947 =cut
3949 sub IsItemIssued {
3950 my $itemnumber = shift;
3951 my $dbh = C4::Context->dbh;
3952 my $sth = $dbh->prepare(q{
3953 SELECT COUNT(*)
3954 FROM issues
3955 WHERE itemnumber = ?
3957 $sth->execute($itemnumber);
3958 return $sth->fetchrow;
3961 =head2 GetAgeRestriction
3963 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3964 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3966 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3967 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3969 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3970 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3971 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3972 Negative days mean the borrower has gone past the age restriction age.
3974 =cut
3976 sub GetAgeRestriction {
3977 my ($record_restrictions, $borrower) = @_;
3978 my $markers = C4::Context->preference('AgeRestrictionMarker');
3980 # Split $record_restrictions to something like FSK 16 or PEGI 6
3981 my @values = split ' ', uc($record_restrictions);
3982 return unless @values;
3984 # Search first occurrence of one of the markers
3985 my @markers = split /\|/, uc($markers);
3986 return unless @markers;
3988 my $index = 0;
3989 my $restriction_year = 0;
3990 for my $value (@values) {
3991 $index++;
3992 for my $marker (@markers) {
3993 $marker =~ s/^\s+//; #remove leading spaces
3994 $marker =~ s/\s+$//; #remove trailing spaces
3995 if ( $marker eq $value ) {
3996 if ( $index <= $#values ) {
3997 $restriction_year += $values[$index];
3999 last;
4001 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4003 # Perhaps it is something like "K16" (as in Finland)
4004 $restriction_year += $1;
4005 last;
4008 last if ( $restriction_year > 0 );
4011 #Check if the borrower is age restricted for this material and for how long.
4012 if ($restriction_year && $borrower) {
4013 if ( $borrower->{'dateofbirth'} ) {
4014 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4015 $alloweddate[0] += $restriction_year;
4017 #Prevent runime eror on leap year (invalid date)
4018 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4019 $alloweddate[2] = 28;
4022 #Get how many days the borrower has to reach the age restriction
4023 my @Today = split /-/, DateTime->today->ymd();
4024 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4025 #Negative days means the borrower went past the age restriction age
4026 return ($restriction_year, $daysToAgeRestriction);
4030 return ($restriction_year);
4034 =head2 GetPendingOnSiteCheckouts
4036 =cut
4038 sub GetPendingOnSiteCheckouts {
4039 my $dbh = C4::Context->dbh;
4040 return $dbh->selectall_arrayref(q|
4041 SELECT
4042 items.barcode,
4043 items.biblionumber,
4044 items.itemnumber,
4045 items.itemnotes,
4046 items.itemcallnumber,
4047 items.location,
4048 issues.date_due,
4049 issues.branchcode,
4050 issues.date_due < NOW() AS is_overdue,
4051 biblio.author,
4052 biblio.title,
4053 borrowers.firstname,
4054 borrowers.surname,
4055 borrowers.cardnumber,
4056 borrowers.borrowernumber
4057 FROM items
4058 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4059 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4060 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4061 WHERE issues.onsite_checkout = 1
4062 |, { Slice => {} } );
4065 sub GetTopIssues {
4066 my ($params) = @_;
4068 my ($count, $branch, $itemtype, $ccode, $newness)
4069 = @$params{qw(count branch itemtype ccode newness)};
4071 my $dbh = C4::Context->dbh;
4072 my $query = q{
4073 SELECT * FROM (
4074 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4075 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4076 i.ccode, SUM(i.issues) AS count
4077 FROM biblio b
4078 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4079 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4082 my (@where_strs, @where_args);
4084 if ($branch) {
4085 push @where_strs, 'i.homebranch = ?';
4086 push @where_args, $branch;
4088 if ($itemtype) {
4089 if (C4::Context->preference('item-level_itypes')){
4090 push @where_strs, 'i.itype = ?';
4091 push @where_args, $itemtype;
4092 } else {
4093 push @where_strs, 'bi.itemtype = ?';
4094 push @where_args, $itemtype;
4097 if ($ccode) {
4098 push @where_strs, 'i.ccode = ?';
4099 push @where_args, $ccode;
4101 if ($newness) {
4102 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4103 push @where_args, $newness;
4106 if (@where_strs) {
4107 $query .= 'WHERE ' . join(' AND ', @where_strs);
4110 $query .= q{
4111 GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4112 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4113 i.ccode
4114 ORDER BY count DESC
4117 $query .= q{ ) xxx WHERE count > 0 };
4118 $count = int($count);
4119 if ($count > 0) {
4120 $query .= "LIMIT $count";
4123 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4125 return @$rows;
4128 sub _CalculateAndUpdateFine {
4129 my ($params) = @_;
4131 my $borrower = $params->{borrower};
4132 my $item = $params->{item};
4133 my $issue = $params->{issue};
4134 my $return_date = $params->{return_date};
4136 unless ($borrower) { carp "No borrower passed in!" && return; }
4137 unless ($item) { carp "No item passed in!" && return; }
4138 unless ($issue) { carp "No issue passed in!" && return; }
4140 my $datedue = dt_from_string( $issue->date_due );
4142 # we only need to calculate and change the fines if we want to do that on return
4143 # Should be on for hourly loans
4144 my $control = C4::Context->preference('CircControl');
4145 my $control_branchcode =
4146 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4147 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
4148 : $issue->branchcode;
4150 my $date_returned = $return_date ? $return_date : dt_from_string();
4152 my ( $amount, $unitcounttotal, $unitcount ) =
4153 C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4155 if ( C4::Context->preference('finesMode') eq 'production' ) {
4156 if ( $amount > 0 ) {
4157 C4::Overdues::UpdateFine({
4158 issue_id => $issue->issue_id,
4159 itemnumber => $issue->itemnumber,
4160 borrowernumber => $issue->borrowernumber,
4161 amount => $amount,
4162 due => output_pref($datedue),
4165 elsif ($return_date) {
4167 # Backdated returns may have fines that shouldn't exist,
4168 # so in this case, we need to drop those fines to 0
4170 C4::Overdues::UpdateFine({
4171 issue_id => $issue->issue_id,
4172 itemnumber => $issue->itemnumber,
4173 borrowernumber => $issue->borrowernumber,
4174 amount => 0,
4175 due => output_pref($datedue),
4181 sub _item_denied_renewal {
4182 my ($params) = @_;
4184 my $item = $params->{item};
4185 return unless $item;
4187 my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4188 return unless $denyingrules;
4189 foreach my $field (keys %$denyingrules) {
4190 my $val = $item->$field;
4191 if( !defined $val) {
4192 if ( any { !defined $_ } @{$denyingrules->{$field}} ){
4193 return 1;
4195 } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4196 # If the results matches the values in the syspref
4197 # We return true if match found
4198 return 1;
4201 return 0;
4207 __END__
4209 =head1 AUTHOR
4211 Koha Development Team <http://koha-community.org/>
4213 =cut