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