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