C4/Circulation.pm

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