C4/Circulation.pm

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