C4/Circulation.pm

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