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     if (   $item->{'notforloan'}
 738         && $item->{'notforloan'} > 0 )
 739     {
 740         $issuingimpossible{NOT_FOR_LOAN} = 1;
 741     }
 742         elsif ( !$item->{'notforloan'} ){
 743                 # we have to check itemtypes.notforloan also
 744                 if (C4::Context->preference('item-level_itypes')){
 745                         # this should probably be a subroutine
 746                         my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
 747                         $sth->execute($item->{'itemtype'});
 748                         my $notforloan=$sth->fetchrow_hashref();
 749                         $sth->finish();
 750                         if ($notforloan->{'notforloan'} == 1){
 751                                 $issuingimpossible{NOT_FOR_LOAN} = 1;
 752                         }
 753                 }
 754                 elsif ($biblioitem->{'notforloan'} == 1){
 755                         $issuingimpossible{NOT_FOR_LOAN} = 1;
 756                 }
 757         }
 758     if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
 759     {
 760         $issuingimpossible{WTHDRAWN} = 1;
 761     }
 762     if (   $item->{'restricted'}
 763         && $item->{'restricted'} == 1 )
 764     {
 765         $issuingimpossible{RESTRICTED} = 1;
 766     }
 767     if ( C4::Context->preference("IndependantBranches") ) {
 768         my $userenv = C4::Context->userenv;
 769         if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
 770             $issuingimpossible{NOTSAMEBRANCH} = 1
 771               if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
 772         }
 773     }
 774
 775     #
 776     # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
 777     #
 778     if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
 779     {
 780
 781         # Already issued to current borrower. Ask whether the loan should
 782         # be renewed.
 783         my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
 784             $borrower->{'borrowernumber'},
 785             $item->{'itemnumber'}
 786         );
 787         if ( $CanBookBeRenewed == 0 ) {    # no more renewals allowed
 788             $issuingimpossible{NO_MORE_RENEWALS} = 1;
 789         }
 790         else {
 791             $needsconfirmation{RENEW_ISSUE} = 1;
 792         }
 793     }
 794     elsif ($issue->{borrowernumber}) {
 795
 796         # issued to someone else
 797         my $currborinfo =    C4::Members::GetMemberDetails( $issue->{borrowernumber} );
 798
 799 #        warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
 800         $needsconfirmation{ISSUED_TO_ANOTHER} =
 801 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
 802     }
 803
 804     # See if the item is on reserve.
 805     my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
 806     if ($restype) {
 807                 my $resbor = $res->{'borrowernumber'};
 808                 my ( $resborrower ) = C4::Members::GetMemberDetails( $resbor, 0 );
 809                 my $branches  = GetBranches();
 810                 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
 811         if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
 812         {
 813             # The item is on reserve and waiting, but has been
 814             # reserved by some other patron.
 815             $needsconfirmation{RESERVE_WAITING} =
 816 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
 817         }
 818         elsif ( $restype eq "Reserved" ) {
 819             # The item is on reserve for someone else.
 820             $needsconfirmation{RESERVED} =
 821 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
 822         }
 823     }
 824     if ( C4::Context->preference("LibraryName") eq "Horowhenua Library Trust" ) {
 825         if ( $borrower->{'categorycode'} eq 'W' ) {
 826             my %emptyhash;
 827             return ( \%emptyhash, \%needsconfirmation );
 828         }
 829         }
 830         return ( \%issuingimpossible, \%needsconfirmation );
 831 }
 832
 833 =head2 AddIssue
 834
 835 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
 836
 837 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
 838
 839 =over 4
 840
 841 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
 842
 843 =item C<$barcode> is the barcode of the item being issued.
 844
 845 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
 846 Calculated if empty.
 847
 848 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
 849
 850 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
 851 Defaults to today.  Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
 852
 853 AddIssue does the following things :
 854
 855   - step 01: check that there is a borrowernumber & a barcode provided
 856   - check for RENEWAL (book issued & being issued to the same patron)
 857       - renewal YES = Calculate Charge & renew
 858       - renewal NO  =
 859           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
 860           * RESERVE PLACED ?
 861               - fill reserve if reserve to this patron
 862               - cancel reserve or not, otherwise
 863           * TRANSFERT PENDING ?
 864               - complete the transfert
 865           * ISSUE THE BOOK
 866
 867 =back
 868
 869 =cut
 870
 871 sub AddIssue {
 872     my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
 873     my $dbh = C4::Context->dbh;
 874         my $barcodecheck=CheckValidBarcode($barcode);
 875
 876     # $issuedate defaults to today.
 877     if ( ! defined $issuedate ) {
 878         $issuedate = strftime( "%Y-%m-%d", localtime );
 879         # TODO: for hourly circ, this will need to be a C4::Dates object
 880         # and all calls to AddIssue including issuedate will need to pass a Dates object.
 881     }
 882         if ($borrower and $barcode and $barcodecheck ne '0'){
 883                 # find which item we issue
 884                 my $item = GetItem('', $barcode) or return undef;       # if we don't get an Item, abort.
 885                 my $branch = (C4::Context->preference('CircControl') eq 'PickupLibrary') ? C4::Context->userenv->{'branch'} :
 886                      (C4::Context->preference('CircControl') eq 'PatronLibrary') ? $borrower->{'branchcode'}        :
 887                      $item->{'homebranch'};     # fallback to item's homebranch
 888
 889                 # get actual issuing if there is one
 890                 my $actualissue = GetItemIssue( $item->{itemnumber});
 891
 892                 # get biblioinformation for this item
 893                 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
 894
 895                 #
 896                 # check if we just renew the issue.
 897                 #
 898                 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
 899                         $datedue = AddRenewal(
 900                                 $borrower->{'borrowernumber'},
 901                                 $item->{'itemnumber'},
 902                                 $branch,
 903                                 $datedue,
 904                 $issuedate, # here interpreted as the renewal date
 905                         );
 906                 }
 907                 else {
 908         # it's NOT a renewal
 909                         if ( $actualissue->{borrowernumber}) {
 910                                 # This book is currently on loan, but not to the person
 911                                 # who wants to borrow it now. mark it returned before issuing to the new borrower
 912                                 AddReturn(
 913                                         $item->{'barcode'},
 914                                         C4::Context->userenv->{'branch'}
 915                                 );
 916                         }
 917
 918                         # See if the item is on reserve.
 919                         my ( $restype, $res ) =
 920                           C4::Reserves::CheckReserves( $item->{'itemnumber'} );
 921                         if ($restype) {
 922                                 my $resbor = $res->{'borrowernumber'};
 923                                 if ( $resbor eq $borrower->{'borrowernumber'} ) {
 924                                         # The item is reserved by the current patron
 925                                         ModReserveFill($res);
 926                                 }
 927                                 elsif ( $restype eq "Waiting" ) {
 928                                         # warn "Waiting";
 929                                         # The item is on reserve and waiting, but has been
 930                                         # reserved by some other patron.
 931                                 }
 932                                 elsif ( $restype eq "Reserved" ) {
 933                                         # warn "Reserved";
 934                                         # The item is reserved by someone else.
 935                                         if ($cancelreserve) { # cancel reserves on this item
 936                                                 CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
 937                                         }
 938                                 }
 939                                 if ($cancelreserve) {
 940                                         CancelReserve($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
 941                                 }
 942                                 else {
 943                                         # set waiting reserve to first in reserve queue as book isn't waiting now
 944                                         ModReserve(1,
 945                                                 $res->{'biblionumber'},
 946                                                 $res->{'borrowernumber'},
 947                                                 $res->{'branchcode'}
 948                                         );
 949                                 }
 950                         }
 951
 952                         # Starting process for transfer job (checking transfert and validate it if we have one)
 953             my ($datesent) = GetTransfers($item->{'itemnumber'});
 954             if ($datesent) {
 955         #       updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
 956                 my $sth =
 957                     $dbh->prepare(
 958                     "UPDATE branchtransfers
 959                         SET datearrived = now(),
 960                         tobranch = ?,
 961                         comments = 'Forced branchtransfer'
 962                     WHERE itemnumber= ? AND datearrived IS NULL"
 963                     );
 964                 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
 965             }
 966
 967         # Record in the database the fact that the book was issued.
 968         my $sth =
 969           $dbh->prepare(
 970                 "INSERT INTO issues
 971                     (borrowernumber, itemnumber,issuedate, date_due, branchcode)
 972                 VALUES (?,?,?,?,?)"
 973           );
 974         unless ($datedue) {
 975             my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
 976             my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
 977             $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch );
 978
 979             # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
 980             if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
 981                 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
 982             }
 983
 984             # if ceilingDueDate ON the datedue can't be after the ceiling date
 985             if ( C4::Context->preference('ceilingDueDate')
 986                  && ( C4::Context->preference('ceilingDueDate') =~ C4::Dates->regexp('syspref') )
 987                  && $datedue->output gt C4::Context->preference('ceilingDueDate') ) {
 988                 $datedue = C4::Dates->new( C4::Context->preference('ceilingDueDate') );
 989             }
 990         }
 991         $sth->execute(
 992             $borrower->{'borrowernumber'},      # borrowernumber
 993             $item->{'itemnumber'},              # itemnumber
 994             $issuedate,                         # issuedate
 995             $datedue->output('iso'),            # date_due
 996             C4::Context->userenv->{'branch'}    # branchcode
 997         );
 998         $sth->finish;
 999         $item->{'issues'}++;
1000         ModItem({ issues           => $item->{'issues'},
1001                   holdingbranch    => C4::Context->userenv->{'branch'},
1002                   itemlost         => 0,
1003                   datelastborrowed => C4::Dates->new()->output('iso'),
1004                   onloan           => $datedue->output('iso'),
1005                 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1006         ModDateLastSeen( $item->{'itemnumber'} );
1007
1008         # If it costs to borrow this book, charge it to the patron's account.
1009         my ( $charge, $itemtype ) = GetIssuingCharges(
1010             $item->{'itemnumber'},
1011             $borrower->{'borrowernumber'}
1012         );
1013         if ( $charge > 0 ) {
1014             AddIssuingCharge(
1015                 $item->{'itemnumber'},
1016                 $borrower->{'borrowernumber'}, $charge
1017             );
1018             $item->{'charge'} = $charge;
1019         }
1020
1021         # Record the fact that this book was issued.
1022         &UpdateStats(
1023             C4::Context->userenv->{'branch'},
1024             'issue', $charge,
1025             ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1026             $item->{'itype'}, $borrower->{'borrowernumber'}
1027         );
1028
1029         # Send a checkout slip.
1030         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1031         my %conditions = (
1032             branchcode   => $branch,
1033             categorycode => $borrower->{categorycode},
1034             item_type    => $item->{itype},
1035             notification => 'CHECKOUT',
1036         );
1037         if ($circulation_alert->is_enabled_for(\%conditions)) {
1038             SendCirculationAlert({
1039                 type     => 'CHECKOUT',
1040                 item     => $item,
1041                 borrower => $borrower,
1042                 branch   => $branch,
1043             });
1044         }
1045     }
1046
1047     logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1048         if C4::Context->preference("IssueLog");
1049   }
1050   return ($datedue);    # not necessarily the same as when it came in!
1051 }
1052
1053 =head2 GetLoanLength
1054
1055 Get loan length for an itemtype, a borrower type and a branch
1056
1057 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1058
1059 =cut
1060
1061 sub GetLoanLength {
1062     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1063     my $dbh = C4::Context->dbh;
1064     my $sth =
1065       $dbh->prepare(
1066 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1067       );
1068 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1069 # try to find issuelength & return the 1st available.
1070 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1071     $sth->execute( $borrowertype, $itemtype, $branchcode );
1072     my $loanlength = $sth->fetchrow_hashref;
1073     return $loanlength->{issuelength}
1074       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1075
1076     $sth->execute( $borrowertype, "*", $branchcode );
1077     $loanlength = $sth->fetchrow_hashref;
1078     return $loanlength->{issuelength}
1079       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1080
1081     $sth->execute( "*", $itemtype, $branchcode );
1082     $loanlength = $sth->fetchrow_hashref;
1083     return $loanlength->{issuelength}
1084       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1085
1086     $sth->execute( "*", "*", $branchcode );
1087     $loanlength = $sth->fetchrow_hashref;
1088     return $loanlength->{issuelength}
1089       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1090
1091     $sth->execute( $borrowertype, $itemtype, "*" );
1092     $loanlength = $sth->fetchrow_hashref;
1093     return $loanlength->{issuelength}
1094       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1095
1096     $sth->execute( $borrowertype, "*", "*" );
1097     $loanlength = $sth->fetchrow_hashref;
1098     return $loanlength->{issuelength}
1099       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1100
1101     $sth->execute( "*", $itemtype, "*" );
1102     $loanlength = $sth->fetchrow_hashref;
1103     return $loanlength->{issuelength}
1104       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1105
1106     $sth->execute( "*", "*", "*" );
1107     $loanlength = $sth->fetchrow_hashref;
1108     return $loanlength->{issuelength}
1109       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1110
1111     # if no rule is set => 21 days (hardcoded)
1112     return 21;
1113 }
1114
1115 =head2 GetIssuingRule
1116
1117 FIXME - This is a copy-paste of GetLoanLength
1118 as a stop-gap.  Do not wish to change API for GetLoanLength
1119 this close to release, however, Overdues::GetIssuingRules is broken.
1120
1121 Get the issuing rule for an itemtype, a borrower type and a branch
1122 Returns a hashref from the issuingrules table.
1123
1124 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1125
1126 =cut
1127
1128 sub GetIssuingRule {
1129     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1130     my $dbh = C4::Context->dbh;
1131     my $sth =  $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"  );
1132     my $irule;
1133
1134         $sth->execute( $borrowertype, $itemtype, $branchcode );
1135     $irule = $sth->fetchrow_hashref;
1136     return $irule if defined($irule) ;
1137
1138     $sth->execute( $borrowertype, "*", $branchcode );
1139     $irule = $sth->fetchrow_hashref;
1140     return $irule if defined($irule) ;
1141
1142     $sth->execute( "*", $itemtype, $branchcode );
1143     $irule = $sth->fetchrow_hashref;
1144     return $irule if defined($irule) ;
1145
1146     $sth->execute( "*", "*", $branchcode );
1147     $irule = $sth->fetchrow_hashref;
1148     return $irule if defined($irule) ;
1149
1150     $sth->execute( $borrowertype, $itemtype, "*" );
1151     $irule = $sth->fetchrow_hashref;
1152     return $irule if defined($irule) ;
1153
1154     $sth->execute( $borrowertype, "*", "*" );
1155     $irule = $sth->fetchrow_hashref;
1156     return $irule if defined($irule) ;
1157
1158     $sth->execute( "*", $itemtype, "*" );
1159     $irule = $sth->fetchrow_hashref;
1160     return $irule if defined($irule) ;
1161
1162     $sth->execute( "*", "*", "*" );
1163     $irule = $sth->fetchrow_hashref;
1164     return $irule if defined($irule) ;
1165
1166     # if no rule matches,
1167     return undef;
1168 }
1169
1170 =head2 GetBranchBorrowerCircRule
1171
1172 =over 4
1173
1174 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1175
1176 =back
1177
1178 Retrieves circulation rule attributes that apply to the given
1179 branch and patron category, regardless of item type.
1180 The return value is a hashref containing the following key:
1181
1182 maxissueqty - maximum number of loans that a
1183 patron of the given category can have at the given
1184 branch.  If the value is undef, no limit.
1185
1186 This will first check for a specific branch and
1187 category match from branch_borrower_circ_rules.
1188
1189 If no rule is found, it will then check default_branch_circ_rules
1190 (same branch, default category).  If no rule is found,
1191 it will then check default_borrower_circ_rules (default
1192 branch, same category), then failing that, default_circ_rules
1193 (default branch, default category).
1194
1195 If no rule has been found in the database, it will default to
1196 the buillt in rule:
1197
1198 maxissueqty - undef
1199
1200 C<$branchcode> and C<$categorycode> should contain the
1201 literal branch code and patron category code, respectively - no
1202 wildcards.
1203
1204 =cut
1205
1206 sub GetBranchBorrowerCircRule {
1207     my $branchcode = shift;
1208     my $categorycode = shift;
1209
1210     my $branch_cat_query = "SELECT maxissueqty
1211                             FROM branch_borrower_circ_rules
1212                             WHERE branchcode = ?
1213                             AND   categorycode = ?";
1214     my $dbh = C4::Context->dbh();
1215     my $sth = $dbh->prepare($branch_cat_query);
1216     $sth->execute($branchcode, $categorycode);
1217     my $result;
1218     if ($result = $sth->fetchrow_hashref()) {
1219         return $result;
1220     }
1221
1222     # try same branch, default borrower category
1223     my $branch_query = "SELECT maxissueqty
1224                         FROM default_branch_circ_rules
1225                         WHERE branchcode = ?";
1226     $sth = $dbh->prepare($branch_query);
1227     $sth->execute($branchcode);
1228     if ($result = $sth->fetchrow_hashref()) {
1229         return $result;
1230     }
1231
1232     # try default branch, same borrower category
1233     my $category_query = "SELECT maxissueqty
1234                           FROM default_borrower_circ_rules
1235                           WHERE categorycode = ?";
1236     $sth = $dbh->prepare($category_query);
1237     $sth->execute($categorycode);
1238     if ($result = $sth->fetchrow_hashref()) {
1239         return $result;
1240     }
1241
1242     # try default branch, default borrower category
1243     my $default_query = "SELECT maxissueqty
1244                           FROM default_circ_rules";
1245     $sth = $dbh->prepare($default_query);
1246     $sth->execute();
1247     if ($result = $sth->fetchrow_hashref()) {
1248         return $result;
1249     }
1250
1251     # built-in default circulation rule
1252     return {
1253         maxissueqty => undef,
1254     };
1255 }
1256
1257 =head2 GetBranchItemRule
1258
1259 =over 4
1260
1261 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1262
1263 =back
1264
1265 Retrieves circulation rule attributes that apply to the given
1266 branch and item type, regardless of patron category.
1267
1268 The return value is a hashref containing the following key:
1269
1270 holdallowed => Hold policy for this branch and itemtype. Possible values:
1271   0: No holds allowed.
1272   1: Holds allowed only by patrons that have the same homebranch as the item.
1273   2: Holds allowed from any patron.
1274
1275 This searches branchitemrules in the following order:
1276
1277   * Same branchcode and itemtype
1278   * Same branchcode, itemtype '*'
1279   * branchcode '*', same itemtype
1280   * branchcode and itemtype '*'
1281
1282 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1283
1284 =cut
1285
1286 sub GetBranchItemRule {
1287     my ( $branchcode, $itemtype ) = @_;
1288     my $dbh = C4::Context->dbh();
1289     my $result = {};
1290
1291     my @attempts = (
1292         ['SELECT holdallowed
1293             FROM branch_item_rules
1294             WHERE branchcode = ?
1295               AND itemtype = ?', $branchcode, $itemtype],
1296         ['SELECT holdallowed
1297             FROM default_branch_circ_rules
1298             WHERE branchcode = ?', $branchcode],
1299         ['SELECT holdallowed
1300             FROM default_branch_item_rules
1301             WHERE itemtype = ?', $itemtype],
1302         ['SELECT holdallowed
1303             FROM default_circ_rules'],
1304     );
1305
1306     foreach my $attempt (@attempts) {
1307         my ($query, @bind_params) = @{$attempt};
1308
1309         # Since branch/category and branch/itemtype use the same per-branch
1310         # defaults tables, we have to check that the key we want is set, not
1311         # just that a row was returned
1312         return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1313     }
1314
1315     # built-in default circulation rule
1316     return {
1317         holdallowed => 2,
1318     };
1319 }
1320
1321 =head2 AddReturn
1322
1323 ($doreturn, $messages, $iteminformation, $borrower) =
1324     &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1325
1326 Returns a book.
1327
1328 =over 4
1329
1330 =item C<$barcode> is the bar code of the book being returned.
1331
1332 =item C<$branch> is the code of the branch where the book is being returned.
1333
1334 =item C<$exemptfine> indicates that overdue charges for the item will be
1335 removed.
1336
1337 =item C<$dropbox> indicates that the check-in date is assumed to be
1338 yesterday, or the last non-holiday as defined in C4::Calendar .  If
1339 overdue charges are applied and C<$dropbox> is true, the last charge
1340 will be removed.  This assumes that the fines accrual script has run
1341 for _today_.
1342
1343 =back
1344
1345 C<&AddReturn> returns a list of four items:
1346
1347 C<$doreturn> is true iff the return succeeded.
1348
1349 C<$messages> is a reference-to-hash giving the reason for failure:
1350
1351 =over 4
1352
1353 =item C<BadBarcode>
1354
1355 No item with this barcode exists. The value is C<$barcode>.
1356
1357 =item C<NotIssued>
1358
1359 The book is not currently on loan. The value is C<$barcode>.
1360
1361 =item C<IsPermanent>
1362
1363 The book's home branch is a permanent collection. If you have borrowed
1364 this book, you are not allowed to return it. The value is the code for
1365 the book's home branch.
1366
1367 =item C<wthdrawn>
1368
1369 This book has been withdrawn/cancelled. The value should be ignored.
1370
1371 =item C<ResFound>
1372
1373 The item was reserved. The value is a reference-to-hash whose keys are
1374 fields from the reserves table of the Koha database, and
1375 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1376 either C<Waiting>, C<Reserved>, or 0.
1377
1378 =back
1379
1380 C<$borrower> is a reference-to-hash, giving information about the
1381 patron who last borrowed the book.
1382
1383 =cut
1384
1385 sub AddReturn {
1386     my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1387     my $dbh      = C4::Context->dbh;
1388     my $messages;
1389     my $doreturn = 1;
1390     my $borrower;
1391     my $validTransfert = 0;
1392     my $reserveDone = 0;
1393
1394     # get information on item
1395     my $iteminformation = GetItemIssue( GetItemnumberFromBarcode($barcode));
1396     my $biblio = GetBiblioItemData($iteminformation->{'biblioitemnumber'});
1397 #     use Data::Dumper;warn Data::Dumper::Dumper($iteminformation);
1398     unless ($iteminformation->{'itemnumber'} ) {
1399         $messages->{'BadBarcode'} = $barcode;
1400         $doreturn = 0;
1401     } else {
1402         # find the borrower
1403         if ( ( not $iteminformation->{borrowernumber} ) && $doreturn ) {
1404             $messages->{'NotIssued'} = $barcode;
1405             # even though item is not on loan, it may still
1406             # be transferred; therefore, get current branch information
1407             my $curr_iteminfo = GetItem($iteminformation->{'itemnumber'});
1408             $iteminformation->{'homebranch'} = $curr_iteminfo->{'homebranch'};
1409             $iteminformation->{'holdingbranch'} = $curr_iteminfo->{'holdingbranch'};
1410             $iteminformation->{'itemlost'} = $curr_iteminfo->{'itemlost'};
1411             $doreturn = 0;
1412         }
1413
1414         # check if the book is in a permanent collection....
1415         my $hbr      = $iteminformation->{C4::Context->preference("HomeOrHoldingBranch")};
1416         my $branches = GetBranches();
1417                 # FIXME -- This 'PE' attribute is largely undocumented.  afaict, there's no user interface that reflects this functionality.
1418         if ( $hbr && $branches->{$hbr}->{'PE'} ) {
1419             $messages->{'IsPermanent'} = $hbr;
1420         }
1421
1422                     # if independent branches are on and returning to different branch, refuse the return
1423         if ($hbr ne C4::Context->userenv->{'branch'} && C4::Context->preference("IndependantBranches")){
1424                           $messages->{'Wrongbranch'} = 1;
1425                           $doreturn=0;
1426                     }
1427
1428         # check that the book has been cancelled
1429         if ( $iteminformation->{'wthdrawn'} ) {
1430             $messages->{'wthdrawn'} = 1;
1431             $doreturn = 0;
1432         }
1433
1434     #     new op dev : if the book returned in an other branch update the holding branch
1435
1436     # update issues, thereby returning book (should push this out into another subroutine
1437         $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1438
1439     # case of a return of document (deal with issues and holdingbranch)
1440
1441         if ($doreturn) {
1442                         my $circControlBranch;
1443                         if($dropbox) {
1444                                 # don't allow dropbox mode to create an invalid entry in issues (issuedate > returndate) FIXME: actually checks eq, not gt
1445                                 undef($dropbox) if ( $iteminformation->{'issuedate'} eq C4::Dates->today('iso') );
1446                                 if (C4::Context->preference('CircControl') eq 'ItemHomeBranch' ) {
1447                                         $circControlBranch = $iteminformation->{homebranch};
1448                                 } elsif ( C4::Context->preference('CircControl') eq 'PatronLibrary') {
1449                                         $circControlBranch = $borrower->{branchcode};
1450                                 } else { # CircControl must be PickupLibrary.
1451                                         $circControlBranch = $iteminformation->{holdingbranch};
1452                                         # FIXME - is this right ? are we sure that the holdingbranch is still the pickup branch?
1453                                 }
1454                         }
1455             MarkIssueReturned($borrower->{'borrowernumber'}, $iteminformation->{'itemnumber'},$circControlBranch);
1456             $messages->{'WasReturned'} = 1;    # FIXME is the "= 1" right?
1457         }
1458
1459     # continue to deal with returns cases, but not only if we have an issue
1460
1461         # the holdingbranch is updated if the document is returned in an other location .
1462         if ( $iteminformation->{'holdingbranch'} ne C4::Context->userenv->{'branch'} ) {
1463                         UpdateHoldingbranch(C4::Context->userenv->{'branch'},$iteminformation->{'itemnumber'});
1464                         #               reload iteminformation holdingbranch with the userenv value
1465                         $iteminformation->{'holdingbranch'} = C4::Context->userenv->{'branch'};
1466         }
1467         ModDateLastSeen( $iteminformation->{'itemnumber'} );
1468         ModItem({ onloan => undef }, $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'});
1469
1470                     if ($iteminformation->{borrowernumber}){
1471                           ($borrower) = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1472         }
1473         # fix up the accounts.....
1474         if ( $iteminformation->{'itemlost'} ) {
1475             $messages->{'WasLost'} = 1;
1476         }
1477
1478     # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1479     #     check if we have a transfer for this document
1480         my ($datesent,$frombranch,$tobranch) = GetTransfers( $iteminformation->{'itemnumber'} );
1481
1482     #     if we have a transfer to do, we update the line of transfers with the datearrived
1483         if ($datesent) {
1484             if ( $tobranch eq C4::Context->userenv->{'branch'} ) {
1485                     my $sth =
1486                     $dbh->prepare(
1487                             "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1488                     );
1489                     $sth->execute( $iteminformation->{'itemnumber'} );
1490                     $sth->finish;
1491     #         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'
1492             C4::Reserves::ModReserveStatus( $iteminformation->{'itemnumber'},'W' );
1493             }
1494         else {
1495             $messages->{'WrongTransfer'} = $tobranch;
1496             $messages->{'WrongTransferItem'} = $iteminformation->{'itemnumber'};
1497         }
1498         $validTransfert = 1;
1499         }
1500
1501     # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1502         # fix up the accounts.....
1503         if ($iteminformation->{'itemlost'}) {
1504                 FixAccountForLostAndReturned($iteminformation, $borrower);
1505                 $messages->{'WasLost'} = 1;
1506         }
1507         # fix up the overdues in accounts...
1508         FixOverduesOnReturn( $borrower->{'borrowernumber'},
1509             $iteminformation->{'itemnumber'}, $exemptfine, $dropbox );
1510
1511     # find reserves.....
1512     #     if we don't have a reserve with the status W, we launch the Checkreserves routine
1513         my ( $resfound, $resrec ) =
1514         C4::Reserves::CheckReserves( $iteminformation->{'itemnumber'} );
1515         if ($resfound) {
1516             $resrec->{'ResFound'}   = $resfound;
1517             $messages->{'ResFound'} = $resrec;
1518             $reserveDone = 1;
1519         }
1520
1521         # update stats?
1522         # Record the fact that this book was returned.
1523         UpdateStats(
1524             $branch, 'return', '0', '',
1525             $iteminformation->{'itemnumber'},
1526             $biblio->{'itemtype'},
1527             $borrower->{'borrowernumber'}
1528         );
1529
1530         # Send a check-in slip.
1531         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1532         my %conditions = (
1533             branchcode   => $branch,
1534             categorycode => $borrower->{categorycode},
1535             item_type    => $iteminformation->{itype},
1536             notification => 'CHECKIN',
1537         );
1538         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1539             SendCirculationAlert({
1540                 type     => 'CHECKIN',
1541                 item     => $iteminformation,
1542                 borrower => $borrower,
1543                 branch   => $branch,
1544             });
1545         }
1546
1547         logaction("CIRCULATION", "RETURN", $iteminformation->{borrowernumber}, $iteminformation->{'biblionumber'})
1548             if C4::Context->preference("ReturnLog");
1549
1550         #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1551         #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1552
1553         if ( ( $branch ne $iteminformation->{'homebranch'}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) and ($reserveDone ne 1) ){
1554                         if (C4::Context->preference("AutomaticItemReturn") == 1) {
1555                                 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1556                                 $messages->{'WasTransfered'} = 1;
1557                         } elsif ( C4::Context->preference("UseBranchTransferLimits") == 1
1558                                         && ! IsTransferAllowed( $branch, $iteminformation->{'homebranch'}, $iteminformation->{ C4::Context->preference("BranchTransferLimitsType") } )
1559                                 ) {
1560                                 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1561                                 $messages->{'WasTransfered'} = 1;
1562                         }
1563                         else {
1564                                 $messages->{'NeedsTransfer'} = 1;
1565                         }
1566         }
1567     }
1568     return ( $doreturn, $messages, $iteminformation, $borrower );
1569 }
1570
1571 =head2 MarkIssueReturned
1572
1573 =over 4
1574
1575 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate);
1576
1577 =back
1578
1579 Unconditionally marks an issue as being returned by
1580 moving the C<issues> row to C<old_issues> and
1581 setting C<returndate> to the current date, or
1582 the last non-holiday date of the branccode specified in
1583 C<dropbox_branch> .  Assumes you've already checked that
1584 it's safe to do this, i.e. last non-holiday > issuedate.
1585
1586 if C<$returndate> is specified (in iso format), it is used as the date
1587 of the return. It is ignored when a dropbox_branch is passed in.
1588
1589 Ideally, this function would be internal to C<C4::Circulation>,
1590 not exported, but it is currently needed by one
1591 routine in C<C4::Accounts>.
1592
1593 =cut
1594
1595 sub MarkIssueReturned {
1596     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate ) = @_;
1597     my $dbh   = C4::Context->dbh;
1598     my $query = "UPDATE issues SET returndate=";
1599     my @bind;
1600     if ($dropbox_branch) {
1601         my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1602         my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1603         $query .= " ? ";
1604         push @bind, $dropboxdate->output('iso');
1605     } elsif ($returndate) {
1606         $query .= " ? ";
1607         push @bind, $returndate;
1608     } else {
1609         $query .= " now() ";
1610     }
1611     $query .= " WHERE  borrowernumber = ?  AND itemnumber = ?";
1612     push @bind, $borrowernumber, $itemnumber;
1613     # FIXME transaction
1614     my $sth_upd  = $dbh->prepare($query);
1615     $sth_upd->execute(@bind);
1616     my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1617                                   WHERE borrowernumber = ?
1618                                   AND itemnumber = ?");
1619     $sth_copy->execute($borrowernumber, $itemnumber);
1620     my $sth_del  = $dbh->prepare("DELETE FROM issues
1621                                   WHERE borrowernumber = ?
1622                                   AND itemnumber = ?");
1623     $sth_del->execute($borrowernumber, $itemnumber);
1624 }
1625
1626 =head2 FixOverduesOnReturn
1627
1628     &FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1629
1630 C<$brn> borrowernumber
1631
1632 C<$itm> itemnumber
1633
1634 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1635 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1636
1637 internal function, called only by AddReturn
1638
1639 =cut
1640
1641 sub FixOverduesOnReturn {
1642     my ( $borrowernumber, $item, $exemptfine, $dropbox ) = @_;
1643     my $dbh = C4::Context->dbh;
1644
1645     # check for overdue fine
1646     my $sth =
1647       $dbh->prepare(
1648 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1649       );
1650     $sth->execute( $borrowernumber, $item );
1651
1652     # alter fine to show that the book has been returned
1653    my $data;
1654         if ($data = $sth->fetchrow_hashref) {
1655         my $uquery;
1656                 my @bind = ($borrowernumber,$item ,$data->{'accountno'});
1657                 if ($exemptfine) {
1658                         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1659                         if (C4::Context->preference("FinesLog")) {
1660                         &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1661                         }
1662                 } elsif ($dropbox && $data->{lastincrement}) {
1663                         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1664                         my $amt = $data->{amount} - $data->{lastincrement} ;
1665                         if (C4::Context->preference("FinesLog")) {
1666                         &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1667                         }
1668                          $uquery = "update accountlines set accounttype='F' ";
1669                          if($outstanding  >= 0 && $amt >=0) {
1670                                 $uquery .= ", amount = ? , amountoutstanding=? ";
1671                                 unshift @bind, ($amt, $outstanding) ;
1672                         }
1673                 } else {
1674                         $uquery = "update accountlines set accounttype='F' ";
1675                 }
1676                 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1677         my $usth = $dbh->prepare($uquery);
1678         $usth->execute(@bind);
1679         $usth->finish();
1680     }
1681
1682     $sth->finish();
1683     return;
1684 }
1685
1686 =head2 FixAccountForLostAndReturned
1687
1688         &FixAccountForLostAndReturned($iteminfo,$borrower);
1689
1690 Calculates the charge for a book lost and returned (Not exported & used only once)
1691
1692 C<$iteminfo> is a hashref to iteminfo. Only {itemnumber} is used.
1693
1694 C<$borrower> is a hashref to borrower. Only {borrowernumber is used.
1695
1696 Internal function, called by AddReturn
1697
1698 =cut
1699
1700 sub FixAccountForLostAndReturned {
1701         my ($iteminfo, $borrower) = @_;
1702         my $dbh = C4::Context->dbh;
1703         my $itm = $iteminfo->{'itemnumber'};
1704         # check for charge made for lost book
1705         my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1706         $sth->execute($itm);
1707         if (my $data = $sth->fetchrow_hashref) {
1708         # writeoff this amount
1709                 my $offset;
1710                 my $amount = $data->{'amount'};
1711                 my $acctno = $data->{'accountno'};
1712                 my $amountleft;
1713                 if ($data->{'amountoutstanding'} == $amount) {
1714                 $offset = $data->{'amount'};
1715                 $amountleft = 0;
1716                 } else {
1717                 $offset = $amount - $data->{'amountoutstanding'};
1718                 $amountleft = $data->{'amountoutstanding'} - $amount;
1719                 }
1720                 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1721                         WHERE (borrowernumber = ?)
1722                         AND (itemnumber = ?) AND (accountno = ?) ");
1723                 $usth->execute($data->{'borrowernumber'},$itm,$acctno);
1724                 $usth->finish;
1725         #check if any credit is left if so writeoff other accounts
1726                 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1727                 if ($amountleft < 0){
1728                 $amountleft*=-1;
1729                 }
1730                 if ($amountleft > 0){
1731                 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1732                                                         AND (amountoutstanding >0) ORDER BY date");
1733                 $msth->execute($data->{'borrowernumber'});
1734         # offset transactions
1735                 my $newamtos;
1736                 my $accdata;
1737                 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1738                         if ($accdata->{'amountoutstanding'} < $amountleft) {
1739                         $newamtos = 0;
1740                         $amountleft -= $accdata->{'amountoutstanding'};
1741                         }  else {
1742                         $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1743                         $amountleft = 0;
1744                         }
1745                         my $thisacct = $accdata->{'accountno'};
1746                         my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1747                                         WHERE (borrowernumber = ?)
1748                                         AND (accountno=?)");
1749                         $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');
1750                         $usth->finish;
1751                         $usth = $dbh->prepare("INSERT INTO accountoffsets
1752                                 (borrowernumber, accountno, offsetaccount,  offsetamount)
1753                                 VALUES
1754                                 (?,?,?,?)");
1755                         $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1756                         $usth->finish;
1757                 }
1758                 $msth->finish;
1759                 }
1760                 if ($amountleft > 0){
1761                         $amountleft*=-1;
1762                 }
1763                 my $desc="Item Returned ".$iteminfo->{'barcode'};
1764                 $usth = $dbh->prepare("INSERT INTO accountlines
1765                         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1766                         VALUES (?,?,now(),?,?,'CR',?)");
1767                 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1768                 $usth->finish;
1769                 $usth = $dbh->prepare("INSERT INTO accountoffsets
1770                         (borrowernumber, accountno, offsetaccount,  offsetamount)
1771                         VALUES (?,?,?,?)");
1772                 $usth->execute($borrower->{'borrowernumber'},$data->{'accountno'},$nextaccntno,$offset);
1773                 $usth->finish;
1774         ModItem({ paidfor => '' }, undef, $itm);
1775         }
1776         $sth->finish;
1777         return;
1778 }
1779
1780 =head2 GetItemIssue
1781
1782 $issues = &GetItemIssue($itemnumber);
1783
1784 Returns patrons currently having a book. nothing if item is not issued atm
1785
1786 C<$itemnumber> is the itemnumber
1787
1788 Returns an array of hashes
1789
1790 FIXME: Though the above says that this function returns nothing if the
1791 item is not issued, this actually returns a hasref that looks like
1792 this:
1793     {
1794       itemnumber => 1,
1795       overdue    => 1
1796     }
1797
1798
1799 =cut
1800
1801 sub GetItemIssue {
1802     my ( $itemnumber) = @_;
1803     return unless $itemnumber;
1804     my $dbh = C4::Context->dbh;
1805     my @GetItemIssues;
1806
1807     # get today date
1808     my $today = POSIX::strftime("%Y%m%d", localtime);
1809
1810     my $sth = $dbh->prepare(
1811         "SELECT * FROM issues
1812         LEFT JOIN items ON issues.itemnumber=items.itemnumber
1813     WHERE
1814     issues.itemnumber=?");
1815     $sth->execute($itemnumber);
1816     my $data = $sth->fetchrow_hashref;
1817     my $datedue = $data->{'date_due'};
1818     $datedue =~ s/-//g;
1819     if ( $datedue < $today ) {
1820         $data->{'overdue'} = 1;
1821     }
1822     $data->{'itemnumber'} = $itemnumber; # fill itemnumber, in case item is not on issue
1823     $sth->finish;
1824     return ($data);
1825 }
1826
1827 =head2 GetOpenIssue
1828
1829 $issue = GetOpenIssue( $itemnumber );
1830
1831 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1832
1833 C<$itemnumber> is the item's itemnumber
1834
1835 Returns a hashref
1836
1837 =cut
1838
1839 sub GetOpenIssue {
1840   my ( $itemnumber ) = @_;
1841
1842   my $dbh = C4::Context->dbh;
1843   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1844   $sth->execute( $itemnumber );
1845   my $issue = $sth->fetchrow_hashref();
1846   return $issue;
1847 }
1848
1849 =head2 GetItemIssues
1850
1851 $issues = &GetItemIssues($itemnumber, $history);
1852
1853 Returns patrons that have issued a book
1854
1855 C<$itemnumber> is the itemnumber
1856 C<$history> is 0 if you want actuel "issuer" (if it exist) and 1 if you want issues history
1857
1858 Returns an array of hashes
1859
1860 =cut
1861
1862 sub GetItemIssues {
1863     my ( $itemnumber,$history ) = @_;
1864     my $dbh = C4::Context->dbh;
1865     my @GetItemIssues;
1866
1867     # get today date
1868     my $today = POSIX::strftime("%Y%m%d", localtime);
1869
1870     my $sql = "SELECT * FROM issues
1871               JOIN borrowers USING (borrowernumber)
1872               JOIN items USING (itemnumber)
1873               WHERE issues.itemnumber = ? ";
1874     if ($history) {
1875         $sql .= "UNION ALL
1876                  SELECT * FROM old_issues
1877                  LEFT JOIN borrowers USING (borrowernumber)
1878                  JOIN items USING (itemnumber)
1879                  WHERE old_issues.itemnumber = ? ";
1880     }
1881     $sql .= "ORDER BY date_due DESC";
1882     my $sth = $dbh->prepare($sql);
1883     if ($history) {
1884         $sth->execute($itemnumber, $itemnumber);
1885     } else {
1886         $sth->execute($itemnumber);
1887     }
1888     while ( my $data = $sth->fetchrow_hashref ) {
1889         my $datedue = $data->{'date_due'};
1890         $datedue =~ s/-//g;
1891         if ( $datedue < $today ) {
1892             $data->{'overdue'} = 1;
1893         }
1894         my $itemnumber = $data->{'itemnumber'};
1895         push @GetItemIssues, $data;
1896     }
1897     $sth->finish;
1898     return ( \@GetItemIssues );
1899 }
1900
1901 =head2 GetBiblioIssues
1902
1903 $issues = GetBiblioIssues($biblionumber);
1904
1905 this function get all issues from a biblionumber.
1906
1907 Return:
1908 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1909 tables issues and the firstname,surname & cardnumber from borrowers.
1910
1911 =cut
1912
1913 sub GetBiblioIssues {
1914     my $biblionumber = shift;
1915     return undef unless $biblionumber;
1916     my $dbh   = C4::Context->dbh;
1917     my $query = "
1918         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1919         FROM issues
1920             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1921             LEFT JOIN items ON issues.itemnumber = items.itemnumber
1922             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1923             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1924         WHERE biblio.biblionumber = ?
1925         UNION ALL
1926         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1927         FROM old_issues
1928             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1929             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1930             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1931             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1932         WHERE biblio.biblionumber = ?
1933         ORDER BY timestamp
1934     ";
1935     my $sth = $dbh->prepare($query);
1936     $sth->execute($biblionumber, $biblionumber);
1937
1938     my @issues;
1939     while ( my $data = $sth->fetchrow_hashref ) {
1940         push @issues, $data;
1941     }
1942     return \@issues;
1943 }
1944
1945 =head2 GetUpcomingDueIssues
1946
1947 =over 4
1948
1949 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
1950
1951 =back
1952
1953 =cut
1954
1955 sub GetUpcomingDueIssues {
1956     my $params = shift;
1957
1958     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
1959     my $dbh = C4::Context->dbh;
1960
1961     my $statement = <<END_SQL;
1962 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
1963 FROM issues
1964 LEFT JOIN items USING (itemnumber)
1965 WhERE returndate is NULL
1966 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
1967 END_SQL
1968
1969     my @bind_parameters = ( $params->{'days_in_advance'} );
1970
1971     my $sth = $dbh->prepare( $statement );
1972     $sth->execute( @bind_parameters );
1973     my $upcoming_dues = $sth->fetchall_arrayref({});
1974     $sth->finish;
1975
1976     return $upcoming_dues;
1977 }
1978
1979 =head2 CanBookBeRenewed
1980
1981 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
1982
1983 Find out whether a borrowed item may be renewed.
1984
1985 C<$dbh> is a DBI handle to the Koha database.
1986
1987 C<$borrowernumber> is the borrower number of the patron who currently
1988 has the item on loan.
1989
1990 C<$itemnumber> is the number of the item to renew.
1991
1992 C<$override_limit>, if supplied with a true value, causes
1993 the limit on the number of times that the loan can be renewed
1994 (as controlled by the item type) to be ignored.
1995
1996 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
1997 item must currently be on loan to the specified borrower; renewals
1998 must be allowed for the item's type; and the borrower must not have
1999 already renewed the loan. $error will contain the reason the renewal can not proceed
2000
2001 =cut
2002
2003 sub CanBookBeRenewed {
2004
2005     # check renewal status
2006     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2007     my $dbh       = C4::Context->dbh;
2008     my $renews    = 1;
2009     my $renewokay = 0;
2010         my $error;
2011
2012     # Look in the issues table for this item, lent to this borrower,
2013     # and not yet returned.
2014
2015     # FIXME - I think this function could be redone to use only one SQL call.
2016     my $sth1 = $dbh->prepare(
2017         "SELECT * FROM issues
2018             WHERE borrowernumber = ?
2019             AND itemnumber = ?"
2020     );
2021     $sth1->execute( $borrowernumber, $itemnumber );
2022     if ( my $data1 = $sth1->fetchrow_hashref ) {
2023
2024         # Found a matching item
2025
2026         # See if this item may be renewed. This query is convoluted
2027         # because it's a bit messy: given the item number, we need to find
2028         # the biblioitem, which gives us the itemtype, which tells us
2029         # whether it may be renewed.
2030         my $query = "SELECT renewalsallowed FROM items ";
2031         $query .= (C4::Context->preference('item-level_itypes'))
2032                     ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2033                     : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2034                        LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2035         $query .= "WHERE items.itemnumber = ?";
2036         my $sth2 = $dbh->prepare($query);
2037         $sth2->execute($itemnumber);
2038         if ( my $data2 = $sth2->fetchrow_hashref ) {
2039             $renews = $data2->{'renewalsallowed'};
2040         }
2041         if ( ( $renews && $renews > $data1->{'renewals'} ) || $override_limit ) {
2042             $renewokay = 1;
2043         }
2044         else {
2045                         $error="too_many";
2046                 }
2047         $sth2->finish;
2048         my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2049         if ($resfound) {
2050             $renewokay = 0;
2051                         $error="on_reserve"
2052         }
2053
2054     }
2055     $sth1->finish;
2056     return ($renewokay,$error);
2057 }
2058
2059 =head2 AddRenewal
2060
2061 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2062
2063 Renews a loan.
2064
2065 C<$borrowernumber> is the borrower number of the patron who currently
2066 has the item.
2067
2068 C<$itemnumber> is the number of the item to renew.
2069
2070 C<$branch> is the library branch.  Defaults to the homebranch of the ITEM.
2071
2072 C<$datedue> can be a C4::Dates object used to set the due date.
2073
2074 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2075 this parameter is not supplied, lastreneweddate is set to the current date.
2076
2077 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2078 from the book's item type.
2079
2080 =cut
2081
2082 sub AddRenewal {
2083         my $borrowernumber = shift or return undef;
2084         my     $itemnumber = shift or return undef;
2085     my $item   = GetItem($itemnumber) or return undef;
2086     my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2087     my $branch  = (@_) ? shift : $item->{homebranch};   # opac-renew doesn't send branch
2088     my $datedue = shift;
2089     my $lastreneweddate = shift;
2090
2091     # If the due date wasn't specified, calculate it by adding the
2092     # book's loan length to today's date.
2093     unless ($datedue && $datedue->output('iso')) {
2094
2095         my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2096         my $loanlength = GetLoanLength(
2097             $borrower->{'categorycode'},
2098              (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2099                         $item->{homebranch}                     # item's homebranch determines loanlength OR do we want the branch specified by the AddRenewal argument?
2100         );
2101                 #FIXME -- use circControl?
2102                 $datedue =  CalcDateDue(C4::Dates->new(),$loanlength,$branch);  # this branch is the transactional branch.
2103                                                                 # The question of whether to use item's homebranch calendar is open.
2104     }
2105
2106     # $lastreneweddate defaults to today.
2107     unless (defined $lastreneweddate) {
2108         $lastreneweddate = strftime( "%Y-%m-%d", localtime );
2109     }
2110
2111     my $dbh = C4::Context->dbh;
2112     # Find the issues record for this book
2113     my $sth =
2114       $dbh->prepare("SELECT * FROM issues
2115                         WHERE borrowernumber=?
2116                         AND itemnumber=?"
2117       );
2118     $sth->execute( $borrowernumber, $itemnumber );
2119     my $issuedata = $sth->fetchrow_hashref;
2120     $sth->finish;
2121
2122     # Update the issues record to have the new due date, and a new count
2123     # of how many times it has been renewed.
2124     my $renews = $issuedata->{'renewals'} + 1;
2125     $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2126                             WHERE borrowernumber=?
2127                             AND itemnumber=?"
2128     );
2129     $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2130     $sth->finish;
2131
2132     # Update the renewal count on the item, and tell zebra to reindex
2133     $renews = $biblio->{'renewals'} + 1;
2134     ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2135
2136     # Charge a new rental fee, if applicable?
2137     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2138     if ( $charge > 0 ) {
2139         my $accountno = getnextacctno( $borrowernumber );
2140         my $item = GetBiblioFromItemNumber($itemnumber);
2141         $sth = $dbh->prepare(
2142                 "INSERT INTO accountlines
2143                     (date,
2144                                         borrowernumber, accountno, amount,
2145                     description,
2146                                         accounttype, amountoutstanding, itemnumber
2147                                         )
2148                     VALUES (now(),?,?,?,?,?,?,?)"
2149         );
2150         $sth->execute( $borrowernumber, $accountno, $charge,
2151             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2152             'Rent', $charge, $itemnumber );
2153         $sth->finish;
2154     }
2155     # Log the renewal
2156     UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2157         return $datedue;
2158 }
2159
2160 sub GetRenewCount {
2161     # check renewal status
2162     my ($bornum,$itemno)=@_;
2163     my $dbh = C4::Context->dbh;
2164     my $renewcount = 0;
2165         my $renewsallowed = 0;
2166         my $renewsleft = 0;
2167     # Look in the issues table for this item, lent to this borrower,
2168     # and not yet returned.
2169
2170     # FIXME - I think this function could be redone to use only one SQL call.
2171     my $sth = $dbh->prepare("select * from issues
2172                                 where (borrowernumber = ?)
2173                                 and (itemnumber = ?)");
2174     $sth->execute($bornum,$itemno);
2175     my $data = $sth->fetchrow_hashref;
2176     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2177     $sth->finish;
2178     my $query = "SELECT renewalsallowed FROM items ";
2179     $query .= (C4::Context->preference('item-level_itypes'))
2180                 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2181                 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2182                    LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2183     $query .= "WHERE items.itemnumber = ?";
2184     my $sth2 = $dbh->prepare($query);
2185     $sth2->execute($itemno);
2186     my $data2 = $sth2->fetchrow_hashref();
2187     $renewsallowed = $data2->{'renewalsallowed'};
2188     $renewsleft = $renewsallowed - $renewcount;
2189     return ($renewcount,$renewsallowed,$renewsleft);
2190 }
2191
2192 =head2 GetIssuingCharges
2193
2194 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2195
2196 Calculate how much it would cost for a given patron to borrow a given
2197 item, including any applicable discounts.
2198
2199 C<$itemnumber> is the item number of item the patron wishes to borrow.
2200
2201 C<$borrowernumber> is the patron's borrower number.
2202
2203 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2204 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2205 if it's a video).
2206
2207 =cut
2208
2209 sub GetIssuingCharges {
2210
2211     # calculate charges due
2212     my ( $itemnumber, $borrowernumber ) = @_;
2213     my $charge = 0;
2214     my $dbh    = C4::Context->dbh;
2215     my $item_type;
2216
2217     # Get the book's item type and rental charge (via its biblioitem).
2218     my $qcharge =     "SELECT itemtypes.itemtype,rentalcharge FROM items
2219             LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2220         $qcharge .= (C4::Context->preference('item-level_itypes'))
2221                 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2222                 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2223
2224     $qcharge .=      "WHERE items.itemnumber =?";
2225
2226     my $sth1 = $dbh->prepare($qcharge);
2227     $sth1->execute($itemnumber);
2228     if ( my $data1 = $sth1->fetchrow_hashref ) {
2229         $item_type = $data1->{'itemtype'};
2230         $charge    = $data1->{'rentalcharge'};
2231         my $q2 = "SELECT rentaldiscount FROM borrowers
2232             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2233             WHERE borrowers.borrowernumber = ?
2234             AND issuingrules.itemtype = ?";
2235         my $sth2 = $dbh->prepare($q2);
2236         $sth2->execute( $borrowernumber, $item_type );
2237         if ( my $data2 = $sth2->fetchrow_hashref ) {
2238             my $discount = $data2->{'rentaldiscount'};
2239             if ( $discount eq 'NULL' ) {
2240                 $discount = 0;
2241             }
2242             $charge = ( $charge * ( 100 - $discount ) ) / 100;
2243         }
2244         $sth2->finish;
2245     }
2246
2247     $sth1->finish;
2248     return ( $charge, $item_type );
2249 }
2250
2251 =head2 AddIssuingCharge
2252
2253 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2254
2255 =cut
2256
2257 sub AddIssuingCharge {
2258     my ( $itemnumber, $borrowernumber, $charge ) = @_;
2259     my $dbh = C4::Context->dbh;
2260     my $nextaccntno = getnextacctno( $borrowernumber );
2261     my $query ="
2262         INSERT INTO accountlines
2263             (borrowernumber, itemnumber, accountno,
2264             date, amount, description, accounttype,
2265             amountoutstanding)
2266         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2267     ";
2268     my $sth = $dbh->prepare($query);
2269     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2270     $sth->finish;
2271 }
2272
2273 =head2 GetTransfers
2274
2275 GetTransfers($itemnumber);
2276
2277 =cut
2278
2279 sub GetTransfers {
2280     my ($itemnumber) = @_;
2281
2282     my $dbh = C4::Context->dbh;
2283
2284     my $query = '
2285         SELECT datesent,
2286                frombranch,
2287                tobranch
2288         FROM branchtransfers
2289         WHERE itemnumber = ?
2290           AND datearrived IS NULL
2291         ';
2292     my $sth = $dbh->prepare($query);
2293     $sth->execute($itemnumber);
2294     my @row = $sth->fetchrow_array();
2295     $sth->finish;
2296     return @row;
2297 }
2298
2299 =head2 GetTransfersFromTo
2300
2301 @results = GetTransfersFromTo($frombranch,$tobranch);
2302
2303 Returns the list of pending transfers between $from and $to branch
2304
2305 =cut
2306
2307 sub GetTransfersFromTo {
2308     my ( $frombranch, $tobranch ) = @_;
2309     return unless ( $frombranch && $tobranch );
2310     my $dbh   = C4::Context->dbh;
2311     my $query = "
2312         SELECT itemnumber,datesent,frombranch
2313         FROM   branchtransfers
2314         WHERE  frombranch=?
2315           AND  tobranch=?
2316           AND datearrived IS NULL
2317     ";
2318     my $sth = $dbh->prepare($query);
2319     $sth->execute( $frombranch, $tobranch );
2320     my @gettransfers;
2321
2322     while ( my $data = $sth->fetchrow_hashref ) {
2323         push @gettransfers, $data;
2324     }
2325     $sth->finish;
2326     return (@gettransfers);
2327 }
2328
2329 =head2 DeleteTransfer
2330
2331 &DeleteTransfer($itemnumber);
2332
2333 =cut
2334
2335 sub DeleteTransfer {
2336     my ($itemnumber) = @_;
2337     my $dbh          = C4::Context->dbh;
2338     my $sth          = $dbh->prepare(
2339         "DELETE FROM branchtransfers
2340          WHERE itemnumber=?
2341          AND datearrived IS NULL "
2342     );
2343     $sth->execute($itemnumber);
2344     $sth->finish;
2345 }
2346
2347 =head2 AnonymiseIssueHistory
2348
2349 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2350
2351 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2352 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2353
2354 return the number of affected rows.
2355
2356 =cut
2357
2358 sub AnonymiseIssueHistory {
2359     my $date           = shift;
2360     my $borrowernumber = shift;
2361     my $dbh            = C4::Context->dbh;
2362     my $query          = "
2363         UPDATE old_issues
2364         SET    borrowernumber = NULL
2365         WHERE  returndate < '".$date."'
2366           AND borrowernumber IS NOT NULL
2367     ";
2368     $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2369     my $rows_affected = $dbh->do($query);
2370     return $rows_affected;
2371 }
2372
2373 =head2 SendCirculationAlert
2374
2375 Send out a C<check-in> or C<checkout> alert using the messaging system.
2376
2377 B<Parameters>:
2378
2379 =over 4
2380
2381 =item type
2382
2383 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2384
2385 =item item
2386
2387 Hashref of information about the item being checked in or out.
2388
2389 =item borrower
2390
2391 Hashref of information about the borrower of the item.
2392
2393 =item branch
2394
2395 The branchcode from where the checkout or check-in took place.
2396
2397 =back
2398
2399 B<Example>:
2400
2401     SendCirculationAlert({
2402         type     => 'CHECKOUT',
2403         item     => $item,
2404         borrower => $borrower,
2405         branch   => $branch,
2406     });
2407
2408 =cut
2409
2410 sub SendCirculationAlert {
2411     my ($opts) = @_;
2412     my ($type, $item, $borrower, $branch) =
2413         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2414     my %message_name = (
2415         CHECKIN  => 'Item Check-in',
2416         CHECKOUT => 'Item Checkout',
2417     );
2418     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2419         borrowernumber => $borrower->{borrowernumber},
2420         message_name   => $message_name{$type},
2421     });
2422     my $letter = C4::Letters::getletter('circulation', $type);
2423     C4::Letters::parseletter($letter, 'biblio',      $item->{biblionumber});
2424     C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2425     C4::Letters::parseletter($letter, 'borrowers',   $borrower->{borrowernumber});
2426     C4::Letters::parseletter($letter, 'branches',    $branch);
2427     my @transports = @{ $borrower_preferences->{transports} };
2428     # warn "no transports" unless @transports;
2429     for (@transports) {
2430         # warn "transport: $_";
2431         my $message = C4::Message->find_last_message($borrower, $type, $_);
2432         if (!$message) {
2433             #warn "create new message";
2434             C4::Message->enqueue($letter, $borrower, $_);
2435         } else {
2436             #warn "append to old message";
2437             $message->append($letter);
2438             $message->update;
2439         }
2440     }
2441     $letter;
2442 }
2443
2444 =head2 updateWrongTransfer
2445
2446 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2447
2448 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
2449
2450 =cut
2451
2452 sub updateWrongTransfer {
2453         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2454         my $dbh = C4::Context->dbh;
2455 # first step validate the actual line of transfert .
2456         my $sth =
2457                 $dbh->prepare(
2458                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2459                 );
2460                 $sth->execute($FromLibrary,$itemNumber);
2461                 $sth->finish;
2462
2463 # second step create a new line of branchtransfer to the right location .
2464         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2465
2466 #third step changing holdingbranch of item
2467         UpdateHoldingbranch($FromLibrary,$itemNumber);
2468 }
2469
2470 =head2 UpdateHoldingbranch
2471
2472 $items = UpdateHoldingbranch($branch,$itmenumber);
2473 Simple methode for updating hodlingbranch in items BDD line
2474
2475 =cut
2476
2477 sub UpdateHoldingbranch {
2478         my ( $branch,$itemnumber ) = @_;
2479     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2480 }
2481
2482 =head2 CalcDateDue
2483
2484 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2485 this function calculates the due date given the loan length ,
2486 checking against the holidays calendar as per the 'useDaysMode' syspref.
2487 C<$startdate>   = C4::Dates object representing start date of loan period (assumed to be today)
2488 C<$branch>  = location whose calendar to use
2489 C<$loanlength>  = loan length prior to adjustment
2490 =cut
2491
2492 sub CalcDateDue {
2493         my ($startdate,$loanlength,$branch) = @_;
2494         if(C4::Context->preference('useDaysMode') eq 'Days') {  # ignoring calendar
2495                 my $datedue = time + ($loanlength) * 86400;
2496         #FIXME - assumes now even though we take a startdate
2497                 my @datearr  = localtime($datedue);
2498                 return C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2499         } else {
2500                 my $calendar = C4::Calendar->new(  branchcode => $branch );
2501                 my $datedue = $calendar->addDate($startdate, $loanlength);
2502                 return $datedue;
2503         }
2504 }
2505
2506 =head2 CheckValidDatedue
2507        This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2508        To be replaced by CalcDateDue() once C4::Calendar use is tested.
2509
2510 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2511 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2512 C<$date_due>   = returndate calculate with no day check
2513 C<$itemnumber>  = itemnumber
2514 C<$branchcode>  = location of issue (affected by 'CircControl' syspref)
2515 C<$loanlength>  = loan length prior to adjustment
2516 =cut
2517
2518 sub CheckValidDatedue {
2519 my ($date_due,$itemnumber,$branchcode)=@_;
2520 my @datedue=split('-',$date_due->output('iso'));
2521 my $years=$datedue[0];
2522 my $month=$datedue[1];
2523 my $day=$datedue[2];
2524 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2525 my $dow;
2526 for (my $i=0;$i<2;$i++){
2527     $dow=Day_of_Week($years,$month,$day);
2528     ($dow=0) if ($dow>6);
2529     my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2530     my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2531     my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2532         if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2533         $i=0;
2534         (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2535         }
2536     }
2537     my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2538 return $newdatedue;
2539 }
2540
2541
2542 =head2 CheckRepeatableHolidays
2543
2544 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2545 this function checks if the date due is a repeatable holiday
2546 C<$date_due>   = returndate calculate with no day check
2547 C<$itemnumber>  = itemnumber
2548 C<$branchcode>  = localisation of issue
2549
2550 =cut
2551
2552 sub CheckRepeatableHolidays{
2553 my($itemnumber,$week_day,$branchcode)=@_;
2554 my $dbh = C4::Context->dbh;
2555 my $query = qq|SELECT count(*)
2556         FROM repeatable_holidays
2557         WHERE branchcode=?
2558         AND weekday=?|;
2559 my $sth = $dbh->prepare($query);
2560 $sth->execute($branchcode,$week_day);
2561 my $result=$sth->fetchrow;
2562 $sth->finish;
2563 return $result;
2564 }
2565
2566
2567 =head2 CheckSpecialHolidays
2568
2569 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2570 this function check if the date is a special holiday
2571 C<$years>   = the years of datedue
2572 C<$month>   = the month of datedue
2573 C<$day>     = the day of datedue
2574 C<$itemnumber>  = itemnumber
2575 C<$branchcode>  = localisation of issue
2576
2577 =cut
2578
2579 sub CheckSpecialHolidays{
2580 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2581 my $dbh = C4::Context->dbh;
2582 my $query=qq|SELECT count(*)
2583              FROM `special_holidays`
2584              WHERE year=?
2585              AND month=?
2586              AND day=?
2587              AND branchcode=?
2588             |;
2589 my $sth = $dbh->prepare($query);
2590 $sth->execute($years,$month,$day,$branchcode);
2591 my $countspecial=$sth->fetchrow ;
2592 $sth->finish;
2593 return $countspecial;
2594 }
2595
2596 =head2 CheckRepeatableSpecialHolidays
2597
2598 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2599 this function check if the date is a repeatble special holidays
2600 C<$month>   = the month of datedue
2601 C<$day>     = the day of datedue
2602 C<$itemnumber>  = itemnumber
2603 C<$branchcode>  = localisation of issue
2604
2605 =cut
2606
2607 sub CheckRepeatableSpecialHolidays{
2608 my ($month,$day,$itemnumber,$branchcode) = @_;
2609 my $dbh = C4::Context->dbh;
2610 my $query=qq|SELECT count(*)
2611              FROM `repeatable_holidays`
2612              WHERE month=?
2613              AND day=?
2614              AND branchcode=?
2615             |;
2616 my $sth = $dbh->prepare($query);
2617 $sth->execute($month,$day,$branchcode);
2618 my $countspecial=$sth->fetchrow ;
2619 $sth->finish;
2620 return $countspecial;
2621 }
2622
2623
2624
2625 sub CheckValidBarcode{
2626 my ($barcode) = @_;
2627 my $dbh = C4::Context->dbh;
2628 my $query=qq|SELECT count(*)
2629              FROM items
2630              WHERE barcode=?
2631             |;
2632 my $sth = $dbh->prepare($query);
2633 $sth->execute($barcode);
2634 my $exist=$sth->fetchrow ;
2635 $sth->finish;
2636 return $exist;
2637 }
2638
2639 =head2 IsBranchTransferAllowed
2640
2641 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2642
2643 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2644
2645 =cut
2646
2647 sub IsBranchTransferAllowed {
2648         my ( $toBranch, $fromBranch, $code ) = @_;
2649
2650         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2651
2652         my $limitType = C4::Context->preference("BranchTransferLimitsType");
2653         my $dbh = C4::Context->dbh;
2654
2655         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2656         $sth->execute( $toBranch, $fromBranch, $code );
2657         my $limit = $sth->fetchrow_hashref();
2658
2659         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2660         if ( $limit->{'limitId'} ) {
2661                 return 0;
2662         } else {
2663                 return 1;
2664         }
2665 }
2666
2667 =head2 CreateBranchTransferLimit
2668
2669 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2670
2671 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2672
2673 =cut
2674
2675 sub CreateBranchTransferLimit {
2676    my ( $toBranch, $fromBranch, $code ) = @_;
2677
2678    my $limitType = C4::Context->preference("BranchTransferLimitsType");
2679
2680    my $dbh = C4::Context->dbh;
2681
2682    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2683    $sth->execute( $code, $toBranch, $fromBranch );
2684 }
2685
2686 =head2 DeleteBranchTransferLimits
2687
2688 DeleteBranchTransferLimits();
2689
2690 =cut
2691
2692 sub DeleteBranchTransferLimits {
2693    my $dbh = C4::Context->dbh;
2694    my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2695    $sth->execute();
2696 }
2697
2698
2699   1;
2700
2701 __END__
2702
2703 =head1 AUTHOR
2704
2705 Koha Developement team <info@koha.org>
2706
2707 =cut
2708