C4/Circulation.pm

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