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