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} = $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, $flags ) = 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);
 854                 my $datedue;
 855
 856                 my $branch;
 857                 # Get which branchcode we need
 858                 if (C4::Context->preference('CircControl') eq 'PickupLibrary'){
 859                         $branch = C4::Context->userenv->{'branch'};
 860                 }
 861                 elsif (C4::Context->preference('CircControl') eq 'PatronLibrary'){
 862                         $branch = $borrower->{'branchcode'};
 863                 }
 864                 else {
 865                         # items home library
 866                         $branch = $item->{'homebranch'};
 867                 }
 868
 869                 # get actual issuing if there is one
 870                 my $actualissue = GetItemIssue( $item->{itemnumber});
 871
 872                 # get biblioinformation for this item
 873                 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
 874
 875                 #
 876                 # check if we just renew the issue.
 877                 #
 878                 if ( $actualissue->{borrowernumber} eq $borrower->{'borrowernumber'} ) {
 879                         AddRenewal(
 880                                 $borrower->{'borrowernumber'},
 881                                 $item->{'itemnumber'},
 882                                 $branch,
 883                                 $date
 884                         );
 885
 886                 }
 887                 else {
 888         # it's NOT a renewal
 889                         if ( $actualissue->{borrowernumber}) {
 890                                 # This book is currently on loan, but not to the person
 891                                 # who wants to borrow it now. mark it returned before issuing to the new borrower
 892                                 AddReturn(
 893                                         $item->{'barcode'},
 894                                         C4::Context->userenv->{'branch'}
 895                                 );
 896                         }
 897
 898                         # See if the item is on reserve.
 899                         my ( $restype, $res ) =
 900                           C4::Reserves::CheckReserves( $item->{'itemnumber'} );
 901                         if ($restype) {
 902                                 my $resbor = $res->{'borrowernumber'};
 903                                 if ( $resbor eq $borrower->{'borrowernumber'} ) {
 904
 905                                         # The item is reserved by the current patron
 906                                         ModReserveFill($res);
 907                                 }
 908                                 elsif ( $restype eq "Waiting" ) {
 909
 910                                         # warn "Waiting";
 911                                         # The item is on reserve and waiting, but has been
 912                                         # reserved by some other patron.
 913                                         my ( $resborrower, $flags ) = GetMemberDetails( $resbor, 0 );
 914                                         my $branches   = GetBranches();
 915                                         my $branchname =
 916                                           $branches->{ $res->{'branchcode'} }->{'branchname'};
 917                                 }
 918                                 elsif ( $restype eq "Reserved" ) {
 919
 920                                         # warn "Reserved";
 921                                         # The item is reserved by someone else.
 922                                         my ( $resborrower, $flags ) =
 923                                           GetMemberDetails( $resbor, 0 );
 924                                         my $branches   = GetBranches();
 925                                         my $branchname =  $branches->{ $res->{'branchcode'} }->{'branchname'};
 926                                         if ($cancelreserve) { # cancel reserves on this item
 927                                                 CancelReserve( 0, $res->{'itemnumber'},
 928                                                         $res->{'borrowernumber'} );
 929                                         }
 930                                 }
 931                                 if ($cancelreserve) {
 932                                         CancelReserve( $res->{'biblionumber'}, 0,
 933                     $res->{'borrowernumber'} );
 934                                 }
 935                                 else {
 936                                         # set waiting reserve to first in reserve queue as book isn't waiting now
 937                                         ModReserve(1,
 938                                                 $res->{'biblionumber'},
 939                                                 $res->{'borrowernumber'},
 940                                                 $res->{'branchcode'}
 941                                         );
 942                                 }
 943                         }
 944
 945                         # Starting process for transfer job (checking transfert and validate it if we have one)
 946             my ($datesent) = GetTransfers($item->{'itemnumber'});
 947             if ($datesent) {
 948         #       updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for lisibility of this case (maybe for stats ....)
 949             my $sth =
 950                     $dbh->prepare(
 951                     "UPDATE branchtransfers
 952                         SET datearrived = now(),
 953                         tobranch = ?,
 954                         comments = 'Forced branchtransfer'
 955                     WHERE itemnumber= ? AND datearrived IS NULL"
 956                     );
 957                     $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
 958                     $sth->finish;
 959             }
 960
 961         # Record in the database the fact that the book was issued.
 962         my $sth =
 963           $dbh->prepare(
 964                 "INSERT INTO issues
 965                     (borrowernumber, itemnumber,issuedate, date_due, branchcode)
 966                 VALUES (?,?,?,?,?)"
 967           );
 968                 my $dateduef;
 969         if ($date) {
 970             $dateduef = $date;
 971         } else {
 972                         my $itype=(C4::Context->preference('item-level_itypes')) ?  $biblio->{'itype'} : $biblio->{'itemtype'} ;
 973                 my $loanlength = GetLoanLength(
 974                     $borrower->{'categorycode'},
 975                     $itype,
 976                 $branch
 977                 );
 978                         $dateduef = CalcDateDue(C4::Dates->new(),$loanlength,$branch);
 979                 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
 980                 if ( C4::Context->preference('ReturnBeforeExpiry') && $dateduef->output('iso') gt $borrower->{dateexpiry} ) {
 981                     $dateduef = C4::Dates->new($borrower->{dateexpiry},'iso');
 982                 }
 983         };
 984                 $sth->execute(
 985             $borrower->{'borrowernumber'},
 986             $item->{'itemnumber'},
 987             strftime( "%Y-%m-%d", localtime ),$dateduef->output('iso'), C4::Context->userenv->{'branch'}
 988         );
 989         $sth->finish;
 990         $item->{'issues'}++;
 991         ModItem({ issues           => $item->{'issues'},
 992                   holdingbranch    => C4::Context->userenv->{'branch'},
 993                   itemlost         => 0,
 994                   datelastborrowed => C4::Dates->new()->output('iso'),
 995                   onloan           => $dateduef->output('iso'),
 996                 }, $item->{'biblionumber'}, $item->{'itemnumber'});
 997         ModDateLastSeen( $item->{'itemnumber'} );
 998
 999         # If it costs to borrow this book, charge it to the patron's account.
1000         my ( $charge, $itemtype ) = GetIssuingCharges(
1001             $item->{'itemnumber'},
1002             $borrower->{'borrowernumber'}
1003         );
1004         if ( $charge > 0 ) {
1005             AddIssuingCharge(
1006                 $item->{'itemnumber'},
1007                 $borrower->{'borrowernumber'}, $charge
1008             );
1009             $item->{'charge'} = $charge;
1010         }
1011
1012         # Record the fact that this book was issued.
1013         &UpdateStats(
1014             C4::Context->userenv->{'branch'},
1015             'issue',                        $charge,
1016             '',                             $item->{'itemnumber'},
1017             $item->{'itype'}, $borrower->{'borrowernumber'}
1018         );
1019     }
1020
1021     logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1022         if C4::Context->preference("IssueLog");
1023     return ($datedue);
1024   }
1025 }
1026
1027 =head2 GetLoanLength
1028
1029 Get loan length for an itemtype, a borrower type and a branch
1030
1031 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1032
1033 =cut
1034
1035 sub GetLoanLength {
1036     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1037     my $dbh = C4::Context->dbh;
1038     my $sth =
1039       $dbh->prepare(
1040 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1041       );
1042 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1043 # try to find issuelength & return the 1st available.
1044 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1045     $sth->execute( $borrowertype, $itemtype, $branchcode );
1046     my $loanlength = $sth->fetchrow_hashref;
1047     return $loanlength->{issuelength}
1048       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1049
1050     $sth->execute( $borrowertype, "*", $branchcode );
1051     $loanlength = $sth->fetchrow_hashref;
1052     return $loanlength->{issuelength}
1053       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1054
1055     $sth->execute( "*", $itemtype, $branchcode );
1056     $loanlength = $sth->fetchrow_hashref;
1057     return $loanlength->{issuelength}
1058       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1059
1060     $sth->execute( "*", "*", $branchcode );
1061     $loanlength = $sth->fetchrow_hashref;
1062     return $loanlength->{issuelength}
1063       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1064
1065     $sth->execute( $borrowertype, $itemtype, "*" );
1066     $loanlength = $sth->fetchrow_hashref;
1067     return $loanlength->{issuelength}
1068       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1069
1070     $sth->execute( $borrowertype, "*", "*" );
1071     $loanlength = $sth->fetchrow_hashref;
1072     return $loanlength->{issuelength}
1073       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1074
1075     $sth->execute( "*", $itemtype, "*" );
1076     $loanlength = $sth->fetchrow_hashref;
1077     return $loanlength->{issuelength}
1078       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1079
1080     $sth->execute( "*", "*", "*" );
1081     $loanlength = $sth->fetchrow_hashref;
1082     return $loanlength->{issuelength}
1083       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1084
1085     # if no rule is set => 21 days (hardcoded)
1086     return 21;
1087 }
1088
1089 =head2 GetIssuingRule
1090
1091 FIXME - This is a copy-paste of GetLoanLength
1092 as a stop-gap.  Do not wish to change API for GetLoanLength
1093 this close to release, however, Overdues::GetIssuingRules is broken.
1094
1095 Get the issuing rule for an itemtype, a borrower type and a branch
1096 Returns a hashref from the issuingrules table.
1097
1098 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1099
1100 =cut
1101
1102 sub GetIssuingRule {
1103     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1104     my $dbh = C4::Context->dbh;
1105     my $sth =  $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"  );
1106     my $irule;
1107
1108         $sth->execute( $borrowertype, $itemtype, $branchcode );
1109     $irule = $sth->fetchrow_hashref;
1110     return $irule if defined($irule) ;
1111
1112     $sth->execute( $borrowertype, "*", $branchcode );
1113     $irule = $sth->fetchrow_hashref;
1114     return $irule if defined($irule) ;
1115
1116     $sth->execute( "*", $itemtype, $branchcode );
1117     $irule = $sth->fetchrow_hashref;
1118     return $irule if defined($irule) ;
1119
1120     $sth->execute( "*", "*", $branchcode );
1121     $irule = $sth->fetchrow_hashref;
1122     return $irule if defined($irule) ;
1123
1124     $sth->execute( $borrowertype, $itemtype, "*" );
1125     $irule = $sth->fetchrow_hashref;
1126     return $irule if defined($irule) ;
1127
1128     $sth->execute( $borrowertype, "*", "*" );
1129     $irule = $sth->fetchrow_hashref;
1130     return $irule if defined($irule) ;
1131
1132     $sth->execute( "*", $itemtype, "*" );
1133     $irule = $sth->fetchrow_hashref;
1134     return $irule if defined($irule) ;
1135
1136     $sth->execute( "*", "*", "*" );
1137     $irule = $sth->fetchrow_hashref;
1138     return $irule if defined($irule) ;
1139
1140     # if no rule matches,
1141     return undef;
1142 }
1143
1144 =head2 GetBranchBorrowerCircRule
1145
1146 =over 4
1147
1148 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1149
1150 =back
1151
1152 Retrieves circulation rule attributes that apply to the given
1153 branch and patron category, regardless of item type.
1154 The return value is a hashref containing the following key:
1155
1156 maxissueqty - maximum number of loans that a
1157 patron of the given category can have at the given
1158 branch.  If the value is undef, no limit.
1159
1160 This will first check for a specific branch and
1161 category match from branch_borrower_circ_rules.
1162
1163 If no rule is found, it will then check default_branch_circ_rules
1164 (same branch, default category).  If no rule is found,
1165 it will then check default_borrower_circ_rules (default
1166 branch, same category), then failing that, default_circ_rules
1167 (default branch, default category).
1168
1169 If no rule has been found in the database, it will default to
1170 the buillt in rule:
1171
1172 maxissueqty - undef
1173
1174 C<$branchcode> and C<$categorycode> should contain the
1175 literal branch code and patron category code, respectively - no
1176 wildcards.
1177
1178 =cut
1179
1180 sub GetBranchBorrowerCircRule {
1181     my $branchcode = shift;
1182     my $categorycode = shift;
1183
1184     my $branch_cat_query = "SELECT maxissueqty
1185                             FROM branch_borrower_circ_rules
1186                             WHERE branchcode = ?
1187                             AND   categorycode = ?";
1188     my $dbh = C4::Context->dbh();
1189     my $sth = $dbh->prepare($branch_cat_query);
1190     $sth->execute($branchcode, $categorycode);
1191     my $result;
1192     if ($result = $sth->fetchrow_hashref()) {
1193         return $result;
1194     }
1195
1196     # try same branch, default borrower category
1197     my $branch_query = "SELECT maxissueqty
1198                         FROM default_branch_circ_rules
1199                         WHERE branchcode = ?";
1200     $sth = $dbh->prepare($branch_query);
1201     $sth->execute($branchcode);
1202     if ($result = $sth->fetchrow_hashref()) {
1203         return $result;
1204     }
1205
1206     # try default branch, same borrower category
1207     my $category_query = "SELECT maxissueqty
1208                           FROM default_borrower_circ_rules
1209                           WHERE categorycode = ?";
1210     $sth = $dbh->prepare($category_query);
1211     $sth->execute($categorycode);
1212     if ($result = $sth->fetchrow_hashref()) {
1213         return $result;
1214     }
1215
1216     # try default branch, default borrower category
1217     my $default_query = "SELECT maxissueqty
1218                           FROM default_circ_rules";
1219     $sth = $dbh->prepare($default_query);
1220     $sth->execute();
1221     if ($result = $sth->fetchrow_hashref()) {
1222         return $result;
1223     }
1224
1225     # built-in default circulation rule
1226     return {
1227         maxissueqty => undef,
1228     };
1229 }
1230
1231 =head2 AddReturn
1232
1233 ($doreturn, $messages, $iteminformation, $borrower) =
1234     &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1235
1236 Returns a book.
1237
1238 C<$barcode> is the bar code of the book being returned. C<$branch> is
1239 the code of the branch where the book is being returned.  C<$exemptfine>
1240 indicates that overdue charges for the item will be removed.  C<$dropbox>
1241 indicates that the check-in date is assumed to be yesterday, or the last
1242 non-holiday as defined in C4::Calendar .  If overdue
1243 charges are applied and C<$dropbox> is true, the last charge will be removed.
1244 This assumes that the fines accrual script has run for _today_.
1245
1246 C<&AddReturn> returns a list of four items:
1247
1248 C<$doreturn> is true iff the return succeeded.
1249
1250 C<$messages> is a reference-to-hash giving the reason for failure:
1251
1252 =over 4
1253
1254 =item C<BadBarcode>
1255
1256 No item with this barcode exists. The value is C<$barcode>.
1257
1258 =item C<NotIssued>
1259
1260 The book is not currently on loan. The value is C<$barcode>.
1261
1262 =item C<IsPermanent>
1263
1264 The book's home branch is a permanent collection. If you have borrowed
1265 this book, you are not allowed to return it. The value is the code for
1266 the book's home branch.
1267
1268 =item C<wthdrawn>
1269
1270 This book has been withdrawn/cancelled. The value should be ignored.
1271
1272 =item C<ResFound>
1273
1274 The item was reserved. The value is a reference-to-hash whose keys are
1275 fields from the reserves table of the Koha database, and
1276 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1277 either C<Waiting>, C<Reserved>, or 0.
1278
1279 =back
1280
1281 C<$borrower> is a reference-to-hash, giving information about the
1282 patron who last borrowed the book.
1283
1284 =cut
1285
1286 sub AddReturn {
1287     my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1288     my $dbh      = C4::Context->dbh;
1289     my $messages;
1290     my $doreturn = 1;
1291     my $borrower;
1292     my $validTransfert = 0;
1293     my $reserveDone = 0;
1294
1295     # get information on item
1296     my $iteminformation = GetItemIssue( GetItemnumberFromBarcode($barcode));
1297     my $biblio = GetBiblioItemData($iteminformation->{'biblioitemnumber'});
1298 #     use Data::Dumper;warn Data::Dumper::Dumper($iteminformation);
1299     unless ($iteminformation->{'itemnumber'} ) {
1300         $messages->{'BadBarcode'} = $barcode;
1301         $doreturn = 0;
1302     } else {
1303         # find the borrower
1304         if ( ( not $iteminformation->{borrowernumber} ) && $doreturn ) {
1305             $messages->{'NotIssued'} = $barcode;
1306             # even though item is not on loan, it may still
1307             # be transferred; therefore, get current branch information
1308             my $curr_iteminfo = GetItem($iteminformation->{'itemnumber'});
1309             $iteminformation->{'homebranch'} = $curr_iteminfo->{'homebranch'};
1310             $iteminformation->{'holdingbranch'} = $curr_iteminfo->{'holdingbranch'};
1311             $doreturn = 0;
1312         }
1313
1314         # check if the book is in a permanent collection....
1315         my $hbr      = $iteminformation->{C4::Context->preference("HomeOrHoldingBranch")};
1316         my $branches = GetBranches();
1317                 # FIXME -- This 'PE' attribute is largely undocumented.  afaict, there's no user interface that reflects this functionality.
1318         if ( $hbr && $branches->{$hbr}->{'PE'} ) {
1319             $messages->{'IsPermanent'} = $hbr;
1320         }
1321
1322                     # if independent branches are on and returning to different branch, refuse the return
1323         if ($hbr ne C4::Context->userenv->{'branch'} && C4::Context->preference("IndependantBranches")){
1324                           $messages->{'Wrongbranch'} = 1;
1325                           $doreturn=0;
1326                     }
1327
1328         # check that the book has been cancelled
1329         if ( $iteminformation->{'wthdrawn'} ) {
1330             $messages->{'wthdrawn'} = 1;
1331             $doreturn = 0;
1332         }
1333
1334     #     new op dev : if the book returned in an other branch update the holding branch
1335
1336     # update issues, thereby returning book (should push this out into another subroutine
1337         $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1338
1339     # case of a return of document (deal with issues and holdingbranch)
1340
1341         if ($doreturn) {
1342                         my $circControlBranch;
1343                         if($dropbox) {
1344                                 # don't allow dropbox mode to create an invalid entry in issues (issuedate > returndate) FIXME: actually checks eq, not gt
1345                                 undef($dropbox) if ( $iteminformation->{'issuedate'} eq C4::Dates->today('iso') );
1346                                 if (C4::Context->preference('CircControl') eq 'ItemHomeBranch' ) {
1347                                         $circControlBranch = $iteminformation->{homebranch};
1348                                 } elsif ( C4::Context->preference('CircControl') eq 'PatronLibrary') {
1349                                         $circControlBranch = $borrower->{branchcode};
1350                                 } else { # CircControl must be PickupLibrary.
1351                                         $circControlBranch = $iteminformation->{holdingbranch};
1352                                         # FIXME - is this right ? are we sure that the holdingbranch is still the pickup branch?
1353                                 }
1354                         }
1355             MarkIssueReturned($borrower->{'borrowernumber'}, $iteminformation->{'itemnumber'},$circControlBranch);
1356             $messages->{'WasReturned'} = 1;    # FIXME is the "= 1" right?
1357         }
1358
1359     # continue to deal with returns cases, but not only if we have an issue
1360
1361         # the holdingbranch is updated if the document is returned in an other location .
1362         if ( $iteminformation->{'holdingbranch'} ne C4::Context->userenv->{'branch'} ) {
1363                         UpdateHoldingbranch(C4::Context->userenv->{'branch'},$iteminformation->{'itemnumber'});
1364                         #               reload iteminformation holdingbranch with the userenv value
1365                         $iteminformation->{'holdingbranch'} = C4::Context->userenv->{'branch'};
1366         }
1367         ModDateLastSeen( $iteminformation->{'itemnumber'} );
1368         ModItem({ onloan => undef }, $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'});
1369
1370                     if ($iteminformation->{borrowernumber}){
1371                           ($borrower) = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1372         }
1373         # fix up the accounts.....
1374         if ( $iteminformation->{'itemlost'} ) {
1375             $messages->{'WasLost'} = 1;
1376         }
1377
1378     # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1379     #     check if we have a transfer for this document
1380         my ($datesent,$frombranch,$tobranch) = GetTransfers( $iteminformation->{'itemnumber'} );
1381
1382     #     if we have a transfer to do, we update the line of transfers with the datearrived
1383         if ($datesent) {
1384             if ( $tobranch eq C4::Context->userenv->{'branch'} ) {
1385                     my $sth =
1386                     $dbh->prepare(
1387                             "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1388                     );
1389                     $sth->execute( $iteminformation->{'itemnumber'} );
1390                     $sth->finish;
1391     #         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'
1392             C4::Reserves::ModReserveStatus( $iteminformation->{'itemnumber'},'W' );
1393             }
1394         else {
1395             $messages->{'WrongTransfer'} = $tobranch;
1396             $messages->{'WrongTransferItem'} = $iteminformation->{'itemnumber'};
1397         }
1398         $validTransfert = 1;
1399         }
1400
1401     # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1402         # fix up the accounts.....
1403         if ($iteminformation->{'itemlost'}) {
1404                 FixAccountForLostAndReturned($iteminformation, $borrower);
1405                 $messages->{'WasLost'} = 1;
1406         }
1407         # fix up the overdues in accounts...
1408         FixOverduesOnReturn( $borrower->{'borrowernumber'},
1409             $iteminformation->{'itemnumber'}, $exemptfine, $dropbox );
1410
1411     # find reserves.....
1412     #     if we don't have a reserve with the status W, we launch the Checkreserves routine
1413         my ( $resfound, $resrec ) =
1414         C4::Reserves::CheckReserves( $iteminformation->{'itemnumber'} );
1415         if ($resfound) {
1416             $resrec->{'ResFound'}   = $resfound;
1417             $messages->{'ResFound'} = $resrec;
1418             $reserveDone = 1;
1419         }
1420
1421         # update stats?
1422         # Record the fact that this book was returned.
1423         UpdateStats(
1424             $branch, 'return', '0', '',
1425             $iteminformation->{'itemnumber'},
1426             $biblio->{'itemtype'},
1427             $borrower->{'borrowernumber'}
1428         );
1429
1430         logaction("CIRCULATION", "RETURN", $iteminformation->{borrowernumber}, $iteminformation->{'biblionumber'})
1431             if C4::Context->preference("ReturnLog");
1432
1433         #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1434         #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1435
1436         if ( ($iteminformation->{'holdingbranch'} ne $iteminformation->{'homebranch'}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) and ($reserveDone ne 1) ){
1437                         if (C4::Context->preference("AutomaticItemReturn") == 1) {
1438                                 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1439                                 $messages->{'WasTransfered'} = 1;
1440                         }
1441                         else {
1442                                 $messages->{'NeedsTransfer'} = 1;
1443                         }
1444         }
1445     }
1446     return ( $doreturn, $messages, $iteminformation, $borrower );
1447 }
1448
1449 =head2 MarkIssueReturned
1450
1451 =over 4
1452
1453 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch);
1454
1455 =back
1456
1457 Unconditionally marks an issue as being returned by
1458 moving the C<issues> row to C<old_issues> and
1459 setting C<returndate> to the current date, or
1460 the last non-holiday date of the branccode specified in
1461 C<dropbox> .  Assumes you've already checked that
1462 it's safe to do this, i.e. last non-holiday > issuedate.
1463
1464 Ideally, this function would be internal to C<C4::Circulation>,
1465 not exported, but it is currently needed by one
1466 routine in C<C4::Accounts>.
1467
1468 =cut
1469
1470 sub MarkIssueReturned {
1471     my ($borrowernumber, $itemnumber, $dropbox_branch ) = @_;
1472         my $dbh = C4::Context->dbh;
1473         my $query = "UPDATE issues SET returndate=";
1474         my @bind = ($borrowernumber,$itemnumber);
1475         if($dropbox_branch) {
1476                 my $calendar = C4::Calendar->new(  branchcode => $dropbox_branch );
1477                 my $dropboxdate = $calendar->addDate(C4::Dates->new(), -1 );
1478                 unshift @bind, $dropboxdate->output('iso') ;
1479                 $query .= " ? "
1480         } else {
1481                 $query .= " now() ";
1482         }
1483         $query .=  " WHERE  borrowernumber = ?  AND itemnumber = ?";
1484     # FIXME transaction
1485     my $sth_upd  = $dbh->prepare($query);
1486     $sth_upd->execute(@bind);
1487     my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1488                                   WHERE borrowernumber = ?
1489                                   AND itemnumber = ?");
1490     $sth_copy->execute($borrowernumber, $itemnumber);
1491     my $sth_del  = $dbh->prepare("DELETE FROM issues
1492                                   WHERE borrowernumber = ?
1493                                   AND itemnumber = ?");
1494     $sth_del->execute($borrowernumber, $itemnumber);
1495 }
1496
1497 =head2 FixOverduesOnReturn
1498
1499     &FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1500
1501 C<$brn> borrowernumber
1502
1503 C<$itm> itemnumber
1504
1505 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1506 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1507
1508 internal function, called only by AddReturn
1509
1510 =cut
1511
1512 sub FixOverduesOnReturn {
1513     my ( $borrowernumber, $item, $exemptfine, $dropbox ) = @_;
1514     my $dbh = C4::Context->dbh;
1515
1516     # check for overdue fine
1517     my $sth =
1518       $dbh->prepare(
1519 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1520       );
1521     $sth->execute( $borrowernumber, $item );
1522
1523     # alter fine to show that the book has been returned
1524    my $data;
1525         if ($data = $sth->fetchrow_hashref) {
1526         my $uquery;
1527                 my @bind = ($borrowernumber,$item ,$data->{'accountno'});
1528                 if ($exemptfine) {
1529                         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1530                         if (C4::Context->preference("FinesLog")) {
1531                         &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1532                         }
1533                 } elsif ($dropbox && $data->{lastincrement}) {
1534                         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1535                         my $amt = $data->{amount} - $data->{lastincrement} ;
1536                         if (C4::Context->preference("FinesLog")) {
1537                         &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1538                         }
1539                          $uquery = "update accountlines set accounttype='F' ";
1540                          if($outstanding  >= 0 && $amt >=0) {
1541                                 $uquery .= ", amount = ? , amountoutstanding=? ";
1542                                 unshift @bind, ($amt, $outstanding) ;
1543                         }
1544                 } else {
1545                         $uquery = "update accountlines set accounttype='F' ";
1546                 }
1547                 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1548         my $usth = $dbh->prepare($uquery);
1549         $usth->execute(@bind);
1550         $usth->finish();
1551     }
1552
1553     $sth->finish();
1554     return;
1555 }
1556
1557 =head2 FixAccountForLostAndReturned
1558
1559         &FixAccountForLostAndReturned($iteminfo,$borrower);
1560
1561 Calculates the charge for a book lost and returned (Not exported & used only once)
1562
1563 C<$iteminfo> is a hashref to iteminfo. Only {itemnumber} is used.
1564
1565 C<$borrower> is a hashref to borrower. Only {borrowernumber is used.
1566
1567 Internal function, called by AddReturn
1568
1569 =cut
1570
1571 sub FixAccountForLostAndReturned {
1572         my ($iteminfo, $borrower) = @_;
1573         my $dbh = C4::Context->dbh;
1574         my $itm = $iteminfo->{'itemnumber'};
1575         # check for charge made for lost book
1576         my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1577         $sth->execute($itm);
1578         if (my $data = $sth->fetchrow_hashref) {
1579         # writeoff this amount
1580                 my $offset;
1581                 my $amount = $data->{'amount'};
1582                 my $acctno = $data->{'accountno'};
1583                 my $amountleft;
1584                 if ($data->{'amountoutstanding'} == $amount) {
1585                 $offset = $data->{'amount'};
1586                 $amountleft = 0;
1587                 } else {
1588                 $offset = $amount - $data->{'amountoutstanding'};
1589                 $amountleft = $data->{'amountoutstanding'} - $amount;
1590                 }
1591                 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1592                         WHERE (borrowernumber = ?)
1593                         AND (itemnumber = ?) AND (accountno = ?) ");
1594                 $usth->execute($data->{'borrowernumber'},$itm,$acctno);
1595                 $usth->finish;
1596         #check if any credit is left if so writeoff other accounts
1597                 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1598                 if ($amountleft < 0){
1599                 $amountleft*=-1;
1600                 }
1601                 if ($amountleft > 0){
1602                 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1603                                                         AND (amountoutstanding >0) ORDER BY date");
1604                 $msth->execute($data->{'borrowernumber'});
1605         # offset transactions
1606                 my $newamtos;
1607                 my $accdata;
1608                 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1609                         if ($accdata->{'amountoutstanding'} < $amountleft) {
1610                         $newamtos = 0;
1611                         $amountleft -= $accdata->{'amountoutstanding'};
1612                         }  else {
1613                         $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1614                         $amountleft = 0;
1615                         }
1616                         my $thisacct = $accdata->{'accountno'};
1617                         my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1618                                         WHERE (borrowernumber = ?)
1619                                         AND (accountno=?)");
1620                         $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');
1621                         $usth->finish;
1622                         $usth = $dbh->prepare("INSERT INTO accountoffsets
1623                                 (borrowernumber, accountno, offsetaccount,  offsetamount)
1624                                 VALUES
1625                                 (?,?,?,?)");
1626                         $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1627                         $usth->finish;
1628                 }
1629                 $msth->finish;
1630                 }
1631                 if ($amountleft > 0){
1632                         $amountleft*=-1;
1633                 }
1634                 my $desc="Item Returned ".$iteminfo->{'barcode'};
1635                 $usth = $dbh->prepare("INSERT INTO accountlines
1636                         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1637                         VALUES (?,?,now(),?,?,'CR',?)");
1638                 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1639                 $usth->finish;
1640                 $usth = $dbh->prepare("INSERT INTO accountoffsets
1641                         (borrowernumber, accountno, offsetaccount,  offsetamount)
1642                         VALUES (?,?,?,?)");
1643                 $usth->execute($borrower->{'borrowernumber'},$data->{'accountno'},$nextaccntno,$offset);
1644                 $usth->finish;
1645         ModItem({ paidfor => '' }, undef, $itm);
1646         }
1647         $sth->finish;
1648         return;
1649 }
1650
1651 =head2 GetItemIssue
1652
1653 $issues = &GetItemIssue($itemnumber);
1654
1655 Returns patrons currently having a book. nothing if item is not issued atm
1656
1657 C<$itemnumber> is the itemnumber
1658
1659 Returns an array of hashes
1660
1661 =cut
1662
1663 sub GetItemIssue {
1664     my ( $itemnumber) = @_;
1665     return unless $itemnumber;
1666     my $dbh = C4::Context->dbh;
1667     my @GetItemIssues;
1668
1669     # get today date
1670     my $today = POSIX::strftime("%Y%m%d", localtime);
1671
1672     my $sth = $dbh->prepare(
1673         "SELECT * FROM issues
1674         LEFT JOIN items ON issues.itemnumber=items.itemnumber
1675     WHERE
1676     issues.itemnumber=?");
1677     $sth->execute($itemnumber);
1678     my $data = $sth->fetchrow_hashref;
1679     my $datedue = $data->{'date_due'};
1680     $datedue =~ s/-//g;
1681     if ( $datedue < $today ) {
1682         $data->{'overdue'} = 1;
1683     }
1684     $data->{'itemnumber'} = $itemnumber; # fill itemnumber, in case item is not on issue
1685     $sth->finish;
1686     return ($data);
1687 }
1688
1689 =head2 GetItemIssues
1690
1691 $issues = &GetItemIssues($itemnumber, $history);
1692
1693 Returns patrons that have issued a book
1694
1695 C<$itemnumber> is the itemnumber
1696 C<$history> is 0 if you want actuel "issuer" (if it exist) and 1 if you want issues history
1697
1698 Returns an array of hashes
1699
1700 =cut
1701
1702 sub GetItemIssues {
1703     my ( $itemnumber,$history ) = @_;
1704     my $dbh = C4::Context->dbh;
1705     my @GetItemIssues;
1706
1707     # get today date
1708     my $today = POSIX::strftime("%Y%m%d", localtime);
1709
1710     my $sql = "SELECT * FROM issues
1711               JOIN borrowers USING (borrowernumber)
1712               JOIN items USING (itemnumber)
1713               WHERE issues.itemnumber = ? ";
1714     if ($history) {
1715         $sql .= "UNION ALL
1716                  SELECT * FROM old_issues
1717                  LEFT JOIN borrowers USING (borrowernumber)
1718                  JOIN items USING (itemnumber)
1719                  WHERE old_issues.itemnumber = ? ";
1720     }
1721     $sql .= "ORDER BY date_due DESC";
1722     my $sth = $dbh->prepare($sql);
1723     if ($history) {
1724         $sth->execute($itemnumber, $itemnumber);
1725     } else {
1726         $sth->execute($itemnumber);
1727     }
1728     while ( my $data = $sth->fetchrow_hashref ) {
1729         my $datedue = $data->{'date_due'};
1730         $datedue =~ s/-//g;
1731         if ( $datedue < $today ) {
1732             $data->{'overdue'} = 1;
1733         }
1734         my $itemnumber = $data->{'itemnumber'};
1735         push @GetItemIssues, $data;
1736     }
1737     $sth->finish;
1738     return ( \@GetItemIssues );
1739 }
1740
1741 =head2 GetBiblioIssues
1742
1743 $issues = GetBiblioIssues($biblionumber);
1744
1745 this function get all issues from a biblionumber.
1746
1747 Return:
1748 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1749 tables issues and the firstname,surname & cardnumber from borrowers.
1750
1751 =cut
1752
1753 sub GetBiblioIssues {
1754     my $biblionumber = shift;
1755     return undef unless $biblionumber;
1756     my $dbh   = C4::Context->dbh;
1757     my $query = "
1758         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1759         FROM issues
1760             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1761             LEFT JOIN items ON issues.itemnumber = items.itemnumber
1762             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1763             LEFT JOIN biblio ON biblio.biblionumber = items.biblioitemnumber
1764         WHERE biblio.biblionumber = ?
1765         UNION ALL
1766         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1767         FROM old_issues
1768             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1769             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1770             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1771             LEFT JOIN biblio ON biblio.biblionumber = items.biblioitemnumber
1772         WHERE biblio.biblionumber = ?
1773         ORDER BY timestamp
1774     ";
1775     my $sth = $dbh->prepare($query);
1776     $sth->execute($biblionumber, $biblionumber);
1777
1778     my @issues;
1779     while ( my $data = $sth->fetchrow_hashref ) {
1780         push @issues, $data;
1781     }
1782     return \@issues;
1783 }
1784
1785 =head2 CanBookBeRenewed
1786
1787 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber);
1788
1789 Find out whether a borrowed item may be renewed.
1790
1791 C<$dbh> is a DBI handle to the Koha database.
1792
1793 C<$borrowernumber> is the borrower number of the patron who currently
1794 has the item on loan.
1795
1796 C<$itemnumber> is the number of the item to renew.
1797
1798 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
1799 item must currently be on loan to the specified borrower; renewals
1800 must be allowed for the item's type; and the borrower must not have
1801 already renewed the loan. $error will contain the reason the renewal can not proceed
1802
1803 =cut
1804
1805 sub CanBookBeRenewed {
1806
1807     # check renewal status
1808     my ( $borrowernumber, $itemnumber ) = @_;
1809     my $dbh       = C4::Context->dbh;
1810     my $renews    = 1;
1811     my $renewokay = 0;
1812         my $error;
1813
1814     # Look in the issues table for this item, lent to this borrower,
1815     # and not yet returned.
1816
1817     # FIXME - I think this function could be redone to use only one SQL call.
1818     my $sth1 = $dbh->prepare(
1819         "SELECT * FROM issues
1820             WHERE borrowernumber = ?
1821             AND itemnumber = ?"
1822     );
1823     $sth1->execute( $borrowernumber, $itemnumber );
1824     if ( my $data1 = $sth1->fetchrow_hashref ) {
1825
1826         # Found a matching item
1827
1828         # See if this item may be renewed. This query is convoluted
1829         # because it's a bit messy: given the item number, we need to find
1830         # the biblioitem, which gives us the itemtype, which tells us
1831         # whether it may be renewed.
1832         my $query = "SELECT renewalsallowed FROM items ";
1833         $query .= (C4::Context->preference('item-level_itypes'))
1834                     ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
1835                     : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
1836                        LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
1837         $query .= "WHERE items.itemnumber = ?";
1838         my $sth2 = $dbh->prepare($query);
1839         $sth2->execute($itemnumber);
1840         if ( my $data2 = $sth2->fetchrow_hashref ) {
1841             $renews = $data2->{'renewalsallowed'};
1842         }
1843         if ( $renews && $renews > $data1->{'renewals'} ) {
1844             $renewokay = 1;
1845         }
1846         else {
1847                         $error="too_many";
1848                 }
1849         $sth2->finish;
1850         my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
1851         if ($resfound) {
1852             $renewokay = 0;
1853                         $error="on_reserve"
1854         }
1855
1856     }
1857     $sth1->finish;
1858     return ($renewokay,$error);
1859 }
1860
1861 =head2 AddRenewal
1862
1863 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue]);
1864
1865 Renews a loan.
1866
1867 C<$borrowernumber> is the borrower number of the patron who currently
1868 has the item.
1869
1870 C<$itemnumber> is the number of the item to renew.
1871
1872 C<$branch> is the library branch.  Defaults to the homebranch of the ITEM.
1873
1874 C<$datedue> can be a C4::Dates object used to set the due date.
1875
1876 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
1877 from the book's item type.
1878
1879 =cut
1880
1881 sub AddRenewal {
1882         my $borrowernumber = shift or return undef;
1883         my     $itemnumber = shift or return undef;
1884     my $item   = GetItem($itemnumber) or return undef;
1885     my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
1886     my $branch  = (@_) ? shift : $item->{homebranch};   # opac-renew doesn't send branch
1887     my $datedue;
1888     # If the due date wasn't specified, calculate it by adding the
1889     # book's loan length to today's date.
1890     unless (@_ and $datedue = shift and $datedue->output('iso')) {
1891
1892         my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
1893         my $loanlength = GetLoanLength(
1894             $borrower->{'categorycode'},
1895              (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
1896                         $item->{homebranch}                     # item's homebranch determines loanlength OR do we want the branch specified by the AddRenewal argument?
1897         );
1898                 #FIXME -- use circControl?
1899                 $datedue =  CalcDateDue(C4::Dates->new(),$loanlength,$branch);  # this branch is the transactional branch.
1900                                                                 # The question of whether to use item's homebranch calendar is open.
1901     }
1902
1903     my $dbh = C4::Context->dbh;
1904     # Find the issues record for this book
1905     my $sth =
1906       $dbh->prepare("SELECT * FROM issues
1907                         WHERE borrowernumber=?
1908                         AND itemnumber=?"
1909       );
1910     $sth->execute( $borrowernumber, $itemnumber );
1911     my $issuedata = $sth->fetchrow_hashref;
1912     $sth->finish;
1913
1914     # Update the issues record to have the new due date, and a new count
1915     # of how many times it has been renewed.
1916     my $renews = $issuedata->{'renewals'} + 1;
1917     $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?
1918                             WHERE borrowernumber=?
1919                             AND itemnumber=?"
1920     );
1921     $sth->execute( $datedue->output('iso'), $renews, $borrowernumber, $itemnumber );
1922     $sth->finish;
1923
1924     # Update the renewal count on the item, and tell zebra to reindex
1925     $renews = $biblio->{'renewals'} + 1;
1926     ModItem({ renewals => $renews }, $biblio->{'biblionumber'}, $itemnumber);
1927
1928     # Charge a new rental fee, if applicable?
1929     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
1930     if ( $charge > 0 ) {
1931         my $accountno = getnextacctno( $borrowernumber );
1932         my $item = GetBiblioFromItemNumber($itemnumber);
1933         $sth = $dbh->prepare(
1934                 "INSERT INTO accountlines
1935                     (date,
1936                                         borrowernumber, accountno, amount,
1937                     description,
1938                                         accounttype, amountoutstanding, itemnumber
1939                                         )
1940                     VALUES (now(),?,?,?,?,?,?,?)"
1941         );
1942         $sth->execute( $borrowernumber, $accountno, $charge,
1943             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
1944             'Rent', $charge, $itemnumber );
1945         $sth->finish;
1946     }
1947     # Log the renewal
1948     UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
1949 }
1950
1951 sub GetRenewCount {
1952     # check renewal status
1953     my ($bornum,$itemno)=@_;
1954     my $dbh = C4::Context->dbh;
1955     my $renewcount = 0;
1956         my $renewsallowed = 0;
1957         my $renewsleft = 0;
1958     # Look in the issues table for this item, lent to this borrower,
1959     # and not yet returned.
1960
1961     # FIXME - I think this function could be redone to use only one SQL call.
1962     my $sth = $dbh->prepare("select * from issues
1963                                 where (borrowernumber = ?)
1964                                 and (itemnumber = ?)");
1965     $sth->execute($bornum,$itemno);
1966     my $data = $sth->fetchrow_hashref;
1967     $renewcount = $data->{'renewals'} if $data->{'renewals'};
1968     $sth->finish;
1969     my $query = "SELECT renewalsallowed FROM items ";
1970     $query .= (C4::Context->preference('item-level_itypes'))
1971                 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
1972                 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
1973                    LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
1974     $query .= "WHERE items.itemnumber = ?";
1975     my $sth2 = $dbh->prepare($query);
1976     $sth2->execute($itemno);
1977     my $data2 = $sth2->fetchrow_hashref();
1978     $renewsallowed = $data2->{'renewalsallowed'};
1979     $renewsleft = $renewsallowed - $renewcount;
1980     return ($renewcount,$renewsallowed,$renewsleft);
1981 }
1982
1983 =head2 GetIssuingCharges
1984
1985 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
1986
1987 Calculate how much it would cost for a given patron to borrow a given
1988 item, including any applicable discounts.
1989
1990 C<$itemnumber> is the item number of item the patron wishes to borrow.
1991
1992 C<$borrowernumber> is the patron's borrower number.
1993
1994 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
1995 and C<$item_type> is the code for the item's item type (e.g., C<VID>
1996 if it's a video).
1997
1998 =cut
1999
2000 sub GetIssuingCharges {
2001
2002     # calculate charges due
2003     my ( $itemnumber, $borrowernumber ) = @_;
2004     my $charge = 0;
2005     my $dbh    = C4::Context->dbh;
2006     my $item_type;
2007
2008     # Get the book's item type and rental charge (via its biblioitem).
2009     my $qcharge =     "SELECT itemtypes.itemtype,rentalcharge FROM items
2010             LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2011         $qcharge .= (C4::Context->preference('item-level_itypes'))
2012                 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2013                 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2014
2015     $qcharge .=      "WHERE items.itemnumber =?";
2016
2017     my $sth1 = $dbh->prepare($qcharge);
2018     $sth1->execute($itemnumber);
2019     if ( my $data1 = $sth1->fetchrow_hashref ) {
2020         $item_type = $data1->{'itemtype'};
2021         $charge    = $data1->{'rentalcharge'};
2022         my $q2 = "SELECT rentaldiscount FROM borrowers
2023             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2024             WHERE borrowers.borrowernumber = ?
2025             AND issuingrules.itemtype = ?";
2026         my $sth2 = $dbh->prepare($q2);
2027         $sth2->execute( $borrowernumber, $item_type );
2028         if ( my $data2 = $sth2->fetchrow_hashref ) {
2029             my $discount = $data2->{'rentaldiscount'};
2030             if ( $discount eq 'NULL' ) {
2031                 $discount = 0;
2032             }
2033             $charge = ( $charge * ( 100 - $discount ) ) / 100;
2034         }
2035         $sth2->finish;
2036     }
2037
2038     $sth1->finish;
2039     return ( $charge, $item_type );
2040 }
2041
2042 =head2 AddIssuingCharge
2043
2044 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2045
2046 =cut
2047
2048 sub AddIssuingCharge {
2049     my ( $itemnumber, $borrowernumber, $charge ) = @_;
2050     my $dbh = C4::Context->dbh;
2051     my $nextaccntno = getnextacctno( $borrowernumber );
2052     my $query ="
2053         INSERT INTO accountlines
2054             (borrowernumber, itemnumber, accountno,
2055             date, amount, description, accounttype,
2056             amountoutstanding)
2057         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2058     ";
2059     my $sth = $dbh->prepare($query);
2060     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2061     $sth->finish;
2062 }
2063
2064 =head2 GetTransfers
2065
2066 GetTransfers($itemnumber);
2067
2068 =cut
2069
2070 sub GetTransfers {
2071     my ($itemnumber) = @_;
2072
2073     my $dbh = C4::Context->dbh;
2074
2075     my $query = '
2076         SELECT datesent,
2077                frombranch,
2078                tobranch
2079         FROM branchtransfers
2080         WHERE itemnumber = ?
2081           AND datearrived IS NULL
2082         ';
2083     my $sth = $dbh->prepare($query);
2084     $sth->execute($itemnumber);
2085     my @row = $sth->fetchrow_array();
2086     $sth->finish;
2087     return @row;
2088 }
2089
2090
2091 =head2 GetTransfersFromTo
2092
2093 @results = GetTransfersFromTo($frombranch,$tobranch);
2094
2095 Returns the list of pending transfers between $from and $to branch
2096
2097 =cut
2098
2099 sub GetTransfersFromTo {
2100     my ( $frombranch, $tobranch ) = @_;
2101     return unless ( $frombranch && $tobranch );
2102     my $dbh   = C4::Context->dbh;
2103     my $query = "
2104         SELECT itemnumber,datesent,frombranch
2105         FROM   branchtransfers
2106         WHERE  frombranch=?
2107           AND  tobranch=?
2108           AND datearrived IS NULL
2109     ";
2110     my $sth = $dbh->prepare($query);
2111     $sth->execute( $frombranch, $tobranch );
2112     my @gettransfers;
2113
2114     while ( my $data = $sth->fetchrow_hashref ) {
2115         push @gettransfers, $data;
2116     }
2117     $sth->finish;
2118     return (@gettransfers);
2119 }
2120
2121 =head2 DeleteTransfer
2122
2123 &DeleteTransfer($itemnumber);
2124
2125 =cut
2126
2127 sub DeleteTransfer {
2128     my ($itemnumber) = @_;
2129     my $dbh          = C4::Context->dbh;
2130     my $sth          = $dbh->prepare(
2131         "DELETE FROM branchtransfers
2132          WHERE itemnumber=?
2133          AND datearrived IS NULL "
2134     );
2135     $sth->execute($itemnumber);
2136     $sth->finish;
2137 }
2138
2139 =head2 AnonymiseIssueHistory
2140
2141 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2142
2143 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2144 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2145
2146 return the number of affected rows.
2147
2148 =cut
2149
2150 sub AnonymiseIssueHistory {
2151     my $date           = shift;
2152     my $borrowernumber = shift;
2153     my $dbh            = C4::Context->dbh;
2154     my $query          = "
2155         UPDATE old_issues
2156         SET    borrowernumber = NULL
2157         WHERE  returndate < '".$date."'
2158           AND borrowernumber IS NOT NULL
2159     ";
2160     $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2161     my $rows_affected = $dbh->do($query);
2162     return $rows_affected;
2163 }
2164
2165 =head2 updateWrongTransfer
2166
2167 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2168
2169 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
2170
2171 =cut
2172
2173 sub updateWrongTransfer {
2174         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2175         my $dbh = C4::Context->dbh;
2176 # first step validate the actual line of transfert .
2177         my $sth =
2178                 $dbh->prepare(
2179                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2180                 );
2181                 $sth->execute($FromLibrary,$itemNumber);
2182                 $sth->finish;
2183
2184 # second step create a new line of branchtransfer to the right location .
2185         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2186
2187 #third step changing holdingbranch of item
2188         UpdateHoldingbranch($FromLibrary,$itemNumber);
2189 }
2190
2191 =head2 UpdateHoldingbranch
2192
2193 $items = UpdateHoldingbranch($branch,$itmenumber);
2194 Simple methode for updating hodlingbranch in items BDD line
2195
2196 =cut
2197
2198 sub UpdateHoldingbranch {
2199         my ( $branch,$itemnumber ) = @_;
2200     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2201 }
2202
2203 =head2 CalcDateDue
2204
2205 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2206 this function calculates the due date given the loan length ,
2207 checking against the holidays calendar as per the 'useDaysMode' syspref.
2208 C<$startdate>   = C4::Dates object representing start date of loan period (assumed to be today)
2209 C<$branch>  = location whose calendar to use
2210 C<$loanlength>  = loan length prior to adjustment
2211 =cut
2212
2213 sub CalcDateDue {
2214         my ($startdate,$loanlength,$branch) = @_;
2215         if(C4::Context->preference('useDaysMode') eq 'Days') {  # ignoring calendar
2216                 my $datedue = time + ($loanlength) * 86400;
2217         #FIXME - assumes now even though we take a startdate
2218                 my @datearr  = localtime($datedue);
2219                 return C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2220         } else {
2221                 my $calendar = C4::Calendar->new(  branchcode => $branch );
2222                 my $datedue = $calendar->addDate($startdate, $loanlength);
2223                 return $datedue;
2224         }
2225 }
2226
2227 =head2 CheckValidDatedue
2228        This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2229        To be replaced by CalcDateDue() once C4::Calendar use is tested.
2230
2231 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2232 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2233 C<$date_due>   = returndate calculate with no day check
2234 C<$itemnumber>  = itemnumber
2235 C<$branchcode>  = location of issue (affected by 'CircControl' syspref)
2236 C<$loanlength>  = loan length prior to adjustment
2237 =cut
2238
2239 sub CheckValidDatedue {
2240 my ($date_due,$itemnumber,$branchcode)=@_;
2241 my @datedue=split('-',$date_due->output('iso'));
2242 my $years=$datedue[0];
2243 my $month=$datedue[1];
2244 my $day=$datedue[2];
2245 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2246 my $dow;
2247 for (my $i=0;$i<2;$i++){
2248     $dow=Day_of_Week($years,$month,$day);
2249     ($dow=0) if ($dow>6);
2250     my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2251     my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2252     my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2253         if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2254         $i=0;
2255         (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2256         }
2257     }
2258     my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2259 return $newdatedue;
2260 }
2261
2262
2263 =head2 CheckRepeatableHolidays
2264
2265 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2266 this function checks if the date due is a repeatable holiday
2267 C<$date_due>   = returndate calculate with no day check
2268 C<$itemnumber>  = itemnumber
2269 C<$branchcode>  = localisation of issue
2270
2271 =cut
2272
2273 sub CheckRepeatableHolidays{
2274 my($itemnumber,$week_day,$branchcode)=@_;
2275 my $dbh = C4::Context->dbh;
2276 my $query = qq|SELECT count(*)
2277         FROM repeatable_holidays
2278         WHERE branchcode=?
2279         AND weekday=?|;
2280 my $sth = $dbh->prepare($query);
2281 $sth->execute($branchcode,$week_day);
2282 my $result=$sth->fetchrow;
2283 $sth->finish;
2284 return $result;
2285 }
2286
2287
2288 =head2 CheckSpecialHolidays
2289
2290 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2291 this function check if the date is a special holiday
2292 C<$years>   = the years of datedue
2293 C<$month>   = the month of datedue
2294 C<$day>     = the day of datedue
2295 C<$itemnumber>  = itemnumber
2296 C<$branchcode>  = localisation of issue
2297
2298 =cut
2299
2300 sub CheckSpecialHolidays{
2301 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2302 my $dbh = C4::Context->dbh;
2303 my $query=qq|SELECT count(*)
2304              FROM `special_holidays`
2305              WHERE year=?
2306              AND month=?
2307              AND day=?
2308              AND branchcode=?
2309             |;
2310 my $sth = $dbh->prepare($query);
2311 $sth->execute($years,$month,$day,$branchcode);
2312 my $countspecial=$sth->fetchrow ;
2313 $sth->finish;
2314 return $countspecial;
2315 }
2316
2317 =head2 CheckRepeatableSpecialHolidays
2318
2319 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2320 this function check if the date is a repeatble special holidays
2321 C<$month>   = the month of datedue
2322 C<$day>     = the day of datedue
2323 C<$itemnumber>  = itemnumber
2324 C<$branchcode>  = localisation of issue
2325
2326 =cut
2327
2328 sub CheckRepeatableSpecialHolidays{
2329 my ($month,$day,$itemnumber,$branchcode) = @_;
2330 my $dbh = C4::Context->dbh;
2331 my $query=qq|SELECT count(*)
2332              FROM `repeatable_holidays`
2333              WHERE month=?
2334              AND day=?
2335              AND branchcode=?
2336             |;
2337 my $sth = $dbh->prepare($query);
2338 $sth->execute($month,$day,$branchcode);
2339 my $countspecial=$sth->fetchrow ;
2340 $sth->finish;
2341 return $countspecial;
2342 }
2343
2344
2345
2346 sub CheckValidBarcode{
2347 my ($barcode) = @_;
2348 my $dbh = C4::Context->dbh;
2349 my $query=qq|SELECT count(*)
2350              FROM items
2351              WHERE barcode=?
2352             |;
2353 my $sth = $dbh->prepare($query);
2354 $sth->execute($barcode);
2355 my $exist=$sth->fetchrow ;
2356 $sth->finish;
2357 return $exist;
2358 }
2359
2360 1;
2361
2362 __END__
2363
2364 =head1 AUTHOR
2365
2366 Koha Developement team <info@koha.org>
2367
2368 =cut
2369