C4/Circulation.pm

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