koha-dev.rot13.org Git - koha_fer/blob - C4/Circulation.pm

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