Bug 20400: Fix get_routing_lists tests
[koha.git] / C4 / Circulation.pm
1 package C4::Circulation;
2
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
5 #
6 # This file is part of Koha.
7 #
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.
12 #
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.
17 #
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>.
20
21
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;
41
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::Holds;
56 use Koha::RefundLostItemFeeRule;
57 use Koha::RefundLostItemFeeRules;
58 use Koha::Account::Lines;
59 use Koha::Account::Offsets;
60 use Carp;
61 use List::MoreUtils qw( uniq );
62 use Scalar::Util qw( looks_like_number );
63 use Date::Calc qw(
64   Today
65   Today_and_Now
66   Add_Delta_YM
67   Add_Delta_DHMS
68   Date_to_Days
69   Day_of_Week
70   Add_Delta_Days
71 );
72 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
73
74 BEGIN {
75         require Exporter;
76         @ISA    = qw(Exporter);
77
78         # FIXME subs that should probably be elsewhere
79         push @EXPORT, qw(
80                 &barcodedecode
81         &LostItem
82         &ReturnLostItem
83         &GetPendingOnSiteCheckouts
84         );
85
86         # subs to deal with issuing a book
87         push @EXPORT, qw(
88                 &CanBookBeIssued
89                 &CanBookBeRenewed
90                 &AddIssue
91                 &AddRenewal
92                 &GetRenewCount
93         &GetSoonestRenewDate
94         &GetLatestAutoRenewDate
95                 &GetIssuingCharges
96         &GetBranchBorrowerCircRule
97         &GetBranchItemRule
98                 &GetBiblioIssues
99                 &GetOpenIssue
100         &CheckIfIssuedToPatron
101         &IsItemIssued
102         GetTopIssues
103         );
104
105         # subs to deal with returns
106         push @EXPORT, qw(
107                 &AddReturn
108         &MarkIssueReturned
109         );
110
111         # subs to deal with transfers
112         push @EXPORT, qw(
113                 &transferbook
114                 &GetTransfers
115                 &GetTransfersFromTo
116                 &updateWrongTransfer
117                 &DeleteTransfer
118                 &IsBranchTransferAllowed
119                 &CreateBranchTransferLimit
120                 &DeleteBranchTransferLimits
121         &TransferSlip
122         );
123
124     # subs to deal with offline circulation
125     push @EXPORT, qw(
126       &GetOfflineOperations
127       &GetOfflineOperation
128       &AddOfflineOperation
129       &DeleteOfflineOperation
130       &ProcessOfflineOperation
131     );
132 }
133
134 =head1 NAME
135
136 C4::Circulation - Koha circulation module
137
138 =head1 SYNOPSIS
139
140 use C4::Circulation;
141
142 =head1 DESCRIPTION
143
144 The functions in this module deal with circulation, issues, and
145 returns, as well as general information about the library.
146 Also deals with inventory.
147
148 =head1 FUNCTIONS
149
150 =head2 barcodedecode
151
152   $str = &barcodedecode($barcode, [$filter]);
153
154 Generic filter function for barcode string.
155 Called on every circ if the System Pref itemBarcodeInputFilter is set.
156 Will do some manipulation of the barcode for systems that deliver a barcode
157 to circulation.pl that differs from the barcode stored for the item.
158 For proper functioning of this filter, calling the function on the 
159 correct barcode string (items.barcode) should return an unaltered barcode.
160
161 The optional $filter argument is to allow for testing or explicit 
162 behavior that ignores the System Pref.  Valid values are the same as the 
163 System Pref options.
164
165 =cut
166
167 # FIXME -- the &decode fcn below should be wrapped into this one.
168 # FIXME -- these plugins should be moved out of Circulation.pm
169 #
170 sub barcodedecode {
171     my ($barcode, $filter) = @_;
172     my $branch = C4::Context::mybranch();
173     $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
174     $filter or return $barcode;     # ensure filter is defined, else return untouched barcode
175         if ($filter eq 'whitespace') {
176                 $barcode =~ s/\s//g;
177         } elsif ($filter eq 'cuecat') {
178                 chomp($barcode);
179             my @fields = split( /\./, $barcode );
180             my @results = map( decode($_), @fields[ 1 .. $#fields ] );
181             ($#results == 2) and return $results[2];
182         } elsif ($filter eq 'T-prefix') {
183                 if ($barcode =~ /^[Tt](\d)/) {
184                         (defined($1) and $1 eq '0') and return $barcode;
185             $barcode = substr($barcode, 2) + 0;     # FIXME: probably should be substr($barcode, 1)
186                 }
187         return sprintf("T%07d", $barcode);
188         # FIXME: $barcode could be "T1", causing warning: substr outside of string
189         # Why drop the nonzero digit after the T?
190         # Why pass non-digits (or empty string) to "T%07d"?
191         } elsif ($filter eq 'libsuite8') {
192                 unless($barcode =~ m/^($branch)-/i){    #if barcode starts with branch code its in Koha style. Skip it.
193                         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
194                                 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
195                         }else{
196                                 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
197                         }
198                 }
199     } elsif ($filter eq 'EAN13') {
200         my $ean = CheckDigits('ean');
201         if ( $ean->is_valid($barcode) ) {
202             #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
203             $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
204         } else {
205             warn "# [$barcode] not valid EAN-13/UPC-A\n";
206         }
207         }
208     return $barcode;    # return barcode, modified or not
209 }
210
211 =head2 decode
212
213   $str = &decode($chunk);
214
215 Decodes a segment of a string emitted by a CueCat barcode scanner and
216 returns it.
217
218 FIXME: Should be replaced with Barcode::Cuecat from CPAN
219 or Javascript based decoding on the client side.
220
221 =cut
222
223 sub decode {
224     my ($encoded) = @_;
225     my $seq =
226       'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
227     my @s = map { index( $seq, $_ ); } split( //, $encoded );
228     my $l = ( $#s + 1 ) % 4;
229     if ($l) {
230         if ( $l == 1 ) {
231             # warn "Error: Cuecat decode parsing failed!";
232             return;
233         }
234         $l = 4 - $l;
235         $#s += $l;
236     }
237     my $r = '';
238     while ( $#s >= 0 ) {
239         my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
240         $r .=
241             chr( ( $n >> 16 ) ^ 67 )
242          .chr( ( $n >> 8 & 255 ) ^ 67 )
243          .chr( ( $n & 255 ) ^ 67 );
244         @s = @s[ 4 .. $#s ];
245     }
246     $r = substr( $r, 0, length($r) - $l );
247     return $r;
248 }
249
250 =head2 transferbook
251
252   ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch, 
253                                             $barcode, $ignore_reserves);
254
255 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
256
257 C<$newbranch> is the code for the branch to which the item should be transferred.
258
259 C<$barcode> is the barcode of the item to be transferred.
260
261 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
262 Otherwise, if an item is reserved, the transfer fails.
263
264 Returns three values:
265
266 =over
267
268 =item $dotransfer 
269
270 is true if the transfer was successful.
271
272 =item $messages
273
274 is a reference-to-hash which may have any of the following keys:
275
276 =over
277
278 =item C<BadBarcode>
279
280 There is no item in the catalog with the given barcode. The value is C<$barcode>.
281
282 =item C<DestinationEqualsHolding>
283
284 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.
285
286 =item C<WasReturned>
287
288 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.
289
290 =item C<ResFound>
291
292 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>.
293
294 =item C<WasTransferred>
295
296 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
297
298 =back
299
300 =back
301
302 =cut
303
304 sub transferbook {
305     my ( $tbr, $barcode, $ignoreRs ) = @_;
306     my $messages;
307     my $dotransfer      = 1;
308     my $item = Koha::Items->find( { barcode => $barcode } );
309
310     # bad barcode..
311     unless ( $item ) {
312         $messages->{'BadBarcode'} = $barcode;
313         $dotransfer = 0;
314     }
315
316     my $itemnumber = $item->itemnumber;
317     my $issue = GetOpenIssue($itemnumber);
318     # get branches of book...
319     my $hbr = $item->homebranch;
320     my $fbr = $item->holdingbranch;
321
322     # if using Branch Transfer Limits
323     if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
324         my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
325         if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
326             if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
327                 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
328                 $dotransfer = 0;
329             }
330         } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
331             $messages->{'NotAllowed'} = $tbr . "::" . $code;
332             $dotransfer = 0;
333         }
334     }
335
336     # can't transfer book if is already there....
337     if ( $fbr eq $tbr ) {
338         $messages->{'DestinationEqualsHolding'} = 1;
339         $dotransfer = 0;
340     }
341
342     # check if it is still issued to someone, return it...
343     if ( $issue ) {
344         AddReturn( $barcode, $fbr );
345         $messages->{'WasReturned'} = $issue->borrowernumber;
346     }
347
348     # find reserves.....
349     # That'll save a database query.
350     my ( $resfound, $resrec, undef ) =
351       CheckReserves( $itemnumber );
352     if ( $resfound and not $ignoreRs ) {
353         $resrec->{'ResFound'} = $resfound;
354
355         #         $messages->{'ResFound'} = $resrec;
356         $dotransfer = 1;
357     }
358
359     #actually do the transfer....
360     if ($dotransfer) {
361         ModItemTransfer( $itemnumber, $fbr, $tbr );
362
363         # don't need to update MARC anymore, we do it in batch now
364         $messages->{'WasTransfered'} = 1;
365
366     }
367     ModDateLastSeen( $itemnumber );
368     return ( $dotransfer, $messages );
369 }
370
371
372 sub TooMany {
373     my $borrower        = shift;
374     my $biblionumber = shift;
375         my $item                = shift;
376     my $params = shift;
377     my $onsite_checkout = $params->{onsite_checkout} || 0;
378     my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
379     my $cat_borrower    = $borrower->{'categorycode'};
380     my $dbh             = C4::Context->dbh;
381         my $branch;
382         # Get which branchcode we need
383         $branch = _GetCircControlBranch($item,$borrower);
384         my $type = (C4::Context->preference('item-level_itypes')) 
385                         ? $item->{'itype'}         # item-level
386                         : $item->{'itemtype'};     # biblio-level
387  
388     # given branch, patron category, and item type, determine
389     # applicable issuing rule
390     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
391         {   categorycode => $cat_borrower,
392             itemtype     => $type,
393             branchcode   => $branch
394         }
395     );
396
397
398     # if a rule is found and has a loan limit set, count
399     # how many loans the patron already has that meet that
400     # rule
401     if (defined($issuing_rule) and defined($issuing_rule->maxissueqty)) {
402         my @bind_params;
403         my $count_query = q|
404             SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
405             FROM issues
406             JOIN items USING (itemnumber)
407         |;
408
409         my $rule_itemtype = $issuing_rule->itemtype;
410         if ($rule_itemtype eq "*") {
411             # matching rule has the default item type, so count only
412             # those existing loans that don't fall under a more
413             # specific rule
414             if (C4::Context->preference('item-level_itypes')) {
415                 $count_query .= " WHERE items.itype NOT IN (
416                                     SELECT itemtype FROM issuingrules
417                                     WHERE branchcode = ?
418                                     AND   (categorycode = ? OR categorycode = ?)
419                                     AND   itemtype <> '*'
420                                   ) ";
421             } else { 
422                 $count_query .= " JOIN  biblioitems USING (biblionumber) 
423                                   WHERE biblioitems.itemtype NOT IN (
424                                     SELECT itemtype FROM issuingrules
425                                     WHERE branchcode = ?
426                                     AND   (categorycode = ? OR categorycode = ?)
427                                     AND   itemtype <> '*'
428                                   ) ";
429             }
430             push @bind_params, $issuing_rule->branchcode;
431             push @bind_params, $issuing_rule->categorycode;
432             push @bind_params, $cat_borrower;
433         } else {
434             # rule has specific item type, so count loans of that
435             # specific item type
436             if (C4::Context->preference('item-level_itypes')) {
437                 $count_query .= " WHERE items.itype = ? ";
438             } else { 
439                 $count_query .= " JOIN  biblioitems USING (biblionumber) 
440                                   WHERE biblioitems.itemtype= ? ";
441             }
442             push @bind_params, $type;
443         }
444
445         $count_query .= " AND borrowernumber = ? ";
446         push @bind_params, $borrower->{'borrowernumber'};
447         my $rule_branch = $issuing_rule->branchcode;
448         if ($rule_branch ne "*") {
449             if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
450                 $count_query .= " AND issues.branchcode = ? ";
451                 push @bind_params, $branch;
452             } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
453                 ; # if branch is the patron's home branch, then count all loans by patron
454             } else {
455                 $count_query .= " AND items.homebranch = ? ";
456                 push @bind_params, $branch;
457             }
458         }
459
460         my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
461
462         my $max_checkouts_allowed = $issuing_rule->maxissueqty;
463         my $max_onsite_checkouts_allowed = $issuing_rule->maxonsiteissueqty;
464
465         if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
466             if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed )  {
467                 return {
468                     reason => 'TOO_MANY_ONSITE_CHECKOUTS',
469                     count => $onsite_checkout_count,
470                     max_allowed => $max_onsite_checkouts_allowed,
471                 }
472             }
473         }
474         if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
475             my $delta = $switch_onsite_checkout ? 1 : 0;
476             if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
477                 return {
478                     reason => 'TOO_MANY_CHECKOUTS',
479                     count => $checkout_count,
480                     max_allowed => $max_checkouts_allowed,
481                 };
482             }
483         } elsif ( not $onsite_checkout ) {
484             if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )  {
485                 return {
486                     reason => 'TOO_MANY_CHECKOUTS',
487                     count => $checkout_count - $onsite_checkout_count,
488                     max_allowed => $max_checkouts_allowed,
489                 };
490             }
491         }
492     }
493
494     # Now count total loans against the limit for the branch
495     my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
496     if (defined($branch_borrower_circ_rule->{maxissueqty})) {
497         my @bind_params = ();
498         my $branch_count_query = q|
499             SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
500             FROM issues
501             JOIN items USING (itemnumber)
502             WHERE borrowernumber = ?
503         |;
504         push @bind_params, $borrower->{borrowernumber};
505
506         if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
507             $branch_count_query .= " AND issues.branchcode = ? ";
508             push @bind_params, $branch;
509         } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
510             ; # if branch is the patron's home branch, then count all loans by patron
511         } else {
512             $branch_count_query .= " AND items.homebranch = ? ";
513             push @bind_params, $branch;
514         }
515         my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
516         my $max_checkouts_allowed = $branch_borrower_circ_rule->{maxissueqty};
517         my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{maxonsiteissueqty};
518
519         if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
520             if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed )  {
521                 return {
522                     reason => 'TOO_MANY_ONSITE_CHECKOUTS',
523                     count => $onsite_checkout_count,
524                     max_allowed => $max_onsite_checkouts_allowed,
525                 }
526             }
527         }
528         if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
529             my $delta = $switch_onsite_checkout ? 1 : 0;
530             if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
531                 return {
532                     reason => 'TOO_MANY_CHECKOUTS',
533                     count => $checkout_count,
534                     max_allowed => $max_checkouts_allowed,
535                 };
536             }
537         } elsif ( not $onsite_checkout ) {
538             if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )  {
539                 return {
540                     reason => 'TOO_MANY_CHECKOUTS',
541                     count => $checkout_count - $onsite_checkout_count,
542                     max_allowed => $max_checkouts_allowed,
543                 };
544             }
545         }
546     }
547
548     if ( not defined( $issuing_rule ) and not defined($branch_borrower_circ_rule->{maxissueqty}) ) {
549         return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
550     }
551
552     # OK, the patron can issue !!!
553     return;
554 }
555
556 =head2 CanBookBeIssued
557
558   ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) =  CanBookBeIssued( $patron,
559                       $barcode, $duedate, $inprocess, $ignore_reserves, $params );
560
561 Check if a book can be issued.
562
563 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
564
565 IMPORTANT: The assumption by users of this routine is that causes blocking
566 the issue are keyed by uppercase labels and other returned
567 data is keyed in lower case!
568
569 =over 4
570
571 =item C<$patron> is a Koha::Patron
572
573 =item C<$barcode> is the bar code of the book being issued.
574
575 =item C<$duedates> is a DateTime object.
576
577 =item C<$inprocess> boolean switch
578
579 =item C<$ignore_reserves> boolean switch
580
581 =item C<$params> Hashref of additional parameters
582
583 Available keys:
584     override_high_holds - Ignore high holds
585     onsite_checkout     - Checkout is an onsite checkout that will not leave the library
586
587 =back
588
589 Returns :
590
591 =over 4
592
593 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
594 Possible values are :
595
596 =back
597
598 =head3 INVALID_DATE 
599
600 sticky due date is invalid
601
602 =head3 GNA
603
604 borrower gone with no address
605
606 =head3 CARD_LOST
607
608 borrower declared it's card lost
609
610 =head3 DEBARRED
611
612 borrower debarred
613
614 =head3 UNKNOWN_BARCODE
615
616 barcode unknown
617
618 =head3 NOT_FOR_LOAN
619
620 item is not for loan
621
622 =head3 WTHDRAWN
623
624 item withdrawn.
625
626 =head3 RESTRICTED
627
628 item is restricted (set by ??)
629
630 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan 
631 could be prevented, but ones that can be overriden by the operator.
632
633 Possible values are :
634
635 =head3 DEBT
636
637 borrower has debts.
638
639 =head3 RENEW_ISSUE
640
641 renewing, not issuing
642
643 =head3 ISSUED_TO_ANOTHER
644
645 issued to someone else.
646
647 =head3 RESERVED
648
649 reserved for someone else.
650
651 =head3 INVALID_DATE
652
653 sticky due date is invalid or due date in the past
654
655 =head3 TOO_MANY
656
657 if the borrower borrows to much things
658
659 =cut
660
661 sub CanBookBeIssued {
662     my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
663     my %needsconfirmation;    # filled with problems that needs confirmations
664     my %issuingimpossible;    # filled with problems that causes the issue to be IMPOSSIBLE
665     my %alerts;               # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
666     my %messages;             # filled with information messages that should be displayed.
667
668     my $onsite_checkout     = $params->{onsite_checkout}     || 0;
669     my $override_high_holds = $params->{override_high_holds} || 0;
670
671     my $item = GetItem(undef, $barcode );
672     # MANDATORY CHECKS - unless item exists, nothing else matters
673     unless ( $item ) {
674         $issuingimpossible{UNKNOWN_BARCODE} = 1;
675     }
676     return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
677
678     my $issue = Koha::Checkouts->find( { itemnumber => $item->{itemnumber} } );
679     my $biblio = Koha::Biblios->find( $item->{biblionumber} );
680     my $biblioitem = $biblio->biblioitem;
681     my $effective_itemtype = $item->{itype}; # GetItem deals with that
682     my $dbh             = C4::Context->dbh;
683     my $patron_unblessed = $patron->unblessed;
684
685     #
686     # DUE DATE is OK ? -- should already have checked.
687     #
688     if ($duedate && ref $duedate ne 'DateTime') {
689         $duedate = dt_from_string($duedate);
690     }
691     my $now = DateTime->now( time_zone => C4::Context->tz() );
692     unless ( $duedate ) {
693         my $issuedate = $now->clone();
694
695         my $branch = _GetCircControlBranch($item, $patron_unblessed);
696         $duedate = CalcDateDue( $issuedate, $effective_itemtype, $branch, $patron_unblessed );
697
698         # Offline circ calls AddIssue directly, doesn't run through here
699         #  So issuingimpossible should be ok.
700     }
701     if ($duedate) {
702         my $today = $now->clone();
703         $today->truncate( to => 'minute');
704         if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
705             $needsconfirmation{INVALID_DATE} = output_pref($duedate);
706         }
707     } else {
708             $issuingimpossible{INVALID_DATE} = output_pref($duedate);
709     }
710
711     #
712     # BORROWER STATUS
713     #
714     if ( $patron->category->category_type eq 'X' && (  $item->{barcode}  )) {
715         # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1  .
716         &UpdateStats({
717                      branch => C4::Context->userenv->{'branch'},
718                      type => 'localuse',
719                      itemnumber => $item->{'itemnumber'},
720                      itemtype => $effective_itemtype,
721                      borrowernumber => $patron->borrowernumber,
722                      ccode => $item->{'ccode'}}
723                     );
724         ModDateLastSeen( $item->{'itemnumber'} );
725         return( { STATS => 1 }, {});
726     }
727
728     if ( $patron->gonenoaddress == 1 ) {
729         $issuingimpossible{GNA} = 1;
730     }
731
732     if ( $patron->lost == 1 ) {
733         $issuingimpossible{CARD_LOST} = 1;
734     }
735     if ( $patron->is_debarred ) {
736         $issuingimpossible{DEBARRED} = 1;
737     }
738
739     if ( $patron->is_expired ) {
740         $issuingimpossible{EXPIRED} = 1;
741     }
742
743     #
744     # BORROWER STATUS
745     #
746
747     # DEBTS
748     my $account = $patron->account;
749     my $balance = $account->balance;
750     my $non_issues_charges = $account->non_issues_charges;
751     my $other_charges = $balance - $non_issues_charges;
752
753     my $amountlimit = C4::Context->preference("noissuescharge");
754     my $allowfineoverride = C4::Context->preference("AllowFineOverride");
755     my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
756
757     # Check the debt of this patrons guarantees
758     my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
759     $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
760     if ( defined $no_issues_charge_guarantees ) {
761         my @guarantees = $patron->guarantees();
762         my $guarantees_non_issues_charges;
763         foreach my $g ( @guarantees ) {
764             $guarantees_non_issues_charges += $g->account->non_issues_charges;
765         }
766
767         if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
768             $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
769         } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
770             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
771         } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
772             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
773         }
774     }
775
776     if ( C4::Context->preference("IssuingInProcess") ) {
777         if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
778             $issuingimpossible{DEBT} = $non_issues_charges;
779         } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
780             $needsconfirmation{DEBT} = $non_issues_charges;
781         } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
782             $needsconfirmation{DEBT} = $non_issues_charges;
783         }
784     }
785     else {
786         if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
787             $needsconfirmation{DEBT} = $non_issues_charges;
788         } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
789             $issuingimpossible{DEBT} = $non_issues_charges;
790         } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
791             $needsconfirmation{DEBT} = $non_issues_charges;
792         }
793     }
794
795     if ($balance > 0 && $other_charges > 0) {
796         $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
797     }
798
799     $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
800     $patron_unblessed = $patron->unblessed;
801
802     if ( my $debarred_date = $patron->is_debarred ) {
803          # patron has accrued fine days or has a restriction. $count is a date
804         if ($debarred_date eq '9999-12-31') {
805             $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
806         }
807         else {
808             $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
809         }
810     } elsif ( my $num_overdues = $patron->has_overdues ) {
811         ## patron has outstanding overdue loans
812         if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
813             $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
814         }
815         elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
816             $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
817         }
818     }
819
820     #
821     # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
822     #
823     if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
824
825         # Already issued to current borrower.
826         # If it is an on-site checkout if it can be switched to a normal checkout
827         # or ask whether the loan should be renewed
828
829         if ( $issue->onsite_checkout
830                 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
831             $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
832         } else {
833             my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
834                 $patron->borrowernumber,
835                 $item->{'itemnumber'},
836             );
837             if ( $CanBookBeRenewed == 0 ) {    # no more renewals allowed
838                 if ( $renewerror eq 'onsite_checkout' ) {
839                     $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
840                 }
841                 else {
842                     $issuingimpossible{NO_MORE_RENEWALS} = 1;
843                 }
844             }
845             else {
846                 $needsconfirmation{RENEW_ISSUE} = 1;
847             }
848         }
849     }
850     elsif ( $issue ) {
851
852         # issued to someone else
853
854         my $patron = Koha::Patrons->find( $issue->borrowernumber );
855
856         my ( $can_be_returned, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
857
858         unless ( $can_be_returned ) {
859             $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
860             $issuingimpossible{branch_to_return} = $message;
861         } else {
862             $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
863             $needsconfirmation{issued_firstname} = $patron->firstname;
864             $needsconfirmation{issued_surname} = $patron->surname;
865             $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
866             $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
867         }
868     }
869
870     # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
871     #
872     my $switch_onsite_checkout = (
873           C4::Context->preference('SwitchOnSiteCheckouts')
874       and $issue
875       and $issue->onsite_checkout
876       and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
877     my $toomany = TooMany( $patron_unblessed, $item->{biblionumber}, $item, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
878     # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
879     if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
880         if ( $toomany->{max_allowed} == 0 ) {
881             $needsconfirmation{PATRON_CANT} = 1;
882         }
883         if ( C4::Context->preference("AllowTooManyOverride") ) {
884             $needsconfirmation{TOO_MANY} = $toomany->{reason};
885             $needsconfirmation{current_loan_count} = $toomany->{count};
886             $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
887         } else {
888             $issuingimpossible{TOO_MANY} = $toomany->{reason};
889             $issuingimpossible{current_loan_count} = $toomany->{count};
890             $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
891         }
892     }
893
894     #
895     # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
896     #
897     $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
898     my $wants_check = $patron->wants_check_for_previous_checkout;
899     $needsconfirmation{PREVISSUE} = 1
900         if ($wants_check and $patron->do_check_for_previous_checkout($item));
901
902     #
903     # ITEM CHECKING
904     #
905     if ( $item->{'notforloan'} )
906     {
907         if(!C4::Context->preference("AllowNotForLoanOverride")){
908             $issuingimpossible{NOT_FOR_LOAN} = 1;
909             $issuingimpossible{item_notforloan} = $item->{'notforloan'};
910         }else{
911             $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
912             $needsconfirmation{item_notforloan} = $item->{'notforloan'};
913         }
914     }
915     else {
916         # we have to check itemtypes.notforloan also
917         if (C4::Context->preference('item-level_itypes')){
918             # this should probably be a subroutine
919             my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
920             $sth->execute($item->{'itemtype'});
921             my $notforloan=$sth->fetchrow_hashref();
922             if ($notforloan->{'notforloan'}) {
923                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
924                     $issuingimpossible{NOT_FOR_LOAN} = 1;
925                     $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
926                 } else {
927                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
928                     $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
929                 }
930             }
931         }
932         elsif ($biblioitem->notforloan == 1){
933             if (!C4::Context->preference("AllowNotForLoanOverride")) {
934                 $issuingimpossible{NOT_FOR_LOAN} = 1;
935                 $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
936             } else {
937                 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
938                 $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
939             }
940         }
941     }
942     if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
943     {
944         $issuingimpossible{WTHDRAWN} = 1;
945     }
946     if (   $item->{'restricted'}
947         && $item->{'restricted'} == 1 )
948     {
949         $issuingimpossible{RESTRICTED} = 1;
950     }
951     if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
952         my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->{itemlost} });
953         my $code = $av->count ? $av->next->lib : '';
954         $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
955         $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
956     }
957     if ( C4::Context->preference("IndependentBranches") ) {
958         my $userenv = C4::Context->userenv;
959         unless ( C4::Context->IsSuperLibrarian() ) {
960             if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
961                 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
962                 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
963             }
964             $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
965               if ( $patron->branchcode ne $userenv->{branch} );
966         }
967     }
968     #
969     # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
970     #
971     my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
972
973     if ( $rentalConfirmation ){
974         my ($rentalCharge) = GetIssuingCharges( $item->{'itemnumber'}, $patron->borrowernumber );
975         if ( $rentalCharge > 0 ){
976             $needsconfirmation{RENTALCHARGE} = $rentalCharge;
977         }
978     }
979
980     unless ( $ignore_reserves ) {
981         # See if the item is on reserve.
982         my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
983         if ($restype) {
984             my $resbor = $res->{'borrowernumber'};
985             if ( $resbor ne $patron->borrowernumber ) {
986                 my $patron = Koha::Patrons->find( $resbor );
987                 if ( $restype eq "Waiting" )
988                 {
989                     # The item is on reserve and waiting, but has been
990                     # reserved by some other patron.
991                     $needsconfirmation{RESERVE_WAITING} = 1;
992                     $needsconfirmation{'resfirstname'} = $patron->firstname;
993                     $needsconfirmation{'ressurname'} = $patron->surname;
994                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
995                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
996                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
997                     $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
998                 }
999                 elsif ( $restype eq "Reserved" ) {
1000                     # The item is on reserve for someone else.
1001                     $needsconfirmation{RESERVED} = 1;
1002                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1003                     $needsconfirmation{'ressurname'} = $patron->surname;
1004                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1005                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1006                     $needsconfirmation{'resbranchcode'} = $patron->branchcode;
1007                     $needsconfirmation{'resreservedate'} = $res->{reservedate};
1008                 }
1009             }
1010         }
1011     }
1012
1013     ## CHECK AGE RESTRICTION
1014     my $agerestriction  = $biblioitem->agerestriction;
1015     my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1016     if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1017         if ( C4::Context->preference('AgeRestrictionOverride') ) {
1018             $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1019         }
1020         else {
1021             $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1022         }
1023     }
1024
1025     ## check for high holds decreasing loan period
1026     if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1027         my $check = checkHighHolds( $item, $patron_unblessed );
1028
1029         if ( $check->{exceeded} ) {
1030             if ($override_high_holds) {
1031                 $alerts{HIGHHOLDS} = {
1032                     num_holds  => $check->{outstanding},
1033                     duration   => $check->{duration},
1034                     returndate => output_pref( $check->{due_date} ),
1035                 };
1036             }
1037             else {
1038                 $needsconfirmation{HIGHHOLDS} = {
1039                     num_holds  => $check->{outstanding},
1040                     duration   => $check->{duration},
1041                     returndate => output_pref( $check->{due_date} ),
1042                 };
1043             }
1044         }
1045     }
1046
1047     if (
1048         !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1049         # don't do the multiple loans per bib check if we've
1050         # already determined that we've got a loan on the same item
1051         !$issuingimpossible{NO_MORE_RENEWALS} &&
1052         !$needsconfirmation{RENEW_ISSUE}
1053     ) {
1054         # Check if borrower has already issued an item from the same biblio
1055         # Only if it's not a subscription
1056         my $biblionumber = $item->{biblionumber};
1057         require C4::Serials;
1058         my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1059         unless ($is_a_subscription) {
1060             # FIXME Should be $patron->checkouts($args);
1061             my $checkouts = Koha::Checkouts->search(
1062                 {
1063                     borrowernumber => $patron->borrowernumber,
1064                     biblionumber   => $biblionumber,
1065                 },
1066                 {
1067                     join => 'item',
1068                 }
1069             );
1070             # if we get here, we don't already have a loan on this item,
1071             # so if there are any loans on this bib, ask for confirmation
1072             if ( $checkouts->count ) {
1073                 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1074             }
1075         }
1076     }
1077
1078     return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1079 }
1080
1081 =head2 CanBookBeReturned
1082
1083   ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1084
1085 Check whether the item can be returned to the provided branch
1086
1087 =over 4
1088
1089 =item C<$item> is a hash of item information as returned from GetItem
1090
1091 =item C<$branch> is the branchcode where the return is taking place
1092
1093 =back
1094
1095 Returns:
1096
1097 =over 4
1098
1099 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1100
1101 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1102
1103 =back
1104
1105 =cut
1106
1107 sub CanBookBeReturned {
1108   my ($item, $branch) = @_;
1109   my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1110
1111   # assume return is allowed to start
1112   my $allowed = 1;
1113   my $message;
1114
1115   # identify all cases where return is forbidden
1116   if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1117      $allowed = 0;
1118      $message = $item->{'homebranch'};
1119   } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1120      $allowed = 0;
1121      $message = $item->{'holdingbranch'};
1122   } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1123      $allowed = 0;
1124      $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1125   }
1126
1127   return ($allowed, $message);
1128 }
1129
1130 =head2 CheckHighHolds
1131
1132     used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1133     decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1134     has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1135
1136 =cut
1137
1138 sub checkHighHolds {
1139     my ( $item, $borrower ) = @_;
1140     my $branch = _GetCircControlBranch( $item, $borrower );
1141     my $item_object = Koha::Items->find( $item->{itemnumber} );
1142
1143     my $return_data = {
1144         exceeded    => 0,
1145         outstanding => 0,
1146         duration    => 0,
1147         due_date    => undef,
1148     };
1149
1150     my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1151
1152     if ( $holds->count() ) {
1153         $return_data->{outstanding} = $holds->count();
1154
1155         my $decreaseLoanHighHoldsControl        = C4::Context->preference('decreaseLoanHighHoldsControl');
1156         my $decreaseLoanHighHoldsValue          = C4::Context->preference('decreaseLoanHighHoldsValue');
1157         my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1158
1159         my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1160
1161         if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1162
1163             # static means just more than a given number of holds on the record
1164
1165             # If the number of holds is less than the threshold, we can stop here
1166             if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1167                 return $return_data;
1168             }
1169         }
1170         elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1171
1172             # dynamic means X more than the number of holdable items on the record
1173
1174             # let's get the items
1175             my @items = $holds->next()->biblio()->items();
1176
1177             # Remove any items with status defined to be ignored even if the would not make item unholdable
1178             foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1179                 @items = grep { !$_->$status } @items;
1180             }
1181
1182             # Remove any items that are not holdable for this patron
1183             @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber ) eq 'OK' } @items;
1184
1185             my $items_count = scalar @items;
1186
1187             my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1188
1189             # If the number of holds is less than the count of items we have
1190             # plus the number of holds allowed above that count, we can stop here
1191             if ( $holds->count() <= $threshold ) {
1192                 return $return_data;
1193             }
1194         }
1195
1196         my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1197
1198         my $calendar = Koha::Calendar->new( branchcode => $branch );
1199
1200         my $itype = $item_object->effective_itemtype;
1201         my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1202
1203         my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1204
1205         my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1206         $reduced_datedue->set_hour($orig_due->hour);
1207         $reduced_datedue->set_minute($orig_due->minute);
1208         $reduced_datedue->truncate( to => 'minute' );
1209
1210         if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1211             $return_data->{exceeded} = 1;
1212             $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1213             $return_data->{due_date} = $reduced_datedue;
1214         }
1215     }
1216
1217     return $return_data;
1218 }
1219
1220 =head2 AddIssue
1221
1222   &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1223
1224 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1225
1226 =over 4
1227
1228 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1229
1230 =item C<$barcode> is the barcode of the item being issued.
1231
1232 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1233 Calculated if empty.
1234
1235 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1236
1237 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1238 Defaults to today.  Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1239
1240 AddIssue does the following things :
1241
1242   - step 01: check that there is a borrowernumber & a barcode provided
1243   - check for RENEWAL (book issued & being issued to the same patron)
1244       - renewal YES = Calculate Charge & renew
1245       - renewal NO  =
1246           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1247           * RESERVE PLACED ?
1248               - fill reserve if reserve to this patron
1249               - cancel reserve or not, otherwise
1250           * TRANSFERT PENDING ?
1251               - complete the transfert
1252           * ISSUE THE BOOK
1253
1254 =back
1255
1256 =cut
1257
1258 sub AddIssue {
1259     my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1260
1261     my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1262     my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1263     my $auto_renew = $params && $params->{auto_renew};
1264     my $dbh          = C4::Context->dbh;
1265     my $barcodecheck = CheckValidBarcode($barcode);
1266
1267     my $issue;
1268
1269     if ( $datedue && ref $datedue ne 'DateTime' ) {
1270         $datedue = dt_from_string($datedue);
1271     }
1272
1273     # $issuedate defaults to today.
1274     if ( !defined $issuedate ) {
1275         $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1276     }
1277     else {
1278         if ( ref $issuedate ne 'DateTime' ) {
1279             $issuedate = dt_from_string($issuedate);
1280
1281         }
1282     }
1283
1284     # Stop here if the patron or barcode doesn't exist
1285     if ( $borrower && $barcode && $barcodecheck ) {
1286         # find which item we issue
1287         my $item = GetItem( '', $barcode )
1288           or return;    # if we don't get an Item, abort.
1289         my $item_object = Koha::Items->find( { barcode => $barcode } );
1290
1291         my $branch = _GetCircControlBranch( $item, $borrower );
1292
1293         # get actual issuing if there is one
1294         my $actualissue = Koha::Checkouts->find( { itemnumber => $item->{itemnumber} } );
1295
1296         # check if we just renew the issue.
1297         if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1298                 and not $switch_onsite_checkout ) {
1299             $datedue = AddRenewal(
1300                 $borrower->{'borrowernumber'},
1301                 $item->{'itemnumber'},
1302                 $branch,
1303                 $datedue,
1304                 $issuedate,    # here interpreted as the renewal date
1305             );
1306         }
1307         else {
1308             # it's NOT a renewal
1309             if ( $actualissue and not $switch_onsite_checkout ) {
1310                 # This book is currently on loan, but not to the person
1311                 # who wants to borrow it now. mark it returned before issuing to the new borrower
1312                 my ( $allowed, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
1313                 return unless $allowed;
1314                 AddReturn( $item->{'barcode'}, C4::Context->userenv->{'branch'} );
1315             }
1316
1317             MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1318
1319             # Starting process for transfer job (checking transfert and validate it if we have one)
1320             my ($datesent) = GetTransfers( $item->{'itemnumber'} );
1321             if ($datesent) {
1322                 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1323                 my $sth = $dbh->prepare(
1324                     "UPDATE branchtransfers 
1325                         SET datearrived = now(),
1326                         tobranch = ?,
1327                         comments = 'Forced branchtransfer'
1328                     WHERE itemnumber= ? AND datearrived IS NULL"
1329                 );
1330                 $sth->execute( C4::Context->userenv->{'branch'},
1331                     $item->{'itemnumber'} );
1332             }
1333
1334             # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1335             unless ($auto_renew) {
1336                 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1337                     {   categorycode => $borrower->{categorycode},
1338                         itemtype     => $item->{itype},
1339                         branchcode   => $branch
1340                     }
1341                 );
1342
1343                 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1344             }
1345
1346             # Record in the database the fact that the book was issued.
1347             unless ($datedue) {
1348                 my $itype = $item_object->effective_itemtype;
1349                 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1350
1351             }
1352             $datedue->truncate( to => 'minute' );
1353
1354             $issue = Koha::Database->new()->schema()->resultset('Issue')->update_or_create(
1355                 {
1356                     borrowernumber => $borrower->{'borrowernumber'},
1357                     itemnumber     => $item->{'itemnumber'},
1358                     issuedate      => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1359                     date_due       => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1360                     branchcode     => C4::Context->userenv->{'branch'},
1361                     onsite_checkout => $onsite_checkout,
1362                     auto_renew      => $auto_renew ? 1 : 0
1363                 }
1364               );
1365
1366             if ( C4::Context->preference('ReturnToShelvingCart') ) {
1367                 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1368                 CartToShelf( $item->{'itemnumber'} );
1369             }
1370             $item->{'issues'}++;
1371             if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1372                 UpdateTotalIssues( $item->{'biblionumber'}, 1 );
1373             }
1374
1375             ## If item was lost, it has now been found, reverse any list item charges if necessary.
1376             if ( $item->{'itemlost'} ) {
1377                 if (
1378                     Koha::RefundLostItemFeeRules->should_refund(
1379                         {
1380                             current_branch      => C4::Context->userenv->{branch},
1381                             item_home_branch    => $item->{homebranch},
1382                             item_holding_branch => $item->{holdingbranch}
1383                         }
1384                     )
1385                   )
1386                 {
1387                     _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef,
1388                         $item->{'barcode'} );
1389                 }
1390             }
1391
1392             ModItem(
1393                 {
1394                     issues        => $item->{'issues'},
1395                     holdingbranch => C4::Context->userenv->{'branch'},
1396                     itemlost      => 0,
1397                     onloan        => $datedue->ymd(),
1398                     datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1399                 },
1400                 $item->{'biblionumber'},
1401                 $item->{'itemnumber'},
1402                 { log_action => 0 }
1403             );
1404             ModDateLastSeen( $item->{'itemnumber'} );
1405
1406            # If it costs to borrow this book, charge it to the patron's account.
1407             my ( $charge, $itemtype ) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1408             if ( $charge > 0 ) {
1409                 AddIssuingCharge( $issue, $charge );
1410                 $item->{'charge'} = $charge;
1411             }
1412
1413             # Record the fact that this book was issued.
1414             &UpdateStats(
1415                 {
1416                     branch => C4::Context->userenv->{'branch'},
1417                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1418                     amount         => $charge,
1419                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1420                     itemnumber     => $item->{'itemnumber'},
1421                     itemtype       => $item->{'itype'},
1422                     location       => $item->{location},
1423                     borrowernumber => $borrower->{'borrowernumber'},
1424                     ccode          => $item->{'ccode'}
1425                 }
1426             );
1427
1428             # Send a checkout slip.
1429             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1430             my %conditions        = (
1431                 branchcode   => $branch,
1432                 categorycode => $borrower->{categorycode},
1433                 item_type    => $item->{itype},
1434                 notification => 'CHECKOUT',
1435             );
1436             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1437                 SendCirculationAlert(
1438                     {
1439                         type     => 'CHECKOUT',
1440                         item     => $item,
1441                         borrower => $borrower,
1442                         branch   => $branch,
1443                     }
1444                 );
1445             }
1446             logaction(
1447                 "CIRCULATION", "ISSUE",
1448                 $borrower->{'borrowernumber'},
1449                 $item->{'itemnumber'}
1450             ) if C4::Context->preference("IssueLog");
1451         }
1452     }
1453     return $issue;
1454 }
1455
1456 =head2 GetLoanLength
1457
1458   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1459
1460 Get loan length for an itemtype, a borrower type and a branch
1461
1462 =cut
1463
1464 sub GetLoanLength {
1465     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1466     my $dbh = C4::Context->dbh;
1467     my $sth = $dbh->prepare(qq{
1468         SELECT issuelength, lengthunit, renewalperiod
1469         FROM issuingrules
1470         WHERE   categorycode=?
1471             AND itemtype=?
1472             AND branchcode=?
1473             AND issuelength IS NOT NULL
1474     });
1475
1476     # try to find issuelength & return the 1st available.
1477     # check with borrowertype, itemtype and branchcode, then without one of those parameters
1478     $sth->execute( $borrowertype, $itemtype, $branchcode );
1479     my $loanlength = $sth->fetchrow_hashref;
1480
1481     return $loanlength
1482       if defined($loanlength) && defined $loanlength->{issuelength};
1483
1484     $sth->execute( $borrowertype, '*', $branchcode );
1485     $loanlength = $sth->fetchrow_hashref;
1486     return $loanlength
1487       if defined($loanlength) && defined $loanlength->{issuelength};
1488
1489     $sth->execute( '*', $itemtype, $branchcode );
1490     $loanlength = $sth->fetchrow_hashref;
1491     return $loanlength
1492       if defined($loanlength) && defined $loanlength->{issuelength};
1493
1494     $sth->execute( '*', '*', $branchcode );
1495     $loanlength = $sth->fetchrow_hashref;
1496     return $loanlength
1497       if defined($loanlength) && defined $loanlength->{issuelength};
1498
1499     $sth->execute( $borrowertype, $itemtype, '*' );
1500     $loanlength = $sth->fetchrow_hashref;
1501     return $loanlength
1502       if defined($loanlength) && defined $loanlength->{issuelength};
1503
1504     $sth->execute( $borrowertype, '*', '*' );
1505     $loanlength = $sth->fetchrow_hashref;
1506     return $loanlength
1507       if defined($loanlength) && defined $loanlength->{issuelength};
1508
1509     $sth->execute( '*', $itemtype, '*' );
1510     $loanlength = $sth->fetchrow_hashref;
1511     return $loanlength
1512       if defined($loanlength) && defined $loanlength->{issuelength};
1513
1514     $sth->execute( '*', '*', '*' );
1515     $loanlength = $sth->fetchrow_hashref;
1516     return $loanlength
1517       if defined($loanlength) && defined $loanlength->{issuelength};
1518
1519     # if no rule is set => 0 day (hardcoded)
1520     return {
1521         issuelength => 0,
1522         renewalperiod => 0,
1523         lengthunit => 'days',
1524     };
1525
1526 }
1527
1528
1529 =head2 GetHardDueDate
1530
1531   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1532
1533 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1534
1535 =cut
1536
1537 sub GetHardDueDate {
1538     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1539
1540     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1541         {   categorycode => $borrowertype,
1542             itemtype     => $itemtype,
1543             branchcode   => $branchcode
1544         }
1545     );
1546
1547
1548     if ( defined( $issuing_rule ) ) {
1549         if ( $issuing_rule->hardduedate ) {
1550             return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1551         } else {
1552             return (undef, undef);
1553         }
1554     }
1555 }
1556
1557 =head2 GetBranchBorrowerCircRule
1558
1559   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1560
1561 Retrieves circulation rule attributes that apply to the given
1562 branch and patron category, regardless of item type.  
1563 The return value is a hashref containing the following key:
1564
1565 maxissueqty - maximum number of loans that a
1566 patron of the given category can have at the given
1567 branch.  If the value is undef, no limit.
1568
1569 maxonsiteissueqty - maximum of on-site checkouts that a
1570 patron of the given category can have at the given
1571 branch.  If the value is undef, no limit.
1572
1573 This will first check for a specific branch and
1574 category match from branch_borrower_circ_rules. 
1575
1576 If no rule is found, it will then check default_branch_circ_rules
1577 (same branch, default category).  If no rule is found,
1578 it will then check default_borrower_circ_rules (default 
1579 branch, same category), then failing that, default_circ_rules
1580 (default branch, default category).
1581
1582 If no rule has been found in the database, it will default to
1583 the buillt in rule:
1584
1585 maxissueqty - undef
1586 maxonsiteissueqty - undef
1587
1588 C<$branchcode> and C<$categorycode> should contain the
1589 literal branch code and patron category code, respectively - no
1590 wildcards.
1591
1592 =cut
1593
1594 sub GetBranchBorrowerCircRule {
1595     my ( $branchcode, $categorycode ) = @_;
1596
1597     my $rules;
1598     my $dbh = C4::Context->dbh();
1599     $rules = $dbh->selectrow_hashref( q|
1600         SELECT maxissueqty, maxonsiteissueqty
1601         FROM branch_borrower_circ_rules
1602         WHERE branchcode = ?
1603         AND   categorycode = ?
1604     |, {}, $branchcode, $categorycode ) ;
1605     return $rules if $rules;
1606
1607     # try same branch, default borrower category
1608     $rules = $dbh->selectrow_hashref( q|
1609         SELECT maxissueqty, maxonsiteissueqty
1610         FROM default_branch_circ_rules
1611         WHERE branchcode = ?
1612     |, {}, $branchcode ) ;
1613     return $rules if $rules;
1614
1615     # try default branch, same borrower category
1616     $rules = $dbh->selectrow_hashref( q|
1617         SELECT maxissueqty, maxonsiteissueqty
1618         FROM default_borrower_circ_rules
1619         WHERE categorycode = ?
1620     |, {}, $categorycode ) ;
1621     return $rules if $rules;
1622
1623     # try default branch, default borrower category
1624     $rules = $dbh->selectrow_hashref( q|
1625         SELECT maxissueqty, maxonsiteissueqty
1626         FROM default_circ_rules
1627     |, {} );
1628     return $rules if $rules;
1629
1630     # built-in default circulation rule
1631     return {
1632         maxissueqty => undef,
1633         maxonsiteissueqty => undef,
1634     };
1635 }
1636
1637 =head2 GetBranchItemRule
1638
1639   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1640
1641 Retrieves circulation rule attributes that apply to the given
1642 branch and item type, regardless of patron category.
1643
1644 The return value is a hashref containing the following keys:
1645
1646 holdallowed => Hold policy for this branch and itemtype. Possible values:
1647   0: No holds allowed.
1648   1: Holds allowed only by patrons that have the same homebranch as the item.
1649   2: Holds allowed from any patron.
1650
1651 returnbranch => branch to which to return item.  Possible values:
1652   noreturn: do not return, let item remain where checked in (floating collections)
1653   homebranch: return to item's home branch
1654   holdingbranch: return to issuer branch
1655
1656 This searches branchitemrules in the following order:
1657
1658   * Same branchcode and itemtype
1659   * Same branchcode, itemtype '*'
1660   * branchcode '*', same itemtype
1661   * branchcode and itemtype '*'
1662
1663 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1664
1665 =cut
1666
1667 sub GetBranchItemRule {
1668     my ( $branchcode, $itemtype ) = @_;
1669     my $dbh = C4::Context->dbh();
1670     my $result = {};
1671
1672     my @attempts = (
1673         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1674             FROM branch_item_rules
1675             WHERE branchcode = ?
1676               AND itemtype = ?', $branchcode, $itemtype],
1677         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1678             FROM default_branch_circ_rules
1679             WHERE branchcode = ?', $branchcode],
1680         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1681             FROM default_branch_item_rules
1682             WHERE itemtype = ?', $itemtype],
1683         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1684             FROM default_circ_rules'],
1685     );
1686
1687     foreach my $attempt (@attempts) {
1688         my ($query, @bind_params) = @{$attempt};
1689         my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1690           or next;
1691
1692         # Since branch/category and branch/itemtype use the same per-branch
1693         # defaults tables, we have to check that the key we want is set, not
1694         # just that a row was returned
1695         $result->{'holdallowed'}  = $search_result->{'holdallowed'}  unless ( defined $result->{'holdallowed'} );
1696         $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1697         $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1698     }
1699     
1700     # built-in default circulation rule
1701     $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1702     $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1703     $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1704
1705     return $result;
1706 }
1707
1708 =head2 AddReturn
1709
1710   ($doreturn, $messages, $iteminformation, $borrower) =
1711       &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1712
1713 Returns a book.
1714
1715 =over 4
1716
1717 =item C<$barcode> is the bar code of the book being returned.
1718
1719 =item C<$branch> is the code of the branch where the book is being returned.
1720
1721 =item C<$exemptfine> indicates that overdue charges for the item will be
1722 removed. Optional.
1723
1724 =item C<$dropbox> indicates that the check-in date is assumed to be
1725 yesterday, or the last non-holiday as defined in C4::Calendar .  If
1726 overdue charges are applied and C<$dropbox> is true, the last charge
1727 will be removed.  This assumes that the fines accrual script has run
1728 for _today_. Optional.
1729
1730 =item C<$return_date> allows the default return date to be overridden
1731 by the given return date. Optional.
1732
1733 =back
1734
1735 C<&AddReturn> returns a list of four items:
1736
1737 C<$doreturn> is true iff the return succeeded.
1738
1739 C<$messages> is a reference-to-hash giving feedback on the operation.
1740 The keys of the hash are:
1741
1742 =over 4
1743
1744 =item C<BadBarcode>
1745
1746 No item with this barcode exists. The value is C<$barcode>.
1747
1748 =item C<NotIssued>
1749
1750 The book is not currently on loan. The value is C<$barcode>.
1751
1752 =item C<withdrawn>
1753
1754 This book has been withdrawn/cancelled. The value should be ignored.
1755
1756 =item C<Wrongbranch>
1757
1758 This book has was returned to the wrong branch.  The value is a hashref
1759 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1760 contain the branchcode of the incorrect and correct return library, respectively.
1761
1762 =item C<ResFound>
1763
1764 The item was reserved. The value is a reference-to-hash whose keys are
1765 fields from the reserves table of the Koha database, and
1766 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1767 either C<Waiting>, C<Reserved>, or 0.
1768
1769 =item C<WasReturned>
1770
1771 Value 1 if return is successful.
1772
1773 =item C<NeedsTransfer>
1774
1775 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1776
1777 =back
1778
1779 C<$iteminformation> is a reference-to-hash, giving information about the
1780 returned item from the issues table.
1781
1782 C<$borrower> is a reference-to-hash, giving information about the
1783 patron who last borrowed the book.
1784
1785 =cut
1786
1787 sub AddReturn {
1788     my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1789
1790     if ($branch and not Koha::Libraries->find($branch)) {
1791         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1792         undef $branch;
1793     }
1794     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1795     my $messages;
1796     my $patron;
1797     my $doreturn       = 1;
1798     my $validTransfert = 0;
1799     my $stat_type = 'return';
1800
1801     # get information on item
1802     my $item = GetItem( undef, $barcode );
1803     unless ($item) {
1804         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1805     }
1806
1807     my $itemnumber = $item->{ itemnumber };
1808     my $itemtype = $item->{itype}; # GetItem called effective_itemtype
1809
1810     my $issue  = Koha::Checkouts->find( { itemnumber => $itemnumber } );
1811     if ( $issue ) {
1812         $patron = Koha::Patrons->find( $issue->borrowernumber )
1813             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1814                 . Dumper($issue->unblessed) . "\n";
1815     } else {
1816         $messages->{'NotIssued'} = $barcode;
1817         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1818         $doreturn = 0;
1819         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1820         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1821         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1822            $messages->{'LocalUse'} = 1;
1823            $stat_type = 'localuse';
1824         }
1825     }
1826
1827     if ( $item->{'location'} eq 'PROC' ) {
1828         if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1829             $item->{'location'} = 'CART';
1830         }
1831         else {
1832             $item->{location} = $item->{permanent_location};
1833         }
1834
1835         ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'}, { log_action => 0 } );
1836     }
1837
1838         # full item data, but no borrowernumber or checkout info (no issue)
1839     my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1840         # get the proper branch to which to return the item
1841     my $returnbranch = $item->{$hbr} || $branch ;
1842         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1843
1844     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
1845     my $patron_unblessed = $patron ? $patron->unblessed : {};
1846
1847     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1848     if ($yaml) {
1849         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
1850         my $rules;
1851         eval { $rules = YAML::Load($yaml); };
1852         if ($@) {
1853             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1854         }
1855         else {
1856             foreach my $key ( keys %$rules ) {
1857                 if ( $item->{notforloan} eq $key ) {
1858                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1859                     ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1860                     last;
1861                 }
1862             }
1863         }
1864     }
1865
1866     # check if the return is allowed at this branch
1867     my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1868     unless ($returnallowed){
1869         $messages->{'Wrongbranch'} = {
1870             Wrongbranch => $branch,
1871             Rightbranch => $message
1872         };
1873         $doreturn = 0;
1874         return ( $doreturn, $messages, $issue, $patron_unblessed);
1875     }
1876
1877     if ( $item->{'withdrawn'} ) { # book has been cancelled
1878         $messages->{'withdrawn'} = 1;
1879         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1880     }
1881
1882     if ( $item->{itemlost} and C4::Context->preference("BlockReturnOfLostItems") ) {
1883         $doreturn = 0;
1884     }
1885
1886     # case of a return of document (deal with issues and holdingbranch)
1887     my $today = DateTime->now( time_zone => C4::Context->tz() );
1888
1889     if ($doreturn) {
1890         my $is_overdue;
1891         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1892         $patron or warn "AddReturn without current borrower";
1893                 my $circControlBranch;
1894         if ($dropbox) {
1895             # define circControlBranch only if dropbox mode is set
1896             # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1897             # FIXME: check issuedate > returndate, factoring in holidays
1898
1899             $circControlBranch = _GetCircControlBranch($item,$patron_unblessed);
1900             $is_overdue = $issue->is_overdue( $dropboxdate );
1901         } else {
1902             $is_overdue = $issue->is_overdue;
1903         }
1904
1905         if ($patron) {
1906             eval {
1907                 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1908                     $circControlBranch, $return_date, $patron->privacy );
1909             };
1910             unless ( $@ ) {
1911                 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue ) || $return_date ) {
1912                     _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed, return_date => $return_date } );
1913                 }
1914             } else {
1915                 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 );
1916
1917                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1918             }
1919
1920             # FIXME is the "= 1" right?  This could be the borrower hash.
1921             $messages->{'WasReturned'} = 1;
1922
1923         }
1924
1925         ModItem( { onloan => undef }, $item->{biblionumber}, $item->{itemnumber}, { log_action => 0 } );
1926     }
1927
1928     # the holdingbranch is updated if the document is returned to another location.
1929     # this is always done regardless of whether the item was on loan or not
1930     my $item_holding_branch = $item->{ holdingbranch };
1931     if ($item->{'holdingbranch'} ne $branch) {
1932         UpdateHoldingbranch($branch, $item->{'itemnumber'});
1933         $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1934     }
1935     ModDateLastSeen( $item->{'itemnumber'} );
1936
1937     # check if we have a transfer for this document
1938     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1939
1940     # if we have a transfer to do, we update the line of transfers with the datearrived
1941     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1942     if ($datesent) {
1943         if ( $tobranch eq $branch ) {
1944             my $sth = C4::Context->dbh->prepare(
1945                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1946             );
1947             $sth->execute( $item->{'itemnumber'} );
1948             # if we have a reservation with valid transfer, we can set it's status to 'W'
1949             ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1950             C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1951         } else {
1952             $messages->{'WrongTransfer'}     = $tobranch;
1953             $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1954         }
1955         $validTransfert = 1;
1956     } else {
1957         ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1958     }
1959
1960     # fix up the accounts.....
1961     if ( $item->{'itemlost'} ) {
1962         $messages->{'WasLost'} = 1;
1963         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
1964             if (
1965                 Koha::RefundLostItemFeeRules->should_refund(
1966                     {
1967                         current_branch      => C4::Context->userenv->{branch},
1968                         item_home_branch    => $item->{homebranch},
1969                         item_holding_branch => $item_holding_branch
1970                     }
1971                 )
1972               )
1973             {
1974                 _FixAccountForLostAndReturned( $item->{'itemnumber'},
1975                     $borrowernumber, $barcode );
1976                 $messages->{'LostItemFeeRefunded'} = 1;
1977             }
1978         }
1979     }
1980
1981     # fix up the overdues in accounts...
1982     if ($borrowernumber) {
1983         my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1984         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!";  # zero is OK, check defined
1985
1986         if ( $issue and $issue->is_overdue ) {
1987         # fix fine days
1988             $today = $dropboxdate if $dropbox;
1989             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item, dt_from_string($issue->date_due), $today );
1990             if ($reminder){
1991                 $messages->{'PrevDebarred'} = $debardate;
1992             } else {
1993                 $messages->{'Debarred'} = $debardate if $debardate;
1994             }
1995         # there's no overdue on the item but borrower had been previously debarred
1996         } elsif ( $issue->date_due and $patron->debarred ) {
1997              if ( $patron->debarred eq "9999-12-31") {
1998                 $messages->{'ForeverDebarred'} = $patron->debarred;
1999              } else {
2000                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2001                   $borrower_debar_dt->truncate(to => 'day');
2002                   my $today_dt = $today->clone()->truncate(to => 'day');
2003                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2004                       $messages->{'PrevDebarred'} = $patron->debarred;
2005                   }
2006              }
2007         }
2008     }
2009
2010     # find reserves.....
2011     # if we don't have a reserve with the status W, we launch the Checkreserves routine
2012     my ($resfound, $resrec);
2013     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2014     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2015     if ($resfound) {
2016           $resrec->{'ResFound'} = $resfound;
2017         $messages->{'ResFound'} = $resrec;
2018     }
2019
2020     # Record the fact that this book was returned.
2021     UpdateStats({
2022         branch         => $branch,
2023         type           => $stat_type,
2024         itemnumber     => $itemnumber,
2025         itemtype       => $itemtype,
2026         borrowernumber => $borrowernumber,
2027         ccode          => $item->{ ccode }
2028     });
2029
2030     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2031     if ( $patron ) {
2032         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2033         my %conditions = (
2034             branchcode   => $branch,
2035             categorycode => $patron->categorycode,
2036             item_type    => $item->{itype},
2037             notification => 'CHECKIN',
2038         );
2039         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2040             SendCirculationAlert({
2041                 type     => 'CHECKIN',
2042                 item     => $item,
2043                 borrower => $patron->unblessed,
2044                 branch   => $branch,
2045             });
2046         }
2047
2048         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2049             if C4::Context->preference("ReturnLog");
2050         }
2051
2052     # Remove any OVERDUES related debarment if the borrower has no overdues
2053     if ( $borrowernumber
2054       && $patron->debarred
2055       && C4::Context->preference('AutoRemoveOverduesRestrictions')
2056       && !Koha::Patrons->find( $borrowernumber )->has_overdues
2057       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2058     ) {
2059         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2060     }
2061
2062     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2063     if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2064         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2065             (C4::Context->preference("UseBranchTransferLimits") and
2066              ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2067            )) {
2068             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2069             $debug and warn "item: " . Dumper($item);
2070             ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2071             $messages->{'WasTransfered'} = 1;
2072         } else {
2073             $messages->{'NeedsTransfer'} = $returnbranch;
2074         }
2075     }
2076
2077     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2078 }
2079
2080 =head2 MarkIssueReturned
2081
2082   MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2083
2084 Unconditionally marks an issue as being returned by
2085 moving the C<issues> row to C<old_issues> and
2086 setting C<returndate> to the current date, or
2087 the last non-holiday date of the branccode specified in
2088 C<dropbox_branch> .  Assumes you've already checked that 
2089 it's safe to do this, i.e. last non-holiday > issuedate.
2090
2091 if C<$returndate> is specified (in iso format), it is used as the date
2092 of the return. It is ignored when a dropbox_branch is passed in.
2093
2094 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2095 the old_issue is immediately anonymised
2096
2097 Ideally, this function would be internal to C<C4::Circulation>,
2098 not exported, but it is currently needed by one 
2099 routine in C<C4::Accounts>.
2100
2101 =cut
2102
2103 sub MarkIssueReturned {
2104     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2105
2106
2107     # Retrieve the issue
2108     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2109     my $issue_id = $issue->issue_id;
2110
2111     my $anonymouspatron;
2112     if ( $privacy == 2 ) {
2113         # The default of 0 will not work due to foreign key constraints
2114         # The anonymisation will fail if AnonymousPatron is not a valid entry
2115         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2116         # Note that a warning should appear on the about page (System information tab).
2117         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2118         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."
2119             unless Koha::Patrons->find( $anonymouspatron );
2120     }
2121     my $database = Koha::Database->new();
2122     my $schema   = $database->schema;
2123     my $dbh   = C4::Context->dbh;
2124
2125     my $query = 'UPDATE issues SET returndate=';
2126     my @bind;
2127     if ($dropbox_branch) {
2128         my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2129         my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2130         $query .= ' ? ';
2131         push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2132     } elsif ($returndate) {
2133         $query .= ' ? ';
2134         push @bind, $returndate;
2135     } else {
2136         $query .= ' now() ';
2137     }
2138     $query .= ' WHERE issue_id = ?';
2139     push @bind, $issue_id;
2140
2141     # FIXME Improve the return value and handle it from callers
2142     $schema->txn_do(sub {
2143
2144         # Update the returndate
2145         $dbh->do( $query, undef, @bind );
2146
2147         # We just updated the returndate, so we need to refetch $issue
2148         $issue->discard_changes;
2149
2150         # Create the old_issues entry
2151         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2152
2153         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2154         if ( $privacy == 2) {
2155             $dbh->do(q|UPDATE old_issues SET borrowernumber=? WHERE issue_id = ?|, undef, $anonymouspatron, $old_checkout->issue_id);
2156         }
2157
2158         # And finally delete the issue
2159         $issue->delete;
2160
2161         ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2162
2163         if ( C4::Context->preference('StoreLastBorrower') ) {
2164             my $item = Koha::Items->find( $itemnumber );
2165             my $patron = Koha::Patrons->find( $borrowernumber );
2166             $item->last_returned_by( $patron );
2167         }
2168     });
2169
2170     return $issue_id;
2171 }
2172
2173 =head2 _debar_user_on_return
2174
2175     _debar_user_on_return($borrower, $item, $datedue, today);
2176
2177 C<$borrower> borrower hashref
2178
2179 C<$item> item hashref
2180
2181 C<$datedue> date due DateTime object
2182
2183 C<$return_date> DateTime object representing the return time
2184
2185 Internal function, called only by AddReturn that calculates and updates
2186  the user fine days, and debars them if necessary.
2187
2188 Should only be called for overdue returns
2189
2190 =cut
2191
2192 sub _debar_user_on_return {
2193     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2194
2195     my $branchcode = _GetCircControlBranch( $item, $borrower );
2196
2197     my $circcontrol = C4::Context->preference('CircControl');
2198     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2199         {   categorycode => $borrower->{categorycode},
2200             itemtype     => $item->{itype},
2201             branchcode   => $branchcode
2202         }
2203     );
2204     my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2205     my $unit     = $issuing_rule ? $issuing_rule->lengthunit : undef;
2206     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2207
2208     if ($finedays) {
2209
2210         # finedays is in days, so hourly loans must multiply by 24
2211         # thus 1 hour late equals 1 day suspension * finedays rate
2212         $finedays = $finedays * 24 if ( $unit eq 'hours' );
2213
2214         # grace period is measured in the same units as the loan
2215         my $grace =
2216           DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2217
2218         my $deltadays = DateTime::Duration->new(
2219             days => $chargeable_units
2220         );
2221         if ( $deltadays->subtract($grace)->is_positive() ) {
2222             my $suspension_days = $deltadays * $finedays;
2223
2224             # If the max suspension days is < than the suspension days
2225             # the suspension days is limited to this maximum period.
2226             my $max_sd = $issuing_rule->maxsuspensiondays;
2227             if ( defined $max_sd ) {
2228                 $max_sd = DateTime::Duration->new( days => $max_sd );
2229                 $suspension_days = $max_sd
2230                   if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2231             }
2232
2233             my ( $has_been_extended, $is_a_reminder );
2234             if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2235                 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2236                 if ( $debarment ) {
2237                     $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2238                     $has_been_extended = 1;
2239                 }
2240             }
2241
2242             if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2243                 # No need to / 1 and do not consider / 0
2244                 $suspension_days = DateTime::Duration->new(
2245                     days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2246                 );
2247             }
2248
2249             my $new_debar_dt =
2250               $return_date->clone()->add_duration( $suspension_days );
2251
2252             Koha::Patron::Debarments::AddUniqueDebarment({
2253                 borrowernumber => $borrower->{borrowernumber},
2254                 expiration     => $new_debar_dt->ymd(),
2255                 type           => 'SUSPENSION',
2256             });
2257             # if borrower was already debarred but does not get an extra debarment
2258             my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2259             my $new_debarment_str;
2260             if ( $borrower->{debarred} eq $patron->is_debarred ) {
2261                 $is_a_reminder = 1;
2262                 $new_debarment_str = $borrower->{debarred};
2263             } else {
2264                 $new_debarment_str = $new_debar_dt->ymd();
2265             }
2266             # FIXME Should return a DateTime object
2267             return $new_debarment_str, $is_a_reminder;
2268         }
2269     }
2270     return;
2271 }
2272
2273 =head2 _FixOverduesOnReturn
2274
2275    &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2276
2277 C<$brn> borrowernumber
2278
2279 C<$itm> itemnumber
2280
2281 C<$exemptfine> BOOL -- remove overdue charge associated with this issue. 
2282 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2283
2284 Internal function, called only by AddReturn
2285
2286 =cut
2287
2288 sub _FixOverduesOnReturn {
2289     my ($borrowernumber, $item);
2290     unless ($borrowernumber = shift) {
2291         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2292         return;
2293     }
2294     unless ($item = shift) {
2295         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2296         return;
2297     }
2298     my ($exemptfine, $dropbox) = @_;
2299     my $dbh = C4::Context->dbh;
2300
2301     # check for overdue fine
2302     my $accountline = Koha::Account::Lines->search(
2303         {
2304             borrowernumber => $borrowernumber,
2305             itemnumber     => $item,
2306             -or            => [
2307                 accounttype => 'FU',
2308                 accounttype => 'O',
2309             ],
2310         }
2311     )->next();
2312     return 0 unless $accountline;    # no warning, there's just nothing to fix
2313
2314     my $uquery;
2315     if ($exemptfine) {
2316         my $amountoutstanding = $accountline->amountoutstanding;
2317
2318         $accountline->accounttype('FFOR');
2319         $accountline->amountoutstanding(0);
2320
2321         Koha::Account::Offset->new(
2322             {
2323                 debit_id => $accountline->id,
2324                 type => 'Forgiven',
2325                 amount => $amountoutstanding * -1,
2326             }
2327         );
2328
2329         if (C4::Context->preference("FinesLog")) {
2330             &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2331         }
2332     } elsif ($dropbox && $accountline->lastincrement) {
2333         my $outstanding = $accountline->amountoutstanding - $accountline->lastincrement;
2334         my $amt = $accountline->amount - $accountline->lastincrement;
2335
2336         Koha::Account::Offset->new(
2337             {
2338                 debit_id => $accountline->id,
2339                 type => 'Dropbox',
2340                 amount => $accountline->lastincrement * -1,
2341             }
2342         );
2343
2344         if ( C4::Context->preference("FinesLog") ) {
2345             &logaction( "FINES", 'MODIFY', $borrowernumber,
2346                 "Dropbox adjustment $amt, item $item" );
2347         }
2348
2349         $accountline->accounttype('F');
2350
2351         if ( $outstanding >= 0 && $amt >= 0 ) {
2352             $accountline->amount($amt);
2353             $accountline->amountoutstanding($outstanding);
2354         }
2355
2356     } else {
2357         $accountline->accounttype('F');
2358     }
2359
2360     return $accountline->store();
2361 }
2362
2363 =head2 _FixAccountForLostAndReturned
2364
2365   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2366
2367 Calculates the charge for a book lost and returned.
2368
2369 Internal function, not exported, called only by AddReturn.
2370
2371 =cut
2372
2373 sub _FixAccountForLostAndReturned {
2374     my $itemnumber     = shift or return;
2375     my $borrowernumber = @_ ? shift : undef;
2376     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2377
2378     # check for charge made for lost book
2379     my $accountline = Koha::Account::Lines->search(
2380         {
2381             itemnumber  => $itemnumber,
2382             accounttype => { -in => [ 'L', 'Rep', 'W' ] },
2383         },
2384         {
2385             order_by => { -desc => [ 'date', 'accountno' ] }
2386         }
2387     )->next();
2388
2389     return unless $accountline;
2390     return if $accountline->accounttype eq 'W';    # Written off
2391
2392     $accountline->accounttype('LR');
2393     $accountline->store();
2394
2395     my $account = Koha::Account->new( { patron_id => $accountline->borrowernumber } );
2396     my $credit_id = $account->pay(
2397         {
2398             amount       => $accountline->amount,
2399             description  => "Item Returned " . $item_id,
2400             account_type => 'CR',
2401             offset_type  => 'Lost Item Return',
2402             accounlines  => [$accountline],
2403
2404         }
2405     );
2406
2407     ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2408
2409     return $credit_id;
2410 }
2411
2412 =head2 _GetCircControlBranch
2413
2414    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2415
2416 Internal function : 
2417
2418 Return the library code to be used to determine which circulation
2419 policy applies to a transaction.  Looks up the CircControl and
2420 HomeOrHoldingBranch system preferences.
2421
2422 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2423
2424 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2425
2426 =cut
2427
2428 sub _GetCircControlBranch {
2429     my ($item, $borrower) = @_;
2430     my $circcontrol = C4::Context->preference('CircControl');
2431     my $branch;
2432
2433     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2434         $branch= C4::Context->userenv->{'branch'};
2435     } elsif ($circcontrol eq 'PatronLibrary') {
2436         $branch=$borrower->{branchcode};
2437     } else {
2438         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2439         $branch = $item->{$branchfield};
2440         # default to item home branch if holdingbranch is used
2441         # and is not defined
2442         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2443             $branch = $item->{homebranch};
2444         }
2445     }
2446     return $branch;
2447 }
2448
2449 =head2 GetOpenIssue
2450
2451   $issue = GetOpenIssue( $itemnumber );
2452
2453 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2454
2455 C<$itemnumber> is the item's itemnumber
2456
2457 Returns a hashref
2458
2459 =cut
2460
2461 sub GetOpenIssue {
2462   my ( $itemnumber ) = @_;
2463   return unless $itemnumber;
2464   my $dbh = C4::Context->dbh;  
2465   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2466   $sth->execute( $itemnumber );
2467   return $sth->fetchrow_hashref();
2468
2469 }
2470
2471 =head2 GetBiblioIssues
2472
2473   $issues = GetBiblioIssues($biblionumber);
2474
2475 this function get all issues from a biblionumber.
2476
2477 Return:
2478 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2479 tables issues and the firstname,surname & cardnumber from borrowers.
2480
2481 =cut
2482
2483 sub GetBiblioIssues {
2484     my $biblionumber = shift;
2485     return unless $biblionumber;
2486     my $dbh   = C4::Context->dbh;
2487     my $query = "
2488         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2489         FROM issues
2490             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2491             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2492             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2493             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2494         WHERE biblio.biblionumber = ?
2495         UNION ALL
2496         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2497         FROM old_issues
2498             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2499             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2500             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2501             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2502         WHERE biblio.biblionumber = ?
2503         ORDER BY timestamp
2504     ";
2505     my $sth = $dbh->prepare($query);
2506     $sth->execute($biblionumber, $biblionumber);
2507
2508     my @issues;
2509     while ( my $data = $sth->fetchrow_hashref ) {
2510         push @issues, $data;
2511     }
2512     return \@issues;
2513 }
2514
2515 =head2 GetUpcomingDueIssues
2516
2517   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2518
2519 =cut
2520
2521 sub GetUpcomingDueIssues {
2522     my $params = shift;
2523
2524     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2525     my $dbh = C4::Context->dbh;
2526
2527     my $statement = <<END_SQL;
2528 SELECT *
2529 FROM (
2530     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2531     FROM issues
2532     LEFT JOIN items USING (itemnumber)
2533     LEFT OUTER JOIN branches USING (branchcode)
2534     WHERE returndate is NULL
2535 ) tmp
2536 WHERE days_until_due >= 0 AND days_until_due <= ?
2537 END_SQL
2538
2539     my @bind_parameters = ( $params->{'days_in_advance'} );
2540     
2541     my $sth = $dbh->prepare( $statement );
2542     $sth->execute( @bind_parameters );
2543     my $upcoming_dues = $sth->fetchall_arrayref({});
2544
2545     return $upcoming_dues;
2546 }
2547
2548 =head2 CanBookBeRenewed
2549
2550   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2551
2552 Find out whether a borrowed item may be renewed.
2553
2554 C<$borrowernumber> is the borrower number of the patron who currently
2555 has the item on loan.
2556
2557 C<$itemnumber> is the number of the item to renew.
2558
2559 C<$override_limit>, if supplied with a true value, causes
2560 the limit on the number of times that the loan can be renewed
2561 (as controlled by the item type) to be ignored. Overriding also allows
2562 to renew sooner than "No renewal before" and to manually renew loans
2563 that are automatically renewed.
2564
2565 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2566 item must currently be on loan to the specified borrower; renewals
2567 must be allowed for the item's type; and the borrower must not have
2568 already renewed the loan. $error will contain the reason the renewal can not proceed
2569
2570 =cut
2571
2572 sub CanBookBeRenewed {
2573     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2574
2575     my $dbh    = C4::Context->dbh;
2576     my $renews = 1;
2577
2578     my $item      = GetItem($itemnumber)      or return ( 0, 'no_item' );
2579     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return ( 0, 'no_checkout' );
2580     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2581
2582     $borrowernumber ||= $issue->borrowernumber;
2583     my $patron = Koha::Patrons->find( $borrowernumber )
2584       or return;
2585
2586     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2587
2588     # This item can fill one or more unfilled reserve, can those unfilled reserves
2589     # all be filled by other available items?
2590     if ( $resfound
2591         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2592     {
2593         my $schema = Koha::Database->new()->schema();
2594
2595         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2596         if ($item_holds) {
2597             # There is an item level hold on this item, no other item can fill the hold
2598             $resfound = 1;
2599         }
2600         else {
2601
2602             # Get all other items that could possibly fill reserves
2603             my @itemnumbers = $schema->resultset('Item')->search(
2604                 {
2605                     biblionumber => $resrec->{biblionumber},
2606                     onloan       => undef,
2607                     notforloan   => 0,
2608                     -not         => { itemnumber => $itemnumber }
2609                 },
2610                 { columns => 'itemnumber' }
2611             )->get_column('itemnumber')->all();
2612
2613             # Get all other reserves that could have been filled by this item
2614             my @borrowernumbers;
2615             while (1) {
2616                 my ( $reserve_found, $reserve, undef ) =
2617                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2618
2619                 if ($reserve_found) {
2620                     push( @borrowernumbers, $reserve->{borrowernumber} );
2621                 }
2622                 else {
2623                     last;
2624                 }
2625             }
2626
2627             # If the count of the union of the lists of reservable items for each borrower
2628             # is equal or greater than the number of borrowers, we know that all reserves
2629             # can be filled with available items. We can get the union of the sets simply
2630             # by pushing all the elements onto an array and removing the duplicates.
2631             my @reservable;
2632             my %borrowers;
2633             ITEM: foreach my $i (@itemnumbers) {
2634                 my $item = GetItem($i);
2635                 next if IsItemOnHoldAndFound($i);
2636                 for my $b (@borrowernumbers) {
2637                     my $borr = $borrowers{$b} //= Koha::Patrons->find( $b )->unblessed;
2638                     next unless IsAvailableForItemLevelRequest($item, $borr);
2639                     next unless CanItemBeReserved($b,$i);
2640
2641                     push @reservable, $i;
2642                     if (@reservable >= @borrowernumbers) {
2643                         $resfound = 0;
2644                         last ITEM;
2645                     }
2646                     last;
2647                 }
2648             }
2649         }
2650     }
2651     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2652
2653     return ( 1, undef ) if $override_limit;
2654
2655     my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2656     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2657         {   categorycode => $patron->categorycode,
2658             itemtype     => $item->{itype},
2659             branchcode   => $branchcode
2660         }
2661     );
2662
2663     return ( 0, "too_many" )
2664       if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2665
2666     my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2667     my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2668     $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2669     my $restricted  = $patron->is_debarred;
2670     my $hasoverdues = $patron->has_overdues;
2671
2672     if ( $restricted and $restrictionblockrenewing ) {
2673         return ( 0, 'restriction');
2674     } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2675         return ( 0, 'overdue');
2676     }
2677
2678     if ( $issue->auto_renew ) {
2679
2680         if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2681             return ( 0, 'auto_account_expired' );
2682         }
2683
2684         if ( defined $issuing_rule->no_auto_renewal_after
2685                 and $issuing_rule->no_auto_renewal_after ne "" ) {
2686             # Get issue_date and add no_auto_renewal_after
2687             # If this is greater than today, it's too late for renewal.
2688             my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2689             $maximum_renewal_date->add(
2690                 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2691             );
2692             my $now = dt_from_string;
2693             if ( $now >= $maximum_renewal_date ) {
2694                 return ( 0, "auto_too_late" );
2695             }
2696         }
2697         if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2698                       and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2699             # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2700             if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2701                 return ( 0, "auto_too_late" );
2702             }
2703         }
2704
2705         if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2706             my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2707             my $amountoutstanding = $patron->account->balance;
2708             if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2709                 return ( 0, "auto_too_much_oweing" );
2710             }
2711         }
2712     }
2713
2714     if ( defined $issuing_rule->norenewalbefore
2715         and $issuing_rule->norenewalbefore ne "" )
2716     {
2717
2718         # Calculate soonest renewal by subtracting 'No renewal before' from due date
2719         my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2720             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2721
2722         # Depending on syspref reset the exact time, only check the date
2723         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2724             and $issuing_rule->lengthunit eq 'days' )
2725         {
2726             $soonestrenewal->truncate( to => 'day' );
2727         }
2728
2729         if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2730         {
2731             return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2732             return ( 0, "too_soon" );
2733         }
2734         elsif ( $issue->auto_renew ) {
2735             return ( 0, "auto_renew" );
2736         }
2737     }
2738
2739     # Fallback for automatic renewals:
2740     # If norenewalbefore is undef, don't renew before due date.
2741     if ( $issue->auto_renew ) {
2742         my $now = dt_from_string;
2743         return ( 0, "auto_renew" )
2744           if $now >= dt_from_string( $issue->date_due, 'sql' );
2745         return ( 0, "auto_too_soon" );
2746     }
2747
2748     return ( 1, undef );
2749 }
2750
2751 =head2 AddRenewal
2752
2753   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2754
2755 Renews a loan.
2756
2757 C<$borrowernumber> is the borrower number of the patron who currently
2758 has the item.
2759
2760 C<$itemnumber> is the number of the item to renew.
2761
2762 C<$branch> is the library where the renewal took place (if any).
2763            The library that controls the circ policies for the renewal is retrieved from the issues record.
2764
2765 C<$datedue> can be a DateTime object used to set the due date.
2766
2767 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2768 this parameter is not supplied, lastreneweddate is set to the current date.
2769
2770 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2771 from the book's item type.
2772
2773 =cut
2774
2775 sub AddRenewal {
2776     my $borrowernumber  = shift;
2777     my $itemnumber      = shift or return;
2778     my $branch          = shift;
2779     my $datedue         = shift;
2780     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2781
2782     my $item   = GetItem($itemnumber) or return;
2783     my $item_object = Koha::Items->find( $itemnumber ); # Should replace $item
2784     my $biblio = $item_object->biblio;
2785
2786     my $dbh = C4::Context->dbh;
2787
2788     # Find the issues record for this book
2789     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
2790
2791     return unless $issue;
2792
2793     $borrowernumber ||= $issue->borrowernumber;
2794
2795     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2796         carp 'Invalid date passed to AddRenewal.';
2797         return;
2798     }
2799
2800     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2801     my $patron_unblessed = $patron->unblessed;
2802
2803     if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2804         _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $patron_unblessed } );
2805     }
2806     _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2807
2808     # If the due date wasn't specified, calculate it by adding the
2809     # book's loan length to today's date or the current due date
2810     # based on the value of the RenewalPeriodBase syspref.
2811     unless ($datedue) {
2812
2813         my $itemtype = $item_object->effective_itemtype;
2814         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2815                                         dt_from_string( $issue->date_due, 'sql' ) :
2816                                         DateTime->now( time_zone => C4::Context->tz());
2817         $datedue =  CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $patron_unblessed), $patron_unblessed, 'is a renewal');
2818     }
2819
2820     # Update the issues record to have the new due date, and a new count
2821     # of how many times it has been renewed.
2822     my $renews = $issue->renewals + 1;
2823     my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2824                             WHERE borrowernumber=? 
2825                             AND itemnumber=?"
2826     );
2827
2828     $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2829
2830     # Update the renewal count on the item, and tell zebra to reindex
2831     $renews = $item->{renewals} + 1;
2832     ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item->{biblionumber}, $itemnumber, { log_action => 0 } );
2833
2834     # Charge a new rental fee, if applicable?
2835     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2836     if ( $charge > 0 ) {
2837         my $accountno = getnextacctno( $borrowernumber );
2838         my $manager_id = 0;
2839         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv; 
2840         $sth = $dbh->prepare(
2841                 "INSERT INTO accountlines
2842                     (date, borrowernumber, accountno, amount, manager_id,
2843                     description,accounttype, amountoutstanding, itemnumber)
2844                     VALUES (now(),?,?,?,?,?,?,?,?)"
2845         );
2846         $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2847             "Renewal of Rental Item " . $biblio->title . " $item->{'barcode'}",
2848             'Rent', $charge, $itemnumber );
2849     }
2850
2851     # Send a renewal slip according to checkout alert preferencei
2852     if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2853         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2854         my %conditions        = (
2855             branchcode   => $branch,
2856             categorycode => $patron->categorycode,
2857             item_type    => $item->{itype},
2858             notification => 'CHECKOUT',
2859         );
2860         if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2861             SendCirculationAlert(
2862                 {
2863                     type     => 'RENEWAL',
2864                     item     => $item,
2865                     borrower => $patron->unblessed,
2866                     branch   => $branch,
2867                 }
2868             );
2869         }
2870     }
2871
2872     # Remove any OVERDUES related debarment if the borrower has no overdues
2873     if ( $patron
2874       && $patron->is_debarred
2875       && ! $patron->has_overdues
2876       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2877     ) {
2878         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2879     }
2880
2881     unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2882         $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2883     }
2884
2885     # Add the renewal to stats
2886     UpdateStats(
2887         {
2888             branch         => $branch,
2889             type           => 'renew',
2890             amount         => $charge,
2891             itemnumber     => $itemnumber,
2892             itemtype       => $item->{itype},
2893             location       => $item->{location},
2894             borrowernumber => $borrowernumber,
2895             ccode          => $item->{'ccode'}
2896         }
2897     );
2898
2899     #Log the renewal
2900     logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2901     return $datedue;
2902 }
2903
2904 sub GetRenewCount {
2905     # check renewal status
2906     my ( $bornum, $itemno ) = @_;
2907     my $dbh           = C4::Context->dbh;
2908     my $renewcount    = 0;
2909     my $renewsallowed = 0;
2910     my $renewsleft    = 0;
2911
2912     my $patron = Koha::Patrons->find( $bornum );
2913     my $item     = GetItem($itemno);
2914
2915     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2916
2917     # Look in the issues table for this item, lent to this borrower,
2918     # and not yet returned.
2919
2920     # FIXME - I think this function could be redone to use only one SQL call.
2921     my $sth = $dbh->prepare(
2922         "select * from issues
2923                                 where (borrowernumber = ?)
2924                                 and (itemnumber = ?)"
2925     );
2926     $sth->execute( $bornum, $itemno );
2927     my $data = $sth->fetchrow_hashref;
2928     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2929     # $item and $borrower should be calculated
2930     my $branchcode = _GetCircControlBranch($item, $patron->unblessed);
2931
2932     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2933         {   categorycode => $patron->categorycode,
2934             itemtype     => $item->{itype},
2935             branchcode   => $branchcode
2936         }
2937     );
2938
2939     $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
2940     $renewsleft    = $renewsallowed - $renewcount;
2941     if($renewsleft < 0){ $renewsleft = 0; }
2942     return ( $renewcount, $renewsallowed, $renewsleft );
2943 }
2944
2945 =head2 GetSoonestRenewDate
2946
2947   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2948
2949 Find out the soonest possible renew date of a borrowed item.
2950
2951 C<$borrowernumber> is the borrower number of the patron who currently
2952 has the item on loan.
2953
2954 C<$itemnumber> is the number of the item to renew.
2955
2956 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2957 renew date, based on the value "No renewal before" of the applicable
2958 issuing rule. Returns the current date if the item can already be
2959 renewed, and returns undefined if the borrower, loan, or item
2960 cannot be found.
2961
2962 =cut
2963
2964 sub GetSoonestRenewDate {
2965     my ( $borrowernumber, $itemnumber ) = @_;
2966
2967     my $dbh = C4::Context->dbh;
2968
2969     my $item      = GetItem($itemnumber)      or return;
2970     my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2971
2972     $borrowernumber ||= $itemissue->borrowernumber;
2973     my $patron = Koha::Patrons->find( $borrowernumber )
2974       or return;
2975
2976     my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
2977     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2978         {   categorycode => $patron->categorycode,
2979             itemtype     => $item->{itype},
2980             branchcode   => $branchcode
2981         }
2982     );
2983
2984     my $now = dt_from_string;
2985     return $now unless $issuing_rule;
2986
2987     if ( defined $issuing_rule->norenewalbefore
2988         and $issuing_rule->norenewalbefore ne "" )
2989     {
2990         my $soonestrenewal =
2991           dt_from_string( $itemissue->date_due )->subtract(
2992             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2993
2994         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2995             and $issuing_rule->lengthunit eq 'days' )
2996         {
2997             $soonestrenewal->truncate( to => 'day' );
2998         }
2999         return $soonestrenewal if $now < $soonestrenewal;
3000     }
3001     return $now;
3002 }
3003
3004 =head2 GetLatestAutoRenewDate
3005
3006   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3007
3008 Find out the latest possible auto renew date of a borrowed item.
3009
3010 C<$borrowernumber> is the borrower number of the patron who currently
3011 has the item on loan.
3012
3013 C<$itemnumber> is the number of the item to renew.
3014
3015 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3016 auto renew date, based on the value "No auto renewal after" and the "No auto
3017 renewal after (hard limit) of the applicable issuing rule.
3018 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3019 or item cannot be found.
3020
3021 =cut
3022
3023 sub GetLatestAutoRenewDate {
3024     my ( $borrowernumber, $itemnumber ) = @_;
3025
3026     my $dbh = C4::Context->dbh;
3027
3028     my $item      = GetItem($itemnumber)      or return;
3029     my $itemissue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
3030
3031     $borrowernumber ||= $itemissue->borrowernumber;
3032     my $patron = Koha::Patrons->find( $borrowernumber )
3033       or return;
3034
3035     my $branchcode = _GetCircControlBranch( $item, $patron->unblessed );
3036     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3037         {   categorycode => $patron->categorycode,
3038             itemtype     => $item->{itype},
3039             branchcode   => $branchcode
3040         }
3041     );
3042
3043     return unless $issuing_rule;
3044     return
3045       if ( not $issuing_rule->no_auto_renewal_after
3046             or $issuing_rule->no_auto_renewal_after eq '' )
3047       and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3048              or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3049
3050     my $maximum_renewal_date;
3051     if ( $issuing_rule->no_auto_renewal_after ) {
3052         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3053         $maximum_renewal_date->add(
3054             $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3055         );
3056     }
3057
3058     if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3059         my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3060         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3061     }
3062     return $maximum_renewal_date;
3063 }
3064
3065
3066 =head2 GetIssuingCharges
3067
3068   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3069
3070 Calculate how much it would cost for a given patron to borrow a given
3071 item, including any applicable discounts.
3072
3073 C<$itemnumber> is the item number of item the patron wishes to borrow.
3074
3075 C<$borrowernumber> is the patron's borrower number.
3076
3077 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3078 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3079 if it's a video).
3080
3081 =cut
3082
3083 sub GetIssuingCharges {
3084
3085     # calculate charges due
3086     my ( $itemnumber, $borrowernumber ) = @_;
3087     my $charge = 0;
3088     my $dbh    = C4::Context->dbh;
3089     my $item_type;
3090
3091     # Get the book's item type and rental charge (via its biblioitem).
3092     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3093         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3094     $charge_query .= (C4::Context->preference('item-level_itypes'))
3095         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3096         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3097
3098     $charge_query .= ' WHERE items.itemnumber =?';
3099
3100     my $sth = $dbh->prepare($charge_query);
3101     $sth->execute($itemnumber);
3102     if ( my $item_data = $sth->fetchrow_hashref ) {
3103         $item_type = $item_data->{itemtype};
3104         $charge    = $item_data->{rentalcharge};
3105         my $branch = C4::Context::mybranch();
3106         my $discount_query = q|SELECT rentaldiscount,
3107             issuingrules.itemtype, issuingrules.branchcode
3108             FROM borrowers
3109             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3110             WHERE borrowers.borrowernumber = ?
3111             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3112             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3113         my $discount_sth = $dbh->prepare($discount_query);
3114         $discount_sth->execute( $borrowernumber, $item_type, $branch );
3115         my $discount_rules = $discount_sth->fetchall_arrayref({});
3116         if (@{$discount_rules}) {
3117             # We may have multiple rules so get the most specific
3118             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3119             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3120         }
3121         if ($charge) {
3122             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3123         }
3124     }
3125
3126     return ( $charge, $item_type );
3127 }
3128
3129 # Select most appropriate discount rule from those returned
3130 sub _get_discount_from_rule {
3131     my ($rules_ref, $branch, $itemtype) = @_;
3132     my $discount;
3133
3134     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3135         $discount = $rules_ref->[0]->{rentaldiscount};
3136         return (defined $discount) ? $discount : 0;
3137     }
3138     # could have up to 4 does one match $branch and $itemtype
3139     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3140     if (@d) {
3141         $discount = $d[0]->{rentaldiscount};
3142         return (defined $discount) ? $discount : 0;
3143     }
3144     # do we have item type + all branches
3145     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3146     if (@d) {
3147         $discount = $d[0]->{rentaldiscount};
3148         return (defined $discount) ? $discount : 0;
3149     }
3150     # do we all item types + this branch
3151     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3152     if (@d) {
3153         $discount = $d[0]->{rentaldiscount};
3154         return (defined $discount) ? $discount : 0;
3155     }
3156     # so all and all (surely we wont get here)
3157     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3158     if (@d) {
3159         $discount = $d[0]->{rentaldiscount};
3160         return (defined $discount) ? $discount : 0;
3161     }
3162     # none of the above
3163     return 0;
3164 }
3165
3166 =head2 AddIssuingCharge
3167
3168   &AddIssuingCharge( $checkout, $charge )
3169
3170 =cut
3171
3172 sub AddIssuingCharge {
3173     my ( $checkout, $charge ) = @_;
3174
3175     # FIXME What if checkout does not exist?
3176
3177     my $nextaccntno = getnextacctno($checkout->borrowernumber);
3178
3179     my $manager_id  = 0;
3180     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3181
3182     my $accountline = Koha::Account::Line->new(
3183         {
3184             borrowernumber    => $checkout->borrowernumber,
3185             itemnumber        => $checkout->itemnumber,
3186             issue_id          => $checkout->issue_id,
3187             accountno         => $nextaccntno,
3188             amount            => $charge,
3189             amountoutstanding => $charge,
3190             manager_id        => $manager_id,
3191             description       => 'Rental',
3192             accounttype       => 'Rent',
3193             date              => \'NOW()',
3194         }
3195     )->store();
3196
3197     Koha::Account::Offset->new(
3198         {
3199             debit_id => $accountline->id,
3200             type     => 'Rental Fee',
3201             amount   => $charge,
3202         }
3203     )->store();
3204 }
3205
3206 =head2 GetTransfers
3207
3208   GetTransfers($itemnumber);
3209
3210 =cut
3211
3212 sub GetTransfers {
3213     my ($itemnumber) = @_;
3214
3215     my $dbh = C4::Context->dbh;
3216
3217     my $query = '
3218         SELECT datesent,
3219                frombranch,
3220                tobranch,
3221                branchtransfer_id
3222         FROM branchtransfers
3223         WHERE itemnumber = ?
3224           AND datearrived IS NULL
3225         ';
3226     my $sth = $dbh->prepare($query);
3227     $sth->execute($itemnumber);
3228     my @row = $sth->fetchrow_array();
3229     return @row;
3230 }
3231
3232 =head2 GetTransfersFromTo
3233
3234   @results = GetTransfersFromTo($frombranch,$tobranch);
3235
3236 Returns the list of pending transfers between $from and $to branch
3237
3238 =cut
3239
3240 sub GetTransfersFromTo {
3241     my ( $frombranch, $tobranch ) = @_;
3242     return unless ( $frombranch && $tobranch );
3243     my $dbh   = C4::Context->dbh;
3244     my $query = "
3245         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3246         FROM   branchtransfers
3247         WHERE  frombranch=?
3248           AND  tobranch=?
3249           AND datearrived IS NULL
3250     ";
3251     my $sth = $dbh->prepare($query);
3252     $sth->execute( $frombranch, $tobranch );
3253     my @gettransfers;
3254
3255     while ( my $data = $sth->fetchrow_hashref ) {
3256         push @gettransfers, $data;
3257     }
3258     return (@gettransfers);
3259 }
3260
3261 =head2 DeleteTransfer
3262
3263   &DeleteTransfer($itemnumber);
3264
3265 =cut
3266
3267 sub DeleteTransfer {
3268     my ($itemnumber) = @_;
3269     return unless $itemnumber;
3270     my $dbh          = C4::Context->dbh;
3271     my $sth          = $dbh->prepare(
3272         "DELETE FROM branchtransfers
3273          WHERE itemnumber=?
3274          AND datearrived IS NULL "
3275     );
3276     return $sth->execute($itemnumber);
3277 }
3278
3279 =head2 SendCirculationAlert
3280
3281 Send out a C<check-in> or C<checkout> alert using the messaging system.
3282
3283 B<Parameters>:
3284
3285 =over 4
3286
3287 =item type
3288
3289 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3290
3291 =item item
3292
3293 Hashref of information about the item being checked in or out.
3294
3295 =item borrower
3296
3297 Hashref of information about the borrower of the item.
3298
3299 =item branch
3300
3301 The branchcode from where the checkout or check-in took place.
3302
3303 =back
3304
3305 B<Example>:
3306
3307     SendCirculationAlert({
3308         type     => 'CHECKOUT',
3309         item     => $item,
3310         borrower => $borrower,
3311         branch   => $branch,
3312     });
3313
3314 =cut
3315
3316 sub SendCirculationAlert {
3317     my ($opts) = @_;
3318     my ($type, $item, $borrower, $branch) =
3319         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3320     my %message_name = (
3321         CHECKIN  => 'Item_Check_in',
3322         CHECKOUT => 'Item_Checkout',
3323         RENEWAL  => 'Item_Checkout',
3324     );
3325     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3326         borrowernumber => $borrower->{borrowernumber},
3327         message_name   => $message_name{$type},
3328     });
3329     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3330
3331     my $schema = Koha::Database->new->schema;
3332     my @transports = keys %{ $borrower_preferences->{transports} };
3333
3334     # From the MySQL doc:
3335     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3336     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3337     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3338     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3339
3340     for my $mtt (@transports) {
3341         my $letter =  C4::Letters::GetPreparedLetter (
3342             module => 'circulation',
3343             letter_code => $type,
3344             branchcode => $branch,
3345             message_transport_type => $mtt,
3346             lang => $borrower->{lang},
3347             tables => {
3348                 $issues_table => $item->{itemnumber},
3349                 'items'       => $item->{itemnumber},
3350                 'biblio'      => $item->{biblionumber},
3351                 'biblioitems' => $item->{biblionumber},
3352                 'borrowers'   => $borrower,
3353                 'branches'    => $branch,
3354             }
3355         ) or next;
3356
3357         $schema->storage->txn_begin;
3358         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3359         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3360         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3361         unless ( $message ) {
3362             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3363             C4::Message->enqueue($letter, $borrower, $mtt);
3364         } else {
3365             $message->append($letter);
3366             $message->update;
3367         }
3368         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3369         $schema->storage->txn_commit;
3370     }
3371
3372     return;
3373 }
3374
3375 =head2 updateWrongTransfer
3376
3377   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3378
3379 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 
3380
3381 =cut
3382
3383 sub updateWrongTransfer {
3384         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3385         my $dbh = C4::Context->dbh;     
3386 # first step validate the actual line of transfert .
3387         my $sth =
3388                 $dbh->prepare(
3389                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3390                 );
3391                 $sth->execute($FromLibrary,$itemNumber);
3392
3393 # second step create a new line of branchtransfer to the right location .
3394         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3395
3396 #third step changing holdingbranch of item
3397         UpdateHoldingbranch($FromLibrary,$itemNumber);
3398 }
3399
3400 =head2 UpdateHoldingbranch
3401
3402   $items = UpdateHoldingbranch($branch,$itmenumber);
3403
3404 Simple methode for updating hodlingbranch in items BDD line
3405
3406 =cut
3407
3408 sub UpdateHoldingbranch {
3409         my ( $branch,$itemnumber ) = @_;
3410     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3411 }
3412
3413 =head2 CalcDateDue
3414
3415 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3416
3417 this function calculates the due date given the start date and configured circulation rules,
3418 checking against the holidays calendar as per the 'useDaysMode' syspref.
3419 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3420 C<$itemtype>  = itemtype code of item in question
3421 C<$branch>  = location whose calendar to use
3422 C<$borrower> = Borrower object
3423 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3424
3425 =cut
3426
3427 sub CalcDateDue {
3428     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3429
3430     $isrenewal ||= 0;
3431
3432     # loanlength now a href
3433     my $loanlength =
3434             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3435
3436     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3437             ? qq{renewalperiod}
3438             : qq{issuelength};
3439
3440     my $datedue;
3441     if ( $startdate ) {
3442         if (ref $startdate ne 'DateTime' ) {
3443             $datedue = dt_from_string($datedue);
3444         } else {
3445             $datedue = $startdate->clone;
3446         }
3447     } else {
3448         $datedue =
3449           DateTime->now( time_zone => C4::Context->tz() )
3450           ->truncate( to => 'minute' );
3451     }
3452
3453
3454     # calculate the datedue as normal
3455     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3456     {    # ignoring calendar
3457         if ( $loanlength->{lengthunit} eq 'hours' ) {
3458             $datedue->add( hours => $loanlength->{$length_key} );
3459         } else {    # days
3460             $datedue->add( days => $loanlength->{$length_key} );
3461             $datedue->set_hour(23);
3462             $datedue->set_minute(59);
3463         }
3464     } else {
3465         my $dur;
3466         if ($loanlength->{lengthunit} eq 'hours') {
3467             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3468         }
3469         else { # days
3470             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3471         }
3472         my $calendar = Koha::Calendar->new( branchcode => $branch );
3473         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3474         if ($loanlength->{lengthunit} eq 'days') {
3475             $datedue->set_hour(23);
3476             $datedue->set_minute(59);
3477         }
3478     }
3479
3480     # if Hard Due Dates are used, retrieve them and apply as necessary
3481     my ( $hardduedate, $hardduedatecompare ) =
3482       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3483     if ($hardduedate) {    # hardduedates are currently dates
3484         $hardduedate->truncate( to => 'minute' );
3485         $hardduedate->set_hour(23);
3486         $hardduedate->set_minute(59);
3487         my $cmp = DateTime->compare( $hardduedate, $datedue );
3488
3489 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3490 # if the calculated date is before the 'after' Hard Due Date (floor), override
3491 # if the hard due date is set to 'exactly', overrride
3492         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3493             $datedue = $hardduedate->clone;
3494         }
3495
3496         # in all other cases, keep the date due as it is
3497
3498     }
3499
3500     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3501     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3502         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3503         if( $expiry_dt ) { #skip empty expiry date..
3504             $expiry_dt->set( hour => 23, minute => 59);
3505             my $d1= $datedue->clone->set_time_zone('floating');
3506             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3507                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3508             }
3509         }
3510         if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3511           my $calendar = Koha::Calendar->new( branchcode => $branch );
3512           if ( $calendar->is_holiday($datedue) ) {
3513               # Don't return on a closed day
3514               $datedue = $calendar->prev_open_day( $datedue );
3515           }
3516         }
3517     }
3518
3519     return $datedue;
3520 }
3521
3522
3523 sub CheckValidBarcode{
3524 my ($barcode) = @_;
3525 my $dbh = C4::Context->dbh;
3526 my $query=qq|SELECT count(*) 
3527              FROM items 
3528              WHERE barcode=?
3529             |;
3530 my $sth = $dbh->prepare($query);
3531 $sth->execute($barcode);
3532 my $exist=$sth->fetchrow ;
3533 return $exist;
3534 }
3535
3536 =head2 IsBranchTransferAllowed
3537
3538   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3539
3540 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3541
3542 =cut
3543
3544 sub IsBranchTransferAllowed {
3545         my ( $toBranch, $fromBranch, $code ) = @_;
3546
3547         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3548         
3549         my $limitType = C4::Context->preference("BranchTransferLimitsType");   
3550         my $dbh = C4::Context->dbh;
3551             
3552         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3553         $sth->execute( $toBranch, $fromBranch, $code );
3554         my $limit = $sth->fetchrow_hashref();
3555                         
3556         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3557         if ( $limit->{'limitId'} ) {
3558                 return 0;
3559         } else {
3560                 return 1;
3561         }
3562 }                                                        
3563
3564 =head2 CreateBranchTransferLimit
3565
3566   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3567
3568 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3569
3570 =cut
3571
3572 sub CreateBranchTransferLimit {
3573    my ( $toBranch, $fromBranch, $code ) = @_;
3574    return unless defined($toBranch) && defined($fromBranch);
3575    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3576    
3577    my $dbh = C4::Context->dbh;
3578    
3579    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3580    return $sth->execute( $code, $toBranch, $fromBranch );
3581 }
3582
3583 =head2 DeleteBranchTransferLimits
3584
3585     my $result = DeleteBranchTransferLimits($frombranch);
3586
3587 Deletes all the library transfer limits for one library.  Returns the
3588 number of limits deleted, 0e0 if no limits were deleted, or undef if
3589 no arguments are supplied.
3590
3591 =cut
3592
3593 sub DeleteBranchTransferLimits {
3594     my $branch = shift;
3595     return unless defined $branch;
3596     my $dbh    = C4::Context->dbh;
3597     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3598     return $sth->execute($branch);
3599 }
3600
3601 sub ReturnLostItem{
3602     my ( $borrowernumber, $itemnum ) = @_;
3603
3604     MarkIssueReturned( $borrowernumber, $itemnum );
3605     my $patron = Koha::Patrons->find( $borrowernumber );
3606     my $item = C4::Items::GetItem( $itemnum );
3607     my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3608     my @datearr = localtime(time);
3609     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3610     my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3611     ModItem({ paidfor =>  $old_note."Paid for by $bor $date" }, undef, $itemnum);
3612 }
3613
3614
3615 sub LostItem{
3616     my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3617
3618     unless ( $mark_lost_from ) {
3619         # Temporary check to avoid regressions
3620         die q|LostItem called without $mark_lost_from, check the API.|;
3621     }
3622
3623     my $mark_returned;
3624     if ( $force_mark_returned ) {
3625         $mark_returned = 1;
3626     } else {
3627         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3628         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3629     }
3630
3631     my $dbh = C4::Context->dbh();
3632     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title 
3633                            FROM issues 
3634                            JOIN items USING (itemnumber) 
3635                            JOIN biblio USING (biblionumber)
3636                            WHERE issues.itemnumber=?");
3637     $sth->execute($itemnumber);
3638     my $issues=$sth->fetchrow_hashref();
3639
3640     # If a borrower lost the item, add a replacement cost to the their record
3641     if ( my $borrowernumber = $issues->{borrowernumber} ){
3642         my $patron = Koha::Patrons->find( $borrowernumber );
3643
3644         if (C4::Context->preference('WhenLostForgiveFine')){
3645             my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3646             defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3647         }
3648         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3649             C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3650             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3651             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3652         }
3653
3654         MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$patron->privacy) if $mark_returned;
3655     }
3656 }
3657
3658 sub GetOfflineOperations {
3659     my $dbh = C4::Context->dbh;
3660     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3661     $sth->execute(C4::Context->userenv->{'branch'});
3662     my $results = $sth->fetchall_arrayref({});
3663     return $results;
3664 }
3665
3666 sub GetOfflineOperation {
3667     my $operationid = shift;
3668     return unless $operationid;
3669     my $dbh = C4::Context->dbh;
3670     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3671     $sth->execute( $operationid );
3672     return $sth->fetchrow_hashref;
3673 }
3674
3675 sub AddOfflineOperation {
3676     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3677     my $dbh = C4::Context->dbh;
3678     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3679     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3680     return "Added.";
3681 }
3682
3683 sub DeleteOfflineOperation {
3684     my $dbh = C4::Context->dbh;
3685     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3686     $sth->execute( shift );
3687     return "Deleted.";
3688 }
3689
3690 sub ProcessOfflineOperation {
3691     my $operation = shift;
3692
3693     my $report;
3694     if ( $operation->{action} eq 'return' ) {
3695         $report = ProcessOfflineReturn( $operation );
3696     } elsif ( $operation->{action} eq 'issue' ) {
3697         $report = ProcessOfflineIssue( $operation );
3698     } elsif ( $operation->{action} eq 'payment' ) {
3699         $report = ProcessOfflinePayment( $operation );
3700     }
3701
3702     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3703
3704     return $report;
3705 }
3706
3707 sub ProcessOfflineReturn {
3708     my $operation = shift;
3709
3710     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3711
3712     if ( $item ) {
3713         my $itemnumber = $item->itemnumber;
3714         my $issue = GetOpenIssue( $itemnumber );
3715         if ( $issue ) {
3716             MarkIssueReturned(
3717                 $issue->{borrowernumber},
3718                 $itemnumber,
3719                 undef,
3720                 $operation->{timestamp},
3721             );
3722             ModItem(
3723                 { renewals => 0, onloan => undef },
3724                 $issue->{'biblionumber'},
3725                 $itemnumber,
3726                 { log_action => 0 }
3727             );
3728             return "Success.";
3729         } else {
3730             return "Item not issued.";
3731         }
3732     } else {
3733         return "Item not found.";
3734     }
3735 }
3736
3737 sub ProcessOfflineIssue {
3738     my $operation = shift;
3739
3740     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3741
3742     if ( $patron ) {
3743         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3744         unless ($item) {
3745             return "Barcode not found.";
3746         }
3747         my $itemnumber = $item->itemnumber;
3748         my $issue = GetOpenIssue( $itemnumber );
3749
3750         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3751             MarkIssueReturned(
3752                 $issue->{borrowernumber},
3753                 $itemnumber,
3754                 undef,
3755                 $operation->{timestamp},
3756             );
3757         }
3758         AddIssue(
3759             $patron->unblessed,
3760             $operation->{'barcode'},
3761             undef,
3762             1,
3763             $operation->{timestamp},
3764             undef,
3765         );
3766         return "Success.";
3767     } else {
3768         return "Borrower not found.";
3769     }
3770 }
3771
3772 sub ProcessOfflinePayment {
3773     my $operation = shift;
3774
3775     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} });
3776     my $amount = $operation->{amount};
3777
3778     Koha::Account->new( { patron_id => $patron->id } )->pay( { amount => $amount } );
3779
3780     return "Success."
3781 }
3782
3783
3784 =head2 TransferSlip
3785
3786   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3787
3788   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3789
3790 =cut
3791
3792 sub TransferSlip {
3793     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3794
3795     my $item =  GetItem( $itemnumber, $barcode )
3796       or return;
3797
3798     return C4::Letters::GetPreparedLetter (
3799         module => 'circulation',
3800         letter_code => 'TRANSFERSLIP',
3801         branchcode => $branch,
3802         tables => {
3803             'branches'    => $to_branch,
3804             'biblio'      => $item->{biblionumber},
3805             'items'       => $item,
3806         },
3807     );
3808 }
3809
3810 =head2 CheckIfIssuedToPatron
3811
3812   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3813
3814   Return 1 if any record item is issued to patron, otherwise return 0
3815
3816 =cut
3817
3818 sub CheckIfIssuedToPatron {
3819     my ($borrowernumber, $biblionumber) = @_;
3820
3821     my $dbh = C4::Context->dbh;
3822     my $query = q|
3823         SELECT COUNT(*) FROM issues
3824         LEFT JOIN items ON items.itemnumber = issues.itemnumber
3825         WHERE items.biblionumber = ?
3826         AND issues.borrowernumber = ?
3827     |;
3828     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3829     return 1 if $is_issued;
3830     return;
3831 }
3832
3833 =head2 IsItemIssued
3834
3835   IsItemIssued( $itemnumber )
3836
3837   Return 1 if the item is on loan, otherwise return 0
3838
3839 =cut
3840
3841 sub IsItemIssued {
3842     my $itemnumber = shift;
3843     my $dbh = C4::Context->dbh;
3844     my $sth = $dbh->prepare(q{
3845         SELECT COUNT(*)
3846         FROM issues
3847         WHERE itemnumber = ?
3848     });
3849     $sth->execute($itemnumber);
3850     return $sth->fetchrow;
3851 }
3852
3853 =head2 GetAgeRestriction
3854
3855   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3856   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3857
3858   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3859   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3860
3861 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3862 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3863 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3864          Negative days mean the borrower has gone past the age restriction age.
3865
3866 =cut
3867
3868 sub GetAgeRestriction {
3869     my ($record_restrictions, $borrower) = @_;
3870     my $markers = C4::Context->preference('AgeRestrictionMarker');
3871
3872     # Split $record_restrictions to something like FSK 16 or PEGI 6
3873     my @values = split ' ', uc($record_restrictions);
3874     return unless @values;
3875
3876     # Search first occurrence of one of the markers
3877     my @markers = split /\|/, uc($markers);
3878     return unless @markers;
3879
3880     my $index            = 0;
3881     my $restriction_year = 0;
3882     for my $value (@values) {
3883         $index++;
3884         for my $marker (@markers) {
3885             $marker =~ s/^\s+//;    #remove leading spaces
3886             $marker =~ s/\s+$//;    #remove trailing spaces
3887             if ( $marker eq $value ) {
3888                 if ( $index <= $#values ) {
3889                     $restriction_year += $values[$index];
3890                 }
3891                 last;
3892             }
3893             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3894
3895                 # Perhaps it is something like "K16" (as in Finland)
3896                 $restriction_year += $1;
3897                 last;
3898             }
3899         }
3900         last if ( $restriction_year > 0 );
3901     }
3902
3903     #Check if the borrower is age restricted for this material and for how long.
3904     if ($restriction_year && $borrower) {
3905         if ( $borrower->{'dateofbirth'} ) {
3906             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3907             $alloweddate[0] += $restriction_year;
3908
3909             #Prevent runime eror on leap year (invalid date)
3910             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3911                 $alloweddate[2] = 28;
3912             }
3913
3914             #Get how many days the borrower has to reach the age restriction
3915             my @Today = split /-/, DateTime->today->ymd();
3916             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3917             #Negative days means the borrower went past the age restriction age
3918             return ($restriction_year, $daysToAgeRestriction);
3919         }
3920     }
3921
3922     return ($restriction_year);
3923 }
3924
3925
3926 =head2 GetPendingOnSiteCheckouts
3927
3928 =cut
3929
3930 sub GetPendingOnSiteCheckouts {
3931     my $dbh = C4::Context->dbh;
3932     return $dbh->selectall_arrayref(q|
3933         SELECT
3934           items.barcode,
3935           items.biblionumber,
3936           items.itemnumber,
3937           items.itemnotes,
3938           items.itemcallnumber,
3939           items.location,
3940           issues.date_due,
3941           issues.branchcode,
3942           issues.date_due < NOW() AS is_overdue,
3943           biblio.author,
3944           biblio.title,
3945           borrowers.firstname,
3946           borrowers.surname,
3947           borrowers.cardnumber,
3948           borrowers.borrowernumber
3949         FROM items
3950         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
3951         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
3952         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
3953         WHERE issues.onsite_checkout = 1
3954     |, { Slice => {} } );
3955 }
3956
3957 sub GetTopIssues {
3958     my ($params) = @_;
3959
3960     my ($count, $branch, $itemtype, $ccode, $newness)
3961         = @$params{qw(count branch itemtype ccode newness)};
3962
3963     my $dbh = C4::Context->dbh;
3964     my $query = q{
3965         SELECT * FROM (
3966         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
3967           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
3968           i.ccode, SUM(i.issues) AS count
3969         FROM biblio b
3970         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
3971         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
3972     };
3973
3974     my (@where_strs, @where_args);
3975
3976     if ($branch) {
3977         push @where_strs, 'i.homebranch = ?';
3978         push @where_args, $branch;
3979     }
3980     if ($itemtype) {
3981         if (C4::Context->preference('item-level_itypes')){
3982             push @where_strs, 'i.itype = ?';
3983             push @where_args, $itemtype;
3984         } else {
3985             push @where_strs, 'bi.itemtype = ?';
3986             push @where_args, $itemtype;
3987         }
3988     }
3989     if ($ccode) {
3990         push @where_strs, 'i.ccode = ?';
3991         push @where_args, $ccode;
3992     }
3993     if ($newness) {
3994         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
3995         push @where_args, $newness;
3996     }
3997
3998     if (@where_strs) {
3999         $query .= 'WHERE ' . join(' AND ', @where_strs);
4000     }
4001
4002     $query .= q{
4003         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4004           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4005           i.ccode
4006         ORDER BY count DESC
4007     };
4008
4009     $query .= q{ ) xxx WHERE count > 0 };
4010     $count = int($count);
4011     if ($count > 0) {
4012         $query .= "LIMIT $count";
4013     }
4014
4015     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4016
4017     return @$rows;
4018 }
4019
4020 sub _CalculateAndUpdateFine {
4021     my ($params) = @_;
4022
4023     my $borrower    = $params->{borrower};
4024     my $item        = $params->{item};
4025     my $issue       = $params->{issue};
4026     my $return_date = $params->{return_date};
4027
4028     unless ($borrower) { carp "No borrower passed in!" && return; }
4029     unless ($item)     { carp "No item passed in!"     && return; }
4030     unless ($issue)    { carp "No issue passed in!"    && return; }
4031
4032     my $datedue = dt_from_string( $issue->date_due );
4033
4034     # we only need to calculate and change the fines if we want to do that on return
4035     # Should be on for hourly loans
4036     my $control = C4::Context->preference('CircControl');
4037     my $control_branchcode =
4038         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4039       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4040       :                                     $issue->branchcode;
4041
4042     my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4043
4044     my ( $amount, $type, $unitcounttotal ) =
4045       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4046
4047     $type ||= q{};
4048
4049     if ( C4::Context->preference('finesMode') eq 'production' ) {
4050         if ( $amount > 0 ) {
4051             C4::Overdues::UpdateFine({
4052                 issue_id       => $issue->issue_id,
4053                 itemnumber     => $issue->itemnumber,
4054                 borrowernumber => $issue->borrowernumber,
4055                 amount         => $amount,
4056                 type           => $type,
4057                 due            => output_pref($datedue),
4058             });
4059         }
4060         elsif ($return_date) {
4061
4062             # Backdated returns may have fines that shouldn't exist,
4063             # so in this case, we need to drop those fines to 0
4064
4065             C4::Overdues::UpdateFine({
4066                 issue_id       => $issue->issue_id,
4067                 itemnumber     => $issue->itemnumber,
4068                 borrowernumber => $issue->borrowernumber,
4069                 amount         => 0,
4070                 type           => $type,
4071                 due            => output_pref($datedue),
4072             });
4073         }
4074     }
4075 }
4076
4077 1;
4078
4079 __END__
4080
4081 =head1 AUTHOR
4082
4083 Koha Development Team <http://koha-community.org/>
4084
4085 =cut