Bug 5548 Follow up: Confirm Checkout message where it shouldn't be
[wip/koha-chris_n.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 C4::Context;
25 use C4::Stats;
26 use C4::Reserves;
27 use C4::Koha;
28 use C4::Biblio;
29 use C4::Items;
30 use C4::Members;
31 use C4::Dates;
32 use C4::Calendar;
33 use C4::Accounts;
34 use C4::ItemCirculationAlertPreference;
35 use C4::Dates qw(format_date);
36 use C4::Message;
37 use C4::Debug;
38 use Date::Calc qw(
39   Today
40   Today_and_Now
41   Add_Delta_YM
42   Add_Delta_DHMS
43   Date_to_Days
44   Day_of_Week
45   Add_Delta_Days        
46 );
47 use POSIX qw(strftime);
48 use C4::Branch; # GetBranches
49 use C4::Log; # logaction
50
51 use Data::Dumper;
52
53 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
54
55 BEGIN {
56         require Exporter;
57         $VERSION = 3.02;        # for version checking
58         @ISA    = qw(Exporter);
59
60         # FIXME subs that should probably be elsewhere
61         push @EXPORT, qw(
62                 &FixOverduesOnReturn
63                 &barcodedecode
64         );
65
66         # subs to deal with issuing a book
67         push @EXPORT, qw(
68                 &CanBookBeIssued
69                 &CanBookBeRenewed
70                 &AddIssue
71                 &AddRenewal
72                 &GetRenewCount
73                 &GetItemIssue
74                 &GetItemIssues
75                 &GetBorrowerIssues
76                 &GetIssuingCharges
77                 &GetIssuingRule
78         &GetBranchBorrowerCircRule
79         &GetBranchItemRule
80                 &GetBiblioIssues
81                 &GetOpenIssue
82                 &AnonymiseIssueHistory
83         );
84
85         # subs to deal with returns
86         push @EXPORT, qw(
87                 &AddReturn
88         &MarkIssueReturned
89         );
90
91         # subs to deal with transfers
92         push @EXPORT, qw(
93                 &transferbook
94                 &GetTransfers
95                 &GetTransfersFromTo
96                 &updateWrongTransfer
97                 &DeleteTransfer
98                 &IsBranchTransferAllowed
99                 &CreateBranchTransferLimit
100                 &DeleteBranchTransferLimits
101         );
102 }
103
104 =head1 NAME
105
106 C4::Circulation - Koha circulation module
107
108 =head1 SYNOPSIS
109
110 use C4::Circulation;
111
112 =head1 DESCRIPTION
113
114 The functions in this module deal with circulation, issues, and
115 returns, as well as general information about the library.
116 Also deals with stocktaking.
117
118 =head1 FUNCTIONS
119
120 =head2 barcodedecode
121
122   $str = &barcodedecode($barcode, [$filter]);
123
124 Generic filter function for barcode string.
125 Called on every circ if the System Pref itemBarcodeInputFilter is set.
126 Will do some manipulation of the barcode for systems that deliver a barcode
127 to circulation.pl that differs from the barcode stored for the item.
128 For proper functioning of this filter, calling the function on the 
129 correct barcode string (items.barcode) should return an unaltered barcode.
130
131 The optional $filter argument is to allow for testing or explicit 
132 behavior that ignores the System Pref.  Valid values are the same as the 
133 System Pref options.
134
135 =cut
136
137 # FIXME -- the &decode fcn below should be wrapped into this one.
138 # FIXME -- these plugins should be moved out of Circulation.pm
139 #
140 sub barcodedecode {
141     my ($barcode, $filter) = @_;
142     my $branch = C4::Branch::mybranch();
143     $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
144     $filter or return $barcode;     # ensure filter is defined, else return untouched barcode
145         if ($filter eq 'whitespace') {
146                 $barcode =~ s/\s//g;
147         } elsif ($filter eq 'cuecat') {
148                 chomp($barcode);
149             my @fields = split( /\./, $barcode );
150             my @results = map( decode($_), @fields[ 1 .. $#fields ] );
151             ($#results == 2) and return $results[2];
152         } elsif ($filter eq 'T-prefix') {
153                 if ($barcode =~ /^[Tt](\d)/) {
154                         (defined($1) and $1 eq '0') and return $barcode;
155             $barcode = substr($barcode, 2) + 0;     # FIXME: probably should be substr($barcode, 1)
156                 }
157         return sprintf("T%07d", $barcode);
158         # FIXME: $barcode could be "T1", causing warning: substr outside of string
159         # Why drop the nonzero digit after the T?
160         # Why pass non-digits (or empty string) to "T%07d"?
161         } elsif ($filter eq 'libsuite8') {
162                 unless($barcode =~ m/^($branch)-/i){    #if barcode starts with branch code its in Koha style. Skip it.
163                         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
164                                 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
165                         }else{
166                                 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
167                         }
168                 }
169         }
170     return $barcode;    # return barcode, modified or not
171 }
172
173 =head2 decode
174
175   $str = &decode($chunk);
176
177 Decodes a segment of a string emitted by a CueCat barcode scanner and
178 returns it.
179
180 FIXME: Should be replaced with Barcode::Cuecat from CPAN
181 or Javascript based decoding on the client side.
182
183 =cut
184
185 sub decode {
186     my ($encoded) = @_;
187     my $seq =
188       'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
189     my @s = map { index( $seq, $_ ); } split( //, $encoded );
190     my $l = ( $#s + 1 ) % 4;
191     if ($l) {
192         if ( $l == 1 ) {
193             # warn "Error: Cuecat decode parsing failed!";
194             return;
195         }
196         $l = 4 - $l;
197         $#s += $l;
198     }
199     my $r = '';
200     while ( $#s >= 0 ) {
201         my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
202         $r .=
203             chr( ( $n >> 16 ) ^ 67 )
204          .chr( ( $n >> 8 & 255 ) ^ 67 )
205          .chr( ( $n & 255 ) ^ 67 );
206         @s = @s[ 4 .. $#s ];
207     }
208     $r = substr( $r, 0, length($r) - $l );
209     return $r;
210 }
211
212 =head2 transferbook
213
214   ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch, 
215                                             $barcode, $ignore_reserves);
216
217 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
218
219 C<$newbranch> is the code for the branch to which the item should be transferred.
220
221 C<$barcode> is the barcode of the item to be transferred.
222
223 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
224 Otherwise, if an item is reserved, the transfer fails.
225
226 Returns three values:
227
228 =over
229
230 =item $dotransfer 
231
232 is true if the transfer was successful.
233
234 =item $messages
235
236 is a reference-to-hash which may have any of the following keys:
237
238 =over
239
240 =item C<BadBarcode>
241
242 There is no item in the catalog with the given barcode. The value is C<$barcode>.
243
244 =item C<IsPermanent>
245
246 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.
247
248 =item C<DestinationEqualsHolding>
249
250 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.
251
252 =item C<WasReturned>
253
254 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.
255
256 =item C<ResFound>
257
258 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>.
259
260 =item C<WasTransferred>
261
262 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
263
264 =back
265
266 =back
267
268 =cut
269
270 sub transferbook {
271     my ( $tbr, $barcode, $ignoreRs ) = @_;
272     my $messages;
273     my $dotransfer      = 1;
274     my $branches        = GetBranches();
275     my $itemnumber = GetItemnumberFromBarcode( $barcode );
276     my $issue      = GetItemIssue($itemnumber);
277     my $biblio = GetBiblioFromItemNumber($itemnumber);
278
279     # bad barcode..
280     if ( not $itemnumber ) {
281         $messages->{'BadBarcode'} = $barcode;
282         $dotransfer = 0;
283     }
284
285     # get branches of book...
286     my $hbr = $biblio->{'homebranch'};
287     my $fbr = $biblio->{'holdingbranch'};
288
289     # if using Branch Transfer Limits
290     if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
291         if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
292             if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
293                 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
294                 $dotransfer = 0;
295             }
296         } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
297             $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
298             $dotransfer = 0;
299         }
300     }
301
302     # if is permanent...
303     if ( $hbr && $branches->{$hbr}->{'PE'} ) {
304         $messages->{'IsPermanent'} = $hbr;
305         $dotransfer = 0;
306     }
307
308     # can't transfer book if is already there....
309     if ( $fbr eq $tbr ) {
310         $messages->{'DestinationEqualsHolding'} = 1;
311         $dotransfer = 0;
312     }
313
314     # check if it is still issued to someone, return it...
315     if ($issue->{borrowernumber}) {
316         AddReturn( $barcode, $fbr );
317         $messages->{'WasReturned'} = $issue->{borrowernumber};
318     }
319
320     # find reserves.....
321     # That'll save a database query.
322     my ( $resfound, $resrec ) =
323       CheckReserves( $itemnumber );
324     if ( $resfound and not $ignoreRs ) {
325         $resrec->{'ResFound'} = $resfound;
326
327         #         $messages->{'ResFound'} = $resrec;
328         $dotransfer = 1;
329     }
330
331     #actually do the transfer....
332     if ($dotransfer) {
333         ModItemTransfer( $itemnumber, $fbr, $tbr );
334
335         # don't need to update MARC anymore, we do it in batch now
336         $messages->{'WasTransfered'} = 1;
337
338     }
339     ModDateLastSeen( $itemnumber );
340     return ( $dotransfer, $messages, $biblio );
341 }
342
343
344 sub TooMany {
345     my $borrower        = shift;
346     my $biblionumber = shift;
347         my $item                = shift;
348     my $cat_borrower    = $borrower->{'categorycode'};
349     my $dbh             = C4::Context->dbh;
350         my $branch;
351         # Get which branchcode we need
352         $branch = _GetCircControlBranch($item,$borrower);
353         my $type = (C4::Context->preference('item-level_itypes')) 
354                         ? $item->{'itype'}         # item-level
355                         : $item->{'itemtype'};     # biblio-level
356  
357     # given branch, patron category, and item type, determine
358     # applicable issuing rule
359     my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
360
361     # if a rule is found and has a loan limit set, count
362     # how many loans the patron already has that meet that
363     # rule
364     if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
365         my @bind_params;
366         my $count_query = "SELECT COUNT(*) FROM issues
367                            JOIN items USING (itemnumber) ";
368
369         my $rule_itemtype = $issuing_rule->{itemtype};
370         if ($rule_itemtype eq "*") {
371             # matching rule has the default item type, so count only
372             # those existing loans that don't fall under a more
373             # specific rule
374             if (C4::Context->preference('item-level_itypes')) {
375                 $count_query .= " WHERE items.itype NOT IN (
376                                     SELECT itemtype FROM issuingrules
377                                     WHERE branchcode = ?
378                                     AND   (categorycode = ? OR categorycode = ?)
379                                     AND   itemtype <> '*'
380                                   ) ";
381             } else { 
382                 $count_query .= " JOIN  biblioitems USING (biblionumber) 
383                                   WHERE biblioitems.itemtype NOT IN (
384                                     SELECT itemtype FROM issuingrules
385                                     WHERE branchcode = ?
386                                     AND   (categorycode = ? OR categorycode = ?)
387                                     AND   itemtype <> '*'
388                                   ) ";
389             }
390             push @bind_params, $issuing_rule->{branchcode};
391             push @bind_params, $issuing_rule->{categorycode};
392             push @bind_params, $cat_borrower;
393         } else {
394             # rule has specific item type, so count loans of that
395             # specific item type
396             if (C4::Context->preference('item-level_itypes')) {
397                 $count_query .= " WHERE items.itype = ? ";
398             } else { 
399                 $count_query .= " JOIN  biblioitems USING (biblionumber) 
400                                   WHERE biblioitems.itemtype= ? ";
401             }
402             push @bind_params, $type;
403         }
404
405         $count_query .= " AND borrowernumber = ? ";
406         push @bind_params, $borrower->{'borrowernumber'};
407         my $rule_branch = $issuing_rule->{branchcode};
408         if ($rule_branch ne "*") {
409             if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
410                 $count_query .= " AND issues.branchcode = ? ";
411                 push @bind_params, $branch;
412             } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
413                 ; # if branch is the patron's home branch, then count all loans by patron
414             } else {
415                 $count_query .= " AND items.homebranch = ? ";
416                 push @bind_params, $branch;
417             }
418         }
419
420         my $count_sth = $dbh->prepare($count_query);
421         $count_sth->execute(@bind_params);
422         my ($current_loan_count) = $count_sth->fetchrow_array;
423
424         my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
425         if ($current_loan_count >= $max_loans_allowed) {
426             return ($current_loan_count, $max_loans_allowed);
427         }
428     }
429
430     # Now count total loans against the limit for the branch
431     my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
432     if (defined($branch_borrower_circ_rule->{maxissueqty})) {
433         my @bind_params = ();
434         my $branch_count_query = "SELECT COUNT(*) FROM issues 
435                                   JOIN items USING (itemnumber)
436                                   WHERE borrowernumber = ? ";
437         push @bind_params, $borrower->{borrowernumber};
438
439         if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
440             $branch_count_query .= " AND issues.branchcode = ? ";
441             push @bind_params, $branch;
442         } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
443             ; # if branch is the patron's home branch, then count all loans by patron
444         } else {
445             $branch_count_query .= " AND items.homebranch = ? ";
446             push @bind_params, $branch;
447         }
448         my $branch_count_sth = $dbh->prepare($branch_count_query);
449         $branch_count_sth->execute(@bind_params);
450         my ($current_loan_count) = $branch_count_sth->fetchrow_array;
451
452         my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
453         if ($current_loan_count >= $max_loans_allowed) {
454             return ($current_loan_count, $max_loans_allowed);
455         }
456     }
457
458     # OK, the patron can issue !!!
459     return;
460 }
461
462 =head2 itemissues
463
464   @issues = &itemissues($biblioitemnumber, $biblio);
465
466 Looks up information about who has borrowed the bookZ<>(s) with the
467 given biblioitemnumber.
468
469 C<$biblio> is ignored.
470
471 C<&itemissues> returns an array of references-to-hash. The keys
472 include the fields from the C<items> table in the Koha database.
473 Additional keys include:
474
475 =over 4
476
477 =item C<date_due>
478
479 If the item is currently on loan, this gives the due date.
480
481 If the item is not on loan, then this is either "Available" or
482 "Cancelled", if the item has been withdrawn.
483
484 =item C<card>
485
486 If the item is currently on loan, this gives the card number of the
487 patron who currently has the item.
488
489 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
490
491 These give the timestamp for the last three times the item was
492 borrowed.
493
494 =item C<card0>, C<card1>, C<card2>
495
496 The card number of the last three patrons who borrowed this item.
497
498 =item C<borrower0>, C<borrower1>, C<borrower2>
499
500 The borrower number of the last three patrons who borrowed this item.
501
502 =back
503
504 =cut
505
506 #'
507 sub itemissues {
508     my ( $bibitem, $biblio ) = @_;
509     my $dbh = C4::Context->dbh;
510     my $sth =
511       $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
512       || die $dbh->errstr;
513     my $i = 0;
514     my @results;
515
516     $sth->execute($bibitem) || die $sth->errstr;
517
518     while ( my $data = $sth->fetchrow_hashref ) {
519
520         # Find out who currently has this item.
521         # FIXME - Wouldn't it be better to do this as a left join of
522         # some sort? Currently, this code assumes that if
523         # fetchrow_hashref() fails, then the book is on the shelf.
524         # fetchrow_hashref() can fail for any number of reasons (e.g.,
525         # database server crash), not just because no items match the
526         # search criteria.
527         my $sth2 = $dbh->prepare(
528             "SELECT * FROM issues
529                 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
530                 WHERE itemnumber = ?
531             "
532         );
533
534         $sth2->execute( $data->{'itemnumber'} );
535         if ( my $data2 = $sth2->fetchrow_hashref ) {
536             $data->{'date_due'} = $data2->{'date_due'};
537             $data->{'card'}     = $data2->{'cardnumber'};
538             $data->{'borrower'} = $data2->{'borrowernumber'};
539         }
540         else {
541             $data->{'date_due'} = ($data->{'wthdrawn'} eq '1') ? 'Cancelled' : 'Available';
542         }
543
544
545         # Find the last 3 people who borrowed this item.
546         $sth2 = $dbh->prepare(
547             "SELECT * FROM old_issues
548                 LEFT JOIN borrowers ON  issues.borrowernumber = borrowers.borrowernumber
549                 WHERE itemnumber = ?
550                 ORDER BY returndate DESC,timestamp DESC"
551         );
552
553         $sth2->execute( $data->{'itemnumber'} );
554         for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
555         {    # FIXME : error if there is less than 3 pple borrowing this item
556             if ( my $data2 = $sth2->fetchrow_hashref ) {
557                 $data->{"timestamp$i2"} = $data2->{'timestamp'};
558                 $data->{"card$i2"}      = $data2->{'cardnumber'};
559                 $data->{"borrower$i2"}  = $data2->{'borrowernumber'};
560             }    # if
561         }    # for
562
563         $results[$i] = $data;
564         $i++;
565     }
566
567     return (@results);
568 }
569
570 =head2 CanBookBeIssued
571
572   ( $issuingimpossible, $needsconfirmation ) =  CanBookBeIssued( $borrower, 
573                                       $barcode, $duedatespec, $inprocess );
574
575 Check if a book can be issued.
576
577 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
578
579 =over 4
580
581 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
582
583 =item C<$barcode> is the bar code of the book being issued.
584
585 =item C<$duedatespec> is a C4::Dates object.
586
587 =item C<$inprocess>
588
589 =back
590
591 Returns :
592
593 =over 4
594
595 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
596 Possible values are :
597
598 =back
599
600 =head3 INVALID_DATE 
601
602 sticky due date is invalid
603
604 =head3 GNA
605
606 borrower gone with no address
607
608 =head3 CARD_LOST
609
610 borrower declared it's card lost
611
612 =head3 DEBARRED
613
614 borrower debarred
615
616 =head3 UNKNOWN_BARCODE
617
618 barcode unknown
619
620 =head3 NOT_FOR_LOAN
621
622 item is not for loan
623
624 =head3 WTHDRAWN
625
626 item withdrawn.
627
628 =head3 RESTRICTED
629
630 item is restricted (set by ??)
631
632 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan 
633 could be prevented, but ones that can be overriden by the operator.
634
635 Possible values are :
636
637 =head3 DEBT
638
639 borrower has debts.
640
641 =head3 RENEW_ISSUE
642
643 renewing, not issuing
644
645 =head3 ISSUED_TO_ANOTHER
646
647 issued to someone else.
648
649 =head3 RESERVED
650
651 reserved for someone else.
652
653 =head3 INVALID_DATE
654
655 sticky due date is invalid or due date in the past
656
657 =head3 TOO_MANY
658
659 if the borrower borrows to much things
660
661 =cut
662
663 sub CanBookBeIssued {
664     my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
665     my %needsconfirmation;    # filled with problems that needs confirmations
666     my %issuingimpossible;    # filled with problems that causes the issue to be IMPOSSIBLE
667     my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
668     my $issue = GetItemIssue($item->{itemnumber});
669         my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
670         $item->{'itemtype'}=$item->{'itype'}; 
671     my $dbh             = C4::Context->dbh;
672
673     # MANDATORY CHECKS - unless item exists, nothing else matters
674     unless ( $item->{barcode} ) {
675         $issuingimpossible{UNKNOWN_BARCODE} = 1;
676     }
677         return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
678
679     #
680     # DUE DATE is OK ? -- should already have checked.
681     #
682     unless ( $duedate ) {
683         my $issuedate = strftime( "%Y-%m-%d", localtime );
684
685         my $branch = _GetCircControlBranch($item,$borrower);
686         my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
687         $duedate = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $itype, $branch, $borrower );
688
689         # Offline circ calls AddIssue directly, doesn't run through here
690         #  So issuingimpossible should be ok.
691     }
692     if ($duedate) {
693         $needsconfirmation{INVALID_DATE} = $duedate->output('syspref')
694           unless $duedate->output('iso') ge C4::Dates->today('iso');
695     } else {
696         $issuingimpossible{INVALID_DATE} = $duedate->output('syspref');
697     }
698
699     #
700     # BORROWER STATUS
701     #
702     if ( $borrower->{'category_type'} eq 'X' && (  $item->{barcode}  )) { 
703         # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1  .
704         &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'});
705         ModDateLastSeen( $item->{'itemnumber'} );
706         return( { STATS => 1 }, {});
707     }
708     if ( $borrower->{flags}->{GNA} ) {
709         $issuingimpossible{GNA} = 1;
710     }
711     if ( $borrower->{flags}->{'LOST'} ) {
712         $issuingimpossible{CARD_LOST} = 1;
713     }
714     if ( $borrower->{flags}->{'DBARRED'} ) {
715         $issuingimpossible{DEBARRED} = 1;
716     }
717     if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
718         $issuingimpossible{EXPIRED} = 1;
719     } else {
720         my @expirydate=  split /-/,$borrower->{'dateexpiry'};
721         if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
722             Date_to_Days(Today) > Date_to_Days( @expirydate )) {
723             $issuingimpossible{EXPIRED} = 1;                                   
724         }
725     }
726     #
727     # BORROWER STATUS
728     #
729
730     # DEBTS
731     my ($amount) =
732       C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
733     my $amountlimit = C4::Context->preference("noissuescharge");
734     my $allowfineoverride = C4::Context->preference("AllowFineOverride");
735     my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
736     if ( C4::Context->preference("IssuingInProcess") ) {
737         if ( $amount > $amountlimit && !$inprocess && !$allowfineoverride) {
738             $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
739         } elsif ( $amount > $amountlimit && !$inprocess && $allowfineoverride) {
740             $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
741         } elsif ( $allfinesneedoverride && $amount > 0 && $amount <= $amountlimit && !$inprocess ) {
742             $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
743         }
744     }
745     else {
746         if ( $amount > $amountlimit && $allowfineoverride ) {
747             $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
748         } elsif ( $amount > $amountlimit && !$allowfineoverride) {
749             $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
750         } elsif ( $amount > 0 && $allfinesneedoverride ) {
751             $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
752         }
753     }
754
755     my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
756     if ($blocktype == -1) {
757         ## patron has outstanding overdue loans
758             if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
759                 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
760             }
761             elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
762                 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
763             }
764     } elsif($blocktype == 1) {
765         # patron has accrued fine days
766         $issuingimpossible{USERBLOCKEDREMAINING} = $count;
767     }
768
769 #
770     # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
771     #
772         my ($current_loan_count, $max_loans_allowed) = TooMany( $borrower, $item->{biblionumber}, $item );
773     # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
774     if ($max_loans_allowed eq 0) {
775         $needsconfirmation{PATRON_CANT} = 1;
776     } else {
777         if($max_loans_allowed){
778             $needsconfirmation{TOO_MANY} = 1;
779             $needsconfirmation{current_loan_count} = $current_loan_count;
780             $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
781         }
782     }
783
784     #
785     # ITEM CHECKING
786     #
787     if (   $item->{'notforloan'}
788         && $item->{'notforloan'} > 0 )
789     {
790         if(!C4::Context->preference("AllowNotForLoanOverride")){
791             $issuingimpossible{NOT_FOR_LOAN} = 1;
792         }else{
793             $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
794         }
795     }
796     elsif ( !$item->{'notforloan'} ){
797         # we have to check itemtypes.notforloan also
798         if (C4::Context->preference('item-level_itypes')){
799             # this should probably be a subroutine
800             my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
801             $sth->execute($item->{'itemtype'});
802             my $notforloan=$sth->fetchrow_hashref();
803             $sth->finish();
804             if ($notforloan->{'notforloan'}) {
805                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
806                     $issuingimpossible{NOT_FOR_LOAN} = 1;
807                 } else {
808                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
809                 }
810             }
811         }
812         elsif ($biblioitem->{'notforloan'} == 1){
813             if (!C4::Context->preference("AllowNotForLoanOverride")) {
814                 $issuingimpossible{NOT_FOR_LOAN} = 1;
815             } else {
816                 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
817             }
818         }
819     }
820     if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
821     {
822         $issuingimpossible{WTHDRAWN} = 1;
823     }
824     if (   $item->{'restricted'}
825         && $item->{'restricted'} == 1 )
826     {
827         $issuingimpossible{RESTRICTED} = 1;
828     }
829     if ( C4::Context->preference("IndependantBranches") ) {
830         my $userenv = C4::Context->userenv;
831         if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
832             $issuingimpossible{ITEMNOTSAMEBRANCH} = 1
833               if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
834             $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
835               if ( $borrower->{'branchcode'} ne $userenv->{branch} );
836         }
837     }
838
839     #
840     # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
841     #
842     if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
843     {
844
845         # Already issued to current borrower. Ask whether the loan should
846         # be renewed.
847         my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
848             $borrower->{'borrowernumber'},
849             $item->{'itemnumber'}
850         );
851         if ( $CanBookBeRenewed == 0 ) {    # no more renewals allowed
852             $issuingimpossible{NO_MORE_RENEWALS} = 1;
853         }
854         else {
855             $needsconfirmation{RENEW_ISSUE} = 1;
856         }
857     }
858     elsif ($issue->{borrowernumber}) {
859
860         # issued to someone else
861         my $currborinfo =    C4::Members::GetMemberDetails( $issue->{borrowernumber} );
862
863 #        warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
864         $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
865         $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
866         $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
867         $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
868         $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
869     }
870
871     # See if the item is on reserve.
872     my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
873     if ($restype) {
874                 my $resbor = $res->{'borrowernumber'};
875                 my ( $resborrower ) = C4::Members::GetMemberDetails( $resbor, 0 );
876                 my $branches  = GetBranches();
877                 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
878         if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
879         {
880             # The item is on reserve and waiting, but has been
881             # reserved by some other patron.
882             $needsconfirmation{RESERVE_WAITING} = 1;
883             $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
884             $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
885             $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
886             $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
887             $needsconfirmation{'resbranchname'} = $branchname;
888             $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
889         }
890         elsif ( $restype eq "Reserved" ) {
891             # The item is on reserve for someone else.
892             $needsconfirmation{RESERVED} = 1;
893             $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
894             $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
895             $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
896             $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
897             $needsconfirmation{'resbranchname'} = $branchname;
898             $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
899         }
900     }
901         return ( \%issuingimpossible, \%needsconfirmation );
902 }
903
904 =head2 AddIssue
905
906   &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
907
908 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
909
910 =over 4
911
912 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
913
914 =item C<$barcode> is the barcode of the item being issued.
915
916 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
917 Calculated if empty.
918
919 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
920
921 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
922 Defaults to today.  Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
923
924 AddIssue does the following things :
925
926   - step 01: check that there is a borrowernumber & a barcode provided
927   - check for RENEWAL (book issued & being issued to the same patron)
928       - renewal YES = Calculate Charge & renew
929       - renewal NO  =
930           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
931           * RESERVE PLACED ?
932               - fill reserve if reserve to this patron
933               - cancel reserve or not, otherwise
934           * TRANSFERT PENDING ?
935               - complete the transfert
936           * ISSUE THE BOOK
937
938 =back
939
940 =cut
941
942 sub AddIssue {
943     my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
944     my $dbh = C4::Context->dbh;
945         my $barcodecheck=CheckValidBarcode($barcode);
946     # $issuedate defaults to today.
947     if ( ! defined $issuedate ) {
948         $issuedate = strftime( "%Y-%m-%d", localtime );
949         # TODO: for hourly circ, this will need to be a C4::Dates object
950         # and all calls to AddIssue including issuedate will need to pass a Dates object.
951     }
952         if ($borrower and $barcode and $barcodecheck ne '0'){
953                 # find which item we issue
954                 my $item = GetItem('', $barcode) or return undef;       # if we don't get an Item, abort.
955                 my $branch = _GetCircControlBranch($item,$borrower);
956                 
957                 # get actual issuing if there is one
958                 my $actualissue = GetItemIssue( $item->{itemnumber});
959                 
960                 # get biblioinformation for this item
961                 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
962                 
963                 #
964                 # check if we just renew the issue.
965                 #
966                 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
967                         $datedue = AddRenewal(
968                                 $borrower->{'borrowernumber'},
969                                 $item->{'itemnumber'},
970                                 $branch,
971                                 $datedue,
972                 $issuedate, # here interpreted as the renewal date
973                         );
974                 }
975                 else {
976         # it's NOT a renewal
977                         if ( $actualissue->{borrowernumber}) {
978                                 # This book is currently on loan, but not to the person
979                                 # who wants to borrow it now. mark it returned before issuing to the new borrower
980                                 AddReturn(
981                                         $item->{'barcode'},
982                                         C4::Context->userenv->{'branch'}
983                                 );
984                         }
985
986                         # See if the item is on reserve.
987                         my ( $restype, $res ) =
988                           C4::Reserves::CheckReserves( $item->{'itemnumber'} );
989                         if ($restype) {
990                                 my $resbor = $res->{'borrowernumber'};
991                                 if ( $resbor eq $borrower->{'borrowernumber'} ) {
992                                         # The item is reserved by the current patron
993                                         ModReserveFill($res);
994                                 }
995                                 elsif ( $restype eq "Waiting" ) {
996                                         # warn "Waiting";
997                                         # The item is on reserve and waiting, but has been
998                                         # reserved by some other patron.
999                                 }
1000                                 elsif ( $restype eq "Reserved" ) {
1001                                         # warn "Reserved";
1002                                         # The item is reserved by someone else.
1003                                         if ($cancelreserve) { # cancel reserves on this item
1004                                                 CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
1005                                         }
1006                                 }
1007                                 if ($cancelreserve) {
1008                                         CancelReserve($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
1009                                 }
1010                                 else {
1011                                         # set waiting reserve to first in reserve queue as book isn't waiting now
1012                                         ModReserve(1,
1013                                                 $res->{'biblionumber'},
1014                                                 $res->{'borrowernumber'},
1015                                                 $res->{'branchcode'}
1016                                         );
1017                                 }
1018                         }
1019
1020                         # Starting process for transfer job (checking transfert and validate it if we have one)
1021             my ($datesent) = GetTransfers($item->{'itemnumber'});
1022             if ($datesent) {
1023         #       updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1024                 my $sth =
1025                     $dbh->prepare(
1026                     "UPDATE branchtransfers 
1027                         SET datearrived = now(),
1028                         tobranch = ?,
1029                         comments = 'Forced branchtransfer'
1030                     WHERE itemnumber= ? AND datearrived IS NULL"
1031                     );
1032                 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1033             }
1034
1035         # Record in the database the fact that the book was issued.
1036         my $sth =
1037           $dbh->prepare(
1038                 "INSERT INTO issues 
1039                     (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1040                 VALUES (?,?,?,?,?)"
1041           );
1042         unless ($datedue) {
1043             my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1044             $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $itype, $branch, $borrower );
1045
1046         }
1047         $sth->execute(
1048             $borrower->{'borrowernumber'},      # borrowernumber
1049             $item->{'itemnumber'},              # itemnumber
1050             $issuedate,                         # issuedate
1051             $datedue->output('iso'),            # date_due
1052             C4::Context->userenv->{'branch'}    # branchcode
1053         );
1054         $sth->finish;
1055         if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1056           CartToShelf( $item->{'itemnumber'} );
1057         }
1058         $item->{'issues'}++;
1059         ModItem({ issues           => $item->{'issues'},
1060                   holdingbranch    => C4::Context->userenv->{'branch'},
1061                   itemlost         => 0,
1062                   datelastborrowed => C4::Dates->new()->output('iso'),
1063                   onloan           => $datedue->output('iso'),
1064                 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1065         ModDateLastSeen( $item->{'itemnumber'} );
1066
1067         # If it costs to borrow this book, charge it to the patron's account.
1068         my ( $charge, $itemtype ) = GetIssuingCharges(
1069             $item->{'itemnumber'},
1070             $borrower->{'borrowernumber'}
1071         );
1072         if ( $charge > 0 ) {
1073             AddIssuingCharge(
1074                 $item->{'itemnumber'},
1075                 $borrower->{'borrowernumber'}, $charge
1076             );
1077             $item->{'charge'} = $charge;
1078         }
1079
1080         # Record the fact that this book was issued.
1081         &UpdateStats(
1082             C4::Context->userenv->{'branch'},
1083             'issue', $charge,
1084             ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1085             $item->{'itype'}, $borrower->{'borrowernumber'}
1086         );
1087
1088         # Send a checkout slip.
1089         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1090         my %conditions = (
1091             branchcode   => $branch,
1092             categorycode => $borrower->{categorycode},
1093             item_type    => $item->{itype},
1094             notification => 'CHECKOUT',
1095         );
1096         if ($circulation_alert->is_enabled_for(\%conditions)) {
1097             SendCirculationAlert({
1098                 type     => 'CHECKOUT',
1099                 item     => $item,
1100                 borrower => $borrower,
1101                 branch   => $branch,
1102             });
1103         }
1104     }
1105
1106     logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1107         if C4::Context->preference("IssueLog");
1108   }
1109   return ($datedue);    # not necessarily the same as when it came in!
1110 }
1111
1112 =head2 GetLoanLength
1113
1114   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1115
1116 Get loan length for an itemtype, a borrower type and a branch
1117
1118 =cut
1119
1120 sub GetLoanLength {
1121     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1122     my $dbh = C4::Context->dbh;
1123     my $sth =
1124       $dbh->prepare(
1125 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1126       );
1127 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1128 # try to find issuelength & return the 1st available.
1129 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1130     $sth->execute( $borrowertype, $itemtype, $branchcode );
1131     my $loanlength = $sth->fetchrow_hashref;
1132     return $loanlength->{issuelength}
1133       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1134
1135     $sth->execute( $borrowertype, "*", $branchcode );
1136     $loanlength = $sth->fetchrow_hashref;
1137     return $loanlength->{issuelength}
1138       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1139
1140     $sth->execute( "*", $itemtype, $branchcode );
1141     $loanlength = $sth->fetchrow_hashref;
1142     return $loanlength->{issuelength}
1143       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1144
1145     $sth->execute( "*", "*", $branchcode );
1146     $loanlength = $sth->fetchrow_hashref;
1147     return $loanlength->{issuelength}
1148       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1149
1150     $sth->execute( $borrowertype, $itemtype, "*" );
1151     $loanlength = $sth->fetchrow_hashref;
1152     return $loanlength->{issuelength}
1153       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1154
1155     $sth->execute( $borrowertype, "*", "*" );
1156     $loanlength = $sth->fetchrow_hashref;
1157     return $loanlength->{issuelength}
1158       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1159
1160     $sth->execute( "*", $itemtype, "*" );
1161     $loanlength = $sth->fetchrow_hashref;
1162     return $loanlength->{issuelength}
1163       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1164
1165     $sth->execute( "*", "*", "*" );
1166     $loanlength = $sth->fetchrow_hashref;
1167     return $loanlength->{issuelength}
1168       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1169
1170     # if no rule is set => 21 days (hardcoded)
1171     return 21;
1172 }
1173
1174
1175 =head2 GetHardDueDate
1176
1177   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1178
1179 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1180
1181 =cut
1182
1183 sub GetHardDueDate {
1184     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1185     my $dbh = C4::Context->dbh;
1186     my $sth =
1187       $dbh->prepare(
1188 "select hardduedate, hardduedatecompare from issuingrules where categorycode=? and itemtype=? and branchcode=?"
1189       );
1190     $sth->execute( $borrowertype, $itemtype, $branchcode );
1191     my $results = $sth->fetchrow_hashref;
1192     return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1193       if defined($results) && $results->{hardduedate} ne 'NULL';
1194
1195     $sth->execute( $borrowertype, "*", $branchcode );
1196     $results = $sth->fetchrow_hashref;
1197     return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1198       if defined($results) && $results->{hardduedate} ne 'NULL';
1199
1200     $sth->execute( "*", $itemtype, $branchcode );
1201     $results = $sth->fetchrow_hashref;
1202     return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1203       if defined($results) && $results->{hardduedate} ne 'NULL';
1204
1205     $sth->execute( "*", "*", $branchcode );
1206     $results = $sth->fetchrow_hashref;
1207     return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1208       if defined($results) && $results->{hardduedate} ne 'NULL';
1209
1210     $sth->execute( $borrowertype, $itemtype, "*" );
1211     $results = $sth->fetchrow_hashref;
1212     return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1213       if defined($results) && $results->{hardduedate} ne 'NULL';
1214
1215     $sth->execute( $borrowertype, "*", "*" );
1216     $results = $sth->fetchrow_hashref;
1217     return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1218       if defined($results) && $results->{hardduedate} ne 'NULL';
1219
1220     $sth->execute( "*", $itemtype, "*" );
1221     $results = $sth->fetchrow_hashref;
1222     return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1223       if defined($results) && $results->{hardduedate} ne 'NULL';
1224
1225     $sth->execute( "*", "*", "*" );
1226     $results = $sth->fetchrow_hashref;
1227     return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1228       if defined($results) && $results->{hardduedate} ne 'NULL';
1229
1230     # if no rule is set => return undefined
1231     return (undef, undef);
1232 }
1233
1234 =head2 GetIssuingRule
1235
1236   my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1237
1238 FIXME - This is a copy-paste of GetLoanLength
1239 as a stop-gap.  Do not wish to change API for GetLoanLength 
1240 this close to release, however, Overdues::GetIssuingRules is broken.
1241
1242 Get the issuing rule for an itemtype, a borrower type and a branch
1243 Returns a hashref from the issuingrules table.
1244
1245 =cut
1246
1247 sub GetIssuingRule {
1248     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1249     my $dbh = C4::Context->dbh;
1250     my $sth =  $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"  );
1251     my $irule;
1252
1253         $sth->execute( $borrowertype, $itemtype, $branchcode );
1254     $irule = $sth->fetchrow_hashref;
1255     return $irule if defined($irule) ;
1256
1257     $sth->execute( $borrowertype, "*", $branchcode );
1258     $irule = $sth->fetchrow_hashref;
1259     return $irule if defined($irule) ;
1260
1261     $sth->execute( "*", $itemtype, $branchcode );
1262     $irule = $sth->fetchrow_hashref;
1263     return $irule if defined($irule) ;
1264
1265     $sth->execute( "*", "*", $branchcode );
1266     $irule = $sth->fetchrow_hashref;
1267     return $irule if defined($irule) ;
1268
1269     $sth->execute( $borrowertype, $itemtype, "*" );
1270     $irule = $sth->fetchrow_hashref;
1271     return $irule if defined($irule) ;
1272
1273     $sth->execute( $borrowertype, "*", "*" );
1274     $irule = $sth->fetchrow_hashref;
1275     return $irule if defined($irule) ;
1276
1277     $sth->execute( "*", $itemtype, "*" );
1278     $irule = $sth->fetchrow_hashref;
1279     return $irule if defined($irule) ;
1280
1281     $sth->execute( "*", "*", "*" );
1282     $irule = $sth->fetchrow_hashref;
1283     return $irule if defined($irule) ;
1284
1285     # if no rule matches,
1286     return undef;
1287 }
1288
1289 =head2 GetBranchBorrowerCircRule
1290
1291   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1292
1293 Retrieves circulation rule attributes that apply to the given
1294 branch and patron category, regardless of item type.  
1295 The return value is a hashref containing the following key:
1296
1297 maxissueqty - maximum number of loans that a
1298 patron of the given category can have at the given
1299 branch.  If the value is undef, no limit.
1300
1301 This will first check for a specific branch and
1302 category match from branch_borrower_circ_rules. 
1303
1304 If no rule is found, it will then check default_branch_circ_rules
1305 (same branch, default category).  If no rule is found,
1306 it will then check default_borrower_circ_rules (default 
1307 branch, same category), then failing that, default_circ_rules
1308 (default branch, default category).
1309
1310 If no rule has been found in the database, it will default to
1311 the buillt in rule:
1312
1313 maxissueqty - undef
1314
1315 C<$branchcode> and C<$categorycode> should contain the
1316 literal branch code and patron category code, respectively - no
1317 wildcards.
1318
1319 =cut
1320
1321 sub GetBranchBorrowerCircRule {
1322     my $branchcode = shift;
1323     my $categorycode = shift;
1324
1325     my $branch_cat_query = "SELECT maxissueqty
1326                             FROM branch_borrower_circ_rules
1327                             WHERE branchcode = ?
1328                             AND   categorycode = ?";
1329     my $dbh = C4::Context->dbh();
1330     my $sth = $dbh->prepare($branch_cat_query);
1331     $sth->execute($branchcode, $categorycode);
1332     my $result;
1333     if ($result = $sth->fetchrow_hashref()) {
1334         return $result;
1335     }
1336
1337     # try same branch, default borrower category
1338     my $branch_query = "SELECT maxissueqty
1339                         FROM default_branch_circ_rules
1340                         WHERE branchcode = ?";
1341     $sth = $dbh->prepare($branch_query);
1342     $sth->execute($branchcode);
1343     if ($result = $sth->fetchrow_hashref()) {
1344         return $result;
1345     }
1346
1347     # try default branch, same borrower category
1348     my $category_query = "SELECT maxissueqty
1349                           FROM default_borrower_circ_rules
1350                           WHERE categorycode = ?";
1351     $sth = $dbh->prepare($category_query);
1352     $sth->execute($categorycode);
1353     if ($result = $sth->fetchrow_hashref()) {
1354         return $result;
1355     }
1356   
1357     # try default branch, default borrower category
1358     my $default_query = "SELECT maxissueqty
1359                           FROM default_circ_rules";
1360     $sth = $dbh->prepare($default_query);
1361     $sth->execute();
1362     if ($result = $sth->fetchrow_hashref()) {
1363         return $result;
1364     }
1365     
1366     # built-in default circulation rule
1367     return {
1368         maxissueqty => undef,
1369     };
1370 }
1371
1372 =head2 GetBranchItemRule
1373
1374   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1375
1376 Retrieves circulation rule attributes that apply to the given
1377 branch and item type, regardless of patron category.
1378
1379 The return value is a hashref containing the following key:
1380
1381 holdallowed => Hold policy for this branch and itemtype. Possible values:
1382   0: No holds allowed.
1383   1: Holds allowed only by patrons that have the same homebranch as the item.
1384   2: Holds allowed from any patron.
1385
1386 This searches branchitemrules in the following order:
1387
1388   * Same branchcode and itemtype
1389   * Same branchcode, itemtype '*'
1390   * branchcode '*', same itemtype
1391   * branchcode and itemtype '*'
1392
1393 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1394
1395 =cut
1396
1397 sub GetBranchItemRule {
1398     my ( $branchcode, $itemtype ) = @_;
1399     my $dbh = C4::Context->dbh();
1400     my $result = {};
1401
1402     my @attempts = (
1403         ['SELECT holdallowed
1404             FROM branch_item_rules
1405             WHERE branchcode = ?
1406               AND itemtype = ?', $branchcode, $itemtype],
1407         ['SELECT holdallowed
1408             FROM default_branch_circ_rules
1409             WHERE branchcode = ?', $branchcode],
1410         ['SELECT holdallowed
1411             FROM default_branch_item_rules
1412             WHERE itemtype = ?', $itemtype],
1413         ['SELECT holdallowed
1414             FROM default_circ_rules'],
1415     );
1416
1417     foreach my $attempt (@attempts) {
1418         my ($query, @bind_params) = @{$attempt};
1419
1420         # Since branch/category and branch/itemtype use the same per-branch
1421         # defaults tables, we have to check that the key we want is set, not
1422         # just that a row was returned
1423         return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1424     }
1425     
1426     # built-in default circulation rule
1427     return {
1428         holdallowed => 2,
1429     };
1430 }
1431
1432 =head2 AddReturn
1433
1434   ($doreturn, $messages, $iteminformation, $borrower) =
1435       &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1436
1437 Returns a book.
1438
1439 =over 4
1440
1441 =item C<$barcode> is the bar code of the book being returned.
1442
1443 =item C<$branch> is the code of the branch where the book is being returned.
1444
1445 =item C<$exemptfine> indicates that overdue charges for the item will be
1446 removed.
1447
1448 =item C<$dropbox> indicates that the check-in date is assumed to be
1449 yesterday, or the last non-holiday as defined in C4::Calendar .  If
1450 overdue charges are applied and C<$dropbox> is true, the last charge
1451 will be removed.  This assumes that the fines accrual script has run
1452 for _today_.
1453
1454 =back
1455
1456 C<&AddReturn> returns a list of four items:
1457
1458 C<$doreturn> is true iff the return succeeded.
1459
1460 C<$messages> is a reference-to-hash giving feedback on the operation.
1461 The keys of the hash are:
1462
1463 =over 4
1464
1465 =item C<BadBarcode>
1466
1467 No item with this barcode exists. The value is C<$barcode>.
1468
1469 =item C<NotIssued>
1470
1471 The book is not currently on loan. The value is C<$barcode>.
1472
1473 =item C<IsPermanent>
1474
1475 The book's home branch is a permanent collection. If you have borrowed
1476 this book, you are not allowed to return it. The value is the code for
1477 the book's home branch.
1478
1479 =item C<wthdrawn>
1480
1481 This book has been withdrawn/cancelled. The value should be ignored.
1482
1483 =item C<Wrongbranch>
1484
1485 This book has was returned to the wrong branch.  The value is a hashref
1486 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1487 contain the branchcode of the incorrect and correct return library, respectively.
1488
1489 =item C<ResFound>
1490
1491 The item was reserved. The value is a reference-to-hash whose keys are
1492 fields from the reserves table of the Koha database, and
1493 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1494 either C<Waiting>, C<Reserved>, or 0.
1495
1496 =back
1497
1498 C<$iteminformation> is a reference-to-hash, giving information about the
1499 returned item from the issues table.
1500
1501 C<$borrower> is a reference-to-hash, giving information about the
1502 patron who last borrowed the book.
1503
1504 =cut
1505
1506 sub AddReturn {
1507     my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1508     if ($branch and not GetBranchDetail($branch)) {
1509         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1510         undef $branch;
1511     }
1512     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1513     my $messages;
1514     my $borrower;
1515     my $biblio;
1516     my $doreturn       = 1;
1517     my $validTransfert = 0;
1518     
1519     # get information on item
1520     my $itemnumber = GetItemnumberFromBarcode( $barcode );
1521     unless ($itemnumber) {
1522         return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower.  bail out.
1523     }
1524     my $issue  = GetItemIssue($itemnumber);
1525 #   warn Dumper($iteminformation);
1526     if ($issue and $issue->{borrowernumber}) {
1527         $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1528             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1529                 . Dumper($issue) . "\n";
1530     } else {
1531         $messages->{'NotIssued'} = $barcode;
1532         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1533         $doreturn = 0;
1534         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1535     }
1536
1537     my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1538         # full item data, but no borrowernumber or checkout info (no issue)
1539         # we know GetItem should work because GetItemnumberFromBarcode worked
1540     my $hbr      = C4::Context->preference("HomeOrHoldingBranchReturn") || "homebranch";
1541     $hbr = $item->{$hbr} || '';
1542         # item must be from items table -- issues table has branchcode and issuingbranch, not homebranch nor holdingbranch
1543
1544     my $borrowernumber = $borrower->{'borrowernumber'} || undef;    # we don't know if we had a borrower or not
1545
1546     # check if the book is in a permanent collection....
1547     # FIXME -- This 'PE' attribute is largely undocumented.  afaict, there's no user interface that reflects this functionality.
1548     if ( $hbr ) {
1549         my $branches = GetBranches();    # a potentially expensive call for a non-feature.
1550         $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1551     }
1552
1553     # if indy branches and returning to different branch, refuse the return
1554     if ($hbr ne $branch && C4::Context->preference("IndependantBranches")){
1555         $messages->{'Wrongbranch'} = {
1556             Wrongbranch => $branch,
1557             Rightbranch => $hbr,
1558         };
1559         $doreturn = 0;
1560         # bailing out here - in this case, current desired behavior
1561         # is to act as if no return ever happened at all.
1562         # FIXME - even in an indy branches situation, there should
1563         # still be an option for the library to accept the item
1564         # and transfer it to its owning library.
1565         return ( $doreturn, $messages, $issue, $borrower );
1566     }
1567
1568     if ( $item->{'wthdrawn'} ) { # book has been cancelled
1569         $messages->{'wthdrawn'} = 1;
1570         $doreturn = 0;
1571     }
1572
1573     # case of a return of document (deal with issues and holdingbranch)
1574     if ($doreturn) {
1575         $borrower or warn "AddReturn without current borrower";
1576                 my $circControlBranch;
1577         if ($dropbox) {
1578             # define circControlBranch only if dropbox mode is set
1579             # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1580             # FIXME: check issuedate > returndate, factoring in holidays
1581             $circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1582         }
1583
1584         if ($borrowernumber) {
1585             MarkIssueReturned($borrowernumber, $item->{'itemnumber'}, $circControlBranch, '', $borrower->{'privacy'});
1586             $messages->{'WasReturned'} = 1;    # FIXME is the "= 1" right?  This could be the borrower hash.
1587         }
1588
1589         ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1590     }
1591
1592     # the holdingbranch is updated if the document is returned to another location.
1593     # this is always done regardless of whether the item was on loan or not
1594     if ($item->{'holdingbranch'} ne $branch) {
1595         UpdateHoldingbranch($branch, $item->{'itemnumber'});
1596         $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1597     }
1598     ModDateLastSeen( $item->{'itemnumber'} );
1599
1600     # check if we have a transfer for this document
1601     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1602
1603     # if we have a transfer to do, we update the line of transfers with the datearrived
1604     if ($datesent) {
1605         if ( $tobranch eq $branch ) {
1606             my $sth = C4::Context->dbh->prepare(
1607                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1608             );
1609             $sth->execute( $item->{'itemnumber'} );
1610             # if we have a reservation with valid transfer, we can set it's status to 'W'
1611             C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1612         } else {
1613             $messages->{'WrongTransfer'}     = $tobranch;
1614             $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1615         }
1616         $validTransfert = 1;
1617     }
1618
1619     # fix up the accounts.....
1620     if ($item->{'itemlost'}) {
1621         _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode);    # can tolerate undef $borrowernumber
1622         $messages->{'WasLost'} = 1;
1623     }
1624
1625     # fix up the overdues in accounts...
1626     if ($borrowernumber) {
1627         my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1628         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!";  # zero is OK, check defined
1629     }
1630
1631     # find reserves.....
1632     # if we don't have a reserve with the status W, we launch the Checkreserves routine
1633     my ($resfound, $resrec) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1634     if ($resfound) {
1635           $resrec->{'ResFound'} = $resfound;
1636         $messages->{'ResFound'} = $resrec;
1637     }
1638
1639     # update stats?
1640     # Record the fact that this book was returned.
1641     UpdateStats(
1642         $branch, 'return', '0', '',
1643         $item->{'itemnumber'},
1644         $biblio->{'itemtype'},
1645         $borrowernumber
1646     );
1647
1648     # Send a check-in slip. # NOTE: borrower may be undef.  probably shouldn't try to send messages then.
1649     my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1650     my %conditions = (
1651         branchcode   => $branch,
1652         categorycode => $borrower->{categorycode},
1653         item_type    => $item->{itype},
1654         notification => 'CHECKIN',
1655     );
1656     if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1657         SendCirculationAlert({
1658             type     => 'CHECKIN',
1659             item     => $item,
1660             borrower => $borrower,
1661             branch   => $branch,
1662         });
1663     }
1664     
1665     logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1666         if C4::Context->preference("ReturnLog");
1667     
1668     # FIXME: make this comment intelligible.
1669     #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1670     #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1671
1672     if ($doreturn and ($branch ne $hbr) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) ){
1673         if ( C4::Context->preference("AutomaticItemReturn"    ) or
1674             (C4::Context->preference("UseBranchTransferLimits") and
1675              ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1676            )) {
1677             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1678             $debug and warn "item: " . Dumper($item);
1679             ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1680             $messages->{'WasTransfered'} = 1;
1681         } else {
1682             $messages->{'NeedsTransfer'} = 1;   # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1683         }
1684     }
1685     return ( $doreturn, $messages, $issue, $borrower );
1686 }
1687
1688 =head2 MarkIssueReturned
1689
1690   MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1691
1692 Unconditionally marks an issue as being returned by
1693 moving the C<issues> row to C<old_issues> and
1694 setting C<returndate> to the current date, or
1695 the last non-holiday date of the branccode specified in
1696 C<dropbox_branch> .  Assumes you've already checked that 
1697 it's safe to do this, i.e. last non-holiday > issuedate.
1698
1699 if C<$returndate> is specified (in iso format), it is used as the date
1700 of the return. It is ignored when a dropbox_branch is passed in.
1701
1702 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1703 the old_issue is immediately anonymised
1704
1705 Ideally, this function would be internal to C<C4::Circulation>,
1706 not exported, but it is currently needed by one 
1707 routine in C<C4::Accounts>.
1708
1709 =cut
1710
1711 sub MarkIssueReturned {
1712     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1713     my $dbh   = C4::Context->dbh;
1714     my $query = "UPDATE issues SET returndate=";
1715     my @bind;
1716     if ($dropbox_branch) {
1717         my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1718         my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1719         $query .= " ? ";
1720         push @bind, $dropboxdate->output('iso');
1721     } elsif ($returndate) {
1722         $query .= " ? ";
1723         push @bind, $returndate;
1724     } else {
1725         $query .= " now() ";
1726     }
1727     $query .= " WHERE  borrowernumber = ?  AND itemnumber = ?";
1728     push @bind, $borrowernumber, $itemnumber;
1729     # FIXME transaction
1730     my $sth_upd  = $dbh->prepare($query);
1731     $sth_upd->execute(@bind);
1732     my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues 
1733                                   WHERE borrowernumber = ?
1734                                   AND itemnumber = ?");
1735     $sth_copy->execute($borrowernumber, $itemnumber);
1736     # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
1737     if ( $privacy == 2) {
1738         # The default of 0 does not work due to foreign key constraints
1739         # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
1740         my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
1741         my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
1742                                   WHERE borrowernumber = ?
1743                                   AND itemnumber = ?");
1744        $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
1745     }
1746     my $sth_del  = $dbh->prepare("DELETE FROM issues
1747                                   WHERE borrowernumber = ?
1748                                   AND itemnumber = ?");
1749     $sth_del->execute($borrowernumber, $itemnumber);
1750 }
1751
1752 =head2 _FixOverduesOnReturn
1753
1754    &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1755
1756 C<$brn> borrowernumber
1757
1758 C<$itm> itemnumber
1759
1760 C<$exemptfine> BOOL -- remove overdue charge associated with this issue. 
1761 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1762
1763 Internal function, called only by AddReturn
1764
1765 =cut
1766
1767 sub _FixOverduesOnReturn {
1768     my ($borrowernumber, $item);
1769     unless ($borrowernumber = shift) {
1770         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1771         return;
1772     }
1773     unless ($item = shift) {
1774         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1775         return;
1776     }
1777     my ($exemptfine, $dropbox) = @_;
1778     my $dbh = C4::Context->dbh;
1779
1780     # check for overdue fine
1781     my $sth = $dbh->prepare(
1782 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1783     );
1784     $sth->execute( $borrowernumber, $item );
1785
1786     # alter fine to show that the book has been returned
1787     my $data = $sth->fetchrow_hashref;
1788     return 0 unless $data;    # no warning, there's just nothing to fix
1789
1790     my $uquery;
1791     my @bind = ($borrowernumber, $item, $data->{'accountno'});
1792     if ($exemptfine) {
1793         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1794         if (C4::Context->preference("FinesLog")) {
1795             &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1796         }
1797     } elsif ($dropbox && $data->{lastincrement}) {
1798         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1799         my $amt = $data->{amount} - $data->{lastincrement} ;
1800         if (C4::Context->preference("FinesLog")) {
1801             &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1802         }
1803          $uquery = "update accountlines set accounttype='F' ";
1804          if($outstanding  >= 0 && $amt >=0) {
1805             $uquery .= ", amount = ? , amountoutstanding=? ";
1806             unshift @bind, ($amt, $outstanding) ;
1807         }
1808     } else {
1809         $uquery = "update accountlines set accounttype='F' ";
1810     }
1811     $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1812     my $usth = $dbh->prepare($uquery);
1813     return $usth->execute(@bind);
1814 }
1815
1816 =head2 _FixAccountForLostAndReturned
1817
1818   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1819
1820 Calculates the charge for a book lost and returned.
1821
1822 Internal function, not exported, called only by AddReturn.
1823
1824 FIXME: This function reflects how inscrutable fines logic is.  Fix both.
1825 FIXME: Give a positive return value on success.  It might be the $borrowernumber who received credit, or the amount forgiven.
1826
1827 =cut
1828
1829 sub _FixAccountForLostAndReturned {
1830     my $itemnumber     = shift or return;
1831     my $borrowernumber = @_ ? shift : undef;
1832     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
1833     my $dbh = C4::Context->dbh;
1834     # check for charge made for lost book
1835     my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1836     $sth->execute($itemnumber);
1837     my $data = $sth->fetchrow_hashref;
1838     $data or return;    # bail if there is nothing to do
1839
1840     # writeoff this amount
1841     my $offset;
1842     my $amount = $data->{'amount'};
1843     my $acctno = $data->{'accountno'};
1844     my $amountleft;                                             # Starts off undef/zero.
1845     if ($data->{'amountoutstanding'} == $amount) {
1846         $offset     = $data->{'amount'};
1847         $amountleft = 0;                                        # Hey, it's zero here, too.
1848     } else {
1849         $offset     = $amount - $data->{'amountoutstanding'};   # Um, isn't this the same as ZERO?  We just tested those two things are ==
1850         $amountleft = $data->{'amountoutstanding'} - $amount;   # Um, isn't this the same as ZERO?  We just tested those two things are ==
1851     }
1852     my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1853         WHERE (borrowernumber = ?)
1854         AND (itemnumber = ?) AND (accountno = ?) ");
1855     $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno);      # We might be adjusting an account for some OTHER borrowernumber now.  Not the one we passed in.  
1856     #check if any credit is left if so writeoff other accounts
1857     my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1858     $amountleft *= -1 if ($amountleft < 0);
1859     if ($amountleft > 0) {
1860         my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1861                             AND (amountoutstanding >0) ORDER BY date");     # might want to order by amountoustanding ASC (pay smallest first)
1862         $msth->execute($data->{'borrowernumber'});
1863         # offset transactions
1864         my $newamtos;
1865         my $accdata;
1866         while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1867             if ($accdata->{'amountoutstanding'} < $amountleft) {
1868                 $newamtos = 0;
1869                 $amountleft -= $accdata->{'amountoutstanding'};
1870             }  else {
1871                 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1872                 $amountleft = 0;
1873             }
1874             my $thisacct = $accdata->{'accountno'};
1875             # FIXME: move prepares outside while loop!
1876             my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1877                     WHERE (borrowernumber = ?)
1878                     AND (accountno=?)");
1879             $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');    # FIXME: '$thisacct' is a string literal!
1880             $usth = $dbh->prepare("INSERT INTO accountoffsets
1881                 (borrowernumber, accountno, offsetaccount,  offsetamount)
1882                 VALUES
1883                 (?,?,?,?)");
1884             $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1885         }
1886         $msth->finish;  # $msth might actually have data left
1887     }
1888     $amountleft *= -1 if ($amountleft > 0);
1889     my $desc = "Item Returned " . $item_id;
1890     $usth = $dbh->prepare("INSERT INTO accountlines
1891         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1892         VALUES (?,?,now(),?,?,'CR',?)");
1893     $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1894     if ($borrowernumber) {
1895         # FIXME: same as query above.  use 1 sth for both
1896         $usth = $dbh->prepare("INSERT INTO accountoffsets
1897             (borrowernumber, accountno, offsetaccount,  offsetamount)
1898             VALUES (?,?,?,?)");
1899         $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
1900     }
1901     ModItem({ paidfor => '' }, undef, $itemnumber);
1902     return;
1903 }
1904
1905 =head2 _GetCircControlBranch
1906
1907    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
1908
1909 Internal function : 
1910
1911 Return the library code to be used to determine which circulation
1912 policy applies to a transaction.  Looks up the CircControl and
1913 HomeOrHoldingBranch system preferences.
1914
1915 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
1916
1917 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
1918
1919 =cut
1920
1921 sub _GetCircControlBranch {
1922     my ($item, $borrower) = @_;
1923     my $circcontrol = C4::Context->preference('CircControl');
1924     my $branch;
1925
1926     if ($circcontrol eq 'PickupLibrary') {
1927         $branch= C4::Context->userenv->{'branch'};
1928     } elsif ($circcontrol eq 'PatronLibrary') {
1929         $branch=$borrower->{branchcode};
1930     } else {
1931         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
1932         $branch = $item->{$branchfield};
1933         # default to item home branch if holdingbranch is used
1934         # and is not defined
1935         if (!defined($branch) && $branchfield eq 'holdingbranch') {
1936             $branch = $item->{homebranch};
1937         }
1938     }
1939     return $branch;
1940 }
1941
1942
1943
1944
1945
1946
1947 =head2 GetItemIssue
1948
1949   $issue = &GetItemIssue($itemnumber);
1950
1951 Returns patron currently having a book, or undef if not checked out.
1952
1953 C<$itemnumber> is the itemnumber.
1954
1955 C<$issue> is a hashref of the row from the issues table.
1956
1957 =cut
1958
1959 sub GetItemIssue {
1960     my ($itemnumber) = @_;
1961     return unless $itemnumber;
1962     my $sth = C4::Context->dbh->prepare(
1963         "SELECT *
1964         FROM issues 
1965         LEFT JOIN items ON issues.itemnumber=items.itemnumber
1966         WHERE issues.itemnumber=?");
1967     $sth->execute($itemnumber);
1968     my $data = $sth->fetchrow_hashref;
1969     return unless $data;
1970     $data->{'overdue'} = ($data->{'date_due'} lt C4::Dates->today('iso')) ? 1 : 0;
1971     return ($data);
1972 }
1973
1974 =head2 GetOpenIssue
1975
1976   $issue = GetOpenIssue( $itemnumber );
1977
1978 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1979
1980 C<$itemnumber> is the item's itemnumber
1981
1982 Returns a hashref
1983
1984 =cut
1985
1986 sub GetOpenIssue {
1987   my ( $itemnumber ) = @_;
1988
1989   my $dbh = C4::Context->dbh;  
1990   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1991   $sth->execute( $itemnumber );
1992   my $issue = $sth->fetchrow_hashref();
1993   return $issue;
1994 }
1995
1996 =head2 GetItemIssues
1997
1998   $issues = &GetItemIssues($itemnumber, $history);
1999
2000 Returns patrons that have issued a book
2001
2002 C<$itemnumber> is the itemnumber
2003 C<$history> is false if you just want the current "issuer" (if any)
2004 and true if you want issues history from old_issues also.
2005
2006 Returns reference to an array of hashes
2007
2008 =cut
2009
2010 sub GetItemIssues {
2011     my ( $itemnumber, $history ) = @_;
2012     
2013     my $today = C4::Dates->today('iso');  # get today date
2014     my $sql = "SELECT * FROM issues 
2015               JOIN borrowers USING (borrowernumber)
2016               JOIN items     USING (itemnumber)
2017               WHERE issues.itemnumber = ? ";
2018     if ($history) {
2019         $sql .= "UNION ALL
2020                  SELECT * FROM old_issues 
2021                  LEFT JOIN borrowers USING (borrowernumber)
2022                  JOIN items USING (itemnumber)
2023                  WHERE old_issues.itemnumber = ? ";
2024     }
2025     $sql .= "ORDER BY date_due DESC";
2026     my $sth = C4::Context->dbh->prepare($sql);
2027     if ($history) {
2028         $sth->execute($itemnumber, $itemnumber);
2029     } else {
2030         $sth->execute($itemnumber);
2031     }
2032     my $results = $sth->fetchall_arrayref({});
2033     foreach (@$results) {
2034         $_->{'overdue'} = ($_->{'date_due'} lt $today) ? 1 : 0;
2035     }
2036     return $results;
2037 }
2038
2039 =head2 GetBiblioIssues
2040
2041   $issues = GetBiblioIssues($biblionumber);
2042
2043 this function get all issues from a biblionumber.
2044
2045 Return:
2046 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2047 tables issues and the firstname,surname & cardnumber from borrowers.
2048
2049 =cut
2050
2051 sub GetBiblioIssues {
2052     my $biblionumber = shift;
2053     return undef unless $biblionumber;
2054     my $dbh   = C4::Context->dbh;
2055     my $query = "
2056         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2057         FROM issues
2058             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2059             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2060             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2061             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2062         WHERE biblio.biblionumber = ?
2063         UNION ALL
2064         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2065         FROM old_issues
2066             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2067             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2068             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2069             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2070         WHERE biblio.biblionumber = ?
2071         ORDER BY timestamp
2072     ";
2073     my $sth = $dbh->prepare($query);
2074     $sth->execute($biblionumber, $biblionumber);
2075
2076     my @issues;
2077     while ( my $data = $sth->fetchrow_hashref ) {
2078         push @issues, $data;
2079     }
2080     return \@issues;
2081 }
2082
2083 =head2 GetUpcomingDueIssues
2084
2085   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2086
2087 =cut
2088
2089 sub GetUpcomingDueIssues {
2090     my $params = shift;
2091
2092     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2093     my $dbh = C4::Context->dbh;
2094
2095     my $statement = <<END_SQL;
2096 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
2097 FROM issues 
2098 LEFT JOIN items USING (itemnumber)
2099 WhERE returndate is NULL
2100 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
2101 END_SQL
2102
2103     my @bind_parameters = ( $params->{'days_in_advance'} );
2104     
2105     my $sth = $dbh->prepare( $statement );
2106     $sth->execute( @bind_parameters );
2107     my $upcoming_dues = $sth->fetchall_arrayref({});
2108     $sth->finish;
2109
2110     return $upcoming_dues;
2111 }
2112
2113 =head2 CanBookBeRenewed
2114
2115   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2116
2117 Find out whether a borrowed item may be renewed.
2118
2119 C<$dbh> is a DBI handle to the Koha database.
2120
2121 C<$borrowernumber> is the borrower number of the patron who currently
2122 has the item on loan.
2123
2124 C<$itemnumber> is the number of the item to renew.
2125
2126 C<$override_limit>, if supplied with a true value, causes
2127 the limit on the number of times that the loan can be renewed
2128 (as controlled by the item type) to be ignored.
2129
2130 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2131 item must currently be on loan to the specified borrower; renewals
2132 must be allowed for the item's type; and the borrower must not have
2133 already renewed the loan. $error will contain the reason the renewal can not proceed
2134
2135 =cut
2136
2137 sub CanBookBeRenewed {
2138
2139     # check renewal status
2140     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2141     my $dbh       = C4::Context->dbh;
2142     my $renews    = 1;
2143     my $renewokay = 0;
2144         my $error;
2145
2146     # Look in the issues table for this item, lent to this borrower,
2147     # and not yet returned.
2148
2149     # Look in the issues table for this item, lent to this borrower,
2150     # and not yet returned.
2151     my %branch = (
2152             'ItemHomeLibrary' => 'items.homebranch',
2153             'PickupLibrary'   => 'items.holdingbranch',
2154             'PatronLibrary'   => 'borrowers.branchcode'
2155             );
2156     my $controlbranch = $branch{C4::Context->preference('CircControl')};
2157     my $itype         = C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype';
2158     
2159     my $sthcount = $dbh->prepare("
2160                    SELECT 
2161                     borrowers.categorycode, biblioitems.itemtype, issues.renewals, renewalsallowed, $controlbranch
2162                    FROM  issuingrules, 
2163                    issues 
2164                    LEFT JOIN items USING (itemnumber) 
2165                    LEFT JOIN borrowers USING (borrowernumber) 
2166                    LEFT JOIN biblioitems USING (biblioitemnumber)
2167                    
2168                    WHERE
2169                     (issuingrules.categorycode = borrowers.categorycode OR issuingrules.categorycode = '*')
2170                    AND
2171                     (issuingrules.itemtype = $itype OR issuingrules.itemtype = '*')
2172                    AND
2173                     (issuingrules.branchcode = $controlbranch OR issuingrules.branchcode = '*') 
2174                    AND 
2175                     borrowernumber = ? 
2176                    AND
2177                     itemnumber = ?
2178                    ORDER BY
2179                     issuingrules.categorycode desc,
2180                     issuingrules.itemtype desc,
2181                     issuingrules.branchcode desc
2182                    LIMIT 1;
2183                   ");
2184
2185     $sthcount->execute( $borrowernumber, $itemnumber );
2186     if ( my $data1 = $sthcount->fetchrow_hashref ) {
2187         
2188         if ( ( $data1->{renewalsallowed} && $data1->{renewalsallowed} > $data1->{renewals} ) || $override_limit ) {
2189             $renewokay = 1;
2190         }
2191         else {
2192                         $error="too_many";
2193                 }
2194                 
2195         my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2196         if ($resfound) {
2197             $renewokay = 0;
2198                         $error="on_reserve"
2199         }
2200
2201     }
2202     return ($renewokay,$error);
2203 }
2204
2205 =head2 AddRenewal
2206
2207   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2208
2209 Renews a loan.
2210
2211 C<$borrowernumber> is the borrower number of the patron who currently
2212 has the item.
2213
2214 C<$itemnumber> is the number of the item to renew.
2215
2216 C<$branch> is the library where the renewal took place (if any).
2217            The library that controls the circ policies for the renewal is retrieved from the issues record.
2218
2219 C<$datedue> can be a C4::Dates object used to set the due date.
2220
2221 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2222 this parameter is not supplied, lastreneweddate is set to the current date.
2223
2224 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2225 from the book's item type.
2226
2227 =cut
2228
2229 sub AddRenewal {
2230     my $borrowernumber  = shift or return undef;
2231     my $itemnumber      = shift or return undef;
2232     my $branch          = shift;
2233     my $datedue         = shift;
2234     my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2235     my $item   = GetItem($itemnumber) or return undef;
2236     my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2237
2238     my $dbh = C4::Context->dbh;
2239     # Find the issues record for this book
2240     my $sth =
2241       $dbh->prepare("SELECT * FROM issues
2242                         WHERE borrowernumber=? 
2243                         AND itemnumber=?"
2244       );
2245     $sth->execute( $borrowernumber, $itemnumber );
2246     my $issuedata = $sth->fetchrow_hashref;
2247     $sth->finish;
2248     if($datedue && ! $datedue->output('iso')){
2249         warn "Invalid date passed to AddRenewal.";
2250         return undef;
2251     }
2252     # If the due date wasn't specified, calculate it by adding the
2253     # book's loan length to today's date or the current due date
2254     # based on the value of the RenewalPeriodBase syspref.
2255     unless ($datedue) {
2256
2257         my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2258         my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2259
2260         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2261                                         C4::Dates->new($issuedata->{date_due}, 'iso') :
2262                                         C4::Dates->new();
2263         $datedue =  CalcDateDue($datedue,$itemtype,$issuedata->{'branchcode'},$borrower);
2264     }
2265
2266     # Update the issues record to have the new due date, and a new count
2267     # of how many times it has been renewed.
2268     my $renews = $issuedata->{'renewals'} + 1;
2269     $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2270                             WHERE borrowernumber=? 
2271                             AND itemnumber=?"
2272     );
2273     $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2274     $sth->finish;
2275
2276     # Update the renewal count on the item, and tell zebra to reindex
2277     $renews = $biblio->{'renewals'} + 1;
2278     ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2279
2280     # Charge a new rental fee, if applicable?
2281     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2282     if ( $charge > 0 ) {
2283         my $accountno = getnextacctno( $borrowernumber );
2284         my $item = GetBiblioFromItemNumber($itemnumber);
2285         $sth = $dbh->prepare(
2286                 "INSERT INTO accountlines
2287                     (date,
2288                                         borrowernumber, accountno, amount,
2289                     description,
2290                                         accounttype, amountoutstanding, itemnumber
2291                                         )
2292                     VALUES (now(),?,?,?,?,?,?,?)"
2293         );
2294         $sth->execute( $borrowernumber, $accountno, $charge,
2295             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2296             'Rent', $charge, $itemnumber );
2297         $sth->finish;
2298     }
2299     # Log the renewal
2300     UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2301         return $datedue;
2302 }
2303
2304 sub GetRenewCount {
2305     # check renewal status
2306     my ( $bornum, $itemno ) = @_;
2307     my $dbh           = C4::Context->dbh;
2308     my $renewcount    = 0;
2309     my $renewsallowed = 0;
2310     my $renewsleft    = 0;
2311
2312     my $borrower = C4::Members::GetMemberDetails($bornum);
2313     my $item     = GetItem($itemno); 
2314
2315     # Look in the issues table for this item, lent to this borrower,
2316     # and not yet returned.
2317
2318     # FIXME - I think this function could be redone to use only one SQL call.
2319     my $sth = $dbh->prepare(
2320         "select * from issues
2321                                 where (borrowernumber = ?)
2322                                 and (itemnumber = ?)"
2323     );
2324     $sth->execute( $bornum, $itemno );
2325     my $data = $sth->fetchrow_hashref;
2326     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2327     $sth->finish;
2328     # $item and $borrower should be calculated
2329     my $branchcode = _GetCircControlBranch($item, $borrower);
2330     
2331     my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2332     
2333     $renewsallowed = $issuingrule->{'renewalsallowed'};
2334     $renewsleft    = $renewsallowed - $renewcount;
2335     if($renewsleft < 0){ $renewsleft = 0; }
2336     return ( $renewcount, $renewsallowed, $renewsleft );
2337 }
2338
2339 =head2 GetIssuingCharges
2340
2341   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2342
2343 Calculate how much it would cost for a given patron to borrow a given
2344 item, including any applicable discounts.
2345
2346 C<$itemnumber> is the item number of item the patron wishes to borrow.
2347
2348 C<$borrowernumber> is the patron's borrower number.
2349
2350 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2351 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2352 if it's a video).
2353
2354 =cut
2355
2356 sub GetIssuingCharges {
2357
2358     # calculate charges due
2359     my ( $itemnumber, $borrowernumber ) = @_;
2360     my $charge = 0;
2361     my $dbh    = C4::Context->dbh;
2362     my $item_type;
2363
2364     # Get the book's item type and rental charge (via its biblioitem).
2365     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2366         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2367     $charge_query .= (C4::Context->preference('item-level_itypes'))
2368         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2369         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2370
2371     $charge_query .= ' WHERE items.itemnumber =?';
2372
2373     my $sth = $dbh->prepare($charge_query);
2374     $sth->execute($itemnumber);
2375     if ( my $item_data = $sth->fetchrow_hashref ) {
2376         $item_type = $item_data->{itemtype};
2377         $charge    = $item_data->{rentalcharge};
2378         my $branch = C4::Branch::mybranch();
2379         my $discount_query = q|SELECT rentaldiscount,
2380             issuingrules.itemtype, issuingrules.branchcode
2381             FROM borrowers
2382             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2383             WHERE borrowers.borrowernumber = ?
2384             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2385             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2386         my $discount_sth = $dbh->prepare($discount_query);
2387         $discount_sth->execute( $borrowernumber, $item_type, $branch );
2388         my $discount_rules = $discount_sth->fetchall_arrayref({});
2389         if (@{$discount_rules}) {
2390             # We may have multiple rules so get the most specific
2391             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2392             $charge = ( $charge * ( 100 - $discount ) ) / 100;
2393         }
2394     }
2395
2396     $sth->finish; # we havent _explicitly_ fetched all rows
2397     return ( $charge, $item_type );
2398 }
2399
2400 # Select most appropriate discount rule from those returned
2401 sub _get_discount_from_rule {
2402     my ($rules_ref, $branch, $itemtype) = @_;
2403     my $discount;
2404
2405     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2406         $discount = $rules_ref->[0]->{rentaldiscount};
2407         return (defined $discount) ? $discount : 0;
2408     }
2409     # could have up to 4 does one match $branch and $itemtype
2410     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2411     if (@d) {
2412         $discount = $d[0]->{rentaldiscount};
2413         return (defined $discount) ? $discount : 0;
2414     }
2415     # do we have item type + all branches
2416     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2417     if (@d) {
2418         $discount = $d[0]->{rentaldiscount};
2419         return (defined $discount) ? $discount : 0;
2420     }
2421     # do we all item types + this branch
2422     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2423     if (@d) {
2424         $discount = $d[0]->{rentaldiscount};
2425         return (defined $discount) ? $discount : 0;
2426     }
2427     # so all and all (surely we wont get here)
2428     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2429     if (@d) {
2430         $discount = $d[0]->{rentaldiscount};
2431         return (defined $discount) ? $discount : 0;
2432     }
2433     # none of the above
2434     return 0;
2435 }
2436
2437 =head2 AddIssuingCharge
2438
2439   &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2440
2441 =cut
2442
2443 sub AddIssuingCharge {
2444     my ( $itemnumber, $borrowernumber, $charge ) = @_;
2445     my $dbh = C4::Context->dbh;
2446     my $nextaccntno = getnextacctno( $borrowernumber );
2447     my $query ="
2448         INSERT INTO accountlines
2449             (borrowernumber, itemnumber, accountno,
2450             date, amount, description, accounttype,
2451             amountoutstanding)
2452         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2453     ";
2454     my $sth = $dbh->prepare($query);
2455     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2456     $sth->finish;
2457 }
2458
2459 =head2 GetTransfers
2460
2461   GetTransfers($itemnumber);
2462
2463 =cut
2464
2465 sub GetTransfers {
2466     my ($itemnumber) = @_;
2467
2468     my $dbh = C4::Context->dbh;
2469
2470     my $query = '
2471         SELECT datesent,
2472                frombranch,
2473                tobranch
2474         FROM branchtransfers
2475         WHERE itemnumber = ?
2476           AND datearrived IS NULL
2477         ';
2478     my $sth = $dbh->prepare($query);
2479     $sth->execute($itemnumber);
2480     my @row = $sth->fetchrow_array();
2481     $sth->finish;
2482     return @row;
2483 }
2484
2485 =head2 GetTransfersFromTo
2486
2487   @results = GetTransfersFromTo($frombranch,$tobranch);
2488
2489 Returns the list of pending transfers between $from and $to branch
2490
2491 =cut
2492
2493 sub GetTransfersFromTo {
2494     my ( $frombranch, $tobranch ) = @_;
2495     return unless ( $frombranch && $tobranch );
2496     my $dbh   = C4::Context->dbh;
2497     my $query = "
2498         SELECT itemnumber,datesent,frombranch
2499         FROM   branchtransfers
2500         WHERE  frombranch=?
2501           AND  tobranch=?
2502           AND datearrived IS NULL
2503     ";
2504     my $sth = $dbh->prepare($query);
2505     $sth->execute( $frombranch, $tobranch );
2506     my @gettransfers;
2507
2508     while ( my $data = $sth->fetchrow_hashref ) {
2509         push @gettransfers, $data;
2510     }
2511     $sth->finish;
2512     return (@gettransfers);
2513 }
2514
2515 =head2 DeleteTransfer
2516
2517   &DeleteTransfer($itemnumber);
2518
2519 =cut
2520
2521 sub DeleteTransfer {
2522     my ($itemnumber) = @_;
2523     my $dbh          = C4::Context->dbh;
2524     my $sth          = $dbh->prepare(
2525         "DELETE FROM branchtransfers
2526          WHERE itemnumber=?
2527          AND datearrived IS NULL "
2528     );
2529     $sth->execute($itemnumber);
2530     $sth->finish;
2531 }
2532
2533 =head2 AnonymiseIssueHistory
2534
2535   $rows = AnonymiseIssueHistory($date,$borrowernumber)
2536
2537 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2538 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2539
2540 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2541 setting (force delete).
2542
2543 return the number of affected rows.
2544
2545 =cut
2546
2547 sub AnonymiseIssueHistory {
2548     my $date           = shift;
2549     my $borrowernumber = shift;
2550     my $dbh            = C4::Context->dbh;
2551     my $query          = "
2552         UPDATE old_issues
2553         SET    borrowernumber = ?
2554         WHERE  returndate < ?
2555           AND borrowernumber IS NOT NULL
2556     ";
2557
2558     # The default of 0 does not work due to foreign key constraints
2559     # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2560     my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2561     my @bind_params = ($anonymouspatron, $date);
2562     if (defined $borrowernumber) {
2563        $query .= " AND borrowernumber = ?";
2564        push @bind_params, $borrowernumber;
2565     } else {
2566        $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2567     }
2568     my $sth = $dbh->prepare($query);
2569     $sth->execute(@bind_params);
2570     my $rows_affected = $sth->rows;  ### doublecheck row count return function
2571     return $rows_affected;
2572 }
2573
2574 =head2 SendCirculationAlert
2575
2576 Send out a C<check-in> or C<checkout> alert using the messaging system.
2577
2578 B<Parameters>:
2579
2580 =over 4
2581
2582 =item type
2583
2584 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2585
2586 =item item
2587
2588 Hashref of information about the item being checked in or out.
2589
2590 =item borrower
2591
2592 Hashref of information about the borrower of the item.
2593
2594 =item branch
2595
2596 The branchcode from where the checkout or check-in took place.
2597
2598 =back
2599
2600 B<Example>:
2601
2602     SendCirculationAlert({
2603         type     => 'CHECKOUT',
2604         item     => $item,
2605         borrower => $borrower,
2606         branch   => $branch,
2607     });
2608
2609 =cut
2610
2611 sub SendCirculationAlert {
2612     my ($opts) = @_;
2613     my ($type, $item, $borrower, $branch) =
2614         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2615     my %message_name = (
2616         CHECKIN  => 'Item Check-in',
2617         CHECKOUT => 'Item Checkout',
2618     );
2619     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2620         borrowernumber => $borrower->{borrowernumber},
2621         message_name   => $message_name{$type},
2622     });
2623     my $letter = C4::Letters::getletter('circulation', $type);
2624     C4::Letters::parseletter($letter, 'biblio',      $item->{biblionumber});
2625     C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2626     C4::Letters::parseletter($letter, 'borrowers',   $borrower->{borrowernumber});
2627     C4::Letters::parseletter($letter, 'branches',    $branch);
2628     my @transports = @{ $borrower_preferences->{transports} };
2629     # warn "no transports" unless @transports;
2630     for (@transports) {
2631         # warn "transport: $_";
2632         my $message = C4::Message->find_last_message($borrower, $type, $_);
2633         if (!$message) {
2634             #warn "create new message";
2635             C4::Message->enqueue($letter, $borrower, $_);
2636         } else {
2637             #warn "append to old message";
2638             $message->append($letter);
2639             $message->update;
2640         }
2641     }
2642     $letter;
2643 }
2644
2645 =head2 updateWrongTransfer
2646
2647   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2648
2649 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 
2650
2651 =cut
2652
2653 sub updateWrongTransfer {
2654         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2655         my $dbh = C4::Context->dbh;     
2656 # first step validate the actual line of transfert .
2657         my $sth =
2658                 $dbh->prepare(
2659                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2660                 );
2661                 $sth->execute($FromLibrary,$itemNumber);
2662                 $sth->finish;
2663
2664 # second step create a new line of branchtransfer to the right location .
2665         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2666
2667 #third step changing holdingbranch of item
2668         UpdateHoldingbranch($FromLibrary,$itemNumber);
2669 }
2670
2671 =head2 UpdateHoldingbranch
2672
2673   $items = UpdateHoldingbranch($branch,$itmenumber);
2674
2675 Simple methode for updating hodlingbranch in items BDD line
2676
2677 =cut
2678
2679 sub UpdateHoldingbranch {
2680         my ( $branch,$itemnumber ) = @_;
2681     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2682 }
2683
2684 =head2 CalcDateDue
2685
2686 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
2687
2688 this function calculates the due date given the start date and configured circulation rules,
2689 checking against the holidays calendar as per the 'useDaysMode' syspref.
2690 C<$startdate>   = C4::Dates object representing start date of loan period (assumed to be today)
2691 C<$itemtype>  = itemtype code of item in question
2692 C<$branch>  = location whose calendar to use
2693 C<$borrower> = Borrower object
2694 =cut
2695
2696 sub CalcDateDue { 
2697         my ($startdate,$itemtype,$branch,$borrower) = @_;
2698         my $datedue;
2699         my $loanlength = GetLoanLength($borrower->{'categorycode'},$itemtype, $branch);
2700
2701         if(C4::Context->preference('useDaysMode') eq 'Days') {  # ignoring calendar
2702                 my $timedue = time + ($loanlength) * 86400;
2703         #FIXME - assumes now even though we take a startdate 
2704                 my @datearr  = localtime($timedue);
2705                 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2706         } else {
2707                 my $calendar = C4::Calendar->new(  branchcode => $branch );
2708                 $datedue = $calendar->addDate($startdate, $loanlength);
2709         }
2710
2711         # if Hard Due Dates are used, retreive them and apply as necessary
2712         my ($hardduedate, $hardduedatecompare) = GetHardDueDate($borrower->{'categorycode'},$itemtype, $branch);
2713         if ( $hardduedate && $hardduedate->output('iso') && $hardduedate->output('iso') ne '0000-00-00') {
2714             # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
2715             if ( $datedue->output( 'iso' ) gt $hardduedate->output( 'iso' ) && $hardduedatecompare == -1) {
2716                 $datedue = $hardduedate;
2717             # if the calculated date is before the 'after' Hard Due Date (floor), override
2718             } elsif ( $datedue->output( 'iso' ) lt $hardduedate->output( 'iso' ) && $hardduedatecompare == 1) {
2719                 $datedue = $hardduedate;               
2720             # if the hard due date is set to 'exactly', overrride
2721             } elsif ( $hardduedatecompare == 0) {
2722                 $datedue = $hardduedate;
2723             }
2724             # in all other cases, keep the date due as it is
2725         }
2726
2727         # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2728         if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2729             $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2730         }
2731
2732
2733         return $datedue;
2734 }
2735
2736 =head2 CheckValidDatedue
2737
2738   $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2739
2740 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2741 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2742
2743 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2744 C<$date_due>   = returndate calculate with no day check
2745 C<$itemnumber>  = itemnumber
2746 C<$branchcode>  = location of issue (affected by 'CircControl' syspref)
2747 C<$loanlength>  = loan length prior to adjustment
2748
2749 =cut
2750
2751 sub CheckValidDatedue {
2752 my ($date_due,$itemnumber,$branchcode)=@_;
2753 my @datedue=split('-',$date_due->output('iso'));
2754 my $years=$datedue[0];
2755 my $month=$datedue[1];
2756 my $day=$datedue[2];
2757 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2758 my $dow;
2759 for (my $i=0;$i<2;$i++){
2760     $dow=Day_of_Week($years,$month,$day);
2761     ($dow=0) if ($dow>6);
2762     my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2763     my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2764     my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2765         if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2766         $i=0;
2767         (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2768         }
2769     }
2770     my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2771 return $newdatedue;
2772 }
2773
2774
2775 =head2 CheckRepeatableHolidays
2776
2777   $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2778
2779 This function checks if the date due is a repeatable holiday
2780
2781 C<$date_due>   = returndate calculate with no day check
2782 C<$itemnumber>  = itemnumber
2783 C<$branchcode>  = localisation of issue 
2784
2785 =cut
2786
2787 sub CheckRepeatableHolidays{
2788 my($itemnumber,$week_day,$branchcode)=@_;
2789 my $dbh = C4::Context->dbh;
2790 my $query = qq|SELECT count(*)  
2791         FROM repeatable_holidays 
2792         WHERE branchcode=?
2793         AND weekday=?|;
2794 my $sth = $dbh->prepare($query);
2795 $sth->execute($branchcode,$week_day);
2796 my $result=$sth->fetchrow;
2797 $sth->finish;
2798 return $result;
2799 }
2800
2801
2802 =head2 CheckSpecialHolidays
2803
2804   $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2805
2806 This function check if the date is a special holiday
2807
2808 C<$years>   = the years of datedue
2809 C<$month>   = the month of datedue
2810 C<$day>     = the day of datedue
2811 C<$itemnumber>  = itemnumber
2812 C<$branchcode>  = localisation of issue 
2813
2814 =cut
2815
2816 sub CheckSpecialHolidays{
2817 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2818 my $dbh = C4::Context->dbh;
2819 my $query=qq|SELECT count(*) 
2820              FROM `special_holidays`
2821              WHERE year=?
2822              AND month=?
2823              AND day=?
2824              AND branchcode=?
2825             |;
2826 my $sth = $dbh->prepare($query);
2827 $sth->execute($years,$month,$day,$branchcode);
2828 my $countspecial=$sth->fetchrow ;
2829 $sth->finish;
2830 return $countspecial;
2831 }
2832
2833 =head2 CheckRepeatableSpecialHolidays
2834
2835   $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2836
2837 This function check if the date is a repeatble special holidays
2838
2839 C<$month>   = the month of datedue
2840 C<$day>     = the day of datedue
2841 C<$itemnumber>  = itemnumber
2842 C<$branchcode>  = localisation of issue 
2843
2844 =cut
2845
2846 sub CheckRepeatableSpecialHolidays{
2847 my ($month,$day,$itemnumber,$branchcode) = @_;
2848 my $dbh = C4::Context->dbh;
2849 my $query=qq|SELECT count(*) 
2850              FROM `repeatable_holidays`
2851              WHERE month=?
2852              AND day=?
2853              AND branchcode=?
2854             |;
2855 my $sth = $dbh->prepare($query);
2856 $sth->execute($month,$day,$branchcode);
2857 my $countspecial=$sth->fetchrow ;
2858 $sth->finish;
2859 return $countspecial;
2860 }
2861
2862
2863
2864 sub CheckValidBarcode{
2865 my ($barcode) = @_;
2866 my $dbh = C4::Context->dbh;
2867 my $query=qq|SELECT count(*) 
2868              FROM items 
2869              WHERE barcode=?
2870             |;
2871 my $sth = $dbh->prepare($query);
2872 $sth->execute($barcode);
2873 my $exist=$sth->fetchrow ;
2874 $sth->finish;
2875 return $exist;
2876 }
2877
2878 =head2 IsBranchTransferAllowed
2879
2880   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2881
2882 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2883
2884 =cut
2885
2886 sub IsBranchTransferAllowed {
2887         my ( $toBranch, $fromBranch, $code ) = @_;
2888
2889         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2890         
2891         my $limitType = C4::Context->preference("BranchTransferLimitsType");   
2892         my $dbh = C4::Context->dbh;
2893             
2894         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2895         $sth->execute( $toBranch, $fromBranch, $code );
2896         my $limit = $sth->fetchrow_hashref();
2897                         
2898         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2899         if ( $limit->{'limitId'} ) {
2900                 return 0;
2901         } else {
2902                 return 1;
2903         }
2904 }                                                        
2905
2906 =head2 CreateBranchTransferLimit
2907
2908   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2909
2910 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2911
2912 =cut
2913
2914 sub CreateBranchTransferLimit {
2915    my ( $toBranch, $fromBranch, $code ) = @_;
2916
2917    my $limitType = C4::Context->preference("BranchTransferLimitsType");
2918    
2919    my $dbh = C4::Context->dbh;
2920    
2921    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2922    $sth->execute( $code, $toBranch, $fromBranch );
2923 }
2924
2925 =head2 DeleteBranchTransferLimits
2926
2927   DeleteBranchTransferLimits();
2928
2929 =cut
2930
2931 sub DeleteBranchTransferLimits {
2932    my $dbh = C4::Context->dbh;
2933    my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2934    $sth->execute();
2935 }
2936
2937
2938   1;
2939
2940 __END__
2941
2942 =head1 AUTHOR
2943
2944 Koha Development Team <http://koha-community.org/>
2945
2946 =cut
2947