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