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