C4/Circulation.pm

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