C4/Circulation.pm

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