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