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