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     #
 744     # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
 745     #
 746         my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
 747     # if TooMany return / 0, then the user has no permission to check out this book
 748     if ($toomany =~ /\/ 0/) {
 749         $needsconfirmation{PATRON_CANT} = 1;
 750     } else {
 751         $needsconfirmation{TOO_MANY} = $toomany if $toomany;
 752     }
 753
 754     #
 755     # ITEM CHECKING
 756     #
 757     if (   $item->{'notforloan'}
 758         && $item->{'notforloan'} > 0 )
 759     {
 760         if(!C4::Context->preference("AllowNotForLoanOverride")){
 761             $issuingimpossible{NOT_FOR_LOAN} = 1;
 762         }else{
 763             $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 764         }
 765     }
 766     elsif ( !$item->{'notforloan'} ){
 767         # we have to check itemtypes.notforloan also
 768         if (C4::Context->preference('item-level_itypes')){
 769             # this should probably be a subroutine
 770             my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
 771             $sth->execute($item->{'itemtype'});
 772             my $notforloan=$sth->fetchrow_hashref();
 773             $sth->finish();
 774             if ($notforloan->{'notforloan'}) {
 775                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
 776                     $issuingimpossible{NOT_FOR_LOAN} = 1;
 777                 } else {
 778                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 779                 }
 780             }
 781         }
 782         elsif ($biblioitem->{'notforloan'} == 1){
 783             if (!C4::Context->preference("AllowNotForLoanOverride")) {
 784                 $issuingimpossible{NOT_FOR_LOAN} = 1;
 785             } else {
 786                 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 787             }
 788         }
 789     }
 790     if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
 791     {
 792         $issuingimpossible{WTHDRAWN} = 1;
 793     }
 794     if (   $item->{'restricted'}
 795         && $item->{'restricted'} == 1 )
 796     {
 797         $issuingimpossible{RESTRICTED} = 1;
 798     }
 799     if ( C4::Context->preference("IndependantBranches") ) {
 800         my $userenv = C4::Context->userenv;
 801         if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
 802             $issuingimpossible{NOTSAMEBRANCH} = 1
 803               if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
 804         }
 805     }
 806
 807     #
 808     # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
 809     #
 810     if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
 811     {
 812
 813         # Already issued to current borrower. Ask whether the loan should
 814         # be renewed.
 815         my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
 816             $borrower->{'borrowernumber'},
 817             $item->{'itemnumber'}
 818         );
 819         if ( $CanBookBeRenewed == 0 ) {    # no more renewals allowed
 820             $issuingimpossible{NO_MORE_RENEWALS} = 1;
 821         }
 822         else {
 823             $needsconfirmation{RENEW_ISSUE} = 1;
 824         }
 825     }
 826     elsif ($issue->{borrowernumber}) {
 827
 828         # issued to someone else
 829         my $currborinfo =    C4::Members::GetMemberDetails( $issue->{borrowernumber} );
 830
 831 #        warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
 832         $needsconfirmation{ISSUED_TO_ANOTHER} =
 833 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
 834     }
 835
 836     # See if the item is on reserve.
 837     my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
 838     if ($restype) {
 839                 my $resbor = $res->{'borrowernumber'};
 840                 my ( $resborrower ) = C4::Members::GetMemberDetails( $resbor, 0 );
 841                 my $branches  = GetBranches();
 842                 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
 843         if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
 844         {
 845             # The item is on reserve and waiting, but has been
 846             # reserved by some other patron.
 847             $needsconfirmation{RESERVE_WAITING} =
 848 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
 849         }
 850         elsif ( $restype eq "Reserved" ) {
 851             # The item is on reserve for someone else.
 852             $needsconfirmation{RESERVED} =
 853 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
 854         }
 855     }
 856         return ( \%issuingimpossible, \%needsconfirmation );
 857 }
 858
 859 =head2 AddIssue
 860
 861 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
 862
 863 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
 864
 865 =over 4
 866
 867 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
 868
 869 =item C<$barcode> is the barcode of the item being issued.
 870
 871 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
 872 Calculated if empty.
 873
 874 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
 875
 876 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
 877 Defaults to today.  Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
 878
 879 AddIssue does the following things :
 880
 881   - step 01: check that there is a borrowernumber & a barcode provided
 882   - check for RENEWAL (book issued & being issued to the same patron)
 883       - renewal YES = Calculate Charge & renew
 884       - renewal NO  =
 885           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
 886           * RESERVE PLACED ?
 887               - fill reserve if reserve to this patron
 888               - cancel reserve or not, otherwise
 889           * TRANSFERT PENDING ?
 890               - complete the transfert
 891           * ISSUE THE BOOK
 892
 893 =back
 894
 895 =cut
 896
 897 sub AddIssue {
 898     my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
 899     my $dbh = C4::Context->dbh;
 900         my $barcodecheck=CheckValidBarcode($barcode);
 901
 902     # $issuedate defaults to today.
 903     if ( ! defined $issuedate ) {
 904         $issuedate = strftime( "%Y-%m-%d", localtime );
 905         # TODO: for hourly circ, this will need to be a C4::Dates object
 906         # and all calls to AddIssue including issuedate will need to pass a Dates object.
 907     }
 908         if ($borrower and $barcode and $barcodecheck ne '0'){
 909                 # find which item we issue
 910                 my $item = GetItem('', $barcode) or return undef;       # if we don't get an Item, abort.
 911                 my $branch = (C4::Context->preference('CircControl') eq 'PickupLibrary') ? C4::Context->userenv->{'branch'} :
 912                      (C4::Context->preference('CircControl') eq 'PatronLibrary') ? $borrower->{'branchcode'}        :
 913                      $item->{'homebranch'};     # fallback to item's homebranch
 914
 915                 # get actual issuing if there is one
 916                 my $actualissue = GetItemIssue( $item->{itemnumber});
 917
 918                 # get biblioinformation for this item
 919                 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
 920
 921                 #
 922                 # check if we just renew the issue.
 923                 #
 924                 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
 925                         $datedue = AddRenewal(
 926                                 $borrower->{'borrowernumber'},
 927                                 $item->{'itemnumber'},
 928                                 $branch,
 929                                 $datedue,
 930                 $issuedate, # here interpreted as the renewal date
 931                         );
 932                 }
 933                 else {
 934         # it's NOT a renewal
 935                         if ( $actualissue->{borrowernumber}) {
 936                                 # This book is currently on loan, but not to the person
 937                                 # who wants to borrow it now. mark it returned before issuing to the new borrower
 938                                 AddReturn(
 939                                         $item->{'barcode'},
 940                                         C4::Context->userenv->{'branch'}
 941                                 );
 942                         }
 943
 944                         # See if the item is on reserve.
 945                         my ( $restype, $res ) =
 946                           C4::Reserves::CheckReserves( $item->{'itemnumber'} );
 947                         if ($restype) {
 948                                 my $resbor = $res->{'borrowernumber'};
 949                                 if ( $resbor eq $borrower->{'borrowernumber'} ) {
 950                                         # The item is reserved by the current patron
 951                                         ModReserveFill($res);
 952                                 }
 953                                 elsif ( $restype eq "Waiting" ) {
 954                                         # warn "Waiting";
 955                                         # The item is on reserve and waiting, but has been
 956                                         # reserved by some other patron.
 957                                 }
 958                                 elsif ( $restype eq "Reserved" ) {
 959                                         # warn "Reserved";
 960                                         # The item is reserved by someone else.
 961                                         if ($cancelreserve) { # cancel reserves on this item
 962                                                 CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
 963                                         }
 964                                 }
 965                                 if ($cancelreserve) {
 966                                         CancelReserve($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
 967                                 }
 968                                 else {
 969                                         # set waiting reserve to first in reserve queue as book isn't waiting now
 970                                         ModReserve(1,
 971                                                 $res->{'biblionumber'},
 972                                                 $res->{'borrowernumber'},
 973                                                 $res->{'branchcode'}
 974                                         );
 975                                 }
 976                         }
 977
 978                         # Starting process for transfer job (checking transfert and validate it if we have one)
 979             my ($datesent) = GetTransfers($item->{'itemnumber'});
 980             if ($datesent) {
 981         #       updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
 982                 my $sth =
 983                     $dbh->prepare(
 984                     "UPDATE branchtransfers
 985                         SET datearrived = now(),
 986                         tobranch = ?,
 987                         comments = 'Forced branchtransfer'
 988                     WHERE itemnumber= ? AND datearrived IS NULL"
 989                     );
 990                 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
 991             }
 992
 993         # Record in the database the fact that the book was issued.
 994         my $sth =
 995           $dbh->prepare(
 996                 "INSERT INTO issues
 997                     (borrowernumber, itemnumber,issuedate, date_due, branchcode)
 998                 VALUES (?,?,?,?,?)"
 999           );
1000         unless ($datedue) {
1001             my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1002             my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
1003             $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
1004
1005         }
1006         $sth->execute(
1007             $borrower->{'borrowernumber'},      # borrowernumber
1008             $item->{'itemnumber'},              # itemnumber
1009             $issuedate,                         # issuedate
1010             $datedue->output('iso'),            # date_due
1011             C4::Context->userenv->{'branch'}    # branchcode
1012         );
1013         $sth->finish;
1014         $item->{'issues'}++;
1015         ModItem({ issues           => $item->{'issues'},
1016                   holdingbranch    => C4::Context->userenv->{'branch'},
1017                   itemlost         => 0,
1018                   datelastborrowed => C4::Dates->new()->output('iso'),
1019                   onloan           => $datedue->output('iso'),
1020                 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1021         ModDateLastSeen( $item->{'itemnumber'} );
1022
1023         # If it costs to borrow this book, charge it to the patron's account.
1024         my ( $charge, $itemtype ) = GetIssuingCharges(
1025             $item->{'itemnumber'},
1026             $borrower->{'borrowernumber'}
1027         );
1028         if ( $charge > 0 ) {
1029             AddIssuingCharge(
1030                 $item->{'itemnumber'},
1031                 $borrower->{'borrowernumber'}, $charge
1032             );
1033             $item->{'charge'} = $charge;
1034         }
1035
1036         # Record the fact that this book was issued.
1037         &UpdateStats(
1038             C4::Context->userenv->{'branch'},
1039             'issue', $charge,
1040             ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1041             $item->{'itype'}, $borrower->{'borrowernumber'}
1042         );
1043
1044         # Send a checkout slip.
1045         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1046         my %conditions = (
1047             branchcode   => $branch,
1048             categorycode => $borrower->{categorycode},
1049             item_type    => $item->{itype},
1050             notification => 'CHECKOUT',
1051         );
1052         if ($circulation_alert->is_enabled_for(\%conditions)) {
1053             SendCirculationAlert({
1054                 type     => 'CHECKOUT',
1055                 item     => $item,
1056                 borrower => $borrower,
1057                 branch   => $branch,
1058             });
1059         }
1060     }
1061
1062     logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1063         if C4::Context->preference("IssueLog");
1064   }
1065   return ($datedue);    # not necessarily the same as when it came in!
1066 }
1067
1068 =head2 GetLoanLength
1069
1070 Get loan length for an itemtype, a borrower type and a branch
1071
1072 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1073
1074 =cut
1075
1076 sub GetLoanLength {
1077     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1078     my $dbh = C4::Context->dbh;
1079     my $sth =
1080       $dbh->prepare(
1081 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1082       );
1083 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1084 # try to find issuelength & return the 1st available.
1085 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1086     $sth->execute( $borrowertype, $itemtype, $branchcode );
1087     my $loanlength = $sth->fetchrow_hashref;
1088     return $loanlength->{issuelength}
1089       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1090
1091     $sth->execute( $borrowertype, "*", $branchcode );
1092     $loanlength = $sth->fetchrow_hashref;
1093     return $loanlength->{issuelength}
1094       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1095
1096     $sth->execute( "*", $itemtype, $branchcode );
1097     $loanlength = $sth->fetchrow_hashref;
1098     return $loanlength->{issuelength}
1099       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1100
1101     $sth->execute( "*", "*", $branchcode );
1102     $loanlength = $sth->fetchrow_hashref;
1103     return $loanlength->{issuelength}
1104       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1105
1106     $sth->execute( $borrowertype, $itemtype, "*" );
1107     $loanlength = $sth->fetchrow_hashref;
1108     return $loanlength->{issuelength}
1109       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1110
1111     $sth->execute( $borrowertype, "*", "*" );
1112     $loanlength = $sth->fetchrow_hashref;
1113     return $loanlength->{issuelength}
1114       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1115
1116     $sth->execute( "*", $itemtype, "*" );
1117     $loanlength = $sth->fetchrow_hashref;
1118     return $loanlength->{issuelength}
1119       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1120
1121     $sth->execute( "*", "*", "*" );
1122     $loanlength = $sth->fetchrow_hashref;
1123     return $loanlength->{issuelength}
1124       if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1125
1126     # if no rule is set => 21 days (hardcoded)
1127     return 21;
1128 }
1129
1130 =head2 GetIssuingRule
1131
1132 FIXME - This is a copy-paste of GetLoanLength
1133 as a stop-gap.  Do not wish to change API for GetLoanLength
1134 this close to release, however, Overdues::GetIssuingRules is broken.
1135
1136 Get the issuing rule for an itemtype, a borrower type and a branch
1137 Returns a hashref from the issuingrules table.
1138
1139 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1140
1141 =cut
1142
1143 sub GetIssuingRule {
1144     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1145     my $dbh = C4::Context->dbh;
1146     my $sth =  $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"  );
1147     my $irule;
1148
1149         $sth->execute( $borrowertype, $itemtype, $branchcode );
1150     $irule = $sth->fetchrow_hashref;
1151     return $irule if defined($irule) ;
1152
1153     $sth->execute( $borrowertype, "*", $branchcode );
1154     $irule = $sth->fetchrow_hashref;
1155     return $irule if defined($irule) ;
1156
1157     $sth->execute( "*", $itemtype, $branchcode );
1158     $irule = $sth->fetchrow_hashref;
1159     return $irule if defined($irule) ;
1160
1161     $sth->execute( "*", "*", $branchcode );
1162     $irule = $sth->fetchrow_hashref;
1163     return $irule if defined($irule) ;
1164
1165     $sth->execute( $borrowertype, $itemtype, "*" );
1166     $irule = $sth->fetchrow_hashref;
1167     return $irule if defined($irule) ;
1168
1169     $sth->execute( $borrowertype, "*", "*" );
1170     $irule = $sth->fetchrow_hashref;
1171     return $irule if defined($irule) ;
1172
1173     $sth->execute( "*", $itemtype, "*" );
1174     $irule = $sth->fetchrow_hashref;
1175     return $irule if defined($irule) ;
1176
1177     $sth->execute( "*", "*", "*" );
1178     $irule = $sth->fetchrow_hashref;
1179     return $irule if defined($irule) ;
1180
1181     # if no rule matches,
1182     return undef;
1183 }
1184
1185 =head2 GetBranchBorrowerCircRule
1186
1187 =over 4
1188
1189 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1190
1191 =back
1192
1193 Retrieves circulation rule attributes that apply to the given
1194 branch and patron category, regardless of item type.
1195 The return value is a hashref containing the following key:
1196
1197 maxissueqty - maximum number of loans that a
1198 patron of the given category can have at the given
1199 branch.  If the value is undef, no limit.
1200
1201 This will first check for a specific branch and
1202 category match from branch_borrower_circ_rules.
1203
1204 If no rule is found, it will then check default_branch_circ_rules
1205 (same branch, default category).  If no rule is found,
1206 it will then check default_borrower_circ_rules (default
1207 branch, same category), then failing that, default_circ_rules
1208 (default branch, default category).
1209
1210 If no rule has been found in the database, it will default to
1211 the buillt in rule:
1212
1213 maxissueqty - undef
1214
1215 C<$branchcode> and C<$categorycode> should contain the
1216 literal branch code and patron category code, respectively - no
1217 wildcards.
1218
1219 =cut
1220
1221 sub GetBranchBorrowerCircRule {
1222     my $branchcode = shift;
1223     my $categorycode = shift;
1224
1225     my $branch_cat_query = "SELECT maxissueqty
1226                             FROM branch_borrower_circ_rules
1227                             WHERE branchcode = ?
1228                             AND   categorycode = ?";
1229     my $dbh = C4::Context->dbh();
1230     my $sth = $dbh->prepare($branch_cat_query);
1231     $sth->execute($branchcode, $categorycode);
1232     my $result;
1233     if ($result = $sth->fetchrow_hashref()) {
1234         return $result;
1235     }
1236
1237     # try same branch, default borrower category
1238     my $branch_query = "SELECT maxissueqty
1239                         FROM default_branch_circ_rules
1240                         WHERE branchcode = ?";
1241     $sth = $dbh->prepare($branch_query);
1242     $sth->execute($branchcode);
1243     if ($result = $sth->fetchrow_hashref()) {
1244         return $result;
1245     }
1246
1247     # try default branch, same borrower category
1248     my $category_query = "SELECT maxissueqty
1249                           FROM default_borrower_circ_rules
1250                           WHERE categorycode = ?";
1251     $sth = $dbh->prepare($category_query);
1252     $sth->execute($categorycode);
1253     if ($result = $sth->fetchrow_hashref()) {
1254         return $result;
1255     }
1256
1257     # try default branch, default borrower category
1258     my $default_query = "SELECT maxissueqty
1259                           FROM default_circ_rules";
1260     $sth = $dbh->prepare($default_query);
1261     $sth->execute();
1262     if ($result = $sth->fetchrow_hashref()) {
1263         return $result;
1264     }
1265
1266     # built-in default circulation rule
1267     return {
1268         maxissueqty => undef,
1269     };
1270 }
1271
1272 =head2 GetBranchItemRule
1273
1274 =over 4
1275
1276 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1277
1278 =back
1279
1280 Retrieves circulation rule attributes that apply to the given
1281 branch and item type, regardless of patron category.
1282
1283 The return value is a hashref containing the following key:
1284
1285 holdallowed => Hold policy for this branch and itemtype. Possible values:
1286   0: No holds allowed.
1287   1: Holds allowed only by patrons that have the same homebranch as the item.
1288   2: Holds allowed from any patron.
1289
1290 This searches branchitemrules in the following order:
1291
1292   * Same branchcode and itemtype
1293   * Same branchcode, itemtype '*'
1294   * branchcode '*', same itemtype
1295   * branchcode and itemtype '*'
1296
1297 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1298
1299 =cut
1300
1301 sub GetBranchItemRule {
1302     my ( $branchcode, $itemtype ) = @_;
1303     my $dbh = C4::Context->dbh();
1304     my $result = {};
1305
1306     my @attempts = (
1307         ['SELECT holdallowed
1308             FROM branch_item_rules
1309             WHERE branchcode = ?
1310               AND itemtype = ?', $branchcode, $itemtype],
1311         ['SELECT holdallowed
1312             FROM default_branch_circ_rules
1313             WHERE branchcode = ?', $branchcode],
1314         ['SELECT holdallowed
1315             FROM default_branch_item_rules
1316             WHERE itemtype = ?', $itemtype],
1317         ['SELECT holdallowed
1318             FROM default_circ_rules'],
1319     );
1320
1321     foreach my $attempt (@attempts) {
1322         my ($query, @bind_params) = @{$attempt};
1323
1324         # Since branch/category and branch/itemtype use the same per-branch
1325         # defaults tables, we have to check that the key we want is set, not
1326         # just that a row was returned
1327         return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1328     }
1329
1330     # built-in default circulation rule
1331     return {
1332         holdallowed => 2,
1333     };
1334 }
1335
1336 =head2 AddReturn
1337
1338 ($doreturn, $messages, $iteminformation, $borrower) =
1339     &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1340
1341 Returns a book.
1342
1343 =over 4
1344
1345 =item C<$barcode> is the bar code of the book being returned.
1346
1347 =item C<$branch> is the code of the branch where the book is being returned.
1348
1349 =item C<$exemptfine> indicates that overdue charges for the item will be
1350 removed.
1351
1352 =item C<$dropbox> indicates that the check-in date is assumed to be
1353 yesterday, or the last non-holiday as defined in C4::Calendar .  If
1354 overdue charges are applied and C<$dropbox> is true, the last charge
1355 will be removed.  This assumes that the fines accrual script has run
1356 for _today_.
1357
1358 =back
1359
1360 C<&AddReturn> returns a list of four items:
1361
1362 C<$doreturn> is true iff the return succeeded.
1363
1364 C<$messages> is a reference-to-hash giving the reason for failure:
1365
1366 =over 4
1367
1368 =item C<BadBarcode>
1369
1370 No item with this barcode exists. The value is C<$barcode>.
1371
1372 =item C<NotIssued>
1373
1374 The book is not currently on loan. The value is C<$barcode>.
1375
1376 =item C<IsPermanent>
1377
1378 The book's home branch is a permanent collection. If you have borrowed
1379 this book, you are not allowed to return it. The value is the code for
1380 the book's home branch.
1381
1382 =item C<wthdrawn>
1383
1384 This book has been withdrawn/cancelled. The value should be ignored.
1385
1386 =item C<ResFound>
1387
1388 The item was reserved. The value is a reference-to-hash whose keys are
1389 fields from the reserves table of the Koha database, and
1390 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1391 either C<Waiting>, C<Reserved>, or 0.
1392
1393 =back
1394
1395 C<$iteminformation> is a reference-to-hash, giving information about the
1396 returned item from the issues table.
1397
1398 C<$borrower> is a reference-to-hash, giving information about the
1399 patron who last borrowed the book.
1400
1401 =cut
1402
1403 sub AddReturn {
1404     my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1405     if ($branch and not GetBranchDetail($branch)) {
1406         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1407         undef $branch;
1408     }
1409     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1410     my $messages;
1411     my $borrower;
1412     my $doreturn       = 1;
1413     my $validTransfert = 0;
1414     my $reserveDone    = 0;
1415
1416     # get information on item
1417     my $itemnumber      = GetItemnumberFromBarcode( $barcode );
1418     my $iteminformation = GetItemIssue($itemnumber);
1419     my $biblio          = GetBiblioItemData($iteminformation->{'biblioitemnumber'});
1420 #     use Data::Dumper;warn Data::Dumper::Dumper($iteminformation);
1421     unless ($itemnumber) {
1422         $messages->{'BadBarcode'} = $barcode;
1423         $doreturn = 0;
1424     } else {
1425         if ( not %$iteminformation ) {
1426             $messages->{'NotIssued'} = $barcode;
1427             # even though item is not on loan, it may still
1428             # be transferred; therefore, get current branch information
1429             my $curr_iteminfo = GetItem($itemnumber);
1430             $iteminformation->{'itemnumber'}    = $curr_iteminfo->{'itemnumber'};
1431             $iteminformation->{'homebranch'}    = $curr_iteminfo->{'homebranch'};
1432             $iteminformation->{'holdingbranch'} = $curr_iteminfo->{'holdingbranch'};
1433             $iteminformation->{'itemlost'}      = $curr_iteminfo->{'itemlost'};
1434             # These lines patch up $iteminformation enough so it can be used below for other messages
1435             $doreturn = 0;
1436         }
1437
1438         my $hbr = $iteminformation->{C4::Context->preference("HomeOrHoldingBranch")} || '';
1439         # check if the book is in a permanent collection....
1440         # FIXME -- This 'PE' attribute is largely undocumented.  afaict, there's no user interface that reflects this functionality.
1441         if ( $hbr ) {
1442             my $branches = GetBranches();    # a potentially expensive call for a non-feature.
1443             $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1444         }
1445
1446         # if indy branches and returning to different branch, refuse the return
1447         if ($hbr ne $branch && C4::Context->preference("IndependantBranches")){
1448             $messages->{'Wrongbranch'} = 1;
1449             $doreturn = 0;
1450         }
1451
1452         if ( $iteminformation->{'wthdrawn'} ) { # book has been cancelled
1453             $messages->{'wthdrawn'} = 1;
1454             $doreturn = 0;
1455         }
1456
1457         # if the book returned in an other branch, update the holding branch
1458         # update issues, thereby returning book (should push this out into another subroutine
1459         $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1460
1461         # case of a return of document (deal with issues and holdingbranch)
1462
1463         if ($doreturn) {
1464                         my $circControlBranch;
1465                         if ($dropbox) {
1466                                 # don't allow dropbox mode to create an invalid entry in issues (issuedate > returndate) FIXME: actually checks eq, not gt
1467                                 undef($dropbox) if ( $iteminformation->{'issuedate'} eq C4::Dates->today('iso') );
1468                                 if (C4::Context->preference('CircControl') eq 'ItemHomeBranch' ) {
1469                                         $circControlBranch = $iteminformation->{homebranch};
1470                                 } elsif ( C4::Context->preference('CircControl') eq 'PatronLibrary') {
1471                                         $circControlBranch = $borrower->{branchcode};
1472                                 } else { # CircControl must be PickupLibrary.
1473                                         $circControlBranch = $iteminformation->{holdingbranch};
1474                                         # FIXME - is this right ? are we sure that the holdingbranch is still the pickup branch?
1475                                 }
1476                         }
1477             MarkIssueReturned($borrower->{'borrowernumber'}, $iteminformation->{'itemnumber'},$circControlBranch);
1478             $messages->{'WasReturned'} = 1;    # FIXME is the "= 1" right?
1479
1480             # continue to deal with returns cases, but not only if we have an issue
1481
1482             # the holdingbranch is updated if the document is returned in an other location .
1483             if ( $iteminformation->{'holdingbranch'} ne $branch ) {
1484                 UpdateHoldingbranch($branch, $iteminformation->{'itemnumber'});
1485                 $iteminformation->{'holdingbranch'} = $branch; # update iteminformation holdingbranch too
1486             }
1487             ModDateLastSeen( $iteminformation->{'itemnumber'} );
1488             ModItem({ onloan => undef }, $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'});
1489
1490             if ($iteminformation->{borrowernumber}){
1491                 $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 ); # FIXME: we shouldn't need to make the same call twice
1492             }
1493         }
1494         # fix up the accounts.....
1495         if ( $iteminformation->{'itemlost'} ) {
1496             $messages->{'WasLost'} = 1;
1497         }
1498
1499         # check if we have a transfer for this document
1500         my ($datesent,$frombranch,$tobranch) = GetTransfers( $iteminformation->{'itemnumber'} );
1501
1502         # if we have a transfer to do, we update the line of transfers with the datearrived
1503         if ($datesent) {
1504             if ( $tobranch eq $branch ) {
1505                 my $sth = C4::Context->dbh->prepare(
1506                     "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1507                 );
1508                 $sth->execute( $iteminformation->{'itemnumber'} );
1509                 # if we have a reservation with the validate of transfer, we can set it's status to 'W'
1510                 C4::Reserves::ModReserveStatus($iteminformation->{'itemnumber'}, 'W');
1511             } else {
1512                 $messages->{'WrongTransfer'}     = $tobranch;
1513                 $messages->{'WrongTransferItem'} = $iteminformation->{'itemnumber'};
1514             }
1515             $validTransfert = 1;
1516         }
1517
1518         # fix up the accounts.....
1519         if ($iteminformation->{'itemlost'}) {
1520             FixAccountForLostAndReturned($iteminformation, $borrower);
1521             $messages->{'WasLost'} = 1;
1522         }
1523
1524         # fix up the overdues in accounts...
1525         FixOverduesOnReturn( $borrower->{'borrowernumber'},
1526             $iteminformation->{'itemnumber'}, $exemptfine, $dropbox );
1527
1528         # find reserves.....
1529         # if we don't have a reserve with the status W, we launch the Checkreserves routine
1530         my ( $resfound, $resrec ) = C4::Reserves::CheckReserves( $iteminformation->{'itemnumber'} );
1531         if ($resfound) {
1532               $resrec->{'ResFound'} = $resfound;
1533             $messages->{'ResFound'} = $resrec;
1534             $reserveDone = 1;
1535         }
1536
1537         # update stats?
1538         # Record the fact that this book was returned.
1539         UpdateStats(
1540             $branch, 'return', '0', '',
1541             $iteminformation->{'itemnumber'},
1542             $biblio->{'itemtype'},
1543             $borrower->{'borrowernumber'}
1544         );
1545
1546         # Send a check-in slip.
1547         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1548         my %conditions = (
1549             branchcode   => $branch,
1550             categorycode => $borrower->{categorycode},
1551             item_type    => $iteminformation->{itype},
1552             notification => 'CHECKIN',
1553         );
1554         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1555             SendCirculationAlert({
1556                 type     => 'CHECKIN',
1557                 item     => $iteminformation,
1558                 borrower => $borrower,
1559                 branch   => $branch,
1560             });
1561         }
1562
1563         logaction("CIRCULATION", "RETURN", $iteminformation->{borrowernumber}, $iteminformation->{'biblionumber'})
1564             if C4::Context->preference("ReturnLog");
1565
1566         #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1567         #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1568
1569         if ($doreturn and ($branch ne $iteminformation->{'homebranch'}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) and ($reserveDone ne 1) ){
1570                         if (C4::Context->preference("AutomaticItemReturn") == 1) {
1571                                 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1572                                 $messages->{'WasTransfered'} = 1;
1573                         } elsif ( C4::Context->preference("UseBranchTransferLimits") == 1
1574                                         && ! IsBranchTransferAllowed( $branch, $iteminformation->{'homebranch'}, $iteminformation->{ C4::Context->preference("BranchTransferLimitsType") } )
1575                                 ) {
1576                                 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1577                                 $messages->{'WasTransfered'} = 1;
1578                         } else {
1579                                 $messages->{'NeedsTransfer'} = 1;
1580                         }
1581         }
1582     }
1583     return ( $doreturn, $messages, $iteminformation, $borrower );
1584 }
1585
1586 =head2 MarkIssueReturned
1587
1588 =over 4
1589
1590 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate);
1591
1592 =back
1593
1594 Unconditionally marks an issue as being returned by
1595 moving the C<issues> row to C<old_issues> and
1596 setting C<returndate> to the current date, or
1597 the last non-holiday date of the branccode specified in
1598 C<dropbox_branch> .  Assumes you've already checked that
1599 it's safe to do this, i.e. last non-holiday > issuedate.
1600
1601 if C<$returndate> is specified (in iso format), it is used as the date
1602 of the return. It is ignored when a dropbox_branch is passed in.
1603
1604 Ideally, this function would be internal to C<C4::Circulation>,
1605 not exported, but it is currently needed by one
1606 routine in C<C4::Accounts>.
1607
1608 =cut
1609
1610 sub MarkIssueReturned {
1611     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate ) = @_;
1612     my $dbh   = C4::Context->dbh;
1613     my $query = "UPDATE issues SET returndate=";
1614     my @bind;
1615     if ($dropbox_branch) {
1616         my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1617         my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1618         $query .= " ? ";
1619         push @bind, $dropboxdate->output('iso');
1620     } elsif ($returndate) {
1621         $query .= " ? ";
1622         push @bind, $returndate;
1623     } else {
1624         $query .= " now() ";
1625     }
1626     $query .= " WHERE  borrowernumber = ?  AND itemnumber = ?";
1627     push @bind, $borrowernumber, $itemnumber;
1628     # FIXME transaction
1629     my $sth_upd  = $dbh->prepare($query);
1630     $sth_upd->execute(@bind);
1631     my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1632                                   WHERE borrowernumber = ?
1633                                   AND itemnumber = ?");
1634     $sth_copy->execute($borrowernumber, $itemnumber);
1635     my $sth_del  = $dbh->prepare("DELETE FROM issues
1636                                   WHERE borrowernumber = ?
1637                                   AND itemnumber = ?");
1638     $sth_del->execute($borrowernumber, $itemnumber);
1639 }
1640
1641 =head2 FixOverduesOnReturn
1642
1643     &FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1644
1645 C<$brn> borrowernumber
1646
1647 C<$itm> itemnumber
1648
1649 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1650 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1651
1652 internal function, called only by AddReturn
1653
1654 =cut
1655
1656 sub FixOverduesOnReturn {
1657     my ( $borrowernumber, $item, $exemptfine, $dropbox ) = @_;
1658     my $dbh = C4::Context->dbh;
1659
1660     # check for overdue fine
1661     my $sth =
1662       $dbh->prepare(
1663 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1664       );
1665     $sth->execute( $borrowernumber, $item );
1666
1667     # alter fine to show that the book has been returned
1668    my $data;
1669         if ($data = $sth->fetchrow_hashref) {
1670         my $uquery;
1671                 my @bind = ($borrowernumber,$item ,$data->{'accountno'});
1672                 if ($exemptfine) {
1673                         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1674                         if (C4::Context->preference("FinesLog")) {
1675                         &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1676                         }
1677                 } elsif ($dropbox && $data->{lastincrement}) {
1678                         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1679                         my $amt = $data->{amount} - $data->{lastincrement} ;
1680                         if (C4::Context->preference("FinesLog")) {
1681                         &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1682                         }
1683                          $uquery = "update accountlines set accounttype='F' ";
1684                          if($outstanding  >= 0 && $amt >=0) {
1685                                 $uquery .= ", amount = ? , amountoutstanding=? ";
1686                                 unshift @bind, ($amt, $outstanding) ;
1687                         }
1688                 } else {
1689                         $uquery = "update accountlines set accounttype='F' ";
1690                 }
1691                 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1692         my $usth = $dbh->prepare($uquery);
1693         $usth->execute(@bind);
1694         $usth->finish();
1695     }
1696
1697     $sth->finish();
1698     return;
1699 }
1700
1701 =head2 FixAccountForLostAndReturned
1702
1703         &FixAccountForLostAndReturned($iteminfo,$borrower);
1704
1705 Calculates the charge for a book lost and returned (Not exported & used only once)
1706
1707 C<$iteminfo> is a hashref to iteminfo. Only {itemnumber} is used.
1708
1709 C<$borrower> is a hashref to borrower. Only {borrowernumber is used.
1710
1711 Internal function, called by AddReturn
1712
1713 =cut
1714
1715 sub FixAccountForLostAndReturned {
1716         my ($iteminfo, $borrower) = @_;
1717         my $dbh = C4::Context->dbh;
1718         my $itm = $iteminfo->{'itemnumber'};
1719         # check for charge made for lost book
1720         my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1721         $sth->execute($itm);
1722         if (my $data = $sth->fetchrow_hashref) {
1723         # writeoff this amount
1724                 my $offset;
1725                 my $amount = $data->{'amount'};
1726                 my $acctno = $data->{'accountno'};
1727                 my $amountleft;
1728                 if ($data->{'amountoutstanding'} == $amount) {
1729                 $offset = $data->{'amount'};
1730                 $amountleft = 0;
1731                 } else {
1732                 $offset = $amount - $data->{'amountoutstanding'};
1733                 $amountleft = $data->{'amountoutstanding'} - $amount;
1734                 }
1735                 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1736                         WHERE (borrowernumber = ?)
1737                         AND (itemnumber = ?) AND (accountno = ?) ");
1738                 $usth->execute($data->{'borrowernumber'},$itm,$acctno);
1739                 $usth->finish;
1740         #check if any credit is left if so writeoff other accounts
1741                 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1742                 if ($amountleft < 0){
1743                 $amountleft*=-1;
1744                 }
1745                 if ($amountleft > 0){
1746                 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1747                                                         AND (amountoutstanding >0) ORDER BY date");
1748                 $msth->execute($data->{'borrowernumber'});
1749         # offset transactions
1750                 my $newamtos;
1751                 my $accdata;
1752                 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1753                         if ($accdata->{'amountoutstanding'} < $amountleft) {
1754                         $newamtos = 0;
1755                         $amountleft -= $accdata->{'amountoutstanding'};
1756                         }  else {
1757                         $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1758                         $amountleft = 0;
1759                         }
1760                         my $thisacct = $accdata->{'accountno'};
1761                         my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1762                                         WHERE (borrowernumber = ?)
1763                                         AND (accountno=?)");
1764                         $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');
1765                         $usth->finish;
1766                         $usth = $dbh->prepare("INSERT INTO accountoffsets
1767                                 (borrowernumber, accountno, offsetaccount,  offsetamount)
1768                                 VALUES
1769                                 (?,?,?,?)");
1770                         $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1771                         $usth->finish;
1772                 }
1773                 $msth->finish;
1774                 }
1775                 if ($amountleft > 0){
1776                         $amountleft*=-1;
1777                 }
1778                 my $desc="Item Returned ".$iteminfo->{'barcode'};
1779                 $usth = $dbh->prepare("INSERT INTO accountlines
1780                         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1781                         VALUES (?,?,now(),?,?,'CR',?)");
1782                 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1783                 $usth->finish;
1784                 $usth = $dbh->prepare("INSERT INTO accountoffsets
1785                         (borrowernumber, accountno, offsetaccount,  offsetamount)
1786                         VALUES (?,?,?,?)");
1787                 $usth->execute($borrower->{'borrowernumber'},$data->{'accountno'},$nextaccntno,$offset);
1788                 $usth->finish;
1789         ModItem({ paidfor => '' }, undef, $itm);
1790         }
1791         $sth->finish;
1792         return;
1793 }
1794
1795 =head2 GetItemIssue
1796
1797 $issues = &GetItemIssue($itemnumber);
1798
1799 Returns patrons currently having a book. nothing if item is not issued atm
1800
1801 C<$itemnumber> is the itemnumber
1802
1803 Returns an array of hashes
1804
1805 FIXME: Though the above says that this function returns nothing if the
1806 item is not issued, this actually returns a hasref that looks like
1807 this:
1808     {
1809       itemnumber => 1,
1810       overdue    => 1
1811     }
1812
1813
1814 =cut
1815
1816 sub GetItemIssue {
1817     my ( $itemnumber) = @_;
1818     return unless $itemnumber;
1819     my $dbh = C4::Context->dbh;
1820     my @GetItemIssues;
1821
1822     # get today date
1823     my $today = POSIX::strftime("%Y%m%d", localtime);
1824
1825     my $sth = $dbh->prepare(
1826         "SELECT * FROM issues
1827         LEFT JOIN items ON issues.itemnumber=items.itemnumber
1828     WHERE
1829     issues.itemnumber=?");
1830     $sth->execute($itemnumber);
1831     my $data = $sth->fetchrow_hashref;
1832     my $datedue = $data->{'date_due'};
1833     $datedue =~ s/-//g;
1834     if ( $datedue < $today ) {
1835         $data->{'overdue'} = 1;
1836     }
1837     $data->{'itemnumber'} = $itemnumber; # fill itemnumber, in case item is not on issue
1838     $sth->finish;
1839     return ($data);
1840 }
1841
1842 =head2 GetOpenIssue
1843
1844 $issue = GetOpenIssue( $itemnumber );
1845
1846 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1847
1848 C<$itemnumber> is the item's itemnumber
1849
1850 Returns a hashref
1851
1852 =cut
1853
1854 sub GetOpenIssue {
1855   my ( $itemnumber ) = @_;
1856
1857   my $dbh = C4::Context->dbh;
1858   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1859   $sth->execute( $itemnumber );
1860   my $issue = $sth->fetchrow_hashref();
1861   return $issue;
1862 }
1863
1864 =head2 GetItemIssues
1865
1866 $issues = &GetItemIssues($itemnumber, $history);
1867
1868 Returns patrons that have issued a book
1869
1870 C<$itemnumber> is the itemnumber
1871 C<$history> is 0 if you want actuel "issuer" (if it exist) and 1 if you want issues history
1872
1873 Returns an array of hashes
1874
1875 =cut
1876
1877 sub GetItemIssues {
1878     my ( $itemnumber,$history ) = @_;
1879     my $dbh = C4::Context->dbh;
1880     my @GetItemIssues;
1881
1882     # get today date
1883     my $today = POSIX::strftime("%Y%m%d", localtime);
1884
1885     my $sql = "SELECT * FROM issues
1886               JOIN borrowers USING (borrowernumber)
1887               JOIN items USING (itemnumber)
1888               WHERE issues.itemnumber = ? ";
1889     if ($history) {
1890         $sql .= "UNION ALL
1891                  SELECT * FROM old_issues
1892                  LEFT JOIN borrowers USING (borrowernumber)
1893                  JOIN items USING (itemnumber)
1894                  WHERE old_issues.itemnumber = ? ";
1895     }
1896     $sql .= "ORDER BY date_due DESC";
1897     my $sth = $dbh->prepare($sql);
1898     if ($history) {
1899         $sth->execute($itemnumber, $itemnumber);
1900     } else {
1901         $sth->execute($itemnumber);
1902     }
1903     while ( my $data = $sth->fetchrow_hashref ) {
1904         my $datedue = $data->{'date_due'};
1905         $datedue =~ s/-//g;
1906         if ( $datedue < $today ) {
1907             $data->{'overdue'} = 1;
1908         }
1909         my $itemnumber = $data->{'itemnumber'};
1910         push @GetItemIssues, $data;
1911     }
1912     $sth->finish;
1913     return ( \@GetItemIssues );
1914 }
1915
1916 =head2 GetBiblioIssues
1917
1918 $issues = GetBiblioIssues($biblionumber);
1919
1920 this function get all issues from a biblionumber.
1921
1922 Return:
1923 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1924 tables issues and the firstname,surname & cardnumber from borrowers.
1925
1926 =cut
1927
1928 sub GetBiblioIssues {
1929     my $biblionumber = shift;
1930     return undef unless $biblionumber;
1931     my $dbh   = C4::Context->dbh;
1932     my $query = "
1933         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1934         FROM issues
1935             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1936             LEFT JOIN items ON issues.itemnumber = items.itemnumber
1937             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1938             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1939         WHERE biblio.biblionumber = ?
1940         UNION ALL
1941         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1942         FROM old_issues
1943             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1944             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1945             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1946             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1947         WHERE biblio.biblionumber = ?
1948         ORDER BY timestamp
1949     ";
1950     my $sth = $dbh->prepare($query);
1951     $sth->execute($biblionumber, $biblionumber);
1952
1953     my @issues;
1954     while ( my $data = $sth->fetchrow_hashref ) {
1955         push @issues, $data;
1956     }
1957     return \@issues;
1958 }
1959
1960 =head2 GetUpcomingDueIssues
1961
1962 =over 4
1963
1964 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
1965
1966 =back
1967
1968 =cut
1969
1970 sub GetUpcomingDueIssues {
1971     my $params = shift;
1972
1973     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
1974     my $dbh = C4::Context->dbh;
1975
1976     my $statement = <<END_SQL;
1977 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
1978 FROM issues
1979 LEFT JOIN items USING (itemnumber)
1980 WhERE returndate is NULL
1981 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
1982 END_SQL
1983
1984     my @bind_parameters = ( $params->{'days_in_advance'} );
1985
1986     my $sth = $dbh->prepare( $statement );
1987     $sth->execute( @bind_parameters );
1988     my $upcoming_dues = $sth->fetchall_arrayref({});
1989     $sth->finish;
1990
1991     return $upcoming_dues;
1992 }
1993
1994 =head2 CanBookBeRenewed
1995
1996 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
1997
1998 Find out whether a borrowed item may be renewed.
1999
2000 C<$dbh> is a DBI handle to the Koha database.
2001
2002 C<$borrowernumber> is the borrower number of the patron who currently
2003 has the item on loan.
2004
2005 C<$itemnumber> is the number of the item to renew.
2006
2007 C<$override_limit>, if supplied with a true value, causes
2008 the limit on the number of times that the loan can be renewed
2009 (as controlled by the item type) to be ignored.
2010
2011 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2012 item must currently be on loan to the specified borrower; renewals
2013 must be allowed for the item's type; and the borrower must not have
2014 already renewed the loan. $error will contain the reason the renewal can not proceed
2015
2016 =cut
2017
2018 sub CanBookBeRenewed {
2019
2020     # check renewal status
2021     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2022     my $dbh       = C4::Context->dbh;
2023     my $renews    = 1;
2024     my $renewokay = 0;
2025         my $error;
2026
2027     # Look in the issues table for this item, lent to this borrower,
2028     # and not yet returned.
2029
2030     # FIXME - I think this function could be redone to use only one SQL call.
2031     my $sth1 = $dbh->prepare(
2032         "SELECT * FROM issues
2033             WHERE borrowernumber = ?
2034             AND itemnumber = ?"
2035     );
2036     $sth1->execute( $borrowernumber, $itemnumber );
2037     if ( my $data1 = $sth1->fetchrow_hashref ) {
2038
2039         # Found a matching item
2040
2041         # See if this item may be renewed. This query is convoluted
2042         # because it's a bit messy: given the item number, we need to find
2043         # the biblioitem, which gives us the itemtype, which tells us
2044         # whether it may be renewed.
2045         my $query = "SELECT renewalsallowed FROM items ";
2046         $query .= (C4::Context->preference('item-level_itypes'))
2047                     ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2048                     : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2049                        LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2050         $query .= "WHERE items.itemnumber = ?";
2051         my $sth2 = $dbh->prepare($query);
2052         $sth2->execute($itemnumber);
2053         if ( my $data2 = $sth2->fetchrow_hashref ) {
2054             $renews = $data2->{'renewalsallowed'};
2055         }
2056         if ( ( $renews && $renews > $data1->{'renewals'} ) || $override_limit ) {
2057             $renewokay = 1;
2058         }
2059         else {
2060                         $error="too_many";
2061                 }
2062         $sth2->finish;
2063         my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2064         if ($resfound) {
2065             $renewokay = 0;
2066                         $error="on_reserve"
2067         }
2068
2069     }
2070     $sth1->finish;
2071     return ($renewokay,$error);
2072 }
2073
2074 =head2 AddRenewal
2075
2076 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2077
2078 Renews a loan.
2079
2080 C<$borrowernumber> is the borrower number of the patron who currently
2081 has the item.
2082
2083 C<$itemnumber> is the number of the item to renew.
2084
2085 C<$branch> is the library where the renewal took place (if any).
2086            The library that controls the circ policies for the renewal is retrieved from the issues record.
2087
2088 C<$datedue> can be a C4::Dates object used to set the due date.
2089
2090 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2091 this parameter is not supplied, lastreneweddate is set to the current date.
2092
2093 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2094 from the book's item type.
2095
2096 =cut
2097
2098 sub AddRenewal {
2099     my $borrowernumber  = shift or return undef;
2100     my $itemnumber      = shift or return undef;
2101     my $branch          = shift;
2102     my $datedue         = shift;
2103     my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2104     my $item   = GetItem($itemnumber) or return undef;
2105     my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2106
2107     my $dbh = C4::Context->dbh;
2108     # Find the issues record for this book
2109     my $sth =
2110       $dbh->prepare("SELECT * FROM issues
2111                         WHERE borrowernumber=?
2112                         AND itemnumber=?"
2113       );
2114     $sth->execute( $borrowernumber, $itemnumber );
2115     my $issuedata = $sth->fetchrow_hashref;
2116     $sth->finish;
2117     if($datedue && ! $datedue->output('iso')){
2118         warn "Invalid date passed to AddRenewal.";
2119         return undef;
2120     }
2121     # If the due date wasn't specified, calculate it by adding the
2122     # book's loan length to today's date or the current due date
2123     # based on the value of the RenewalPeriodBase syspref.
2124     unless ($datedue) {
2125
2126         my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2127         my $loanlength = GetLoanLength(
2128                     $borrower->{'categorycode'},
2129                     (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2130                                 $issuedata->{'branchcode'}  );   # that's the circ control branch.
2131
2132         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2133                                         C4::Dates->new($issuedata->{date_due}, 'iso') :
2134                                         C4::Dates->new();
2135         $datedue =  CalcDateDue($datedue,$loanlength,$issuedata->{'branchcode'},$borrower);
2136     }
2137
2138     # Update the issues record to have the new due date, and a new count
2139     # of how many times it has been renewed.
2140     my $renews = $issuedata->{'renewals'} + 1;
2141     $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2142                             WHERE borrowernumber=?
2143                             AND itemnumber=?"
2144     );
2145     $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2146     $sth->finish;
2147
2148     # Update the renewal count on the item, and tell zebra to reindex
2149     $renews = $biblio->{'renewals'} + 1;
2150     ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2151
2152     # Charge a new rental fee, if applicable?
2153     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2154     if ( $charge > 0 ) {
2155         my $accountno = getnextacctno( $borrowernumber );
2156         my $item = GetBiblioFromItemNumber($itemnumber);
2157         $sth = $dbh->prepare(
2158                 "INSERT INTO accountlines
2159                     (date,
2160                                         borrowernumber, accountno, amount,
2161                     description,
2162                                         accounttype, amountoutstanding, itemnumber
2163                                         )
2164                     VALUES (now(),?,?,?,?,?,?,?)"
2165         );
2166         $sth->execute( $borrowernumber, $accountno, $charge,
2167             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2168             'Rent', $charge, $itemnumber );
2169         $sth->finish;
2170     }
2171     # Log the renewal
2172     UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2173         return $datedue;
2174 }
2175
2176 sub GetRenewCount {
2177     # check renewal status
2178     my ($bornum,$itemno)=@_;
2179     my $dbh = C4::Context->dbh;
2180     my $renewcount = 0;
2181         my $renewsallowed = 0;
2182         my $renewsleft = 0;
2183     # Look in the issues table for this item, lent to this borrower,
2184     # and not yet returned.
2185
2186     # FIXME - I think this function could be redone to use only one SQL call.
2187     my $sth = $dbh->prepare("select * from issues
2188                                 where (borrowernumber = ?)
2189                                 and (itemnumber = ?)");
2190     $sth->execute($bornum,$itemno);
2191     my $data = $sth->fetchrow_hashref;
2192     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2193     $sth->finish;
2194     my $query = "SELECT renewalsallowed FROM items ";
2195     $query .= (C4::Context->preference('item-level_itypes'))
2196                 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2197                 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2198                    LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2199     $query .= "WHERE items.itemnumber = ?";
2200     my $sth2 = $dbh->prepare($query);
2201     $sth2->execute($itemno);
2202     my $data2 = $sth2->fetchrow_hashref();
2203     $renewsallowed = $data2->{'renewalsallowed'};
2204     $renewsleft = $renewsallowed - $renewcount;
2205     return ($renewcount,$renewsallowed,$renewsleft);
2206 }
2207
2208 =head2 GetIssuingCharges
2209
2210 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2211
2212 Calculate how much it would cost for a given patron to borrow a given
2213 item, including any applicable discounts.
2214
2215 C<$itemnumber> is the item number of item the patron wishes to borrow.
2216
2217 C<$borrowernumber> is the patron's borrower number.
2218
2219 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2220 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2221 if it's a video).
2222
2223 =cut
2224
2225 sub GetIssuingCharges {
2226
2227     # calculate charges due
2228     my ( $itemnumber, $borrowernumber ) = @_;
2229     my $charge = 0;
2230     my $dbh    = C4::Context->dbh;
2231     my $item_type;
2232
2233     # Get the book's item type and rental charge (via its biblioitem).
2234     my $qcharge =     "SELECT itemtypes.itemtype,rentalcharge FROM items
2235             LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2236         $qcharge .= (C4::Context->preference('item-level_itypes'))
2237                 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2238                 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2239
2240     $qcharge .=      "WHERE items.itemnumber =?";
2241
2242     my $sth1 = $dbh->prepare($qcharge);
2243     $sth1->execute($itemnumber);
2244     if ( my $data1 = $sth1->fetchrow_hashref ) {
2245         $item_type = $data1->{'itemtype'};
2246         $charge    = $data1->{'rentalcharge'};
2247         my $q2 = "SELECT rentaldiscount FROM borrowers
2248             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2249             WHERE borrowers.borrowernumber = ?
2250             AND issuingrules.itemtype = ?";
2251         my $sth2 = $dbh->prepare($q2);
2252         $sth2->execute( $borrowernumber, $item_type );
2253         if ( my $data2 = $sth2->fetchrow_hashref ) {
2254             my $discount = $data2->{'rentaldiscount'};
2255             if ( $discount eq 'NULL' ) {
2256                 $discount = 0;
2257             }
2258             $charge = ( $charge * ( 100 - $discount ) ) / 100;
2259         }
2260         $sth2->finish;
2261     }
2262
2263     $sth1->finish;
2264     return ( $charge, $item_type );
2265 }
2266
2267 =head2 AddIssuingCharge
2268
2269 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2270
2271 =cut
2272
2273 sub AddIssuingCharge {
2274     my ( $itemnumber, $borrowernumber, $charge ) = @_;
2275     my $dbh = C4::Context->dbh;
2276     my $nextaccntno = getnextacctno( $borrowernumber );
2277     my $query ="
2278         INSERT INTO accountlines
2279             (borrowernumber, itemnumber, accountno,
2280             date, amount, description, accounttype,
2281             amountoutstanding)
2282         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2283     ";
2284     my $sth = $dbh->prepare($query);
2285     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2286     $sth->finish;
2287 }
2288
2289 =head2 GetTransfers
2290
2291 GetTransfers($itemnumber);
2292
2293 =cut
2294
2295 sub GetTransfers {
2296     my ($itemnumber) = @_;
2297
2298     my $dbh = C4::Context->dbh;
2299
2300     my $query = '
2301         SELECT datesent,
2302                frombranch,
2303                tobranch
2304         FROM branchtransfers
2305         WHERE itemnumber = ?
2306           AND datearrived IS NULL
2307         ';
2308     my $sth = $dbh->prepare($query);
2309     $sth->execute($itemnumber);
2310     my @row = $sth->fetchrow_array();
2311     $sth->finish;
2312     return @row;
2313 }
2314
2315 =head2 GetTransfersFromTo
2316
2317 @results = GetTransfersFromTo($frombranch,$tobranch);
2318
2319 Returns the list of pending transfers between $from and $to branch
2320
2321 =cut
2322
2323 sub GetTransfersFromTo {
2324     my ( $frombranch, $tobranch ) = @_;
2325     return unless ( $frombranch && $tobranch );
2326     my $dbh   = C4::Context->dbh;
2327     my $query = "
2328         SELECT itemnumber,datesent,frombranch
2329         FROM   branchtransfers
2330         WHERE  frombranch=?
2331           AND  tobranch=?
2332           AND datearrived IS NULL
2333     ";
2334     my $sth = $dbh->prepare($query);
2335     $sth->execute( $frombranch, $tobranch );
2336     my @gettransfers;
2337
2338     while ( my $data = $sth->fetchrow_hashref ) {
2339         push @gettransfers, $data;
2340     }
2341     $sth->finish;
2342     return (@gettransfers);
2343 }
2344
2345 =head2 DeleteTransfer
2346
2347 &DeleteTransfer($itemnumber);
2348
2349 =cut
2350
2351 sub DeleteTransfer {
2352     my ($itemnumber) = @_;
2353     my $dbh          = C4::Context->dbh;
2354     my $sth          = $dbh->prepare(
2355         "DELETE FROM branchtransfers
2356          WHERE itemnumber=?
2357          AND datearrived IS NULL "
2358     );
2359     $sth->execute($itemnumber);
2360     $sth->finish;
2361 }
2362
2363 =head2 AnonymiseIssueHistory
2364
2365 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2366
2367 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2368 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2369
2370 return the number of affected rows.
2371
2372 =cut
2373
2374 sub AnonymiseIssueHistory {
2375     my $date           = shift;
2376     my $borrowernumber = shift;
2377     my $dbh            = C4::Context->dbh;
2378     my $query          = "
2379         UPDATE old_issues
2380         SET    borrowernumber = NULL
2381         WHERE  returndate < '".$date."'
2382           AND borrowernumber IS NOT NULL
2383     ";
2384     $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2385     my $rows_affected = $dbh->do($query);
2386     return $rows_affected;
2387 }
2388
2389 =head2 SendCirculationAlert
2390
2391 Send out a C<check-in> or C<checkout> alert using the messaging system.
2392
2393 B<Parameters>:
2394
2395 =over 4
2396
2397 =item type
2398
2399 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2400
2401 =item item
2402
2403 Hashref of information about the item being checked in or out.
2404
2405 =item borrower
2406
2407 Hashref of information about the borrower of the item.
2408
2409 =item branch
2410
2411 The branchcode from where the checkout or check-in took place.
2412
2413 =back
2414
2415 B<Example>:
2416
2417     SendCirculationAlert({
2418         type     => 'CHECKOUT',
2419         item     => $item,
2420         borrower => $borrower,
2421         branch   => $branch,
2422     });
2423
2424 =cut
2425
2426 sub SendCirculationAlert {
2427     my ($opts) = @_;
2428     my ($type, $item, $borrower, $branch) =
2429         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2430     my %message_name = (
2431         CHECKIN  => 'Item Check-in',
2432         CHECKOUT => 'Item Checkout',
2433     );
2434     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2435         borrowernumber => $borrower->{borrowernumber},
2436         message_name   => $message_name{$type},
2437     });
2438     my $letter = C4::Letters::getletter('circulation', $type);
2439     C4::Letters::parseletter($letter, 'biblio',      $item->{biblionumber});
2440     C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2441     C4::Letters::parseletter($letter, 'borrowers',   $borrower->{borrowernumber});
2442     C4::Letters::parseletter($letter, 'branches',    $branch);
2443     my @transports = @{ $borrower_preferences->{transports} };
2444     # warn "no transports" unless @transports;
2445     for (@transports) {
2446         # warn "transport: $_";
2447         my $message = C4::Message->find_last_message($borrower, $type, $_);
2448         if (!$message) {
2449             #warn "create new message";
2450             C4::Message->enqueue($letter, $borrower, $_);
2451         } else {
2452             #warn "append to old message";
2453             $message->append($letter);
2454             $message->update;
2455         }
2456     }
2457     $letter;
2458 }
2459
2460 =head2 updateWrongTransfer
2461
2462 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2463
2464 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
2465
2466 =cut
2467
2468 sub updateWrongTransfer {
2469         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2470         my $dbh = C4::Context->dbh;
2471 # first step validate the actual line of transfert .
2472         my $sth =
2473                 $dbh->prepare(
2474                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2475                 );
2476                 $sth->execute($FromLibrary,$itemNumber);
2477                 $sth->finish;
2478
2479 # second step create a new line of branchtransfer to the right location .
2480         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2481
2482 #third step changing holdingbranch of item
2483         UpdateHoldingbranch($FromLibrary,$itemNumber);
2484 }
2485
2486 =head2 UpdateHoldingbranch
2487
2488 $items = UpdateHoldingbranch($branch,$itmenumber);
2489 Simple methode for updating hodlingbranch in items BDD line
2490
2491 =cut
2492
2493 sub UpdateHoldingbranch {
2494         my ( $branch,$itemnumber ) = @_;
2495     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2496 }
2497
2498 =head2 CalcDateDue
2499
2500 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2501 this function calculates the due date given the loan length ,
2502 checking against the holidays calendar as per the 'useDaysMode' syspref.
2503 C<$startdate>   = C4::Dates object representing start date of loan period (assumed to be today)
2504 C<$branch>  = location whose calendar to use
2505 C<$loanlength>  = loan length prior to adjustment
2506 =cut
2507
2508 sub CalcDateDue {
2509         my ($startdate,$loanlength,$branch,$borrower) = @_;
2510         my $datedue;
2511
2512         if(C4::Context->preference('useDaysMode') eq 'Days') {  # ignoring calendar
2513                 my $timedue = time + ($loanlength) * 86400;
2514         #FIXME - assumes now even though we take a startdate
2515                 my @datearr  = localtime($timedue);
2516                 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2517         } else {
2518                 my $calendar = C4::Calendar->new(  branchcode => $branch );
2519                 $datedue = $calendar->addDate($startdate, $loanlength);
2520         }
2521
2522         # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2523         if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2524             $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2525         }
2526
2527         # if ceilingDueDate ON the datedue can't be after the ceiling date
2528         if ( C4::Context->preference('ceilingDueDate')
2529              && ( C4::Context->preference('ceilingDueDate') =~ C4::Dates->regexp('syspref') )
2530              && $datedue->output gt C4::Context->preference('ceilingDueDate') ) {
2531             $datedue = C4::Dates->new( C4::Context->preference('ceilingDueDate') );
2532         }
2533
2534         return $datedue;
2535 }
2536
2537 =head2 CheckValidDatedue
2538        This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2539        To be replaced by CalcDateDue() once C4::Calendar use is tested.
2540
2541 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2542 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2543 C<$date_due>   = returndate calculate with no day check
2544 C<$itemnumber>  = itemnumber
2545 C<$branchcode>  = location of issue (affected by 'CircControl' syspref)
2546 C<$loanlength>  = loan length prior to adjustment
2547 =cut
2548
2549 sub CheckValidDatedue {
2550 my ($date_due,$itemnumber,$branchcode)=@_;
2551 my @datedue=split('-',$date_due->output('iso'));
2552 my $years=$datedue[0];
2553 my $month=$datedue[1];
2554 my $day=$datedue[2];
2555 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2556 my $dow;
2557 for (my $i=0;$i<2;$i++){
2558     $dow=Day_of_Week($years,$month,$day);
2559     ($dow=0) if ($dow>6);
2560     my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2561     my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2562     my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2563         if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2564         $i=0;
2565         (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2566         }
2567     }
2568     my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2569 return $newdatedue;
2570 }
2571
2572
2573 =head2 CheckRepeatableHolidays
2574
2575 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2576 this function checks if the date due is a repeatable holiday
2577 C<$date_due>   = returndate calculate with no day check
2578 C<$itemnumber>  = itemnumber
2579 C<$branchcode>  = localisation of issue
2580
2581 =cut
2582
2583 sub CheckRepeatableHolidays{
2584 my($itemnumber,$week_day,$branchcode)=@_;
2585 my $dbh = C4::Context->dbh;
2586 my $query = qq|SELECT count(*)
2587         FROM repeatable_holidays
2588         WHERE branchcode=?
2589         AND weekday=?|;
2590 my $sth = $dbh->prepare($query);
2591 $sth->execute($branchcode,$week_day);
2592 my $result=$sth->fetchrow;
2593 $sth->finish;
2594 return $result;
2595 }
2596
2597
2598 =head2 CheckSpecialHolidays
2599
2600 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2601 this function check if the date is a special holiday
2602 C<$years>   = the years of datedue
2603 C<$month>   = the month of datedue
2604 C<$day>     = the day of datedue
2605 C<$itemnumber>  = itemnumber
2606 C<$branchcode>  = localisation of issue
2607
2608 =cut
2609
2610 sub CheckSpecialHolidays{
2611 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2612 my $dbh = C4::Context->dbh;
2613 my $query=qq|SELECT count(*)
2614              FROM `special_holidays`
2615              WHERE year=?
2616              AND month=?
2617              AND day=?
2618              AND branchcode=?
2619             |;
2620 my $sth = $dbh->prepare($query);
2621 $sth->execute($years,$month,$day,$branchcode);
2622 my $countspecial=$sth->fetchrow ;
2623 $sth->finish;
2624 return $countspecial;
2625 }
2626
2627 =head2 CheckRepeatableSpecialHolidays
2628
2629 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2630 this function check if the date is a repeatble special holidays
2631 C<$month>   = the month of datedue
2632 C<$day>     = the day of datedue
2633 C<$itemnumber>  = itemnumber
2634 C<$branchcode>  = localisation of issue
2635
2636 =cut
2637
2638 sub CheckRepeatableSpecialHolidays{
2639 my ($month,$day,$itemnumber,$branchcode) = @_;
2640 my $dbh = C4::Context->dbh;
2641 my $query=qq|SELECT count(*)
2642              FROM `repeatable_holidays`
2643              WHERE month=?
2644              AND day=?
2645              AND branchcode=?
2646             |;
2647 my $sth = $dbh->prepare($query);
2648 $sth->execute($month,$day,$branchcode);
2649 my $countspecial=$sth->fetchrow ;
2650 $sth->finish;
2651 return $countspecial;
2652 }
2653
2654
2655
2656 sub CheckValidBarcode{
2657 my ($barcode) = @_;
2658 my $dbh = C4::Context->dbh;
2659 my $query=qq|SELECT count(*)
2660              FROM items
2661              WHERE barcode=?
2662             |;
2663 my $sth = $dbh->prepare($query);
2664 $sth->execute($barcode);
2665 my $exist=$sth->fetchrow ;
2666 $sth->finish;
2667 return $exist;
2668 }
2669
2670 =head2 IsBranchTransferAllowed
2671
2672 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2673
2674 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2675
2676 =cut
2677
2678 sub IsBranchTransferAllowed {
2679         my ( $toBranch, $fromBranch, $code ) = @_;
2680
2681         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2682
2683         my $limitType = C4::Context->preference("BranchTransferLimitsType");
2684         my $dbh = C4::Context->dbh;
2685
2686         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2687         $sth->execute( $toBranch, $fromBranch, $code );
2688         my $limit = $sth->fetchrow_hashref();
2689
2690         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2691         if ( $limit->{'limitId'} ) {
2692                 return 0;
2693         } else {
2694                 return 1;
2695         }
2696 }
2697
2698 =head2 CreateBranchTransferLimit
2699
2700 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2701
2702 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2703
2704 =cut
2705
2706 sub CreateBranchTransferLimit {
2707    my ( $toBranch, $fromBranch, $code ) = @_;
2708
2709    my $limitType = C4::Context->preference("BranchTransferLimitsType");
2710
2711    my $dbh = C4::Context->dbh;
2712
2713    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2714    $sth->execute( $code, $toBranch, $fromBranch );
2715 }
2716
2717 =head2 DeleteBranchTransferLimits
2718
2719 DeleteBranchTransferLimits();
2720
2721 =cut
2722
2723 sub DeleteBranchTransferLimits {
2724    my $dbh = C4::Context->dbh;
2725    my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2726    $sth->execute();
2727 }
2728
2729
2730   1;
2731
2732 __END__
2733
2734 =head1 AUTHOR
2735
2736 Koha Developement team <info@koha.org>
2737
2738 =cut
2739