C4/Circulation.pm

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