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