Bug 7061: unnecessary global variables declared in C4::SQLHelper
[koha.git] / C4 / Circulation.pm
1 package C4::Circulation;
2
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
5 #
6 # This file is part of Koha.
7 #
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
11 # version.
12 #
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20
21
22 use strict;
23 #use warnings; FIXME - Bug 2505
24 use C4::Context;
25 use C4::Stats;
26 use C4::Reserves;
27 use C4::Biblio;
28 use C4::Items;
29 use C4::Members;
30 use C4::Dates;
31 use C4::Calendar;
32 use C4::Accounts;
33 use C4::ItemCirculationAlertPreference;
34 use C4::Dates qw(format_date);
35 use C4::Message;
36 use C4::Debug;
37 use Date::Calc qw(
38   Today
39   Today_and_Now
40   Add_Delta_YM
41   Add_Delta_DHMS
42   Date_to_Days
43   Day_of_Week
44   Add_Delta_Days        
45 );
46 use POSIX qw(strftime);
47 use C4::Branch; # GetBranches
48 use C4::Log; # logaction
49
50 use Data::Dumper;
51
52 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
53
54 BEGIN {
55         require Exporter;
56         $VERSION = 3.02;        # for version checking
57         @ISA    = qw(Exporter);
58
59         # FIXME subs that should probably be elsewhere
60         push @EXPORT, qw(
61                 &barcodedecode
62         &LostItem
63         &ReturnLostItem
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 GetMember or 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'} > 0 )
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::GetMember( borrowernumber => $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::GetMember( borrowernumber => $resbor );
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 GetMember or 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     my $stat_type = 'return';    
1519
1520     # get information on item
1521     my $itemnumber = GetItemnumberFromBarcode( $barcode );
1522     unless ($itemnumber) {
1523         return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower.  bail out.
1524     }
1525     my $issue  = GetItemIssue($itemnumber);
1526 #   warn Dumper($iteminformation);
1527     if ($issue and $issue->{borrowernumber}) {
1528         $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1529             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1530                 . Dumper($issue) . "\n";
1531     } else {
1532         $messages->{'NotIssued'} = $barcode;
1533         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1534         $doreturn = 0;
1535         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1536         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1537         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1538            $messages->{'LocalUse'} = 1;
1539            $stat_type = 'localuse';
1540         }
1541     }
1542
1543     my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1544         # full item data, but no borrowernumber or checkout info (no issue)
1545         # we know GetItem should work because GetItemnumberFromBarcode worked
1546     my $hbr      = C4::Context->preference("HomeOrHoldingBranchReturn") || "homebranch";
1547     $hbr = $item->{$hbr} || '';
1548         # item must be from items table -- issues table has branchcode and issuingbranch, not homebranch nor holdingbranch
1549
1550     my $borrowernumber = $borrower->{'borrowernumber'} || undef;    # we don't know if we had a borrower or not
1551
1552     # check if the book is in a permanent collection....
1553     # FIXME -- This 'PE' attribute is largely undocumented.  afaict, there's no user interface that reflects this functionality.
1554     if ( $hbr ) {
1555         my $branches = GetBranches();    # a potentially expensive call for a non-feature.
1556         $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1557     }
1558
1559     # if indy branches and returning to different branch, refuse the return
1560     if ($hbr ne $branch && C4::Context->preference("IndependantBranches")){
1561         $messages->{'Wrongbranch'} = {
1562             Wrongbranch => $branch,
1563             Rightbranch => $hbr,
1564         };
1565         $doreturn = 0;
1566         # bailing out here - in this case, current desired behavior
1567         # is to act as if no return ever happened at all.
1568         # FIXME - even in an indy branches situation, there should
1569         # still be an option for the library to accept the item
1570         # and transfer it to its owning library.
1571         return ( $doreturn, $messages, $issue, $borrower );
1572     }
1573
1574     if ( $item->{'wthdrawn'} ) { # book has been cancelled
1575         $messages->{'wthdrawn'} = 1;
1576         $doreturn = 0;
1577     }
1578
1579     # case of a return of document (deal with issues and holdingbranch)
1580     if ($doreturn) {
1581         $borrower or warn "AddReturn without current borrower";
1582                 my $circControlBranch;
1583         if ($dropbox) {
1584             # define circControlBranch only if dropbox mode is set
1585             # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1586             # FIXME: check issuedate > returndate, factoring in holidays
1587             $circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1588         }
1589
1590         if ($borrowernumber) {
1591             MarkIssueReturned($borrowernumber, $item->{'itemnumber'}, $circControlBranch, '', $borrower->{'privacy'});
1592             $messages->{'WasReturned'} = 1;    # FIXME is the "= 1" right?  This could be the borrower hash.
1593         }
1594
1595         ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1596     }
1597
1598     # the holdingbranch is updated if the document is returned to another location.
1599     # this is always done regardless of whether the item was on loan or not
1600     if ($item->{'holdingbranch'} ne $branch) {
1601         UpdateHoldingbranch($branch, $item->{'itemnumber'});
1602         $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1603     }
1604     ModDateLastSeen( $item->{'itemnumber'} );
1605
1606     # check if we have a transfer for this document
1607     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1608
1609     # if we have a transfer to do, we update the line of transfers with the datearrived
1610     if ($datesent) {
1611         if ( $tobranch eq $branch ) {
1612             my $sth = C4::Context->dbh->prepare(
1613                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1614             );
1615             $sth->execute( $item->{'itemnumber'} );
1616             # if we have a reservation with valid transfer, we can set it's status to 'W'
1617             C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1618         } else {
1619             $messages->{'WrongTransfer'}     = $tobranch;
1620             $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1621         }
1622         $validTransfert = 1;
1623     }
1624
1625     # fix up the accounts.....
1626     if ($item->{'itemlost'}) {
1627         _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode);    # can tolerate undef $borrowernumber
1628         $messages->{'WasLost'} = 1;
1629     }
1630
1631     # fix up the overdues in accounts...
1632     if ($borrowernumber) {
1633         my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1634         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!";  # zero is OK, check defined
1635     }
1636
1637     # find reserves.....
1638     # if we don't have a reserve with the status W, we launch the Checkreserves routine
1639     my ($resfound, $resrec) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1640     if ($resfound) {
1641           $resrec->{'ResFound'} = $resfound;
1642         $messages->{'ResFound'} = $resrec;
1643     }
1644
1645     # update stats?
1646     # Record the fact that this book was returned.
1647     UpdateStats(
1648         $branch, $stat_type, '0', '',
1649         $item->{'itemnumber'},
1650         $biblio->{'itemtype'},
1651         $borrowernumber
1652     );
1653
1654     # Send a check-in slip. # NOTE: borrower may be undef.  probably shouldn't try to send messages then.
1655     my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1656     my %conditions = (
1657         branchcode   => $branch,
1658         categorycode => $borrower->{categorycode},
1659         item_type    => $item->{itype},
1660         notification => 'CHECKIN',
1661     );
1662     if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1663         SendCirculationAlert({
1664             type     => 'CHECKIN',
1665             item     => $item,
1666             borrower => $borrower,
1667             branch   => $branch,
1668         });
1669     }
1670     
1671     logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1672         if C4::Context->preference("ReturnLog");
1673     
1674     # FIXME: make this comment intelligible.
1675     #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1676     #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1677
1678     if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
1679         if ( C4::Context->preference("AutomaticItemReturn"    ) or
1680             (C4::Context->preference("UseBranchTransferLimits") and
1681              ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1682            )) {
1683             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1684             $debug and warn "item: " . Dumper($item);
1685             ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1686             $messages->{'WasTransfered'} = 1;
1687         } else {
1688             $messages->{'NeedsTransfer'} = 1;   # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1689         }
1690     }
1691     return ( $doreturn, $messages, $issue, $borrower );
1692 }
1693
1694 =head2 MarkIssueReturned
1695
1696   MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1697
1698 Unconditionally marks an issue as being returned by
1699 moving the C<issues> row to C<old_issues> and
1700 setting C<returndate> to the current date, or
1701 the last non-holiday date of the branccode specified in
1702 C<dropbox_branch> .  Assumes you've already checked that 
1703 it's safe to do this, i.e. last non-holiday > issuedate.
1704
1705 if C<$returndate> is specified (in iso format), it is used as the date
1706 of the return. It is ignored when a dropbox_branch is passed in.
1707
1708 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1709 the old_issue is immediately anonymised
1710
1711 Ideally, this function would be internal to C<C4::Circulation>,
1712 not exported, but it is currently needed by one 
1713 routine in C<C4::Accounts>.
1714
1715 =cut
1716
1717 sub MarkIssueReturned {
1718     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1719     my $dbh   = C4::Context->dbh;
1720     my $query = "UPDATE issues SET returndate=";
1721     my @bind;
1722     if ($dropbox_branch) {
1723         my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1724         my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1725         $query .= " ? ";
1726         push @bind, $dropboxdate->output('iso');
1727     } elsif ($returndate) {
1728         $query .= " ? ";
1729         push @bind, $returndate;
1730     } else {
1731         $query .= " now() ";
1732     }
1733     $query .= " WHERE  borrowernumber = ?  AND itemnumber = ?";
1734     push @bind, $borrowernumber, $itemnumber;
1735     # FIXME transaction
1736     my $sth_upd  = $dbh->prepare($query);
1737     $sth_upd->execute(@bind);
1738     my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues 
1739                                   WHERE borrowernumber = ?
1740                                   AND itemnumber = ?");
1741     $sth_copy->execute($borrowernumber, $itemnumber);
1742     # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
1743     if ( $privacy == 2) {
1744         # The default of 0 does not work due to foreign key constraints
1745         # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
1746         my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
1747         my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
1748                                   WHERE borrowernumber = ?
1749                                   AND itemnumber = ?");
1750        $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
1751     }
1752     my $sth_del  = $dbh->prepare("DELETE FROM issues
1753                                   WHERE borrowernumber = ?
1754                                   AND itemnumber = ?");
1755     $sth_del->execute($borrowernumber, $itemnumber);
1756 }
1757
1758 =head2 _FixOverduesOnReturn
1759
1760    &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1761
1762 C<$brn> borrowernumber
1763
1764 C<$itm> itemnumber
1765
1766 C<$exemptfine> BOOL -- remove overdue charge associated with this issue. 
1767 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1768
1769 Internal function, called only by AddReturn
1770
1771 =cut
1772
1773 sub _FixOverduesOnReturn {
1774     my ($borrowernumber, $item);
1775     unless ($borrowernumber = shift) {
1776         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1777         return;
1778     }
1779     unless ($item = shift) {
1780         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1781         return;
1782     }
1783     my ($exemptfine, $dropbox) = @_;
1784     my $dbh = C4::Context->dbh;
1785
1786     # check for overdue fine
1787     my $sth = $dbh->prepare(
1788 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1789     );
1790     $sth->execute( $borrowernumber, $item );
1791
1792     # alter fine to show that the book has been returned
1793     my $data = $sth->fetchrow_hashref;
1794     return 0 unless $data;    # no warning, there's just nothing to fix
1795
1796     my $uquery;
1797     my @bind = ($borrowernumber, $item, $data->{'accountno'});
1798     if ($exemptfine) {
1799         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1800         if (C4::Context->preference("FinesLog")) {
1801             &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1802         }
1803     } elsif ($dropbox && $data->{lastincrement}) {
1804         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1805         my $amt = $data->{amount} - $data->{lastincrement} ;
1806         if (C4::Context->preference("FinesLog")) {
1807             &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1808         }
1809          $uquery = "update accountlines set accounttype='F' ";
1810          if($outstanding  >= 0 && $amt >=0) {
1811             $uquery .= ", amount = ? , amountoutstanding=? ";
1812             unshift @bind, ($amt, $outstanding) ;
1813         }
1814     } else {
1815         $uquery = "update accountlines set accounttype='F' ";
1816     }
1817     $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1818     my $usth = $dbh->prepare($uquery);
1819     return $usth->execute(@bind);
1820 }
1821
1822 =head2 _FixAccountForLostAndReturned
1823
1824   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1825
1826 Calculates the charge for a book lost and returned.
1827
1828 Internal function, not exported, called only by AddReturn.
1829
1830 FIXME: This function reflects how inscrutable fines logic is.  Fix both.
1831 FIXME: Give a positive return value on success.  It might be the $borrowernumber who received credit, or the amount forgiven.
1832
1833 =cut
1834
1835 sub _FixAccountForLostAndReturned {
1836     my $itemnumber     = shift or return;
1837     my $borrowernumber = @_ ? shift : undef;
1838     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
1839     my $dbh = C4::Context->dbh;
1840     # check for charge made for lost book
1841     my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1842     $sth->execute($itemnumber);
1843     my $data = $sth->fetchrow_hashref;
1844     $data or return;    # bail if there is nothing to do
1845
1846     # writeoff this amount
1847     my $offset;
1848     my $amount = $data->{'amount'};
1849     my $acctno = $data->{'accountno'};
1850     my $amountleft;                                             # Starts off undef/zero.
1851     if ($data->{'amountoutstanding'} == $amount) {
1852         $offset     = $data->{'amount'};
1853         $amountleft = 0;                                        # Hey, it's zero here, too.
1854     } else {
1855         $offset     = $amount - $data->{'amountoutstanding'};   # Um, isn't this the same as ZERO?  We just tested those two things are ==
1856         $amountleft = $data->{'amountoutstanding'} - $amount;   # Um, isn't this the same as ZERO?  We just tested those two things are ==
1857     }
1858     my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1859         WHERE (borrowernumber = ?)
1860         AND (itemnumber = ?) AND (accountno = ?) ");
1861     $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno);      # We might be adjusting an account for some OTHER borrowernumber now.  Not the one we passed in.  
1862     #check if any credit is left if so writeoff other accounts
1863     my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1864     $amountleft *= -1 if ($amountleft < 0);
1865     if ($amountleft > 0) {
1866         my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1867                             AND (amountoutstanding >0) ORDER BY date");     # might want to order by amountoustanding ASC (pay smallest first)
1868         $msth->execute($data->{'borrowernumber'});
1869         # offset transactions
1870         my $newamtos;
1871         my $accdata;
1872         while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1873             if ($accdata->{'amountoutstanding'} < $amountleft) {
1874                 $newamtos = 0;
1875                 $amountleft -= $accdata->{'amountoutstanding'};
1876             }  else {
1877                 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1878                 $amountleft = 0;
1879             }
1880             my $thisacct = $accdata->{'accountno'};
1881             # FIXME: move prepares outside while loop!
1882             my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1883                     WHERE (borrowernumber = ?)
1884                     AND (accountno=?)");
1885             $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');    # FIXME: '$thisacct' is a string literal!
1886             $usth = $dbh->prepare("INSERT INTO accountoffsets
1887                 (borrowernumber, accountno, offsetaccount,  offsetamount)
1888                 VALUES
1889                 (?,?,?,?)");
1890             $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1891         }
1892         $msth->finish;  # $msth might actually have data left
1893     }
1894     $amountleft *= -1 if ($amountleft > 0);
1895     my $desc = "Item Returned " . $item_id;
1896     $usth = $dbh->prepare("INSERT INTO accountlines
1897         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1898         VALUES (?,?,now(),?,?,'CR',?)");
1899     $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1900     if ($borrowernumber) {
1901         # FIXME: same as query above.  use 1 sth for both
1902         $usth = $dbh->prepare("INSERT INTO accountoffsets
1903             (borrowernumber, accountno, offsetaccount,  offsetamount)
1904             VALUES (?,?,?,?)");
1905         $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
1906     }
1907     ModItem({ paidfor => '' }, undef, $itemnumber);
1908     return;
1909 }
1910
1911 =head2 _GetCircControlBranch
1912
1913    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
1914
1915 Internal function : 
1916
1917 Return the library code to be used to determine which circulation
1918 policy applies to a transaction.  Looks up the CircControl and
1919 HomeOrHoldingBranch system preferences.
1920
1921 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
1922
1923 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
1924
1925 =cut
1926
1927 sub _GetCircControlBranch {
1928     my ($item, $borrower) = @_;
1929     my $circcontrol = C4::Context->preference('CircControl');
1930     my $branch;
1931
1932     if ($circcontrol eq 'PickupLibrary') {
1933         $branch= C4::Context->userenv->{'branch'} if C4::Context->userenv;
1934     } elsif ($circcontrol eq 'PatronLibrary') {
1935         $branch=$borrower->{branchcode};
1936     } else {
1937         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
1938         $branch = $item->{$branchfield};
1939         # default to item home branch if holdingbranch is used
1940         # and is not defined
1941         if (!defined($branch) && $branchfield eq 'holdingbranch') {
1942             $branch = $item->{homebranch};
1943         }
1944     }
1945     return $branch;
1946 }
1947
1948
1949
1950
1951
1952
1953 =head2 GetItemIssue
1954
1955   $issue = &GetItemIssue($itemnumber);
1956
1957 Returns patron currently having a book, or undef if not checked out.
1958
1959 C<$itemnumber> is the itemnumber.
1960
1961 C<$issue> is a hashref of the row from the issues table.
1962
1963 =cut
1964
1965 sub GetItemIssue {
1966     my ($itemnumber) = @_;
1967     return unless $itemnumber;
1968     my $sth = C4::Context->dbh->prepare(
1969         "SELECT *
1970         FROM issues 
1971         LEFT JOIN items ON issues.itemnumber=items.itemnumber
1972         WHERE issues.itemnumber=?");
1973     $sth->execute($itemnumber);
1974     my $data = $sth->fetchrow_hashref;
1975     return unless $data;
1976     $data->{'overdue'} = ($data->{'date_due'} lt C4::Dates->today('iso')) ? 1 : 0;
1977     return ($data);
1978 }
1979
1980 =head2 GetOpenIssue
1981
1982   $issue = GetOpenIssue( $itemnumber );
1983
1984 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1985
1986 C<$itemnumber> is the item's itemnumber
1987
1988 Returns a hashref
1989
1990 =cut
1991
1992 sub GetOpenIssue {
1993   my ( $itemnumber ) = @_;
1994
1995   my $dbh = C4::Context->dbh;  
1996   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1997   $sth->execute( $itemnumber );
1998   my $issue = $sth->fetchrow_hashref();
1999   return $issue;
2000 }
2001
2002 =head2 GetItemIssues
2003
2004   $issues = &GetItemIssues($itemnumber, $history);
2005
2006 Returns patrons that have issued a book
2007
2008 C<$itemnumber> is the itemnumber
2009 C<$history> is false if you just want the current "issuer" (if any)
2010 and true if you want issues history from old_issues also.
2011
2012 Returns reference to an array of hashes
2013
2014 =cut
2015
2016 sub GetItemIssues {
2017     my ( $itemnumber, $history ) = @_;
2018     
2019     my $today = C4::Dates->today('iso');  # get today date
2020     my $sql = "SELECT * FROM issues 
2021               JOIN borrowers USING (borrowernumber)
2022               JOIN items     USING (itemnumber)
2023               WHERE issues.itemnumber = ? ";
2024     if ($history) {
2025         $sql .= "UNION ALL
2026                  SELECT * FROM old_issues 
2027                  LEFT JOIN borrowers USING (borrowernumber)
2028                  JOIN items USING (itemnumber)
2029                  WHERE old_issues.itemnumber = ? ";
2030     }
2031     $sql .= "ORDER BY date_due DESC";
2032     my $sth = C4::Context->dbh->prepare($sql);
2033     if ($history) {
2034         $sth->execute($itemnumber, $itemnumber);
2035     } else {
2036         $sth->execute($itemnumber);
2037     }
2038     my $results = $sth->fetchall_arrayref({});
2039     foreach (@$results) {
2040         $_->{'overdue'} = ($_->{'date_due'} lt $today) ? 1 : 0;
2041     }
2042     return $results;
2043 }
2044
2045 =head2 GetBiblioIssues
2046
2047   $issues = GetBiblioIssues($biblionumber);
2048
2049 this function get all issues from a biblionumber.
2050
2051 Return:
2052 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2053 tables issues and the firstname,surname & cardnumber from borrowers.
2054
2055 =cut
2056
2057 sub GetBiblioIssues {
2058     my $biblionumber = shift;
2059     return undef unless $biblionumber;
2060     my $dbh   = C4::Context->dbh;
2061     my $query = "
2062         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2063         FROM issues
2064             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2065             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2066             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2067             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2068         WHERE biblio.biblionumber = ?
2069         UNION ALL
2070         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2071         FROM old_issues
2072             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2073             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2074             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2075             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2076         WHERE biblio.biblionumber = ?
2077         ORDER BY timestamp
2078     ";
2079     my $sth = $dbh->prepare($query);
2080     $sth->execute($biblionumber, $biblionumber);
2081
2082     my @issues;
2083     while ( my $data = $sth->fetchrow_hashref ) {
2084         push @issues, $data;
2085     }
2086     return \@issues;
2087 }
2088
2089 =head2 GetUpcomingDueIssues
2090
2091   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2092
2093 =cut
2094
2095 sub GetUpcomingDueIssues {
2096     my $params = shift;
2097
2098     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2099     my $dbh = C4::Context->dbh;
2100
2101     my $statement = <<END_SQL;
2102 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2103 FROM issues 
2104 LEFT JOIN items USING (itemnumber)
2105 LEFT OUTER JOIN branches USING (branchcode)
2106 WhERE returndate is NULL
2107 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
2108 END_SQL
2109
2110     my @bind_parameters = ( $params->{'days_in_advance'} );
2111     
2112     my $sth = $dbh->prepare( $statement );
2113     $sth->execute( @bind_parameters );
2114     my $upcoming_dues = $sth->fetchall_arrayref({});
2115     $sth->finish;
2116
2117     return $upcoming_dues;
2118 }
2119
2120 =head2 CanBookBeRenewed
2121
2122   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2123
2124 Find out whether a borrowed item may be renewed.
2125
2126 C<$dbh> is a DBI handle to the Koha database.
2127
2128 C<$borrowernumber> is the borrower number of the patron who currently
2129 has the item on loan.
2130
2131 C<$itemnumber> is the number of the item to renew.
2132
2133 C<$override_limit>, if supplied with a true value, causes
2134 the limit on the number of times that the loan can be renewed
2135 (as controlled by the item type) to be ignored.
2136
2137 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2138 item must currently be on loan to the specified borrower; renewals
2139 must be allowed for the item's type; and the borrower must not have
2140 already renewed the loan. $error will contain the reason the renewal can not proceed
2141
2142 =cut
2143
2144 sub CanBookBeRenewed {
2145
2146     # check renewal status
2147     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2148     my $dbh       = C4::Context->dbh;
2149     my $renews    = 1;
2150     my $renewokay = 0;
2151         my $error;
2152
2153     # Look in the issues table for this item, lent to this borrower,
2154     # and not yet returned.
2155
2156     # Look in the issues table for this item, lent to this borrower,
2157     # and not yet returned.
2158     my %branch = (
2159             'ItemHomeLibrary' => 'items.homebranch',
2160             'PickupLibrary'   => 'items.holdingbranch',
2161             'PatronLibrary'   => 'borrowers.branchcode'
2162             );
2163     my $controlbranch = $branch{C4::Context->preference('CircControl')};
2164     my $itype         = C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype';
2165     
2166     my $sthcount = $dbh->prepare("
2167                    SELECT 
2168                     borrowers.categorycode, biblioitems.itemtype, issues.renewals, renewalsallowed, $controlbranch
2169                    FROM  issuingrules, 
2170                    issues 
2171                    LEFT JOIN items USING (itemnumber) 
2172                    LEFT JOIN borrowers USING (borrowernumber) 
2173                    LEFT JOIN biblioitems USING (biblioitemnumber)
2174                    
2175                    WHERE
2176                     (issuingrules.categorycode = borrowers.categorycode OR issuingrules.categorycode = '*')
2177                    AND
2178                     (issuingrules.itemtype = $itype OR issuingrules.itemtype = '*')
2179                    AND
2180                     (issuingrules.branchcode = $controlbranch OR issuingrules.branchcode = '*') 
2181                    AND 
2182                     borrowernumber = ? 
2183                    AND
2184                     itemnumber = ?
2185                    ORDER BY
2186                     issuingrules.categorycode desc,
2187                     issuingrules.itemtype desc,
2188                     issuingrules.branchcode desc
2189                    LIMIT 1;
2190                   ");
2191
2192     $sthcount->execute( $borrowernumber, $itemnumber );
2193     if ( my $data1 = $sthcount->fetchrow_hashref ) {
2194         
2195         if ( ( $data1->{renewalsallowed} && $data1->{renewalsallowed} > $data1->{renewals} ) || $override_limit ) {
2196             $renewokay = 1;
2197         }
2198         else {
2199                         $error="too_many";
2200                 }
2201                 
2202         my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2203         if ($resfound) {
2204             $renewokay = 0;
2205                         $error="on_reserve"
2206         }
2207
2208     }
2209     return ($renewokay,$error);
2210 }
2211
2212 =head2 AddRenewal
2213
2214   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2215
2216 Renews a loan.
2217
2218 C<$borrowernumber> is the borrower number of the patron who currently
2219 has the item.
2220
2221 C<$itemnumber> is the number of the item to renew.
2222
2223 C<$branch> is the library where the renewal took place (if any).
2224            The library that controls the circ policies for the renewal is retrieved from the issues record.
2225
2226 C<$datedue> can be a C4::Dates object used to set the due date.
2227
2228 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2229 this parameter is not supplied, lastreneweddate is set to the current date.
2230
2231 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2232 from the book's item type.
2233
2234 =cut
2235
2236 sub AddRenewal {
2237     my $borrowernumber  = shift or return undef;
2238     my $itemnumber      = shift or return undef;
2239     my $branch          = shift;
2240     my $datedue         = shift;
2241     my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2242     my $item   = GetItem($itemnumber) or return undef;
2243     my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2244
2245     my $dbh = C4::Context->dbh;
2246     # Find the issues record for this book
2247     my $sth =
2248       $dbh->prepare("SELECT * FROM issues
2249                         WHERE borrowernumber=? 
2250                         AND itemnumber=?"
2251       );
2252     $sth->execute( $borrowernumber, $itemnumber );
2253     my $issuedata = $sth->fetchrow_hashref;
2254     $sth->finish;
2255     if($datedue && ! $datedue->output('iso')){
2256         warn "Invalid date passed to AddRenewal.";
2257         return undef;
2258     }
2259     # If the due date wasn't specified, calculate it by adding the
2260     # book's loan length to today's date or the current due date
2261     # based on the value of the RenewalPeriodBase syspref.
2262     unless ($datedue) {
2263
2264         my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return undef;
2265         my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2266
2267         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2268                                         C4::Dates->new($issuedata->{date_due}, 'iso') :
2269                                         C4::Dates->new();
2270         $datedue =  CalcDateDue($datedue,$itemtype,$issuedata->{'branchcode'},$borrower);
2271     }
2272
2273     # Update the issues record to have the new due date, and a new count
2274     # of how many times it has been renewed.
2275     my $renews = $issuedata->{'renewals'} + 1;
2276     $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2277                             WHERE borrowernumber=? 
2278                             AND itemnumber=?"
2279     );
2280     $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2281     $sth->finish;
2282
2283     # Update the renewal count on the item, and tell zebra to reindex
2284     $renews = $biblio->{'renewals'} + 1;
2285     ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2286
2287     # Charge a new rental fee, if applicable?
2288     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2289     if ( $charge > 0 ) {
2290         my $accountno = getnextacctno( $borrowernumber );
2291         my $item = GetBiblioFromItemNumber($itemnumber);
2292         my $manager_id = 0;
2293         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv; 
2294         $sth = $dbh->prepare(
2295                 "INSERT INTO accountlines
2296                     (date, borrowernumber, accountno, amount, manager_id,
2297                     description,accounttype, amountoutstanding, itemnumber)
2298                     VALUES (now(),?,?,?,?,?,?,?,?)"
2299         );
2300         $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2301             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2302             'Rent', $charge, $itemnumber );
2303         $sth->finish;
2304     }
2305     # Log the renewal
2306     UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2307         return $datedue;
2308 }
2309
2310 sub GetRenewCount {
2311     # check renewal status
2312     my ( $bornum, $itemno ) = @_;
2313     my $dbh           = C4::Context->dbh;
2314     my $renewcount    = 0;
2315     my $renewsallowed = 0;
2316     my $renewsleft    = 0;
2317
2318     my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2319     my $item     = GetItem($itemno); 
2320
2321     # Look in the issues table for this item, lent to this borrower,
2322     # and not yet returned.
2323
2324     # FIXME - I think this function could be redone to use only one SQL call.
2325     my $sth = $dbh->prepare(
2326         "select * from issues
2327                                 where (borrowernumber = ?)
2328                                 and (itemnumber = ?)"
2329     );
2330     $sth->execute( $bornum, $itemno );
2331     my $data = $sth->fetchrow_hashref;
2332     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2333     $sth->finish;
2334     # $item and $borrower should be calculated
2335     my $branchcode = _GetCircControlBranch($item, $borrower);
2336     
2337     my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2338     
2339     $renewsallowed = $issuingrule->{'renewalsallowed'};
2340     $renewsleft    = $renewsallowed - $renewcount;
2341     if($renewsleft < 0){ $renewsleft = 0; }
2342     return ( $renewcount, $renewsallowed, $renewsleft );
2343 }
2344
2345 =head2 GetIssuingCharges
2346
2347   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2348
2349 Calculate how much it would cost for a given patron to borrow a given
2350 item, including any applicable discounts.
2351
2352 C<$itemnumber> is the item number of item the patron wishes to borrow.
2353
2354 C<$borrowernumber> is the patron's borrower number.
2355
2356 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2357 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2358 if it's a video).
2359
2360 =cut
2361
2362 sub GetIssuingCharges {
2363
2364     # calculate charges due
2365     my ( $itemnumber, $borrowernumber ) = @_;
2366     my $charge = 0;
2367     my $dbh    = C4::Context->dbh;
2368     my $item_type;
2369
2370     # Get the book's item type and rental charge (via its biblioitem).
2371     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2372         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2373     $charge_query .= (C4::Context->preference('item-level_itypes'))
2374         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2375         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2376
2377     $charge_query .= ' WHERE items.itemnumber =?';
2378
2379     my $sth = $dbh->prepare($charge_query);
2380     $sth->execute($itemnumber);
2381     if ( my $item_data = $sth->fetchrow_hashref ) {
2382         $item_type = $item_data->{itemtype};
2383         $charge    = $item_data->{rentalcharge};
2384         my $branch = C4::Branch::mybranch();
2385         my $discount_query = q|SELECT rentaldiscount,
2386             issuingrules.itemtype, issuingrules.branchcode
2387             FROM borrowers
2388             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2389             WHERE borrowers.borrowernumber = ?
2390             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2391             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2392         my $discount_sth = $dbh->prepare($discount_query);
2393         $discount_sth->execute( $borrowernumber, $item_type, $branch );
2394         my $discount_rules = $discount_sth->fetchall_arrayref({});
2395         if (@{$discount_rules}) {
2396             # We may have multiple rules so get the most specific
2397             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2398             $charge = ( $charge * ( 100 - $discount ) ) / 100;
2399         }
2400     }
2401
2402     $sth->finish; # we havent _explicitly_ fetched all rows
2403     return ( $charge, $item_type );
2404 }
2405
2406 # Select most appropriate discount rule from those returned
2407 sub _get_discount_from_rule {
2408     my ($rules_ref, $branch, $itemtype) = @_;
2409     my $discount;
2410
2411     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2412         $discount = $rules_ref->[0]->{rentaldiscount};
2413         return (defined $discount) ? $discount : 0;
2414     }
2415     # could have up to 4 does one match $branch and $itemtype
2416     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2417     if (@d) {
2418         $discount = $d[0]->{rentaldiscount};
2419         return (defined $discount) ? $discount : 0;
2420     }
2421     # do we have item type + all branches
2422     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2423     if (@d) {
2424         $discount = $d[0]->{rentaldiscount};
2425         return (defined $discount) ? $discount : 0;
2426     }
2427     # do we all item types + this branch
2428     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2429     if (@d) {
2430         $discount = $d[0]->{rentaldiscount};
2431         return (defined $discount) ? $discount : 0;
2432     }
2433     # so all and all (surely we wont get here)
2434     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2435     if (@d) {
2436         $discount = $d[0]->{rentaldiscount};
2437         return (defined $discount) ? $discount : 0;
2438     }
2439     # none of the above
2440     return 0;
2441 }
2442
2443 =head2 AddIssuingCharge
2444
2445   &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2446
2447 =cut
2448
2449 sub AddIssuingCharge {
2450     my ( $itemnumber, $borrowernumber, $charge ) = @_;
2451     my $dbh = C4::Context->dbh;
2452     my $nextaccntno = getnextacctno( $borrowernumber );
2453     my $manager_id = 0;
2454     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2455     my $query ="
2456         INSERT INTO accountlines
2457             (borrowernumber, itemnumber, accountno,
2458             date, amount, description, accounttype,
2459             amountoutstanding, manager_id)
2460         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2461     ";
2462     my $sth = $dbh->prepare($query);
2463     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2464     $sth->finish;
2465 }
2466
2467 =head2 GetTransfers
2468
2469   GetTransfers($itemnumber);
2470
2471 =cut
2472
2473 sub GetTransfers {
2474     my ($itemnumber) = @_;
2475
2476     my $dbh = C4::Context->dbh;
2477
2478     my $query = '
2479         SELECT datesent,
2480                frombranch,
2481                tobranch
2482         FROM branchtransfers
2483         WHERE itemnumber = ?
2484           AND datearrived IS NULL
2485         ';
2486     my $sth = $dbh->prepare($query);
2487     $sth->execute($itemnumber);
2488     my @row = $sth->fetchrow_array();
2489     $sth->finish;
2490     return @row;
2491 }
2492
2493 =head2 GetTransfersFromTo
2494
2495   @results = GetTransfersFromTo($frombranch,$tobranch);
2496
2497 Returns the list of pending transfers between $from and $to branch
2498
2499 =cut
2500
2501 sub GetTransfersFromTo {
2502     my ( $frombranch, $tobranch ) = @_;
2503     return unless ( $frombranch && $tobranch );
2504     my $dbh   = C4::Context->dbh;
2505     my $query = "
2506         SELECT itemnumber,datesent,frombranch
2507         FROM   branchtransfers
2508         WHERE  frombranch=?
2509           AND  tobranch=?
2510           AND datearrived IS NULL
2511     ";
2512     my $sth = $dbh->prepare($query);
2513     $sth->execute( $frombranch, $tobranch );
2514     my @gettransfers;
2515
2516     while ( my $data = $sth->fetchrow_hashref ) {
2517         push @gettransfers, $data;
2518     }
2519     $sth->finish;
2520     return (@gettransfers);
2521 }
2522
2523 =head2 DeleteTransfer
2524
2525   &DeleteTransfer($itemnumber);
2526
2527 =cut
2528
2529 sub DeleteTransfer {
2530     my ($itemnumber) = @_;
2531     my $dbh          = C4::Context->dbh;
2532     my $sth          = $dbh->prepare(
2533         "DELETE FROM branchtransfers
2534          WHERE itemnumber=?
2535          AND datearrived IS NULL "
2536     );
2537     $sth->execute($itemnumber);
2538     $sth->finish;
2539 }
2540
2541 =head2 AnonymiseIssueHistory
2542
2543   $rows = AnonymiseIssueHistory($date,$borrowernumber)
2544
2545 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2546 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2547
2548 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2549 setting (force delete).
2550
2551 return the number of affected rows.
2552
2553 =cut
2554
2555 sub AnonymiseIssueHistory {
2556     my $date           = shift;
2557     my $borrowernumber = shift;
2558     my $dbh            = C4::Context->dbh;
2559     my $query          = "
2560         UPDATE old_issues
2561         SET    borrowernumber = ?
2562         WHERE  returndate < ?
2563           AND borrowernumber IS NOT NULL
2564     ";
2565
2566     # The default of 0 does not work due to foreign key constraints
2567     # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2568     my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2569     my @bind_params = ($anonymouspatron, $date);
2570     if (defined $borrowernumber) {
2571        $query .= " AND borrowernumber = ?";
2572        push @bind_params, $borrowernumber;
2573     } else {
2574        $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2575     }
2576     my $sth = $dbh->prepare($query);
2577     $sth->execute(@bind_params);
2578     my $rows_affected = $sth->rows;  ### doublecheck row count return function
2579     return $rows_affected;
2580 }
2581
2582 =head2 SendCirculationAlert
2583
2584 Send out a C<check-in> or C<checkout> alert using the messaging system.
2585
2586 B<Parameters>:
2587
2588 =over 4
2589
2590 =item type
2591
2592 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2593
2594 =item item
2595
2596 Hashref of information about the item being checked in or out.
2597
2598 =item borrower
2599
2600 Hashref of information about the borrower of the item.
2601
2602 =item branch
2603
2604 The branchcode from where the checkout or check-in took place.
2605
2606 =back
2607
2608 B<Example>:
2609
2610     SendCirculationAlert({
2611         type     => 'CHECKOUT',
2612         item     => $item,
2613         borrower => $borrower,
2614         branch   => $branch,
2615     });
2616
2617 =cut
2618
2619 sub SendCirculationAlert {
2620     my ($opts) = @_;
2621     my ($type, $item, $borrower, $branch) =
2622         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2623     my %message_name = (
2624         CHECKIN  => 'Item_Check_in',
2625         CHECKOUT => 'Item_Checkout',
2626     );
2627     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2628         borrowernumber => $borrower->{borrowernumber},
2629         message_name   => $message_name{$type},
2630     });
2631     my $letter = C4::Letters::getletter('circulation', $type);
2632     C4::Letters::parseletter($letter, 'biblio',      $item->{biblionumber});
2633     C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2634     C4::Letters::parseletter($letter, 'borrowers',   $borrower->{borrowernumber});
2635     C4::Letters::parseletter($letter, 'branches',    $branch);
2636     my @transports = @{ $borrower_preferences->{transports} };
2637     # warn "no transports" unless @transports;
2638     for (@transports) {
2639         # warn "transport: $_";
2640         my $message = C4::Message->find_last_message($borrower, $type, $_);
2641         if (!$message) {
2642             #warn "create new message";
2643             C4::Message->enqueue($letter, $borrower, $_);
2644         } else {
2645             #warn "append to old message";
2646             $message->append($letter);
2647             $message->update;
2648         }
2649     }
2650     $letter;
2651 }
2652
2653 =head2 updateWrongTransfer
2654
2655   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2656
2657 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 
2658
2659 =cut
2660
2661 sub updateWrongTransfer {
2662         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2663         my $dbh = C4::Context->dbh;     
2664 # first step validate the actual line of transfert .
2665         my $sth =
2666                 $dbh->prepare(
2667                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2668                 );
2669                 $sth->execute($FromLibrary,$itemNumber);
2670                 $sth->finish;
2671
2672 # second step create a new line of branchtransfer to the right location .
2673         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2674
2675 #third step changing holdingbranch of item
2676         UpdateHoldingbranch($FromLibrary,$itemNumber);
2677 }
2678
2679 =head2 UpdateHoldingbranch
2680
2681   $items = UpdateHoldingbranch($branch,$itmenumber);
2682
2683 Simple methode for updating hodlingbranch in items BDD line
2684
2685 =cut
2686
2687 sub UpdateHoldingbranch {
2688         my ( $branch,$itemnumber ) = @_;
2689     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2690 }
2691
2692 =head2 CalcDateDue
2693
2694 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
2695
2696 this function calculates the due date given the start date and configured circulation rules,
2697 checking against the holidays calendar as per the 'useDaysMode' syspref.
2698 C<$startdate>   = C4::Dates object representing start date of loan period (assumed to be today)
2699 C<$itemtype>  = itemtype code of item in question
2700 C<$branch>  = location whose calendar to use
2701 C<$borrower> = Borrower object
2702
2703 =cut
2704
2705 sub CalcDateDue { 
2706         my ($startdate,$itemtype,$branch,$borrower) = @_;
2707         my $datedue;
2708         my $loanlength = GetLoanLength($borrower->{'categorycode'},$itemtype, $branch);
2709
2710         # if globalDueDate ON the datedue is set to that date
2711         if ( C4::Context->preference('globalDueDate')
2712              && ( C4::Context->preference('globalDueDate') =~ C4::Dates->regexp('syspref') ) ) {
2713             $datedue = C4::Dates->new( C4::Context->preference('globalDueDate') );
2714         } else {
2715         # otherwise, calculate the datedue as normal
2716                 if(C4::Context->preference('useDaysMode') eq 'Days') {  # ignoring calendar
2717                         my $timedue = time + ($loanlength) * 86400;
2718                 #FIXME - assumes now even though we take a startdate 
2719                         my @datearr  = localtime($timedue);
2720                         $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2721                 } else {
2722                         my $calendar = C4::Calendar->new(  branchcode => $branch );
2723                         $datedue = $calendar->addDate($startdate, $loanlength);
2724                 }
2725         }
2726
2727         # if Hard Due Dates are used, retreive them and apply as necessary
2728         my ($hardduedate, $hardduedatecompare) = GetHardDueDate($borrower->{'categorycode'},$itemtype, $branch);
2729         if ( $hardduedate && $hardduedate->output('iso') && $hardduedate->output('iso') ne '0000-00-00') {
2730             # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
2731             if ( $datedue->output( 'iso' ) gt $hardduedate->output( 'iso' ) && $hardduedatecompare == -1) {
2732                 $datedue = $hardduedate;
2733             # if the calculated date is before the 'after' Hard Due Date (floor), override
2734             } elsif ( $datedue->output( 'iso' ) lt $hardduedate->output( 'iso' ) && $hardduedatecompare == 1) {
2735                 $datedue = $hardduedate;               
2736             # if the hard due date is set to 'exactly', overrride
2737             } elsif ( $hardduedatecompare == 0) {
2738                 $datedue = $hardduedate;
2739             }
2740             # in all other cases, keep the date due as it is
2741         }
2742
2743         # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2744         if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2745             $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2746         }
2747
2748         return $datedue;
2749 }
2750
2751 =head2 CheckValidDatedue
2752
2753   $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2754
2755 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2756 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2757
2758 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2759 C<$date_due>   = returndate calculate with no day check
2760 C<$itemnumber>  = itemnumber
2761 C<$branchcode>  = location of issue (affected by 'CircControl' syspref)
2762 C<$loanlength>  = loan length prior to adjustment
2763
2764 =cut
2765
2766 sub CheckValidDatedue {
2767 my ($date_due,$itemnumber,$branchcode)=@_;
2768 my @datedue=split('-',$date_due->output('iso'));
2769 my $years=$datedue[0];
2770 my $month=$datedue[1];
2771 my $day=$datedue[2];
2772 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2773 my $dow;
2774 for (my $i=0;$i<2;$i++){
2775     $dow=Day_of_Week($years,$month,$day);
2776     ($dow=0) if ($dow>6);
2777     my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2778     my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2779     my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2780         if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2781         $i=0;
2782         (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2783         }
2784     }
2785     my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2786 return $newdatedue;
2787 }
2788
2789
2790 =head2 CheckRepeatableHolidays
2791
2792   $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2793
2794 This function checks if the date due is a repeatable holiday
2795
2796 C<$date_due>   = returndate calculate with no day check
2797 C<$itemnumber>  = itemnumber
2798 C<$branchcode>  = localisation of issue 
2799
2800 =cut
2801
2802 sub CheckRepeatableHolidays{
2803 my($itemnumber,$week_day,$branchcode)=@_;
2804 my $dbh = C4::Context->dbh;
2805 my $query = qq|SELECT count(*)  
2806         FROM repeatable_holidays 
2807         WHERE branchcode=?
2808         AND weekday=?|;
2809 my $sth = $dbh->prepare($query);
2810 $sth->execute($branchcode,$week_day);
2811 my $result=$sth->fetchrow;
2812 $sth->finish;
2813 return $result;
2814 }
2815
2816
2817 =head2 CheckSpecialHolidays
2818
2819   $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2820
2821 This function check if the date is a special holiday
2822
2823 C<$years>   = the years of datedue
2824 C<$month>   = the month of datedue
2825 C<$day>     = the day of datedue
2826 C<$itemnumber>  = itemnumber
2827 C<$branchcode>  = localisation of issue 
2828
2829 =cut
2830
2831 sub CheckSpecialHolidays{
2832 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2833 my $dbh = C4::Context->dbh;
2834 my $query=qq|SELECT count(*) 
2835              FROM `special_holidays`
2836              WHERE year=?
2837              AND month=?
2838              AND day=?
2839              AND branchcode=?
2840             |;
2841 my $sth = $dbh->prepare($query);
2842 $sth->execute($years,$month,$day,$branchcode);
2843 my $countspecial=$sth->fetchrow ;
2844 $sth->finish;
2845 return $countspecial;
2846 }
2847
2848 =head2 CheckRepeatableSpecialHolidays
2849
2850   $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2851
2852 This function check if the date is a repeatble special holidays
2853
2854 C<$month>   = the month of datedue
2855 C<$day>     = the day of datedue
2856 C<$itemnumber>  = itemnumber
2857 C<$branchcode>  = localisation of issue 
2858
2859 =cut
2860
2861 sub CheckRepeatableSpecialHolidays{
2862 my ($month,$day,$itemnumber,$branchcode) = @_;
2863 my $dbh = C4::Context->dbh;
2864 my $query=qq|SELECT count(*) 
2865              FROM `repeatable_holidays`
2866              WHERE month=?
2867              AND day=?
2868              AND branchcode=?
2869             |;
2870 my $sth = $dbh->prepare($query);
2871 $sth->execute($month,$day,$branchcode);
2872 my $countspecial=$sth->fetchrow ;
2873 $sth->finish;
2874 return $countspecial;
2875 }
2876
2877
2878
2879 sub CheckValidBarcode{
2880 my ($barcode) = @_;
2881 my $dbh = C4::Context->dbh;
2882 my $query=qq|SELECT count(*) 
2883              FROM items 
2884              WHERE barcode=?
2885             |;
2886 my $sth = $dbh->prepare($query);
2887 $sth->execute($barcode);
2888 my $exist=$sth->fetchrow ;
2889 $sth->finish;
2890 return $exist;
2891 }
2892
2893 =head2 IsBranchTransferAllowed
2894
2895   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2896
2897 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2898
2899 =cut
2900
2901 sub IsBranchTransferAllowed {
2902         my ( $toBranch, $fromBranch, $code ) = @_;
2903
2904         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2905         
2906         my $limitType = C4::Context->preference("BranchTransferLimitsType");   
2907         my $dbh = C4::Context->dbh;
2908             
2909         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2910         $sth->execute( $toBranch, $fromBranch, $code );
2911         my $limit = $sth->fetchrow_hashref();
2912                         
2913         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2914         if ( $limit->{'limitId'} ) {
2915                 return 0;
2916         } else {
2917                 return 1;
2918         }
2919 }                                                        
2920
2921 =head2 CreateBranchTransferLimit
2922
2923   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2924
2925 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2926
2927 =cut
2928
2929 sub CreateBranchTransferLimit {
2930    my ( $toBranch, $fromBranch, $code ) = @_;
2931
2932    my $limitType = C4::Context->preference("BranchTransferLimitsType");
2933    
2934    my $dbh = C4::Context->dbh;
2935    
2936    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2937    $sth->execute( $code, $toBranch, $fromBranch );
2938 }
2939
2940 =head2 DeleteBranchTransferLimits
2941
2942   DeleteBranchTransferLimits();
2943
2944 =cut
2945
2946 sub DeleteBranchTransferLimits {
2947    my $dbh = C4::Context->dbh;
2948    my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2949    $sth->execute();
2950 }
2951
2952 sub ReturnLostItem{
2953     my ( $borrowernumber, $itemnum ) = @_;
2954
2955     MarkIssueReturned( $borrowernumber, $itemnum );
2956     my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
2957     my @datearr = localtime(time);
2958     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
2959     my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
2960     ModItem({ paidfor =>  "Paid for by $bor $date" }, undef, $itemnum);
2961 }
2962
2963
2964 sub LostItem{
2965     my ($itemnumber, $mark_returned) = @_;
2966
2967     my $dbh = C4::Context->dbh();
2968     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title 
2969                            FROM issues 
2970                            JOIN items USING (itemnumber) 
2971                            JOIN biblio USING (biblionumber)
2972                            WHERE issues.itemnumber=?");
2973     $sth->execute($itemnumber);
2974     my $issues=$sth->fetchrow_hashref();
2975     $sth->finish;
2976
2977     # if a borrower lost the item, add a replacement cost to the their record
2978     if ( my $borrowernumber = $issues->{borrowernumber} ){
2979
2980         C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
2981         #FIXME : Should probably have a way to distinguish this from an item that really was returned.
2982         #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
2983         MarkIssueReturned($borrowernumber,$itemnumber) if $mark_returned;
2984     }
2985 }
2986
2987
2988 1;
2989
2990 __END__
2991
2992 =head1 AUTHOR
2993
2994 Koha Development Team <http://koha-community.org/>
2995
2996 =cut
2997