C4/Circulation.pm

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