C4/Circulation.pm

   1 package C4::Circulation;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 # copyright 2010 BibLibre
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21
  22 use strict;
  23 #use warnings; FIXME - Bug 2505
  24 use DateTime;
  25 use Koha::DateUtils;
  26 use C4::Context;
  27 use C4::Stats;
  28 use C4::Reserves;
  29 use C4::Biblio;
  30 use C4::Items;
  31 use C4::Members;
  32 use C4::Accounts;
  33 use C4::ItemCirculationAlertPreference;
  34 use C4::Message;
  35 use C4::Debug;
  36 use C4::Log; # logaction
  37 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
  38 use C4::RotatingCollections qw(GetCollectionItemBranches);
  39 use Algorithm::CheckDigits;
  40
  41 use Data::Dumper;
  42 use Koha::Account;
  43 use Koha::AuthorisedValues;
  44 use Koha::DateUtils;
  45 use Koha::Calendar;
  46 use Koha::Checkouts;
  47 use Koha::IssuingRules;
  48 use Koha::Items;
  49 use Koha::Patrons;
  50 use Koha::Patron::Debarments;
  51 use Koha::Database;
  52 use Koha::Libraries;
  53 use Koha::Holds;
  54 use Koha::RefundLostItemFeeRule;
  55 use Koha::RefundLostItemFeeRules;
  56 use Carp;
  57 use List::MoreUtils qw( uniq );
  58 use Scalar::Util qw( looks_like_number );
  59 use Date::Calc qw(
  60   Today
  61   Today_and_Now
  62   Add_Delta_YM
  63   Add_Delta_DHMS
  64   Date_to_Days
  65   Day_of_Week
  66   Add_Delta_Days
  67 );
  68 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  69
  70 BEGIN {
  71         require Exporter;
  72         @ISA    = qw(Exporter);
  73
  74         # FIXME subs that should probably be elsewhere
  75         push @EXPORT, qw(
  76                 &barcodedecode
  77         &LostItem
  78         &ReturnLostItem
  79         &GetPendingOnSiteCheckouts
  80         );
  81
  82         # subs to deal with issuing a book
  83         push @EXPORT, qw(
  84                 &CanBookBeIssued
  85                 &CanBookBeRenewed
  86                 &AddIssue
  87                 &AddRenewal
  88                 &GetRenewCount
  89         &GetSoonestRenewDate
  90         &GetLatestAutoRenewDate
  91                 &GetItemIssue
  92                 &GetIssuingCharges
  93         &GetBranchBorrowerCircRule
  94         &GetBranchItemRule
  95                 &GetBiblioIssues
  96                 &GetOpenIssue
  97         &CheckIfIssuedToPatron
  98         &IsItemIssued
  99         GetTopIssues
 100         );
 101
 102         # subs to deal with returns
 103         push @EXPORT, qw(
 104                 &AddReturn
 105         &MarkIssueReturned
 106         );
 107
 108         # subs to deal with transfers
 109         push @EXPORT, qw(
 110                 &transferbook
 111                 &GetTransfers
 112                 &GetTransfersFromTo
 113                 &updateWrongTransfer
 114                 &DeleteTransfer
 115                 &IsBranchTransferAllowed
 116                 &CreateBranchTransferLimit
 117                 &DeleteBranchTransferLimits
 118         &TransferSlip
 119         );
 120
 121     # subs to deal with offline circulation
 122     push @EXPORT, qw(
 123       &GetOfflineOperations
 124       &GetOfflineOperation
 125       &AddOfflineOperation
 126       &DeleteOfflineOperation
 127       &ProcessOfflineOperation
 128     );
 129 }
 130
 131 =head1 NAME
 132
 133 C4::Circulation - Koha circulation module
 134
 135 =head1 SYNOPSIS
 136
 137 use C4::Circulation;
 138
 139 =head1 DESCRIPTION
 140
 141 The functions in this module deal with circulation, issues, and
 142 returns, as well as general information about the library.
 143 Also deals with inventory.
 144
 145 =head1 FUNCTIONS
 146
 147 =head2 barcodedecode
 148
 149   $str = &barcodedecode($barcode, [$filter]);
 150
 151 Generic filter function for barcode string.
 152 Called on every circ if the System Pref itemBarcodeInputFilter is set.
 153 Will do some manipulation of the barcode for systems that deliver a barcode
 154 to circulation.pl that differs from the barcode stored for the item.
 155 For proper functioning of this filter, calling the function on the
 156 correct barcode string (items.barcode) should return an unaltered barcode.
 157
 158 The optional $filter argument is to allow for testing or explicit
 159 behavior that ignores the System Pref.  Valid values are the same as the
 160 System Pref options.
 161
 162 =cut
 163
 164 # FIXME -- the &decode fcn below should be wrapped into this one.
 165 # FIXME -- these plugins should be moved out of Circulation.pm
 166 #
 167 sub barcodedecode {
 168     my ($barcode, $filter) = @_;
 169     my $branch = C4::Context::mybranch();
 170     $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
 171     $filter or return $barcode;     # ensure filter is defined, else return untouched barcode
 172         if ($filter eq 'whitespace') {
 173                 $barcode =~ s/\s//g;
 174         } elsif ($filter eq 'cuecat') {
 175                 chomp($barcode);
 176             my @fields = split( /\./, $barcode );
 177             my @results = map( decode($_), @fields[ 1 .. $#fields ] );
 178             ($#results == 2) and return $results[2];
 179         } elsif ($filter eq 'T-prefix') {
 180                 if ($barcode =~ /^[Tt](\d)/) {
 181                         (defined($1) and $1 eq '0') and return $barcode;
 182             $barcode = substr($barcode, 2) + 0;     # FIXME: probably should be substr($barcode, 1)
 183                 }
 184         return sprintf("T%07d", $barcode);
 185         # FIXME: $barcode could be "T1", causing warning: substr outside of string
 186         # Why drop the nonzero digit after the T?
 187         # Why pass non-digits (or empty string) to "T%07d"?
 188         } elsif ($filter eq 'libsuite8') {
 189                 unless($barcode =~ m/^($branch)-/i){    #if barcode starts with branch code its in Koha style. Skip it.
 190                         if($barcode =~ m/^(\d)/i){      #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
 191                                 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
 192                         }else{
 193                                 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
 194                         }
 195                 }
 196     } elsif ($filter eq 'EAN13') {
 197         my $ean = CheckDigits('ean');
 198         if ( $ean->is_valid($barcode) ) {
 199             #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
 200             $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
 201         } else {
 202             warn "# [$barcode] not valid EAN-13/UPC-A\n";
 203         }
 204         }
 205     return $barcode;    # return barcode, modified or not
 206 }
 207
 208 =head2 decode
 209
 210   $str = &decode($chunk);
 211
 212 Decodes a segment of a string emitted by a CueCat barcode scanner and
 213 returns it.
 214
 215 FIXME: Should be replaced with Barcode::Cuecat from CPAN
 216 or Javascript based decoding on the client side.
 217
 218 =cut
 219
 220 sub decode {
 221     my ($encoded) = @_;
 222     my $seq =
 223       'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
 224     my @s = map { index( $seq, $_ ); } split( //, $encoded );
 225     my $l = ( $#s + 1 ) % 4;
 226     if ($l) {
 227         if ( $l == 1 ) {
 228             # warn "Error: Cuecat decode parsing failed!";
 229             return;
 230         }
 231         $l = 4 - $l;
 232         $#s += $l;
 233     }
 234     my $r = '';
 235     while ( $#s >= 0 ) {
 236         my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
 237         $r .=
 238             chr( ( $n >> 16 ) ^ 67 )
 239          .chr( ( $n >> 8 & 255 ) ^ 67 )
 240          .chr( ( $n & 255 ) ^ 67 );
 241         @s = @s[ 4 .. $#s ];
 242     }
 243     $r = substr( $r, 0, length($r) - $l );
 244     return $r;
 245 }
 246
 247 =head2 transferbook
 248
 249   ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
 250                                             $barcode, $ignore_reserves);
 251
 252 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
 253
 254 C<$newbranch> is the code for the branch to which the item should be transferred.
 255
 256 C<$barcode> is the barcode of the item to be transferred.
 257
 258 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
 259 Otherwise, if an item is reserved, the transfer fails.
 260
 261 Returns three values:
 262
 263 =over
 264
 265 =item $dotransfer
 266
 267 is true if the transfer was successful.
 268
 269 =item $messages
 270
 271 is a reference-to-hash which may have any of the following keys:
 272
 273 =over
 274
 275 =item C<BadBarcode>
 276
 277 There is no item in the catalog with the given barcode. The value is C<$barcode>.
 278
 279 =item C<IsPermanent>
 280
 281 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.
 282
 283 =item C<DestinationEqualsHolding>
 284
 285 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.
 286
 287 =item C<WasReturned>
 288
 289 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.
 290
 291 =item C<ResFound>
 292
 293 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>.
 294
 295 =item C<WasTransferred>
 296
 297 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
 298
 299 =back
 300
 301 =back
 302
 303 =cut
 304
 305 sub transferbook {
 306     my ( $tbr, $barcode, $ignoreRs ) = @_;
 307     my $messages;
 308     my $dotransfer      = 1;
 309     my $itemnumber = GetItemnumberFromBarcode( $barcode );
 310     my $issue      = GetItemIssue($itemnumber);
 311     my $biblio = GetBiblioFromItemNumber($itemnumber);
 312
 313     # bad barcode..
 314     if ( not $itemnumber ) {
 315         $messages->{'BadBarcode'} = $barcode;
 316         $dotransfer = 0;
 317     }
 318
 319     # get branches of book...
 320     my $hbr = $biblio->{'homebranch'};
 321     my $fbr = $biblio->{'holdingbranch'};
 322
 323     # if using Branch Transfer Limits
 324     if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
 325         if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
 326             if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
 327                 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
 328                 $dotransfer = 0;
 329             }
 330         } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
 331             $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
 332             $dotransfer = 0;
 333         }
 334     }
 335
 336     # if is permanent...
 337     # FIXME Is this still used by someone?
 338     # See other FIXME in AddReturn
 339     my $library = Koha::Libraries->find($hbr);
 340     if ( $library and $library->get_categories->search({'me.categorycode' => 'PE'})->count ) {
 341         $messages->{'IsPermanent'} = $hbr;
 342         $dotransfer = 0;
 343     }
 344
 345     # can't transfer book if is already there....
 346     if ( $fbr eq $tbr ) {
 347         $messages->{'DestinationEqualsHolding'} = 1;
 348         $dotransfer = 0;
 349     }
 350
 351     # check if it is still issued to someone, return it...
 352     if ($issue->{borrowernumber}) {
 353         AddReturn( $barcode, $fbr );
 354         $messages->{'WasReturned'} = $issue->{borrowernumber};
 355     }
 356
 357     # find reserves.....
 358     # That'll save a database query.
 359     my ( $resfound, $resrec, undef ) =
 360       CheckReserves( $itemnumber );
 361     if ( $resfound and not $ignoreRs ) {
 362         $resrec->{'ResFound'} = $resfound;
 363
 364         #         $messages->{'ResFound'} = $resrec;
 365         $dotransfer = 1;
 366     }
 367
 368     #actually do the transfer....
 369     if ($dotransfer) {
 370         ModItemTransfer( $itemnumber, $fbr, $tbr );
 371
 372         # don't need to update MARC anymore, we do it in batch now
 373         $messages->{'WasTransfered'} = 1;
 374
 375     }
 376     ModDateLastSeen( $itemnumber );
 377     return ( $dotransfer, $messages, $biblio );
 378 }
 379
 380
 381 sub TooMany {
 382     my $borrower        = shift;
 383     my $biblionumber = shift;
 384         my $item                = shift;
 385     my $params = shift;
 386     my $onsite_checkout = $params->{onsite_checkout} || 0;
 387     my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
 388     my $cat_borrower    = $borrower->{'categorycode'};
 389     my $dbh             = C4::Context->dbh;
 390         my $branch;
 391         # Get which branchcode we need
 392         $branch = _GetCircControlBranch($item,$borrower);
 393         my $type = (C4::Context->preference('item-level_itypes'))
 394                         ? $item->{'itype'}         # item-level
 395                         : $item->{'itemtype'};     # biblio-level
 396
 397     # given branch, patron category, and item type, determine
 398     # applicable issuing rule
 399     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
 400         {   categorycode => $cat_borrower,
 401             itemtype     => $type,
 402             branchcode   => $branch
 403         }
 404     );
 405
 406
 407     # if a rule is found and has a loan limit set, count
 408     # how many loans the patron already has that meet that
 409     # rule
 410     if (defined($issuing_rule) and defined($issuing_rule->maxissueqty)) {
 411         my @bind_params;
 412         my $count_query = q|
 413             SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
 414             FROM issues
 415             JOIN items USING (itemnumber)
 416         |;
 417
 418         my $rule_itemtype = $issuing_rule->itemtype;
 419         if ($rule_itemtype eq "*") {
 420             # matching rule has the default item type, so count only
 421             # those existing loans that don't fall under a more
 422             # specific rule
 423             if (C4::Context->preference('item-level_itypes')) {
 424                 $count_query .= " WHERE items.itype NOT IN (
 425                                     SELECT itemtype FROM issuingrules
 426                                     WHERE branchcode = ?
 427                                     AND   (categorycode = ? OR categorycode = ?)
 428                                     AND   itemtype <> '*'
 429                                   ) ";
 430             } else {
 431                 $count_query .= " JOIN  biblioitems USING (biblionumber)
 432                                   WHERE biblioitems.itemtype NOT IN (
 433                                     SELECT itemtype FROM issuingrules
 434                                     WHERE branchcode = ?
 435                                     AND   (categorycode = ? OR categorycode = ?)
 436                                     AND   itemtype <> '*'
 437                                   ) ";
 438             }
 439             push @bind_params, $issuing_rule->branchcode;
 440             push @bind_params, $issuing_rule->categorycode;
 441             push @bind_params, $cat_borrower;
 442         } else {
 443             # rule has specific item type, so count loans of that
 444             # specific item type
 445             if (C4::Context->preference('item-level_itypes')) {
 446                 $count_query .= " WHERE items.itype = ? ";
 447             } else {
 448                 $count_query .= " JOIN  biblioitems USING (biblionumber)
 449                                   WHERE biblioitems.itemtype= ? ";
 450             }
 451             push @bind_params, $type;
 452         }
 453
 454         $count_query .= " AND borrowernumber = ? ";
 455         push @bind_params, $borrower->{'borrowernumber'};
 456         my $rule_branch = $issuing_rule->branchcode;
 457         if ($rule_branch ne "*") {
 458             if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
 459                 $count_query .= " AND issues.branchcode = ? ";
 460                 push @bind_params, $branch;
 461             } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
 462                 ; # if branch is the patron's home branch, then count all loans by patron
 463             } else {
 464                 $count_query .= " AND items.homebranch = ? ";
 465                 push @bind_params, $branch;
 466             }
 467         }
 468
 469         my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
 470
 471         my $max_checkouts_allowed = $issuing_rule->maxissueqty;
 472         my $max_onsite_checkouts_allowed = $issuing_rule->maxonsiteissueqty;
 473
 474         if ( $onsite_checkout ) {
 475             if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed )  {
 476                 return {
 477                     reason => 'TOO_MANY_ONSITE_CHECKOUTS',
 478                     count => $onsite_checkout_count,
 479                     max_allowed => $max_onsite_checkouts_allowed,
 480                 }
 481             }
 482         }
 483         if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
 484             my $delta = $switch_onsite_checkout ? 1 : 0;
 485             if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
 486                 return {
 487                     reason => 'TOO_MANY_CHECKOUTS',
 488                     count => $checkout_count,
 489                     max_allowed => $max_checkouts_allowed,
 490                 };
 491             }
 492         } elsif ( not $onsite_checkout ) {
 493             if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )  {
 494                 return {
 495                     reason => 'TOO_MANY_CHECKOUTS',
 496                     count => $checkout_count - $onsite_checkout_count,
 497                     max_allowed => $max_checkouts_allowed,
 498                 };
 499             }
 500         }
 501     }
 502
 503     # Now count total loans against the limit for the branch
 504     my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
 505     if (defined($branch_borrower_circ_rule->{maxissueqty})) {
 506         my @bind_params = ();
 507         my $branch_count_query = q|
 508             SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
 509             FROM issues
 510             JOIN items USING (itemnumber)
 511             WHERE borrowernumber = ?
 512         |;
 513         push @bind_params, $borrower->{borrowernumber};
 514
 515         if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
 516             $branch_count_query .= " AND issues.branchcode = ? ";
 517             push @bind_params, $branch;
 518         } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
 519             ; # if branch is the patron's home branch, then count all loans by patron
 520         } else {
 521             $branch_count_query .= " AND items.homebranch = ? ";
 522             push @bind_params, $branch;
 523         }
 524         my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
 525         my $max_checkouts_allowed = $branch_borrower_circ_rule->{maxissueqty};
 526         my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{maxonsiteissueqty};
 527
 528         if ( $onsite_checkout ) {
 529             if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed )  {
 530                 return {
 531                     reason => 'TOO_MANY_ONSITE_CHECKOUTS',
 532                     count => $onsite_checkout_count,
 533                     max_allowed => $max_onsite_checkouts_allowed,
 534                 }
 535             }
 536         }
 537         if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
 538             my $delta = $switch_onsite_checkout ? 1 : 0;
 539             if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
 540                 return {
 541                     reason => 'TOO_MANY_CHECKOUTS',
 542                     count => $checkout_count,
 543                     max_allowed => $max_checkouts_allowed,
 544                 };
 545             }
 546         } elsif ( not $onsite_checkout ) {
 547             if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )  {
 548                 return {
 549                     reason => 'TOO_MANY_CHECKOUTS',
 550                     count => $checkout_count - $onsite_checkout_count,
 551                     max_allowed => $max_checkouts_allowed,
 552                 };
 553             }
 554         }
 555     }
 556
 557     if ( not defined( $issuing_rule ) and not defined($branch_borrower_circ_rule->{maxissueqty}) ) {
 558         return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
 559     }
 560
 561     # OK, the patron can issue !!!
 562     return;
 563 }
 564
 565 =head2 CanBookBeIssued
 566
 567   ( $issuingimpossible, $needsconfirmation ) =  CanBookBeIssued( $borrower,
 568                       $barcode, $duedate, $inprocess, $ignore_reserves, $params );
 569
 570 Check if a book can be issued.
 571
 572 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
 573
 574 =over 4
 575
 576 =item C<$borrower> hash with borrower informations (from GetMember)
 577
 578 =item C<$barcode> is the bar code of the book being issued.
 579
 580 =item C<$duedates> is a DateTime object.
 581
 582 =item C<$inprocess> boolean switch
 583
 584 =item C<$ignore_reserves> boolean switch
 585
 586 =item C<$params> Hashref of additional parameters
 587
 588 Available keys:
 589     override_high_holds - Ignore high holds
 590     onsite_checkout     - Checkout is an onsite checkout that will not leave the library
 591
 592 =back
 593
 594 Returns :
 595
 596 =over 4
 597
 598 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
 599 Possible values are :
 600
 601 =back
 602
 603 =head3 INVALID_DATE
 604
 605 sticky due date is invalid
 606
 607 =head3 GNA
 608
 609 borrower gone with no address
 610
 611 =head3 CARD_LOST
 612
 613 borrower declared it's card lost
 614
 615 =head3 DEBARRED
 616
 617 borrower debarred
 618
 619 =head3 UNKNOWN_BARCODE
 620
 621 barcode unknown
 622
 623 =head3 NOT_FOR_LOAN
 624
 625 item is not for loan
 626
 627 =head3 WTHDRAWN
 628
 629 item withdrawn.
 630
 631 =head3 RESTRICTED
 632
 633 item is restricted (set by ??)
 634
 635 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
 636 could be prevented, but ones that can be overriden by the operator.
 637
 638 Possible values are :
 639
 640 =head3 DEBT
 641
 642 borrower has debts.
 643
 644 =head3 RENEW_ISSUE
 645
 646 renewing, not issuing
 647
 648 =head3 ISSUED_TO_ANOTHER
 649
 650 issued to someone else.
 651
 652 =head3 RESERVED
 653
 654 reserved for someone else.
 655
 656 =head3 INVALID_DATE
 657
 658 sticky due date is invalid or due date in the past
 659
 660 =head3 TOO_MANY
 661
 662 if the borrower borrows to much things
 663
 664 =cut
 665
 666 sub CanBookBeIssued {
 667     my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
 668     my %needsconfirmation;    # filled with problems that needs confirmations
 669     my %issuingimpossible;    # filled with problems that causes the issue to be IMPOSSIBLE
 670     my %alerts;               # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
 671     my %messages;             # filled with information messages that should be displayed.
 672
 673     my $onsite_checkout     = $params->{onsite_checkout}     || 0;
 674     my $override_high_holds = $params->{override_high_holds} || 0;
 675
 676     my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
 677     my $issue = GetItemIssue($item->{itemnumber});
 678         my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
 679         $item->{'itemtype'}=$item->{'itype'};
 680     my $dbh             = C4::Context->dbh;
 681
 682     # MANDATORY CHECKS - unless item exists, nothing else matters
 683     unless ( $item->{barcode} ) {
 684         $issuingimpossible{UNKNOWN_BARCODE} = 1;
 685     }
 686         return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
 687
 688     #
 689     # DUE DATE is OK ? -- should already have checked.
 690     #
 691     if ($duedate && ref $duedate ne 'DateTime') {
 692         $duedate = dt_from_string($duedate);
 693     }
 694     my $now = DateTime->now( time_zone => C4::Context->tz() );
 695     unless ( $duedate ) {
 696         my $issuedate = $now->clone();
 697
 698         my $branch = _GetCircControlBranch($item,$borrower);
 699         my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
 700         $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
 701
 702         # Offline circ calls AddIssue directly, doesn't run through here
 703         #  So issuingimpossible should be ok.
 704     }
 705     if ($duedate) {
 706         my $today = $now->clone();
 707         $today->truncate( to => 'minute');
 708         if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
 709             $needsconfirmation{INVALID_DATE} = output_pref($duedate);
 710         }
 711     } else {
 712             $issuingimpossible{INVALID_DATE} = output_pref($duedate);
 713     }
 714
 715     #
 716     # BORROWER STATUS
 717     #
 718     if ( $borrower->{'category_type'} eq 'X' && (  $item->{barcode}  )) {
 719         # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1  .
 720         &UpdateStats({
 721                      branch => C4::Context->userenv->{'branch'},
 722                      type => 'localuse',
 723                      itemnumber => $item->{'itemnumber'},
 724                      itemtype => $item->{'itype'},
 725                      borrowernumber => $borrower->{'borrowernumber'},
 726                      ccode => $item->{'ccode'}}
 727                     );
 728         ModDateLastSeen( $item->{'itemnumber'} );
 729         return( { STATS => 1 }, {});
 730     }
 731
 732     my $flags = C4::Members::patronflags( $borrower );
 733     if ( ref $flags ) {
 734         if ( $flags->{GNA} ) {
 735             $issuingimpossible{GNA} = 1;
 736         }
 737         if ( $flags->{'LOST'} ) {
 738             $issuingimpossible{CARD_LOST} = 1;
 739         }
 740         if ( $flags->{'DBARRED'} ) {
 741             $issuingimpossible{DEBARRED} = 1;
 742         }
 743     }
 744     if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
 745         $issuingimpossible{EXPIRED} = 1;
 746     } else {
 747         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'sql', 'floating' );
 748         $expiry_dt->truncate( to => 'day');
 749         my $today = $now->clone()->truncate(to => 'day');
 750         $today->set_time_zone( 'floating' );
 751         if ( DateTime->compare($today, $expiry_dt) == 1 ) {
 752             $issuingimpossible{EXPIRED} = 1;
 753         }
 754     }
 755
 756     #
 757     # BORROWER STATUS
 758     #
 759
 760     # DEBTS
 761     my ($balance, $non_issue_charges, $other_charges) =
 762       C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
 763
 764     my $amountlimit = C4::Context->preference("noissuescharge");
 765     my $allowfineoverride = C4::Context->preference("AllowFineOverride");
 766     my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
 767
 768     # Check the debt of this patrons guarantees
 769     my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
 770     $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
 771     if ( defined $no_issues_charge_guarantees ) {
 772         my $p = Koha::Patrons->find( $borrower->{borrowernumber} );
 773         my @guarantees = $p->guarantees();
 774         my $guarantees_non_issues_charges;
 775         foreach my $g ( @guarantees ) {
 776             my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
 777             $guarantees_non_issues_charges += $n;
 778         }
 779
 780         if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
 781             $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
 782         } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
 783             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
 784         } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
 785             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
 786         }
 787     }
 788
 789     if ( C4::Context->preference("IssuingInProcess") ) {
 790         if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
 791             $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
 792         } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
 793             $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
 794         } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
 795             $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
 796         }
 797     }
 798     else {
 799         if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
 800             $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
 801         } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
 802             $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
 803         } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
 804             $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
 805         }
 806     }
 807
 808     if ($balance > 0 && $other_charges > 0) {
 809         $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
 810     }
 811
 812     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
 813     if ( my $debarred_date = $patron->is_debarred ) {
 814          # patron has accrued fine days or has a restriction. $count is a date
 815         if ($debarred_date eq '9999-12-31') {
 816             $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
 817         }
 818         else {
 819             $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
 820         }
 821     } elsif ( my $num_overdues = $patron->has_overdues ) {
 822         ## patron has outstanding overdue loans
 823         if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
 824             $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
 825         }
 826         elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
 827             $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
 828         }
 829     }
 830
 831     # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
 832     #
 833     my $switch_onsite_checkout = (
 834           C4::Context->preference('SwitchOnSiteCheckouts')
 835       and $issue->{onsite_checkout}
 836       and $issue
 837       and $issue->{borrowernumber} == $borrower->{'borrowernumber'} ? 1 : 0 );
 838     my $toomany = TooMany( $borrower, $item->{biblionumber}, $item, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
 839     # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
 840     if ( $toomany ) {
 841         if ( $toomany->{max_allowed} == 0 ) {
 842             $needsconfirmation{PATRON_CANT} = 1;
 843         }
 844         if ( C4::Context->preference("AllowTooManyOverride") ) {
 845             $needsconfirmation{TOO_MANY} = $toomany->{reason};
 846             $needsconfirmation{current_loan_count} = $toomany->{count};
 847             $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
 848         } else {
 849             $issuingimpossible{TOO_MANY} = $toomany->{reason};
 850             $issuingimpossible{current_loan_count} = $toomany->{count};
 851             $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
 852         }
 853     }
 854
 855     #
 856     # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
 857     #
 858     $patron = Koha::Patrons->find($borrower->{borrowernumber});
 859     my $wants_check = $patron->wants_check_for_previous_checkout;
 860     $needsconfirmation{PREVISSUE} = 1
 861         if ($wants_check and $patron->do_check_for_previous_checkout($item));
 862
 863     #
 864     # ITEM CHECKING
 865     #
 866     if ( $item->{'notforloan'} )
 867     {
 868         if(!C4::Context->preference("AllowNotForLoanOverride")){
 869             $issuingimpossible{NOT_FOR_LOAN} = 1;
 870             $issuingimpossible{item_notforloan} = $item->{'notforloan'};
 871         }else{
 872             $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 873             $needsconfirmation{item_notforloan} = $item->{'notforloan'};
 874         }
 875     }
 876     else {
 877         # we have to check itemtypes.notforloan also
 878         if (C4::Context->preference('item-level_itypes')){
 879             # this should probably be a subroutine
 880             my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
 881             $sth->execute($item->{'itemtype'});
 882             my $notforloan=$sth->fetchrow_hashref();
 883             if ($notforloan->{'notforloan'}) {
 884                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
 885                     $issuingimpossible{NOT_FOR_LOAN} = 1;
 886                     $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
 887                 } else {
 888                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 889                     $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
 890                 }
 891             }
 892         }
 893         elsif ($biblioitem->{'notforloan'} == 1){
 894             if (!C4::Context->preference("AllowNotForLoanOverride")) {
 895                 $issuingimpossible{NOT_FOR_LOAN} = 1;
 896                 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
 897             } else {
 898                 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 899                 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
 900             }
 901         }
 902     }
 903     if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
 904     {
 905         $issuingimpossible{WTHDRAWN} = 1;
 906     }
 907     if (   $item->{'restricted'}
 908         && $item->{'restricted'} == 1 )
 909     {
 910         $issuingimpossible{RESTRICTED} = 1;
 911     }
 912     if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
 913         my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item->{itemlost} });
 914         my $code = $av->count ? $av->next->lib : '';
 915         $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
 916         $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
 917     }
 918     if ( C4::Context->preference("IndependentBranches") ) {
 919         my $userenv = C4::Context->userenv;
 920         unless ( C4::Context->IsSuperLibrarian() ) {
 921             if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
 922                 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
 923                 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
 924             }
 925             $needsconfirmation{BORRNOTSAMEBRANCH} = $borrower->{'branchcode'}
 926               if ( $borrower->{'branchcode'} ne $userenv->{branch} );
 927         }
 928     }
 929     #
 930     # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
 931     #
 932     my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
 933
 934     if ( $rentalConfirmation ){
 935         my ($rentalCharge) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
 936         if ( $rentalCharge > 0 ){
 937             $needsconfirmation{RENTALCHARGE} = $rentalCharge;
 938         }
 939     }
 940
 941     #
 942     # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
 943     #
 944     if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} ){
 945
 946         # Already issued to current borrower.
 947         # If it is an on-site checkout if it can be switched to a normal checkout
 948         # or ask whether the loan should be renewed
 949
 950         if ( $issue->{onsite_checkout}
 951                 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
 952             $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
 953         } else {
 954             my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
 955                 $borrower->{'borrowernumber'},
 956                 $item->{'itemnumber'},
 957             );
 958             if ( $CanBookBeRenewed == 0 ) {    # no more renewals allowed
 959                 if ( $renewerror eq 'onsite_checkout' ) {
 960                     $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
 961                 }
 962                 else {
 963                     $issuingimpossible{NO_MORE_RENEWALS} = 1;
 964                 }
 965             }
 966             else {
 967                 $needsconfirmation{RENEW_ISSUE} = 1;
 968             }
 969         }
 970     }
 971     elsif ($issue->{borrowernumber}) {
 972
 973         # issued to someone else
 974         my $currborinfo =    C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
 975
 976
 977         my ( $can_be_returned, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
 978
 979         unless ( $can_be_returned ) {
 980             $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
 981             $issuingimpossible{branch_to_return} = $message;
 982         } else {
 983             $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
 984             $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
 985             $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
 986             $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
 987             $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
 988         }
 989     }
 990
 991     unless ( $ignore_reserves ) {
 992         # See if the item is on reserve.
 993         my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
 994         if ($restype) {
 995             my $resbor = $res->{'borrowernumber'};
 996             if ( $resbor ne $borrower->{'borrowernumber'} ) {
 997                 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
 998                 if ( $restype eq "Waiting" )
 999                 {
1000                     # The item is on reserve and waiting, but has been
1001                     # reserved by some other patron.
1002                     $needsconfirmation{RESERVE_WAITING} = 1;
1003                     $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1004                     $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1005                     $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1006                     $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1007                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1008                     $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1009                 }
1010                 elsif ( $restype eq "Reserved" ) {
1011                     # The item is on reserve for someone else.
1012                     $needsconfirmation{RESERVED} = 1;
1013                     $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1014                     $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1015                     $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1016                     $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1017                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1018                     $needsconfirmation{'resreservedate'} = $res->{'reservedate'};
1019                 }
1020             }
1021         }
1022     }
1023
1024     ## CHECK AGE RESTRICTION
1025     my $agerestriction  = $biblioitem->{'agerestriction'};
1026     my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $borrower );
1027     if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1028         if ( C4::Context->preference('AgeRestrictionOverride') ) {
1029             $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1030         }
1031         else {
1032             $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1033         }
1034     }
1035
1036     ## check for high holds decreasing loan period
1037     if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1038         my $check = checkHighHolds( $item, $borrower );
1039
1040         if ( $check->{exceeded} ) {
1041             if ($override_high_holds) {
1042                 $alerts{HIGHHOLDS} = {
1043                     num_holds  => $check->{outstanding},
1044                     duration   => $check->{duration},
1045                     returndate => output_pref( $check->{due_date} ),
1046                 };
1047             }
1048             else {
1049                 $needsconfirmation{HIGHHOLDS} = {
1050                     num_holds  => $check->{outstanding},
1051                     duration   => $check->{duration},
1052                     returndate => output_pref( $check->{due_date} ),
1053                 };
1054             }
1055         }
1056     }
1057
1058     if (
1059         !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1060         # don't do the multiple loans per bib check if we've
1061         # already determined that we've got a loan on the same item
1062         !$issuingimpossible{NO_MORE_RENEWALS} &&
1063         !$needsconfirmation{RENEW_ISSUE}
1064     ) {
1065         # Check if borrower has already issued an item from the same biblio
1066         # Only if it's not a subscription
1067         my $biblionumber = $item->{biblionumber};
1068         require C4::Serials;
1069         my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1070         unless ($is_a_subscription) {
1071             my $checkouts = Koha::Checkouts->search(
1072                 {
1073                     borrowernumber => $borrower->{borrowernumber},
1074                     biblionumber   => $biblionumber,
1075                 },
1076                 {
1077                     join => 'item',
1078                 }
1079             );
1080             # if we get here, we don't already have a loan on this item,
1081             # so if there are any loans on this bib, ask for confirmation
1082             if ( $checkouts->count ) {
1083                 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1084             }
1085         }
1086     }
1087
1088     return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1089 }
1090
1091 =head2 CanBookBeReturned
1092
1093   ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1094
1095 Check whether the item can be returned to the provided branch
1096
1097 =over 4
1098
1099 =item C<$item> is a hash of item information as returned from GetItem
1100
1101 =item C<$branch> is the branchcode where the return is taking place
1102
1103 =back
1104
1105 Returns:
1106
1107 =over 4
1108
1109 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1110
1111 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1112
1113 =back
1114
1115 =cut
1116
1117 sub CanBookBeReturned {
1118   my ($item, $branch) = @_;
1119   my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1120
1121   # assume return is allowed to start
1122   my $allowed = 1;
1123   my $message;
1124
1125   # identify all cases where return is forbidden
1126   if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1127      $allowed = 0;
1128      $message = $item->{'homebranch'};
1129   } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1130      $allowed = 0;
1131      $message = $item->{'holdingbranch'};
1132   } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1133      $allowed = 0;
1134      $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1135   }
1136
1137   return ($allowed, $message);
1138 }
1139
1140 =head2 CheckHighHolds
1141
1142     used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1143     decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1144     has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1145
1146 =cut
1147
1148 sub checkHighHolds {
1149     my ( $item, $borrower ) = @_;
1150     my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1151     my $branch = _GetCircControlBranch( $item, $borrower );
1152
1153     my $return_data = {
1154         exceeded    => 0,
1155         outstanding => 0,
1156         duration    => 0,
1157         due_date    => undef,
1158     };
1159
1160     my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1161
1162     if ( $holds->count() ) {
1163         $return_data->{outstanding} = $holds->count();
1164
1165         my $decreaseLoanHighHoldsControl        = C4::Context->preference('decreaseLoanHighHoldsControl');
1166         my $decreaseLoanHighHoldsValue          = C4::Context->preference('decreaseLoanHighHoldsValue');
1167         my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1168
1169         my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1170
1171         if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1172
1173             # static means just more than a given number of holds on the record
1174
1175             # If the number of holds is less than the threshold, we can stop here
1176             if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1177                 return $return_data;
1178             }
1179         }
1180         elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1181
1182             # dynamic means X more than the number of holdable items on the record
1183
1184             # let's get the items
1185             my @items = $holds->next()->biblio()->items();
1186
1187             # Remove any items with status defined to be ignored even if the would not make item unholdable
1188             foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1189                 @items = grep { !$_->$status } @items;
1190             }
1191
1192             # Remove any items that are not holdable for this patron
1193             @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber ) eq 'OK' } @items;
1194
1195             my $items_count = scalar @items;
1196
1197             my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1198
1199             # If the number of holds is less than the count of items we have
1200             # plus the number of holds allowed above that count, we can stop here
1201             if ( $holds->count() <= $threshold ) {
1202                 return $return_data;
1203             }
1204         }
1205
1206         my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1207
1208         my $calendar = Koha::Calendar->new( branchcode => $branch );
1209
1210         my $itype =
1211           ( C4::Context->preference('item-level_itypes') )
1212           ? $biblio->{'itype'}
1213           : $biblio->{'itemtype'};
1214
1215         my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1216
1217         my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1218
1219         my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1220         $reduced_datedue->set_hour($orig_due->hour);
1221         $reduced_datedue->set_minute($orig_due->minute);
1222         $reduced_datedue->truncate( to => 'minute' );
1223
1224         if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1225             $return_data->{exceeded} = 1;
1226             $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1227             $return_data->{due_date} = $reduced_datedue;
1228         }
1229     }
1230
1231     return $return_data;
1232 }
1233
1234 =head2 AddIssue
1235
1236   &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1237
1238 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1239
1240 =over 4
1241
1242 =item C<$borrower> is a hash with borrower informations (from GetMember).
1243
1244 =item C<$barcode> is the barcode of the item being issued.
1245
1246 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1247 Calculated if empty.
1248
1249 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1250
1251 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1252 Defaults to today.  Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1253
1254 AddIssue does the following things :
1255
1256   - step 01: check that there is a borrowernumber & a barcode provided
1257   - check for RENEWAL (book issued & being issued to the same patron)
1258       - renewal YES = Calculate Charge & renew
1259       - renewal NO  =
1260           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1261           * RESERVE PLACED ?
1262               - fill reserve if reserve to this patron
1263               - cancel reserve or not, otherwise
1264           * TRANSFERT PENDING ?
1265               - complete the transfert
1266           * ISSUE THE BOOK
1267
1268 =back
1269
1270 =cut
1271
1272 sub AddIssue {
1273     my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1274
1275     my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1276     my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1277     my $auto_renew = $params && $params->{auto_renew};
1278     my $dbh          = C4::Context->dbh;
1279     my $barcodecheck = CheckValidBarcode($barcode);
1280
1281     my $issue;
1282
1283     if ( $datedue && ref $datedue ne 'DateTime' ) {
1284         $datedue = dt_from_string($datedue);
1285     }
1286
1287     # $issuedate defaults to today.
1288     if ( !defined $issuedate ) {
1289         $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1290     }
1291     else {
1292         if ( ref $issuedate ne 'DateTime' ) {
1293             $issuedate = dt_from_string($issuedate);
1294
1295         }
1296     }
1297
1298     # Stop here if the patron or barcode doesn't exist
1299     if ( $borrower && $barcode && $barcodecheck ) {
1300         # find which item we issue
1301         my $item = GetItem( '', $barcode )
1302           or return;    # if we don't get an Item, abort.
1303
1304         my $branch = _GetCircControlBranch( $item, $borrower );
1305
1306         # get actual issuing if there is one
1307         my $actualissue = GetItemIssue( $item->{itemnumber} );
1308
1309         # get biblioinformation for this item
1310         my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1311
1312         # check if we just renew the issue.
1313         if ( $actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}
1314                 and not $switch_onsite_checkout ) {
1315             $datedue = AddRenewal(
1316                 $borrower->{'borrowernumber'},
1317                 $item->{'itemnumber'},
1318                 $branch,
1319                 $datedue,
1320                 $issuedate,    # here interpreted as the renewal date
1321             );
1322         }
1323         else {
1324             # it's NOT a renewal
1325             if ( $actualissue->{borrowernumber}
1326                     and not $switch_onsite_checkout ) {
1327                 # This book is currently on loan, but not to the person
1328                 # who wants to borrow it now. mark it returned before issuing to the new borrower
1329                 my ( $allowed, $message ) = CanBookBeReturned( $item, C4::Context->userenv->{branch} );
1330                 return unless $allowed;
1331                 AddReturn( $item->{'barcode'}, C4::Context->userenv->{'branch'} );
1332             }
1333
1334             MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1335
1336             # Starting process for transfer job (checking transfert and validate it if we have one)
1337             my ($datesent) = GetTransfers( $item->{'itemnumber'} );
1338             if ($datesent) {
1339                 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1340                 my $sth = $dbh->prepare(
1341                     "UPDATE branchtransfers
1342                         SET datearrived = now(),
1343                         tobranch = ?,
1344                         comments = 'Forced branchtransfer'
1345                     WHERE itemnumber= ? AND datearrived IS NULL"
1346                 );
1347                 $sth->execute( C4::Context->userenv->{'branch'},
1348                     $item->{'itemnumber'} );
1349             }
1350
1351             # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1352             unless ($auto_renew) {
1353                 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1354                     {   categorycode => $borrower->{categorycode},
1355                         itemtype     => $item->{itype},
1356                         branchcode   => $branch
1357                     }
1358                 );
1359
1360                 $auto_renew = $issuing_rule->auto_renew if $issuing_rule;
1361             }
1362
1363             # Record in the database the fact that the book was issued.
1364             unless ($datedue) {
1365                 my $itype =
1366                   ( C4::Context->preference('item-level_itypes') )
1367                   ? $biblio->{'itype'}
1368                   : $biblio->{'itemtype'};
1369                 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1370
1371             }
1372             $datedue->truncate( to => 'minute' );
1373
1374             $issue = Koha::Database->new()->schema()->resultset('Issue')->update_or_create(
1375                 {
1376                     borrowernumber => $borrower->{'borrowernumber'},
1377                     itemnumber     => $item->{'itemnumber'},
1378                     issuedate      => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1379                     date_due       => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1380                     branchcode     => C4::Context->userenv->{'branch'},
1381                     onsite_checkout => $onsite_checkout,
1382                     auto_renew      => $auto_renew ? 1 : 0
1383                 }
1384               );
1385
1386             if ( C4::Context->preference('ReturnToShelvingCart') ) {
1387                 # ReturnToShelvingCart is on, anything issued should be taken off the cart.
1388                 CartToShelf( $item->{'itemnumber'} );
1389             }
1390             $item->{'issues'}++;
1391             if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1392                 UpdateTotalIssues( $item->{'biblionumber'}, 1 );
1393             }
1394
1395             ## If item was lost, it has now been found, reverse any list item charges if necessary.
1396             if ( $item->{'itemlost'} ) {
1397                 if (
1398                     Koha::RefundLostItemFeeRules->should_refund(
1399                         {
1400                             current_branch      => C4::Context->userenv->{branch},
1401                             item_home_branch    => $item->{homebranch},
1402                             item_holding_branch => $item->{holdingbranch}
1403                         }
1404                     )
1405                   )
1406                 {
1407                     _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef,
1408                         $item->{'barcode'} );
1409                 }
1410             }
1411
1412             ModItem(
1413                 {
1414                     issues        => $item->{'issues'},
1415                     holdingbranch => C4::Context->userenv->{'branch'},
1416                     itemlost      => 0,
1417                     onloan        => $datedue->ymd(),
1418                     datelastborrowed => DateTime->now( time_zone => C4::Context->tz() )->ymd(),
1419                 },
1420                 $item->{'biblionumber'},
1421                 $item->{'itemnumber'}
1422             );
1423             ModDateLastSeen( $item->{'itemnumber'} );
1424
1425            # If it costs to borrow this book, charge it to the patron's account.
1426             my ( $charge, $itemtype ) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1427             if ( $charge > 0 ) {
1428                 AddIssuingCharge( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $charge );
1429                 $item->{'charge'} = $charge;
1430             }
1431
1432             # Record the fact that this book was issued.
1433             &UpdateStats(
1434                 {
1435                     branch => C4::Context->userenv->{'branch'},
1436                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1437                     amount         => $charge,
1438                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1439                     itemnumber     => $item->{'itemnumber'},
1440                     itemtype       => $item->{'itype'},
1441                     borrowernumber => $borrower->{'borrowernumber'},
1442                     ccode          => $item->{'ccode'}
1443                 }
1444             );
1445
1446             # Send a checkout slip.
1447             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1448             my %conditions        = (
1449                 branchcode   => $branch,
1450                 categorycode => $borrower->{categorycode},
1451                 item_type    => $item->{itype},
1452                 notification => 'CHECKOUT',
1453             );
1454             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1455                 SendCirculationAlert(
1456                     {
1457                         type     => 'CHECKOUT',
1458                         item     => $item,
1459                         borrower => $borrower,
1460                         branch   => $branch,
1461                     }
1462                 );
1463             }
1464         }
1465
1466         logaction(
1467             "CIRCULATION", "ISSUE",
1468             $borrower->{'borrowernumber'},
1469             $biblio->{'itemnumber'}
1470         ) if C4::Context->preference("IssueLog");
1471     }
1472     return $issue;
1473 }
1474
1475 =head2 GetLoanLength
1476
1477   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1478
1479 Get loan length for an itemtype, a borrower type and a branch
1480
1481 =cut
1482
1483 sub GetLoanLength {
1484     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1485     my $dbh = C4::Context->dbh;
1486     my $sth = $dbh->prepare(qq{
1487         SELECT issuelength, lengthunit, renewalperiod
1488         FROM issuingrules
1489         WHERE   categorycode=?
1490             AND itemtype=?
1491             AND branchcode=?
1492             AND issuelength IS NOT NULL
1493     });
1494
1495     # try to find issuelength & return the 1st available.
1496     # check with borrowertype, itemtype and branchcode, then without one of those parameters
1497     $sth->execute( $borrowertype, $itemtype, $branchcode );
1498     my $loanlength = $sth->fetchrow_hashref;
1499
1500     return $loanlength
1501       if defined($loanlength) && defined $loanlength->{issuelength};
1502
1503     $sth->execute( $borrowertype, '*', $branchcode );
1504     $loanlength = $sth->fetchrow_hashref;
1505     return $loanlength
1506       if defined($loanlength) && defined $loanlength->{issuelength};
1507
1508     $sth->execute( '*', $itemtype, $branchcode );
1509     $loanlength = $sth->fetchrow_hashref;
1510     return $loanlength
1511       if defined($loanlength) && defined $loanlength->{issuelength};
1512
1513     $sth->execute( '*', '*', $branchcode );
1514     $loanlength = $sth->fetchrow_hashref;
1515     return $loanlength
1516       if defined($loanlength) && defined $loanlength->{issuelength};
1517
1518     $sth->execute( $borrowertype, $itemtype, '*' );
1519     $loanlength = $sth->fetchrow_hashref;
1520     return $loanlength
1521       if defined($loanlength) && defined $loanlength->{issuelength};
1522
1523     $sth->execute( $borrowertype, '*', '*' );
1524     $loanlength = $sth->fetchrow_hashref;
1525     return $loanlength
1526       if defined($loanlength) && defined $loanlength->{issuelength};
1527
1528     $sth->execute( '*', $itemtype, '*' );
1529     $loanlength = $sth->fetchrow_hashref;
1530     return $loanlength
1531       if defined($loanlength) && defined $loanlength->{issuelength};
1532
1533     $sth->execute( '*', '*', '*' );
1534     $loanlength = $sth->fetchrow_hashref;
1535     return $loanlength
1536       if defined($loanlength) && defined $loanlength->{issuelength};
1537
1538     # if no rule is set => 0 day (hardcoded)
1539     return {
1540         issuelength => 0,
1541         renewalperiod => 0,
1542         lengthunit => 'days',
1543     };
1544
1545 }
1546
1547
1548 =head2 GetHardDueDate
1549
1550   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1551
1552 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1553
1554 =cut
1555
1556 sub GetHardDueDate {
1557     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1558
1559     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1560         {   categorycode => $borrowertype,
1561             itemtype     => $itemtype,
1562             branchcode   => $branchcode
1563         }
1564     );
1565
1566
1567     if ( defined( $issuing_rule ) ) {
1568         if ( $issuing_rule->hardduedate ) {
1569             return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1570         } else {
1571             return (undef, undef);
1572         }
1573     }
1574 }
1575
1576 =head2 GetBranchBorrowerCircRule
1577
1578   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1579
1580 Retrieves circulation rule attributes that apply to the given
1581 branch and patron category, regardless of item type.
1582 The return value is a hashref containing the following key:
1583
1584 maxissueqty - maximum number of loans that a
1585 patron of the given category can have at the given
1586 branch.  If the value is undef, no limit.
1587
1588 maxonsiteissueqty - maximum of on-site checkouts that a
1589 patron of the given category can have at the given
1590 branch.  If the value is undef, no limit.
1591
1592 This will first check for a specific branch and
1593 category match from branch_borrower_circ_rules.
1594
1595 If no rule is found, it will then check default_branch_circ_rules
1596 (same branch, default category).  If no rule is found,
1597 it will then check default_borrower_circ_rules (default
1598 branch, same category), then failing that, default_circ_rules
1599 (default branch, default category).
1600
1601 If no rule has been found in the database, it will default to
1602 the buillt in rule:
1603
1604 maxissueqty - undef
1605 maxonsiteissueqty - undef
1606
1607 C<$branchcode> and C<$categorycode> should contain the
1608 literal branch code and patron category code, respectively - no
1609 wildcards.
1610
1611 =cut
1612
1613 sub GetBranchBorrowerCircRule {
1614     my ( $branchcode, $categorycode ) = @_;
1615
1616     my $rules;
1617     my $dbh = C4::Context->dbh();
1618     $rules = $dbh->selectrow_hashref( q|
1619         SELECT maxissueqty, maxonsiteissueqty
1620         FROM branch_borrower_circ_rules
1621         WHERE branchcode = ?
1622         AND   categorycode = ?
1623     |, {}, $branchcode, $categorycode ) ;
1624     return $rules if $rules;
1625
1626     # try same branch, default borrower category
1627     $rules = $dbh->selectrow_hashref( q|
1628         SELECT maxissueqty, maxonsiteissueqty
1629         FROM default_branch_circ_rules
1630         WHERE branchcode = ?
1631     |, {}, $branchcode ) ;
1632     return $rules if $rules;
1633
1634     # try default branch, same borrower category
1635     $rules = $dbh->selectrow_hashref( q|
1636         SELECT maxissueqty, maxonsiteissueqty
1637         FROM default_borrower_circ_rules
1638         WHERE categorycode = ?
1639     |, {}, $categorycode ) ;
1640     return $rules if $rules;
1641
1642     # try default branch, default borrower category
1643     $rules = $dbh->selectrow_hashref( q|
1644         SELECT maxissueqty, maxonsiteissueqty
1645         FROM default_circ_rules
1646     |, {} );
1647     return $rules if $rules;
1648
1649     # built-in default circulation rule
1650     return {
1651         maxissueqty => undef,
1652         maxonsiteissueqty => undef,
1653     };
1654 }
1655
1656 =head2 GetBranchItemRule
1657
1658   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1659
1660 Retrieves circulation rule attributes that apply to the given
1661 branch and item type, regardless of patron category.
1662
1663 The return value is a hashref containing the following keys:
1664
1665 holdallowed => Hold policy for this branch and itemtype. Possible values:
1666   0: No holds allowed.
1667   1: Holds allowed only by patrons that have the same homebranch as the item.
1668   2: Holds allowed from any patron.
1669
1670 returnbranch => branch to which to return item.  Possible values:
1671   noreturn: do not return, let item remain where checked in (floating collections)
1672   homebranch: return to item's home branch
1673   holdingbranch: return to issuer branch
1674
1675 This searches branchitemrules in the following order:
1676
1677   * Same branchcode and itemtype
1678   * Same branchcode, itemtype '*'
1679   * branchcode '*', same itemtype
1680   * branchcode and itemtype '*'
1681
1682 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1683
1684 =cut
1685
1686 sub GetBranchItemRule {
1687     my ( $branchcode, $itemtype ) = @_;
1688     my $dbh = C4::Context->dbh();
1689     my $result = {};
1690
1691     my @attempts = (
1692         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1693             FROM branch_item_rules
1694             WHERE branchcode = ?
1695               AND itemtype = ?', $branchcode, $itemtype],
1696         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1697             FROM default_branch_circ_rules
1698             WHERE branchcode = ?', $branchcode],
1699         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1700             FROM default_branch_item_rules
1701             WHERE itemtype = ?', $itemtype],
1702         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1703             FROM default_circ_rules'],
1704     );
1705
1706     foreach my $attempt (@attempts) {
1707         my ($query, @bind_params) = @{$attempt};
1708         my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1709           or next;
1710
1711         # Since branch/category and branch/itemtype use the same per-branch
1712         # defaults tables, we have to check that the key we want is set, not
1713         # just that a row was returned
1714         $result->{'holdallowed'}  = $search_result->{'holdallowed'}  unless ( defined $result->{'holdallowed'} );
1715         $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1716         $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1717     }
1718
1719     # built-in default circulation rule
1720     $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1721     $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1722     $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1723
1724     return $result;
1725 }
1726
1727 =head2 AddReturn
1728
1729   ($doreturn, $messages, $iteminformation, $borrower) =
1730       &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1731
1732 Returns a book.
1733
1734 =over 4
1735
1736 =item C<$barcode> is the bar code of the book being returned.
1737
1738 =item C<$branch> is the code of the branch where the book is being returned.
1739
1740 =item C<$exemptfine> indicates that overdue charges for the item will be
1741 removed. Optional.
1742
1743 =item C<$dropbox> indicates that the check-in date is assumed to be
1744 yesterday, or the last non-holiday as defined in C4::Calendar .  If
1745 overdue charges are applied and C<$dropbox> is true, the last charge
1746 will be removed.  This assumes that the fines accrual script has run
1747 for _today_. Optional.
1748
1749 =item C<$return_date> allows the default return date to be overridden
1750 by the given return date. Optional.
1751
1752 =back
1753
1754 C<&AddReturn> returns a list of four items:
1755
1756 C<$doreturn> is true iff the return succeeded.
1757
1758 C<$messages> is a reference-to-hash giving feedback on the operation.
1759 The keys of the hash are:
1760
1761 =over 4
1762
1763 =item C<BadBarcode>
1764
1765 No item with this barcode exists. The value is C<$barcode>.
1766
1767 =item C<NotIssued>
1768
1769 The book is not currently on loan. The value is C<$barcode>.
1770
1771 =item C<IsPermanent>
1772
1773 The book's home branch is a permanent collection. If you have borrowed
1774 this book, you are not allowed to return it. The value is the code for
1775 the book's home branch.
1776
1777 =item C<withdrawn>
1778
1779 This book has been withdrawn/cancelled. The value should be ignored.
1780
1781 =item C<Wrongbranch>
1782
1783 This book has was returned to the wrong branch.  The value is a hashref
1784 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1785 contain the branchcode of the incorrect and correct return library, respectively.
1786
1787 =item C<ResFound>
1788
1789 The item was reserved. The value is a reference-to-hash whose keys are
1790 fields from the reserves table of the Koha database, and
1791 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1792 either C<Waiting>, C<Reserved>, or 0.
1793
1794 =item C<WasReturned>
1795
1796 Value 1 if return is successful.
1797
1798 =item C<NeedsTransfer>
1799
1800 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1801
1802 =back
1803
1804 C<$iteminformation> is a reference-to-hash, giving information about the
1805 returned item from the issues table.
1806
1807 C<$borrower> is a reference-to-hash, giving information about the
1808 patron who last borrowed the book.
1809
1810 =cut
1811
1812 sub AddReturn {
1813     my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1814
1815     if ($branch and not Koha::Libraries->find($branch)) {
1816         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1817         undef $branch;
1818     }
1819     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1820     my $messages;
1821     my $borrower;
1822     my $doreturn       = 1;
1823     my $validTransfert = 0;
1824     my $stat_type = 'return';
1825
1826     # get information on item
1827     my $item = GetItem( undef, $barcode );
1828     unless ($item) {
1829         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1830     }
1831
1832     my $itemnumber = $item->{ itemnumber };
1833
1834     my $item_level_itypes = C4::Context->preference("item-level_itypes");
1835     my $biblio   = $item_level_itypes ? undef : GetBiblioData( $item->{ biblionumber } ); # don't get bib data unless we need it
1836     my $itemtype = $item_level_itypes ? $item->{itype} : $biblio->{itemtype};
1837
1838     my $issue  = GetItemIssue($itemnumber);
1839     if ($issue and $issue->{borrowernumber}) {
1840         $borrower = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} )
1841             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '$issue->{borrowernumber}'\n"
1842                 . Dumper($issue) . "\n";
1843     } else {
1844         $messages->{'NotIssued'} = $barcode;
1845         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1846         $doreturn = 0;
1847         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1848         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1849         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1850            $messages->{'LocalUse'} = 1;
1851            $stat_type = 'localuse';
1852         }
1853     }
1854
1855     if ( $item->{'location'} eq 'PROC' ) {
1856         if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1857             $item->{'location'} = 'CART';
1858         }
1859         else {
1860             $item->{location} = $item->{permanent_location};
1861         }
1862
1863         ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
1864     }
1865
1866         # full item data, but no borrowernumber or checkout info (no issue)
1867         # we know GetItem should work because GetItemnumberFromBarcode worked
1868     my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1869         # get the proper branch to which to return the item
1870     my $returnbranch = $item->{$hbr} || $branch ;
1871         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1872
1873     my $borrowernumber = $borrower->{'borrowernumber'} || undef;    # we don't know if we had a borrower or not
1874
1875     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1876     if ($yaml) {
1877         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
1878         my $rules;
1879         eval { $rules = YAML::Load($yaml); };
1880         if ($@) {
1881             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1882         }
1883         else {
1884             foreach my $key ( keys %$rules ) {
1885                 if ( $item->{notforloan} eq $key ) {
1886                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1887                     ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1888                     last;
1889                 }
1890             }
1891         }
1892     }
1893
1894
1895     # check if the book is in a permanent collection....
1896     # FIXME -- This 'PE' attribute is largely undocumented.  afaict, there's no user interface that reflects this functionality.
1897     if ( $returnbranch ) {
1898         my $library = Koha::Libraries->find($returnbranch);
1899         if ( $library and $library->get_categories->search({'me.categorycode' => 'PE'})->count ) {
1900             $messages->{'IsPermanent'} = $returnbranch;
1901         }
1902     }
1903
1904     # check if the return is allowed at this branch
1905     my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1906     unless ($returnallowed){
1907         $messages->{'Wrongbranch'} = {
1908             Wrongbranch => $branch,
1909             Rightbranch => $message
1910         };
1911         $doreturn = 0;
1912         return ( $doreturn, $messages, $issue, $borrower );
1913     }
1914
1915     if ( $item->{'withdrawn'} ) { # book has been cancelled
1916         $messages->{'withdrawn'} = 1;
1917         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1918     }
1919
1920     # case of a return of document (deal with issues and holdingbranch)
1921     my $today = DateTime->now( time_zone => C4::Context->tz() );
1922
1923     if ($doreturn) {
1924         my $datedue = $issue->{date_due};
1925         $borrower or warn "AddReturn without current borrower";
1926                 my $circControlBranch;
1927         if ($dropbox) {
1928             # define circControlBranch only if dropbox mode is set
1929             # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1930             # FIXME: check issuedate > returndate, factoring in holidays
1931
1932             $circControlBranch = _GetCircControlBranch($item,$borrower);
1933             $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $dropboxdate ) == -1 ? 1 : 0;
1934         }
1935
1936         if ($borrowernumber) {
1937             if ( ( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'} ) || $return_date ) {
1938                 _CalculateAndUpdateFine( { issue => $issue, item => $item, borrower => $borrower, return_date => $return_date } );
1939             }
1940
1941             eval {
1942                 my $issue_id = MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1943                     $circControlBranch, $return_date, $borrower->{'privacy'} );
1944                 $issue->{issue_id} = $issue_id;
1945             };
1946             if ( $@ ) {
1947                 $messages->{'Wrongbranch'} = {
1948                     Wrongbranch => $branch,
1949                     Rightbranch => $message
1950                 };
1951                 carp $@;
1952                 return ( 0, { WasReturned => 0 }, $issue, $borrower );
1953             }
1954
1955             # FIXME is the "= 1" right?  This could be the borrower hash.
1956             $messages->{'WasReturned'} = 1;
1957
1958         }
1959
1960         ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1961     }
1962
1963     # the holdingbranch is updated if the document is returned to another location.
1964     # this is always done regardless of whether the item was on loan or not
1965     my $item_holding_branch = $item->{ holdingbranch };
1966     if ($item->{'holdingbranch'} ne $branch) {
1967         UpdateHoldingbranch($branch, $item->{'itemnumber'});
1968         $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1969     }
1970     ModDateLastSeen( $item->{'itemnumber'} );
1971
1972     # check if we have a transfer for this document
1973     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1974
1975     # if we have a transfer to do, we update the line of transfers with the datearrived
1976     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1977     if ($datesent) {
1978         if ( $tobranch eq $branch ) {
1979             my $sth = C4::Context->dbh->prepare(
1980                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1981             );
1982             $sth->execute( $item->{'itemnumber'} );
1983             # if we have a reservation with valid transfer, we can set it's status to 'W'
1984             ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1985             C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1986         } else {
1987             $messages->{'WrongTransfer'}     = $tobranch;
1988             $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1989         }
1990         $validTransfert = 1;
1991     } else {
1992         ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1993     }
1994
1995     # fix up the accounts.....
1996     if ( $item->{'itemlost'} ) {
1997         $messages->{'WasLost'} = 1;
1998
1999         if ( $item->{'itemlost'} ) {
2000             if (
2001                 Koha::RefundLostItemFeeRules->should_refund(
2002                     {
2003                         current_branch      => C4::Context->userenv->{branch},
2004                         item_home_branch    => $item->{homebranch},
2005                         item_holding_branch => $item_holding_branch
2006                     }
2007                 )
2008               )
2009             {
2010                 _FixAccountForLostAndReturned( $item->{'itemnumber'}, $borrowernumber, $barcode );
2011                 $messages->{'LostItemFeeRefunded'} = 1;
2012             }
2013         }
2014     }
2015
2016     # fix up the overdues in accounts...
2017     if ($borrowernumber) {
2018         my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
2019         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!";  # zero is OK, check defined
2020
2021         if ( $issue->{overdue} && $issue->{date_due} ) {
2022         # fix fine days
2023             $today = $dropboxdate if $dropbox;
2024             my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
2025             if ($reminder){
2026                 $messages->{'PrevDebarred'} = $debardate;
2027             } else {
2028                 $messages->{'Debarred'} = $debardate if $debardate;
2029             }
2030         # there's no overdue on the item but borrower had been previously debarred
2031         } elsif ( $issue->{date_due} and $borrower->{'debarred'} ) {
2032              if ( $borrower->{debarred} eq "9999-12-31") {
2033                 $messages->{'ForeverDebarred'} = $borrower->{'debarred'};
2034              } else {
2035                   my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2036                   $borrower_debar_dt->truncate(to => 'day');
2037                   my $today_dt = $today->clone()->truncate(to => 'day');
2038                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2039                       $messages->{'PrevDebarred'} = $borrower->{'debarred'};
2040                   }
2041              }
2042         }
2043     }
2044
2045     # find reserves.....
2046     # if we don't have a reserve with the status W, we launch the Checkreserves routine
2047     my ($resfound, $resrec);
2048     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2049     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2050     if ($resfound) {
2051           $resrec->{'ResFound'} = $resfound;
2052         $messages->{'ResFound'} = $resrec;
2053     }
2054
2055     # Record the fact that this book was returned.
2056     UpdateStats({
2057         branch         => $branch,
2058         type           => $stat_type,
2059         itemnumber     => $itemnumber,
2060         itemtype       => $itemtype,
2061         borrowernumber => $borrowernumber,
2062         ccode          => $item->{ ccode }
2063     });
2064
2065     # Send a check-in slip. # NOTE: borrower may be undef.  probably shouldn't try to send messages then.
2066     my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2067     my %conditions = (
2068         branchcode   => $branch,
2069         categorycode => $borrower->{categorycode},
2070         item_type    => $item->{itype},
2071         notification => 'CHECKIN',
2072     );
2073     if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2074         SendCirculationAlert({
2075             type     => 'CHECKIN',
2076             item     => $item,
2077             borrower => $borrower,
2078             branch   => $branch,
2079         });
2080     }
2081
2082     logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2083         if C4::Context->preference("ReturnLog");
2084
2085     # Remove any OVERDUES related debarment if the borrower has no overdues
2086     if ( $borrowernumber
2087       && $borrower->{'debarred'}
2088       && C4::Context->preference('AutoRemoveOverduesRestrictions')
2089       && !Koha::Patrons->find( $borrowernumber )->has_overdues
2090       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2091     ) {
2092         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2093     }
2094
2095     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2096     if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2097         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2098             (C4::Context->preference("UseBranchTransferLimits") and
2099              ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2100            )) {
2101             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2102             $debug and warn "item: " . Dumper($item);
2103             ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2104             $messages->{'WasTransfered'} = 1;
2105         } else {
2106             $messages->{'NeedsTransfer'} = $returnbranch;
2107         }
2108     }
2109
2110     return ( $doreturn, $messages, $issue, $borrower );
2111 }
2112
2113 =head2 MarkIssueReturned
2114
2115   MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2116
2117 Unconditionally marks an issue as being returned by
2118 moving the C<issues> row to C<old_issues> and
2119 setting C<returndate> to the current date, or
2120 the last non-holiday date of the branccode specified in
2121 C<dropbox_branch> .  Assumes you've already checked that
2122 it's safe to do this, i.e. last non-holiday > issuedate.
2123
2124 if C<$returndate> is specified (in iso format), it is used as the date
2125 of the return. It is ignored when a dropbox_branch is passed in.
2126
2127 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2128 the old_issue is immediately anonymised
2129
2130 Ideally, this function would be internal to C<C4::Circulation>,
2131 not exported, but it is currently needed by one
2132 routine in C<C4::Accounts>.
2133
2134 =cut
2135
2136 sub MarkIssueReturned {
2137     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2138
2139     my $anonymouspatron;
2140     if ( $privacy == 2 ) {
2141         # The default of 0 will not work due to foreign key constraints
2142         # The anonymisation will fail if AnonymousPatron is not a valid entry
2143         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2144         # Note that a warning should appear on the about page (System information tab).
2145         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2146         die "Fatal error: the patron ($borrowernumber) has requested their circulation history be anonymized on check-in, but the AnonymousPatron system preference is empty or not set correctly."
2147             unless C4::Members::GetMember( borrowernumber => $anonymouspatron );
2148     }
2149     my $database = Koha::Database->new();
2150     my $schema   = $database->schema;
2151     my $dbh   = C4::Context->dbh;
2152
2153     my $issue_id = $dbh->selectrow_array(
2154         q|SELECT issue_id FROM issues WHERE itemnumber = ?|,
2155         undef, $itemnumber
2156     );
2157
2158     my $query = 'UPDATE issues SET returndate=';
2159     my @bind;
2160     if ($dropbox_branch) {
2161         my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2162         my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2163         $query .= ' ? ';
2164         push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2165     } elsif ($returndate) {
2166         $query .= ' ? ';
2167         push @bind, $returndate;
2168     } else {
2169         $query .= ' now() ';
2170     }
2171     $query .= ' WHERE issue_id = ?';
2172     push @bind, $issue_id;
2173
2174     # FIXME Improve the return value and handle it from callers
2175     $schema->txn_do(sub {
2176         $dbh->do( $query, undef, @bind );
2177
2178         my $id_already_exists = $dbh->selectrow_array(
2179             q|SELECT COUNT(*) FROM old_issues WHERE issue_id = ?|,
2180             undef, $issue_id
2181         );
2182
2183         if ( $id_already_exists ) {
2184             my $new_issue_id = $dbh->selectrow_array(q|SELECT MAX(issue_id)+1 FROM old_issues|);
2185             $dbh->do(
2186                 q|UPDATE issues SET issue_id = ? WHERE issue_id = ?|,
2187                 undef, $new_issue_id, $issue_id
2188             );
2189             $issue_id = $new_issue_id;
2190         }
2191
2192         $dbh->do(q|INSERT INTO old_issues SELECT * FROM issues WHERE issue_id = ?|, undef, $issue_id);
2193
2194         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2195         if ( $privacy == 2) {
2196             $dbh->do(q|UPDATE old_issues SET borrowernumber=? WHERE issue_id = ?|, undef, $anonymouspatron, $issue_id);
2197         }
2198
2199         $dbh->do(q|DELETE FROM issues WHERE issue_id = ?|, undef, $issue_id);
2200
2201         ModItem( { 'onloan' => undef }, undef, $itemnumber );
2202
2203         if ( C4::Context->preference('StoreLastBorrower') ) {
2204             my $item = Koha::Items->find( $itemnumber );
2205             my $patron = Koha::Patrons->find( $borrowernumber );
2206             $item->last_returned_by( $patron );
2207         }
2208     });
2209
2210     return $issue_id;
2211 }
2212
2213 =head2 _debar_user_on_return
2214
2215     _debar_user_on_return($borrower, $item, $datedue, today);
2216
2217 C<$borrower> borrower hashref
2218
2219 C<$item> item hashref
2220
2221 C<$datedue> date due DateTime object
2222
2223 C<$return_date> DateTime object representing the return time
2224
2225 Internal function, called only by AddReturn that calculates and updates
2226  the user fine days, and debars them if necessary.
2227
2228 Should only be called for overdue returns
2229
2230 =cut
2231
2232 sub _debar_user_on_return {
2233     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2234
2235     my $branchcode = _GetCircControlBranch( $item, $borrower );
2236
2237     my $circcontrol = C4::Context->preference('CircControl');
2238     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2239         {   categorycode => $borrower->{categorycode},
2240             itemtype     => $item->{itype},
2241             branchcode   => $branchcode
2242         }
2243     );
2244     my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2245     my $unit     = $issuing_rule ? $issuing_rule->lengthunit : undef;
2246     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2247
2248     if ($finedays) {
2249
2250         # finedays is in days, so hourly loans must multiply by 24
2251         # thus 1 hour late equals 1 day suspension * finedays rate
2252         $finedays = $finedays * 24 if ( $unit eq 'hours' );
2253
2254         # grace period is measured in the same units as the loan
2255         my $grace =
2256           DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2257
2258         my $deltadays = DateTime::Duration->new(
2259             days => $chargeable_units
2260         );
2261         if ( $deltadays->subtract($grace)->is_positive() ) {
2262             my $suspension_days = $deltadays * $finedays;
2263
2264             # If the max suspension days is < than the suspension days
2265             # the suspension days is limited to this maximum period.
2266             my $max_sd = $issuing_rule->maxsuspensiondays;
2267             if ( defined $max_sd ) {
2268                 $max_sd = DateTime::Duration->new( days => $max_sd );
2269                 $suspension_days = $max_sd
2270                   if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2271             }
2272
2273             my ( $has_been_extended, $is_a_reminder );
2274             if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2275                 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2276                 if ( $debarment ) {
2277                     $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2278                     $has_been_extended = 1;
2279                 }
2280             }
2281
2282             my $new_debar_dt =
2283               $return_date->clone()->add_duration( $suspension_days );
2284
2285             Koha::Patron::Debarments::AddUniqueDebarment({
2286                 borrowernumber => $borrower->{borrowernumber},
2287                 expiration     => $new_debar_dt->ymd(),
2288                 type           => 'SUSPENSION',
2289             });
2290             # if borrower was already debarred but does not get an extra debarment
2291             my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2292             my $new_debarment_str;
2293             if ( $borrower->{debarred} eq $patron->is_debarred ) {
2294                 $is_a_reminder = 1;
2295                 $new_debarment_str = $borrower->{debarred};
2296             } else {
2297                 $new_debarment_str = $new_debar_dt->ymd();
2298             }
2299             # FIXME Should return a DateTime object
2300             return $new_debarment_str, $is_a_reminder;
2301         }
2302     }
2303     return;
2304 }
2305
2306 =head2 _FixOverduesOnReturn
2307
2308    &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2309
2310 C<$brn> borrowernumber
2311
2312 C<$itm> itemnumber
2313
2314 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2315 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2316
2317 Internal function, called only by AddReturn
2318
2319 =cut
2320
2321 sub _FixOverduesOnReturn {
2322     my ($borrowernumber, $item);
2323     unless ($borrowernumber = shift) {
2324         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2325         return;
2326     }
2327     unless ($item = shift) {
2328         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2329         return;
2330     }
2331     my ($exemptfine, $dropbox) = @_;
2332     my $dbh = C4::Context->dbh;
2333
2334     # check for overdue fine
2335     my $sth = $dbh->prepare(
2336 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2337     );
2338     $sth->execute( $borrowernumber, $item );
2339
2340     # alter fine to show that the book has been returned
2341     my $data = $sth->fetchrow_hashref;
2342     return 0 unless $data;    # no warning, there's just nothing to fix
2343
2344     my $uquery;
2345     my @bind = ($data->{'accountlines_id'});
2346     if ($exemptfine) {
2347         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2348         if (C4::Context->preference("FinesLog")) {
2349             &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2350         }
2351     } elsif ($dropbox && $data->{lastincrement}) {
2352         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2353         my $amt = $data->{amount} - $data->{lastincrement} ;
2354         if (C4::Context->preference("FinesLog")) {
2355             &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2356         }
2357          $uquery = "update accountlines set accounttype='F' ";
2358          if($outstanding  >= 0 && $amt >=0) {
2359             $uquery .= ", amount = ? , amountoutstanding=? ";
2360             unshift @bind, ($amt, $outstanding) ;
2361         }
2362     } else {
2363         $uquery = "update accountlines set accounttype='F' ";
2364     }
2365     $uquery .= " where (accountlines_id = ?)";
2366     my $usth = $dbh->prepare($uquery);
2367     return $usth->execute(@bind);
2368 }
2369
2370 =head2 _FixAccountForLostAndReturned
2371
2372   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2373
2374 Calculates the charge for a book lost and returned.
2375
2376 Internal function, not exported, called only by AddReturn.
2377
2378 FIXME: This function reflects how inscrutable fines logic is.  Fix both.
2379 FIXME: Give a positive return value on success.  It might be the $borrowernumber who received credit, or the amount forgiven.
2380
2381 =cut
2382
2383 sub _FixAccountForLostAndReturned {
2384     my $itemnumber     = shift or return;
2385     my $borrowernumber = @_ ? shift : undef;
2386     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2387     my $dbh = C4::Context->dbh;
2388     # check for charge made for lost book
2389     my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2390     $sth->execute($itemnumber);
2391     my $data = $sth->fetchrow_hashref;
2392     $data or return;    # bail if there is nothing to do
2393     $data->{accounttype} eq 'W' and return;    # Written off
2394
2395     # writeoff this amount
2396     my $offset;
2397     my $amount = $data->{'amount'};
2398     my $acctno = $data->{'accountno'};
2399     my $amountleft;                                             # Starts off undef/zero.
2400     if ($data->{'amountoutstanding'} == $amount) {
2401         $offset     = $data->{'amount'};
2402         $amountleft = 0;                                        # Hey, it's zero here, too.
2403     } else {
2404         $offset     = $amount - $data->{'amountoutstanding'};   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2405         $amountleft = $data->{'amountoutstanding'} - $amount;   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2406     }
2407     my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2408         WHERE (accountlines_id = ?)");
2409     $usth->execute($data->{'accountlines_id'});      # We might be adjusting an account for some OTHER borrowernumber now.  Not the one we passed in.
2410     #check if any credit is left if so writeoff other accounts
2411     my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2412     $amountleft *= -1 if ($amountleft < 0);
2413     if ($amountleft > 0) {
2414         my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2415                             AND (amountoutstanding >0) ORDER BY date");     # might want to order by amountoustanding ASC (pay smallest first)
2416         $msth->execute($data->{'borrowernumber'});
2417         # offset transactions
2418         my $newamtos;
2419         my $accdata;
2420         while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2421             if ($accdata->{'amountoutstanding'} < $amountleft) {
2422                 $newamtos = 0;
2423                 $amountleft -= $accdata->{'amountoutstanding'};
2424             }  else {
2425                 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2426                 $amountleft = 0;
2427             }
2428             my $thisacct = $accdata->{'accountlines_id'};
2429             # FIXME: move prepares outside while loop!
2430             my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2431                     WHERE (accountlines_id = ?)");
2432             $usth->execute($newamtos,$thisacct);
2433             $usth = $dbh->prepare("INSERT INTO accountoffsets
2434                 (borrowernumber, accountno, offsetaccount,  offsetamount)
2435                 VALUES
2436                 (?,?,?,?)");
2437             $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2438         }
2439     }
2440     $amountleft *= -1 if ($amountleft > 0);
2441     my $desc = "Item Returned " . $item_id;
2442     $usth = $dbh->prepare("INSERT INTO accountlines
2443         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2444         VALUES (?,?,now(),?,?,'CR',?)");
2445     $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2446     if ($borrowernumber) {
2447         # FIXME: same as query above.  use 1 sth for both
2448         $usth = $dbh->prepare("INSERT INTO accountoffsets
2449             (borrowernumber, accountno, offsetaccount,  offsetamount)
2450             VALUES (?,?,?,?)");
2451         $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2452     }
2453     ModItem({ paidfor => '' }, undef, $itemnumber);
2454     return;
2455 }
2456
2457 =head2 _GetCircControlBranch
2458
2459    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2460
2461 Internal function :
2462
2463 Return the library code to be used to determine which circulation
2464 policy applies to a transaction.  Looks up the CircControl and
2465 HomeOrHoldingBranch system preferences.
2466
2467 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2468
2469 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2470
2471 =cut
2472
2473 sub _GetCircControlBranch {
2474     my ($item, $borrower) = @_;
2475     my $circcontrol = C4::Context->preference('CircControl');
2476     my $branch;
2477
2478     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2479         $branch= C4::Context->userenv->{'branch'};
2480     } elsif ($circcontrol eq 'PatronLibrary') {
2481         $branch=$borrower->{branchcode};
2482     } else {
2483         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2484         $branch = $item->{$branchfield};
2485         # default to item home branch if holdingbranch is used
2486         # and is not defined
2487         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2488             $branch = $item->{homebranch};
2489         }
2490     }
2491     return $branch;
2492 }
2493
2494
2495
2496
2497
2498
2499 =head2 GetItemIssue
2500
2501   $issue = &GetItemIssue($itemnumber);
2502
2503 Returns patron currently having a book, or undef if not checked out.
2504
2505 C<$itemnumber> is the itemnumber.
2506
2507 C<$issue> is a hashref of the row from the issues table.
2508
2509 =cut
2510
2511 sub GetItemIssue {
2512     my ($itemnumber) = @_;
2513     return unless $itemnumber;
2514     my $sth = C4::Context->dbh->prepare(
2515         "SELECT items.*, issues.*
2516         FROM issues
2517         LEFT JOIN items ON issues.itemnumber=items.itemnumber
2518         WHERE issues.itemnumber=?");
2519     $sth->execute($itemnumber);
2520     my $data = $sth->fetchrow_hashref;
2521     return unless $data;
2522     $data->{issuedate_sql} = $data->{issuedate};
2523     $data->{date_due_sql} = $data->{date_due};
2524     $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2525     $data->{issuedate}->truncate(to => 'minute');
2526     $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2527     $data->{date_due}->truncate(to => 'minute');
2528     my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2529     $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2530     return $data;
2531 }
2532
2533 =head2 GetOpenIssue
2534
2535   $issue = GetOpenIssue( $itemnumber );
2536
2537 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2538
2539 C<$itemnumber> is the item's itemnumber
2540
2541 Returns a hashref
2542
2543 =cut
2544
2545 sub GetOpenIssue {
2546   my ( $itemnumber ) = @_;
2547   return unless $itemnumber;
2548   my $dbh = C4::Context->dbh;
2549   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2550   $sth->execute( $itemnumber );
2551   return $sth->fetchrow_hashref();
2552
2553 }
2554
2555 =head2 GetBiblioIssues
2556
2557   $issues = GetBiblioIssues($biblionumber);
2558
2559 this function get all issues from a biblionumber.
2560
2561 Return:
2562 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2563 tables issues and the firstname,surname & cardnumber from borrowers.
2564
2565 =cut
2566
2567 sub GetBiblioIssues {
2568     my $biblionumber = shift;
2569     return unless $biblionumber;
2570     my $dbh   = C4::Context->dbh;
2571     my $query = "
2572         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2573         FROM issues
2574             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2575             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2576             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2577             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2578         WHERE biblio.biblionumber = ?
2579         UNION ALL
2580         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2581         FROM old_issues
2582             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2583             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2584             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2585             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2586         WHERE biblio.biblionumber = ?
2587         ORDER BY timestamp
2588     ";
2589     my $sth = $dbh->prepare($query);
2590     $sth->execute($biblionumber, $biblionumber);
2591
2592     my @issues;
2593     while ( my $data = $sth->fetchrow_hashref ) {
2594         push @issues, $data;
2595     }
2596     return \@issues;
2597 }
2598
2599 =head2 GetUpcomingDueIssues
2600
2601   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2602
2603 =cut
2604
2605 sub GetUpcomingDueIssues {
2606     my $params = shift;
2607
2608     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2609     my $dbh = C4::Context->dbh;
2610
2611     my $statement = <<END_SQL;
2612 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2613 FROM issues
2614 LEFT JOIN items USING (itemnumber)
2615 LEFT OUTER JOIN branches USING (branchcode)
2616 WHERE returndate is NULL
2617 HAVING days_until_due >= 0 AND days_until_due <= ?
2618 END_SQL
2619
2620     my @bind_parameters = ( $params->{'days_in_advance'} );
2621
2622     my $sth = $dbh->prepare( $statement );
2623     $sth->execute( @bind_parameters );
2624     my $upcoming_dues = $sth->fetchall_arrayref({});
2625
2626     return $upcoming_dues;
2627 }
2628
2629 =head2 CanBookBeRenewed
2630
2631   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2632
2633 Find out whether a borrowed item may be renewed.
2634
2635 C<$borrowernumber> is the borrower number of the patron who currently
2636 has the item on loan.
2637
2638 C<$itemnumber> is the number of the item to renew.
2639
2640 C<$override_limit>, if supplied with a true value, causes
2641 the limit on the number of times that the loan can be renewed
2642 (as controlled by the item type) to be ignored. Overriding also allows
2643 to renew sooner than "No renewal before" and to manually renew loans
2644 that are automatically renewed.
2645
2646 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2647 item must currently be on loan to the specified borrower; renewals
2648 must be allowed for the item's type; and the borrower must not have
2649 already renewed the loan. $error will contain the reason the renewal can not proceed
2650
2651 =cut
2652
2653 sub CanBookBeRenewed {
2654     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2655
2656     my $dbh    = C4::Context->dbh;
2657     my $renews = 1;
2658
2659     my $item      = GetItem($itemnumber)      or return ( 0, 'no_item' );
2660     my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2661     return ( 0, 'onsite_checkout' ) if $itemissue->{onsite_checkout};
2662
2663     $borrowernumber ||= $itemissue->{borrowernumber};
2664     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2665       or return;
2666
2667     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2668
2669     # This item can fill one or more unfilled reserve, can those unfilled reserves
2670     # all be filled by other available items?
2671     if ( $resfound
2672         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2673     {
2674         my $schema = Koha::Database->new()->schema();
2675
2676         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2677         if ($item_holds) {
2678             # There is an item level hold on this item, no other item can fill the hold
2679             $resfound = 1;
2680         }
2681         else {
2682
2683             # Get all other items that could possibly fill reserves
2684             my @itemnumbers = $schema->resultset('Item')->search(
2685                 {
2686                     biblionumber => $resrec->{biblionumber},
2687                     onloan       => undef,
2688                     notforloan   => 0,
2689                     -not         => { itemnumber => $itemnumber }
2690                 },
2691                 { columns => 'itemnumber' }
2692             )->get_column('itemnumber')->all();
2693
2694             # Get all other reserves that could have been filled by this item
2695             my @borrowernumbers;
2696             while (1) {
2697                 my ( $reserve_found, $reserve, undef ) =
2698                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2699
2700                 if ($reserve_found) {
2701                     push( @borrowernumbers, $reserve->{borrowernumber} );
2702                 }
2703                 else {
2704                     last;
2705                 }
2706             }
2707
2708             # If the count of the union of the lists of reservable items for each borrower
2709             # is equal or greater than the number of borrowers, we know that all reserves
2710             # can be filled with available items. We can get the union of the sets simply
2711             # by pushing all the elements onto an array and removing the duplicates.
2712             my @reservable;
2713             my %borrowers;
2714             ITEM: foreach my $i (@itemnumbers) {
2715                 my $item = GetItem($i);
2716                 next if IsItemOnHoldAndFound($i);
2717                 for my $b (@borrowernumbers) {
2718                     my $borr = $borrowers{$b}//= C4::Members::GetMember(borrowernumber => $b);
2719                     next unless IsAvailableForItemLevelRequest($item, $borr);
2720                     next unless CanItemBeReserved($b,$i);
2721
2722                     push @reservable, $i;
2723                     if (@reservable >= @borrowernumbers) {
2724                         $resfound = 0;
2725                         last ITEM;
2726                     }
2727                     last;
2728                 }
2729             }
2730         }
2731     }
2732     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2733
2734     return ( 1, undef ) if $override_limit;
2735
2736     my $branchcode = _GetCircControlBranch( $item, $borrower );
2737     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2738         {   categorycode => $borrower->{categorycode},
2739             itemtype     => $item->{itype},
2740             branchcode   => $branchcode
2741         }
2742     );
2743
2744     return ( 0, "too_many" )
2745       if not $issuing_rule or $issuing_rule->renewalsallowed <= $itemissue->{renewals};
2746
2747     my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2748     my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2749     my $patron      = Koha::Patrons->find($borrowernumber);
2750     my $restricted  = $patron->is_debarred;
2751     my $hasoverdues = $patron->has_overdues;
2752
2753     if ( $restricted and $restrictionblockrenewing ) {
2754         return ( 0, 'restriction');
2755     } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($itemissue->{overdue} and $overduesblockrenewing eq 'blockitem') ) {
2756         return ( 0, 'overdue');
2757     }
2758
2759     if ( $itemissue->{auto_renew} ) {
2760         if ( defined $issuing_rule->no_auto_renewal_after
2761                 and $issuing_rule->no_auto_renewal_after ne "" ) {
2762             # Get issue_date and add no_auto_renewal_after
2763             # If this is greater than today, it's too late for renewal.
2764             my $maximum_renewal_date = dt_from_string($itemissue->{issuedate});
2765             $maximum_renewal_date->add(
2766                 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2767             );
2768             my $now = dt_from_string;
2769             if ( $now >= $maximum_renewal_date ) {
2770                 return ( 0, "auto_too_late" );
2771             }
2772         }
2773         if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2774                       and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2775             # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2776             if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2777                 return ( 0, "auto_too_late" );
2778             }
2779         }
2780
2781         if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2782             my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2783             my ( $amountoutstanding ) = C4::Members::GetMemberAccountRecords($borrower->{borrowernumber});
2784             if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2785                 return ( 0, "auto_too_much_oweing" );
2786             }
2787         }
2788     }
2789
2790     if ( defined $issuing_rule->norenewalbefore
2791         and $issuing_rule->norenewalbefore ne "" )
2792     {
2793
2794         # Calculate soonest renewal by subtracting 'No renewal before' from due date
2795         my $soonestrenewal =
2796           $itemissue->{date_due}->clone()
2797           ->subtract(
2798             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2799
2800         # Depending on syspref reset the exact time, only check the date
2801         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2802             and $issuing_rule->lengthunit eq 'days' )
2803         {
2804             $soonestrenewal->truncate( to => 'day' );
2805         }
2806
2807         if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2808         {
2809             return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2810             return ( 0, "too_soon" );
2811         }
2812         elsif ( $itemissue->{auto_renew} ) {
2813             return ( 0, "auto_renew" );
2814         }
2815     }
2816
2817     # Fallback for automatic renewals:
2818     # If norenewalbefore is undef, don't renew before due date.
2819     if ( $itemissue->{auto_renew} ) {
2820         my $now = dt_from_string;
2821         return ( 0, "auto_renew" )
2822           if $now >= $itemissue->{date_due};
2823         return ( 0, "auto_too_soon" );
2824     }
2825
2826     return ( 1, undef );
2827 }
2828
2829 =head2 AddRenewal
2830
2831   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2832
2833 Renews a loan.
2834
2835 C<$borrowernumber> is the borrower number of the patron who currently
2836 has the item.
2837
2838 C<$itemnumber> is the number of the item to renew.
2839
2840 C<$branch> is the library where the renewal took place (if any).
2841            The library that controls the circ policies for the renewal is retrieved from the issues record.
2842
2843 C<$datedue> can be a DateTime object used to set the due date.
2844
2845 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2846 this parameter is not supplied, lastreneweddate is set to the current date.
2847
2848 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2849 from the book's item type.
2850
2851 =cut
2852
2853 sub AddRenewal {
2854     my $borrowernumber  = shift;
2855     my $itemnumber      = shift or return;
2856     my $branch          = shift;
2857     my $datedue         = shift;
2858     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2859
2860     my $item   = GetItem($itemnumber) or return;
2861     my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2862
2863     my $dbh = C4::Context->dbh;
2864
2865     # Find the issues record for this book
2866     my $issuedata  = GetItemIssue($itemnumber);
2867
2868     return unless ( $issuedata );
2869
2870     $borrowernumber ||= $issuedata->{borrowernumber};
2871
2872     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2873         carp 'Invalid date passed to AddRenewal.';
2874         return;
2875     }
2876
2877     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2878
2879     if ( C4::Context->preference('CalculateFinesOnReturn') && $issuedata->{overdue} ) {
2880         _CalculateAndUpdateFine( { issue => $issuedata, item => $item, borrower => $borrower } );
2881     }
2882     _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2883
2884     # If the due date wasn't specified, calculate it by adding the
2885     # book's loan length to today's date or the current due date
2886     # based on the value of the RenewalPeriodBase syspref.
2887     unless ($datedue) {
2888
2889         my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2890
2891         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2892                                         dt_from_string( $issuedata->{date_due} ) :
2893                                         DateTime->now( time_zone => C4::Context->tz());
2894         $datedue =  CalcDateDue($datedue, $itemtype, _GetCircControlBranch($item, $borrower), $borrower, 'is a renewal');
2895     }
2896
2897     # Update the issues record to have the new due date, and a new count
2898     # of how many times it has been renewed.
2899     my $renews = $issuedata->{'renewals'} + 1;
2900     my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2901                             WHERE borrowernumber=?
2902                             AND itemnumber=?"
2903     );
2904
2905     $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2906
2907     # Update the renewal count on the item, and tell zebra to reindex
2908     $renews = $biblio->{'renewals'} + 1;
2909     ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2910
2911     # Charge a new rental fee, if applicable?
2912     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2913     if ( $charge > 0 ) {
2914         my $accountno = getnextacctno( $borrowernumber );
2915         my $item = GetBiblioFromItemNumber($itemnumber);
2916         my $manager_id = 0;
2917         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2918         $sth = $dbh->prepare(
2919                 "INSERT INTO accountlines
2920                     (date, borrowernumber, accountno, amount, manager_id,
2921                     description,accounttype, amountoutstanding, itemnumber)
2922                     VALUES (now(),?,?,?,?,?,?,?,?)"
2923         );
2924         $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2925             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2926             'Rent', $charge, $itemnumber );
2927     }
2928
2929     # Send a renewal slip according to checkout alert preferencei
2930     if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2931         $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2932         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2933         my %conditions        = (
2934             branchcode   => $branch,
2935             categorycode => $borrower->{categorycode},
2936             item_type    => $item->{itype},
2937             notification => 'CHECKOUT',
2938         );
2939         if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2940             SendCirculationAlert(
2941                 {
2942                     type     => 'RENEWAL',
2943                     item     => $item,
2944                     borrower => $borrower,
2945                     branch   => $branch,
2946                 }
2947             );
2948         }
2949     }
2950
2951     # Remove any OVERDUES related debarment if the borrower has no overdues
2952     $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2953     if ( $borrowernumber
2954       && $borrower->{'debarred'}
2955       && !Koha::Patrons->find( $borrowernumber )->has_overdues
2956       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2957     ) {
2958         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2959     }
2960
2961     # Add the renewal to stats
2962     UpdateStats(
2963         {
2964             branch => C4::Context->userenv ? C4::Context->userenv->{branch} : $branch,
2965             type           => 'renew',
2966             amount         => $charge,
2967             itemnumber     => $itemnumber,
2968             itemtype       => $item->{itype},
2969             borrowernumber => $borrowernumber,
2970             ccode          => $item->{'ccode'}
2971         }
2972     );
2973
2974     #Log the renewal
2975     logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2976     return $datedue;
2977 }
2978
2979 sub GetRenewCount {
2980     # check renewal status
2981     my ( $bornum, $itemno ) = @_;
2982     my $dbh           = C4::Context->dbh;
2983     my $renewcount    = 0;
2984     my $renewsallowed = 0;
2985     my $renewsleft    = 0;
2986
2987     my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2988     my $item     = GetItem($itemno);
2989
2990     # Look in the issues table for this item, lent to this borrower,
2991     # and not yet returned.
2992
2993     # FIXME - I think this function could be redone to use only one SQL call.
2994     my $sth = $dbh->prepare(
2995         "select * from issues
2996                                 where (borrowernumber = ?)
2997                                 and (itemnumber = ?)"
2998     );
2999     $sth->execute( $bornum, $itemno );
3000     my $data = $sth->fetchrow_hashref;
3001     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3002     # $item and $borrower should be calculated
3003     my $branchcode = _GetCircControlBranch($item, $borrower);
3004
3005     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3006         {   categorycode => $borrower->{categorycode},
3007             itemtype     => $item->{itype},
3008             branchcode   => $branchcode
3009         }
3010     );
3011
3012     $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : undef; # FIXME Just replace undef with 0 to get what we expected. But what about the side-effects? TODO LATER
3013     $renewsleft    = $renewsallowed - $renewcount;
3014     if($renewsleft < 0){ $renewsleft = 0; }
3015     return ( $renewcount, $renewsallowed, $renewsleft );
3016 }
3017
3018 =head2 GetSoonestRenewDate
3019
3020   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3021
3022 Find out the soonest possible renew date of a borrowed item.
3023
3024 C<$borrowernumber> is the borrower number of the patron who currently
3025 has the item on loan.
3026
3027 C<$itemnumber> is the number of the item to renew.
3028
3029 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3030 renew date, based on the value "No renewal before" of the applicable
3031 issuing rule. Returns the current date if the item can already be
3032 renewed, and returns undefined if the borrower, loan, or item
3033 cannot be found.
3034
3035 =cut
3036
3037 sub GetSoonestRenewDate {
3038     my ( $borrowernumber, $itemnumber ) = @_;
3039
3040     my $dbh = C4::Context->dbh;
3041
3042     my $item      = GetItem($itemnumber)      or return;
3043     my $itemissue = GetItemIssue($itemnumber) or return;
3044
3045     $borrowernumber ||= $itemissue->{borrowernumber};
3046     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
3047       or return;
3048
3049     my $branchcode = _GetCircControlBranch( $item, $borrower );
3050     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3051         {   categorycode => $borrower->{categorycode},
3052             itemtype     => $item->{itype},
3053             branchcode   => $branchcode
3054         }
3055     );
3056
3057     my $now = dt_from_string;
3058     return $now unless $issuing_rule;
3059
3060     if ( defined $issuing_rule->norenewalbefore
3061         and $issuing_rule->norenewalbefore ne "" )
3062     {
3063         my $soonestrenewal =
3064           $itemissue->{date_due}->clone()
3065           ->subtract(
3066             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3067
3068         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3069             and $issuing_rule->lengthunit eq 'days' )
3070         {
3071             $soonestrenewal->truncate( to => 'day' );
3072         }
3073         return $soonestrenewal if $now < $soonestrenewal;
3074     }
3075     return $now;
3076 }
3077
3078 =head2 GetLatestAutoRenewDate
3079
3080   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3081
3082 Find out the latest possible auto renew date of a borrowed item.
3083
3084 C<$borrowernumber> is the borrower number of the patron who currently
3085 has the item on loan.
3086
3087 C<$itemnumber> is the number of the item to renew.
3088
3089 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3090 auto renew date, based on the value "No auto renewal after" and the "No auto
3091 renewal after (hard limit) of the applicable issuing rule.
3092 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3093 or item cannot be found.
3094
3095 =cut
3096
3097 sub GetLatestAutoRenewDate {
3098     my ( $borrowernumber, $itemnumber ) = @_;
3099
3100     my $dbh = C4::Context->dbh;
3101
3102     my $item      = GetItem($itemnumber)      or return;
3103     my $itemissue = GetItemIssue($itemnumber) or return;
3104
3105     $borrowernumber ||= $itemissue->{borrowernumber};
3106     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
3107       or return;
3108
3109     my $branchcode = _GetCircControlBranch( $item, $borrower );
3110     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3111         {   categorycode => $borrower->{categorycode},
3112             itemtype     => $item->{itype},
3113             branchcode   => $branchcode
3114         }
3115     );
3116
3117     return unless $issuing_rule;
3118     return
3119       if ( not $issuing_rule->no_auto_renewal_after
3120             or $issuing_rule->no_auto_renewal_after eq '' )
3121       and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3122              or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3123
3124     my $maximum_renewal_date;
3125     if ( $issuing_rule->no_auto_renewal_after ) {
3126         $maximum_renewal_date = dt_from_string($itemissue->{issuedate});
3127         $maximum_renewal_date->add(
3128             $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3129         );
3130     }
3131
3132     if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3133         my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3134         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3135     }
3136     return $maximum_renewal_date;
3137 }
3138
3139
3140 =head2 GetIssuingCharges
3141
3142   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3143
3144 Calculate how much it would cost for a given patron to borrow a given
3145 item, including any applicable discounts.
3146
3147 C<$itemnumber> is the item number of item the patron wishes to borrow.
3148
3149 C<$borrowernumber> is the patron's borrower number.
3150
3151 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3152 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3153 if it's a video).
3154
3155 =cut
3156
3157 sub GetIssuingCharges {
3158
3159     # calculate charges due
3160     my ( $itemnumber, $borrowernumber ) = @_;
3161     my $charge = 0;
3162     my $dbh    = C4::Context->dbh;
3163     my $item_type;
3164
3165     # Get the book's item type and rental charge (via its biblioitem).
3166     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3167         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3168     $charge_query .= (C4::Context->preference('item-level_itypes'))
3169         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3170         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3171
3172     $charge_query .= ' WHERE items.itemnumber =?';
3173
3174     my $sth = $dbh->prepare($charge_query);
3175     $sth->execute($itemnumber);
3176     if ( my $item_data = $sth->fetchrow_hashref ) {
3177         $item_type = $item_data->{itemtype};
3178         $charge    = $item_data->{rentalcharge};
3179         my $branch = C4::Context::mybranch();
3180         my $discount_query = q|SELECT rentaldiscount,
3181             issuingrules.itemtype, issuingrules.branchcode
3182             FROM borrowers
3183             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3184             WHERE borrowers.borrowernumber = ?
3185             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3186             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3187         my $discount_sth = $dbh->prepare($discount_query);
3188         $discount_sth->execute( $borrowernumber, $item_type, $branch );
3189         my $discount_rules = $discount_sth->fetchall_arrayref({});
3190         if (@{$discount_rules}) {
3191             # We may have multiple rules so get the most specific
3192             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3193             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3194         }
3195         if ($charge) {
3196             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3197         }
3198     }
3199
3200     return ( $charge, $item_type );
3201 }
3202
3203 # Select most appropriate discount rule from those returned
3204 sub _get_discount_from_rule {
3205     my ($rules_ref, $branch, $itemtype) = @_;
3206     my $discount;
3207
3208     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3209         $discount = $rules_ref->[0]->{rentaldiscount};
3210         return (defined $discount) ? $discount : 0;
3211     }
3212     # could have up to 4 does one match $branch and $itemtype
3213     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3214     if (@d) {
3215         $discount = $d[0]->{rentaldiscount};
3216         return (defined $discount) ? $discount : 0;
3217     }
3218     # do we have item type + all branches
3219     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3220     if (@d) {
3221         $discount = $d[0]->{rentaldiscount};
3222         return (defined $discount) ? $discount : 0;
3223     }
3224     # do we all item types + this branch
3225     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3226     if (@d) {
3227         $discount = $d[0]->{rentaldiscount};
3228         return (defined $discount) ? $discount : 0;
3229     }
3230     # so all and all (surely we wont get here)
3231     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3232     if (@d) {
3233         $discount = $d[0]->{rentaldiscount};
3234         return (defined $discount) ? $discount : 0;
3235     }
3236     # none of the above
3237     return 0;
3238 }
3239
3240 =head2 AddIssuingCharge
3241
3242   &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3243
3244 =cut
3245
3246 sub AddIssuingCharge {
3247     my ( $itemnumber, $borrowernumber, $charge ) = @_;
3248     my $dbh = C4::Context->dbh;
3249     my $nextaccntno = getnextacctno( $borrowernumber );
3250     my $manager_id = 0;
3251     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3252     my $query ="
3253         INSERT INTO accountlines
3254             (borrowernumber, itemnumber, accountno,
3255             date, amount, description, accounttype,
3256             amountoutstanding, manager_id)
3257         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3258     ";
3259     my $sth = $dbh->prepare($query);
3260     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3261 }
3262
3263 =head2 GetTransfers
3264
3265   GetTransfers($itemnumber);
3266
3267 =cut
3268
3269 sub GetTransfers {
3270     my ($itemnumber) = @_;
3271
3272     my $dbh = C4::Context->dbh;
3273
3274     my $query = '
3275         SELECT datesent,
3276                frombranch,
3277                tobranch,
3278                branchtransfer_id
3279         FROM branchtransfers
3280         WHERE itemnumber = ?
3281           AND datearrived IS NULL
3282         ';
3283     my $sth = $dbh->prepare($query);
3284     $sth->execute($itemnumber);
3285     my @row = $sth->fetchrow_array();
3286     return @row;
3287 }
3288
3289 =head2 GetTransfersFromTo
3290
3291   @results = GetTransfersFromTo($frombranch,$tobranch);
3292
3293 Returns the list of pending transfers between $from and $to branch
3294
3295 =cut
3296
3297 sub GetTransfersFromTo {
3298     my ( $frombranch, $tobranch ) = @_;
3299     return unless ( $frombranch && $tobranch );
3300     my $dbh   = C4::Context->dbh;
3301     my $query = "
3302         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3303         FROM   branchtransfers
3304         WHERE  frombranch=?
3305           AND  tobranch=?
3306           AND datearrived IS NULL
3307     ";
3308     my $sth = $dbh->prepare($query);
3309     $sth->execute( $frombranch, $tobranch );
3310     my @gettransfers;
3311
3312     while ( my $data = $sth->fetchrow_hashref ) {
3313         push @gettransfers, $data;
3314     }
3315     return (@gettransfers);
3316 }
3317
3318 =head2 DeleteTransfer
3319
3320   &DeleteTransfer($itemnumber);
3321
3322 =cut
3323
3324 sub DeleteTransfer {
3325     my ($itemnumber) = @_;
3326     return unless $itemnumber;
3327     my $dbh          = C4::Context->dbh;
3328     my $sth          = $dbh->prepare(
3329         "DELETE FROM branchtransfers
3330          WHERE itemnumber=?
3331          AND datearrived IS NULL "
3332     );
3333     return $sth->execute($itemnumber);
3334 }
3335
3336 =head2 SendCirculationAlert
3337
3338 Send out a C<check-in> or C<checkout> alert using the messaging system.
3339
3340 B<Parameters>:
3341
3342 =over 4
3343
3344 =item type
3345
3346 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3347
3348 =item item
3349
3350 Hashref of information about the item being checked in or out.
3351
3352 =item borrower
3353
3354 Hashref of information about the borrower of the item.
3355
3356 =item branch
3357
3358 The branchcode from where the checkout or check-in took place.
3359
3360 =back
3361
3362 B<Example>:
3363
3364     SendCirculationAlert({
3365         type     => 'CHECKOUT',
3366         item     => $item,
3367         borrower => $borrower,
3368         branch   => $branch,
3369     });
3370
3371 =cut
3372
3373 sub SendCirculationAlert {
3374     my ($opts) = @_;
3375     my ($type, $item, $borrower, $branch) =
3376         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3377     my %message_name = (
3378         CHECKIN  => 'Item_Check_in',
3379         CHECKOUT => 'Item_Checkout',
3380         RENEWAL  => 'Item_Checkout',
3381     );
3382     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3383         borrowernumber => $borrower->{borrowernumber},
3384         message_name   => $message_name{$type},
3385     });
3386     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3387
3388     my $schema = Koha::Database->new->schema;
3389     my @transports = keys %{ $borrower_preferences->{transports} };
3390
3391     # From the MySQL doc:
3392     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3393     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3394     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3395     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3396
3397     for my $mtt (@transports) {
3398         my $letter =  C4::Letters::GetPreparedLetter (
3399             module => 'circulation',
3400             letter_code => $type,
3401             branchcode => $branch,
3402             message_transport_type => $mtt,
3403             lang => $borrower->{lang},
3404             tables => {
3405                 $issues_table => $item->{itemnumber},
3406                 'items'       => $item->{itemnumber},
3407                 'biblio'      => $item->{biblionumber},
3408                 'biblioitems' => $item->{biblionumber},
3409                 'borrowers'   => $borrower,
3410                 'branches'    => $branch,
3411             }
3412         ) or next;
3413
3414         $schema->storage->txn_begin;
3415         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3416         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3417         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3418         unless ( $message ) {
3419             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3420             C4::Message->enqueue($letter, $borrower, $mtt);
3421         } else {
3422             $message->append($letter);
3423             $message->update;
3424         }
3425         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3426         $schema->storage->txn_commit;
3427     }
3428
3429     return;
3430 }
3431
3432 =head2 updateWrongTransfer
3433
3434   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3435
3436 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
3437
3438 =cut
3439
3440 sub updateWrongTransfer {
3441         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3442         my $dbh = C4::Context->dbh;
3443 # first step validate the actual line of transfert .
3444         my $sth =
3445                 $dbh->prepare(
3446                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3447                 );
3448                 $sth->execute($FromLibrary,$itemNumber);
3449
3450 # second step create a new line of branchtransfer to the right location .
3451         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3452
3453 #third step changing holdingbranch of item
3454         UpdateHoldingbranch($FromLibrary,$itemNumber);
3455 }
3456
3457 =head2 UpdateHoldingbranch
3458
3459   $items = UpdateHoldingbranch($branch,$itmenumber);
3460
3461 Simple methode for updating hodlingbranch in items BDD line
3462
3463 =cut
3464
3465 sub UpdateHoldingbranch {
3466         my ( $branch,$itemnumber ) = @_;
3467     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3468 }
3469
3470 =head2 CalcDateDue
3471
3472 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3473
3474 this function calculates the due date given the start date and configured circulation rules,
3475 checking against the holidays calendar as per the 'useDaysMode' syspref.
3476 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3477 C<$itemtype>  = itemtype code of item in question
3478 C<$branch>  = location whose calendar to use
3479 C<$borrower> = Borrower object
3480 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3481
3482 =cut
3483
3484 sub CalcDateDue {
3485     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3486
3487     $isrenewal ||= 0;
3488
3489     # loanlength now a href
3490     my $loanlength =
3491             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3492
3493     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3494             ? qq{renewalperiod}
3495             : qq{issuelength};
3496
3497     my $datedue;
3498     if ( $startdate ) {
3499         if (ref $startdate ne 'DateTime' ) {
3500             $datedue = dt_from_string($datedue);
3501         } else {
3502             $datedue = $startdate->clone;
3503         }
3504     } else {
3505         $datedue =
3506           DateTime->now( time_zone => C4::Context->tz() )
3507           ->truncate( to => 'minute' );
3508     }
3509
3510
3511     # calculate the datedue as normal
3512     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3513     {    # ignoring calendar
3514         if ( $loanlength->{lengthunit} eq 'hours' ) {
3515             $datedue->add( hours => $loanlength->{$length_key} );
3516         } else {    # days
3517             $datedue->add( days => $loanlength->{$length_key} );
3518             $datedue->set_hour(23);
3519             $datedue->set_minute(59);
3520         }
3521     } else {
3522         my $dur;
3523         if ($loanlength->{lengthunit} eq 'hours') {
3524             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3525         }
3526         else { # days
3527             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3528         }
3529         my $calendar = Koha::Calendar->new( branchcode => $branch );
3530         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3531         if ($loanlength->{lengthunit} eq 'days') {
3532             $datedue->set_hour(23);
3533             $datedue->set_minute(59);
3534         }
3535     }
3536
3537     # if Hard Due Dates are used, retrieve them and apply as necessary
3538     my ( $hardduedate, $hardduedatecompare ) =
3539       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3540     if ($hardduedate) {    # hardduedates are currently dates
3541         $hardduedate->truncate( to => 'minute' );
3542         $hardduedate->set_hour(23);
3543         $hardduedate->set_minute(59);
3544         my $cmp = DateTime->compare( $hardduedate, $datedue );
3545
3546 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3547 # if the calculated date is before the 'after' Hard Due Date (floor), override
3548 # if the hard due date is set to 'exactly', overrride
3549         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3550             $datedue = $hardduedate->clone;
3551         }
3552
3553         # in all other cases, keep the date due as it is
3554
3555     }
3556
3557     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3558     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3559         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3560         if( $expiry_dt ) { #skip empty expiry date..
3561             $expiry_dt->set( hour => 23, minute => 59);
3562             my $d1= $datedue->clone->set_time_zone('floating');
3563             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3564                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3565             }
3566         }
3567     }
3568
3569     return $datedue;
3570 }
3571
3572
3573 sub CheckValidBarcode{
3574 my ($barcode) = @_;
3575 my $dbh = C4::Context->dbh;
3576 my $query=qq|SELECT count(*)
3577              FROM items
3578              WHERE barcode=?
3579             |;
3580 my $sth = $dbh->prepare($query);
3581 $sth->execute($barcode);
3582 my $exist=$sth->fetchrow ;
3583 return $exist;
3584 }
3585
3586 =head2 IsBranchTransferAllowed
3587
3588   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3589
3590 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3591
3592 =cut
3593
3594 sub IsBranchTransferAllowed {
3595         my ( $toBranch, $fromBranch, $code ) = @_;
3596
3597         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3598
3599         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3600         my $dbh = C4::Context->dbh;
3601
3602         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3603         $sth->execute( $toBranch, $fromBranch, $code );
3604         my $limit = $sth->fetchrow_hashref();
3605
3606         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3607         if ( $limit->{'limitId'} ) {
3608                 return 0;
3609         } else {
3610                 return 1;
3611         }
3612 }
3613
3614 =head2 CreateBranchTransferLimit
3615
3616   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3617
3618 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3619
3620 =cut
3621
3622 sub CreateBranchTransferLimit {
3623    my ( $toBranch, $fromBranch, $code ) = @_;
3624    return unless defined($toBranch) && defined($fromBranch);
3625    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3626
3627    my $dbh = C4::Context->dbh;
3628
3629    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3630    return $sth->execute( $code, $toBranch, $fromBranch );
3631 }
3632
3633 =head2 DeleteBranchTransferLimits
3634
3635     my $result = DeleteBranchTransferLimits($frombranch);
3636
3637 Deletes all the library transfer limits for one library.  Returns the
3638 number of limits deleted, 0e0 if no limits were deleted, or undef if
3639 no arguments are supplied.
3640
3641 =cut
3642
3643 sub DeleteBranchTransferLimits {
3644     my $branch = shift;
3645     return unless defined $branch;
3646     my $dbh    = C4::Context->dbh;
3647     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3648     return $sth->execute($branch);
3649 }
3650
3651 sub ReturnLostItem{
3652     my ( $borrowernumber, $itemnum ) = @_;
3653
3654     MarkIssueReturned( $borrowernumber, $itemnum );
3655     my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3656     my $item = C4::Items::GetItem( $itemnum );
3657     my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3658     my @datearr = localtime(time);
3659     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3660     my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3661     ModItem({ paidfor =>  $old_note."Paid for by $bor $date" }, undef, $itemnum);
3662 }
3663
3664
3665 sub LostItem{
3666     my ($itemnumber, $mark_returned) = @_;
3667
3668     my $dbh = C4::Context->dbh();
3669     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3670                            FROM issues
3671                            JOIN items USING (itemnumber)
3672                            JOIN biblio USING (biblionumber)
3673                            WHERE issues.itemnumber=?");
3674     $sth->execute($itemnumber);
3675     my $issues=$sth->fetchrow_hashref();
3676
3677     # If a borrower lost the item, add a replacement cost to the their record
3678     if ( my $borrowernumber = $issues->{borrowernumber} ){
3679         my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
3680
3681         if (C4::Context->preference('WhenLostForgiveFine')){
3682             my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3683             defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3684         }
3685         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3686             C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3687             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3688             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3689         }
3690
3691         MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3692     }
3693 }
3694
3695 sub GetOfflineOperations {
3696     my $dbh = C4::Context->dbh;
3697     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3698     $sth->execute(C4::Context->userenv->{'branch'});
3699     my $results = $sth->fetchall_arrayref({});
3700     return $results;
3701 }
3702
3703 sub GetOfflineOperation {
3704     my $operationid = shift;
3705     return unless $operationid;
3706     my $dbh = C4::Context->dbh;
3707     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3708     $sth->execute( $operationid );
3709     return $sth->fetchrow_hashref;
3710 }
3711
3712 sub AddOfflineOperation {
3713     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3714     my $dbh = C4::Context->dbh;
3715     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3716     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3717     return "Added.";
3718 }
3719
3720 sub DeleteOfflineOperation {
3721     my $dbh = C4::Context->dbh;
3722     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3723     $sth->execute( shift );
3724     return "Deleted.";
3725 }
3726
3727 sub ProcessOfflineOperation {
3728     my $operation = shift;
3729
3730     my $report;
3731     if ( $operation->{action} eq 'return' ) {
3732         $report = ProcessOfflineReturn( $operation );
3733     } elsif ( $operation->{action} eq 'issue' ) {
3734         $report = ProcessOfflineIssue( $operation );
3735     } elsif ( $operation->{action} eq 'payment' ) {
3736         $report = ProcessOfflinePayment( $operation );
3737     }
3738
3739     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3740
3741     return $report;
3742 }
3743
3744 sub ProcessOfflineReturn {
3745     my $operation = shift;
3746
3747     my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3748
3749     if ( $itemnumber ) {
3750         my $issue = GetOpenIssue( $itemnumber );
3751         if ( $issue ) {
3752             MarkIssueReturned(
3753                 $issue->{borrowernumber},
3754                 $itemnumber,
3755                 undef,
3756                 $operation->{timestamp},
3757             );
3758             ModItem(
3759                 { renewals => 0, onloan => undef },
3760                 $issue->{'biblionumber'},
3761                 $itemnumber
3762             );
3763             return "Success.";
3764         } else {
3765             return "Item not issued.";
3766         }
3767     } else {
3768         return "Item not found.";
3769     }
3770 }
3771
3772 sub ProcessOfflineIssue {
3773     my $operation = shift;
3774
3775     my $borrower = C4::Members::GetMember( cardnumber => $operation->{cardnumber} );
3776
3777     if ( $borrower->{borrowernumber} ) {
3778         my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3779         unless ($itemnumber) {
3780             return "Barcode not found.";
3781         }
3782         my $issue = GetOpenIssue( $itemnumber );
3783
3784         if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3785             MarkIssueReturned(
3786                 $issue->{borrowernumber},
3787                 $itemnumber,
3788                 undef,
3789                 $operation->{timestamp},
3790             );
3791         }
3792         AddIssue(
3793             $borrower,
3794             $operation->{'barcode'},
3795             undef,
3796             1,
3797             $operation->{timestamp},
3798             undef,
3799         );
3800         return "Success.";
3801     } else {
3802         return "Borrower not found.";
3803     }
3804 }
3805
3806 sub ProcessOfflinePayment {
3807     my $operation = shift;
3808
3809     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} });
3810     my $amount = $operation->{amount};
3811
3812     Koha::Account->new( { patron_id => $patron->id } )->pay( { amount => $amount } );
3813
3814     return "Success."
3815 }
3816
3817
3818 =head2 TransferSlip
3819
3820   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3821
3822   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3823
3824 =cut
3825
3826 sub TransferSlip {
3827     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3828
3829     my $item =  GetItem( $itemnumber, $barcode )
3830       or return;
3831
3832     return C4::Letters::GetPreparedLetter (
3833         module => 'circulation',
3834         letter_code => 'TRANSFERSLIP',
3835         branchcode => $branch,
3836         tables => {
3837             'branches'    => $to_branch,
3838             'biblio'      => $item->{biblionumber},
3839             'items'       => $item,
3840         },
3841     );
3842 }
3843
3844 =head2 CheckIfIssuedToPatron
3845
3846   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3847
3848   Return 1 if any record item is issued to patron, otherwise return 0
3849
3850 =cut
3851
3852 sub CheckIfIssuedToPatron {
3853     my ($borrowernumber, $biblionumber) = @_;
3854
3855     my $dbh = C4::Context->dbh;
3856     my $query = q|
3857         SELECT COUNT(*) FROM issues
3858         LEFT JOIN items ON items.itemnumber = issues.itemnumber
3859         WHERE items.biblionumber = ?
3860         AND issues.borrowernumber = ?
3861     |;
3862     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3863     return 1 if $is_issued;
3864     return;
3865 }
3866
3867 =head2 IsItemIssued
3868
3869   IsItemIssued( $itemnumber )
3870
3871   Return 1 if the item is on loan, otherwise return 0
3872
3873 =cut
3874
3875 sub IsItemIssued {
3876     my $itemnumber = shift;
3877     my $dbh = C4::Context->dbh;
3878     my $sth = $dbh->prepare(q{
3879         SELECT COUNT(*)
3880         FROM issues
3881         WHERE itemnumber = ?
3882     });
3883     $sth->execute($itemnumber);
3884     return $sth->fetchrow;
3885 }
3886
3887 =head2 GetAgeRestriction
3888
3889   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3890   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3891
3892   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3893   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3894
3895 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3896 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3897 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3898          Negative days mean the borrower has gone past the age restriction age.
3899
3900 =cut
3901
3902 sub GetAgeRestriction {
3903     my ($record_restrictions, $borrower) = @_;
3904     my $markers = C4::Context->preference('AgeRestrictionMarker');
3905
3906     # Split $record_restrictions to something like FSK 16 or PEGI 6
3907     my @values = split ' ', uc($record_restrictions);
3908     return unless @values;
3909
3910     # Search first occurrence of one of the markers
3911     my @markers = split /\|/, uc($markers);
3912     return unless @markers;
3913
3914     my $index            = 0;
3915     my $restriction_year = 0;
3916     for my $value (@values) {
3917         $index++;
3918         for my $marker (@markers) {
3919             $marker =~ s/^\s+//;    #remove leading spaces
3920             $marker =~ s/\s+$//;    #remove trailing spaces
3921             if ( $marker eq $value ) {
3922                 if ( $index <= $#values ) {
3923                     $restriction_year += $values[$index];
3924                 }
3925                 last;
3926             }
3927             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3928
3929                 # Perhaps it is something like "K16" (as in Finland)
3930                 $restriction_year += $1;
3931                 last;
3932             }
3933         }
3934         last if ( $restriction_year > 0 );
3935     }
3936
3937     #Check if the borrower is age restricted for this material and for how long.
3938     if ($restriction_year && $borrower) {
3939         if ( $borrower->{'dateofbirth'} ) {
3940             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3941             $alloweddate[0] += $restriction_year;
3942
3943             #Prevent runime eror on leap year (invalid date)
3944             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3945                 $alloweddate[2] = 28;
3946             }
3947
3948             #Get how many days the borrower has to reach the age restriction
3949             my @Today = split /-/, DateTime->today->ymd();
3950             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3951             #Negative days means the borrower went past the age restriction age
3952             return ($restriction_year, $daysToAgeRestriction);
3953         }
3954     }
3955
3956     return ($restriction_year);
3957 }
3958
3959
3960 =head2 GetPendingOnSiteCheckouts
3961
3962 =cut
3963
3964 sub GetPendingOnSiteCheckouts {
3965     my $dbh = C4::Context->dbh;
3966     return $dbh->selectall_arrayref(q|
3967         SELECT
3968           items.barcode,
3969           items.biblionumber,
3970           items.itemnumber,
3971           items.itemnotes,
3972           items.itemcallnumber,
3973           items.location,
3974           issues.date_due,
3975           issues.branchcode,
3976           issues.date_due < NOW() AS is_overdue,
3977           biblio.author,
3978           biblio.title,
3979           borrowers.firstname,
3980           borrowers.surname,
3981           borrowers.cardnumber,
3982           borrowers.borrowernumber
3983         FROM items
3984         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
3985         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
3986         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
3987         WHERE issues.onsite_checkout = 1
3988     |, { Slice => {} } );
3989 }
3990
3991 sub GetTopIssues {
3992     my ($params) = @_;
3993
3994     my ($count, $branch, $itemtype, $ccode, $newness)
3995         = @$params{qw(count branch itemtype ccode newness)};
3996
3997     my $dbh = C4::Context->dbh;
3998     my $query = q{
3999         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4000           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4001           i.ccode, SUM(i.issues) AS count
4002         FROM biblio b
4003         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4004         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4005     };
4006
4007     my (@where_strs, @where_args);
4008
4009     if ($branch) {
4010         push @where_strs, 'i.homebranch = ?';
4011         push @where_args, $branch;
4012     }
4013     if ($itemtype) {
4014         if (C4::Context->preference('item-level_itypes')){
4015             push @where_strs, 'i.itype = ?';
4016             push @where_args, $itemtype;
4017         } else {
4018             push @where_strs, 'bi.itemtype = ?';
4019             push @where_args, $itemtype;
4020         }
4021     }
4022     if ($ccode) {
4023         push @where_strs, 'i.ccode = ?';
4024         push @where_args, $ccode;
4025     }
4026     if ($newness) {
4027         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4028         push @where_args, $newness;
4029     }
4030
4031     if (@where_strs) {
4032         $query .= 'WHERE ' . join(' AND ', @where_strs);
4033     }
4034
4035     $query .= q{
4036         GROUP BY b.biblionumber
4037         HAVING count > 0
4038         ORDER BY count DESC
4039     };
4040
4041     $count = int($count);
4042     if ($count > 0) {
4043         $query .= "LIMIT $count";
4044     }
4045
4046     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4047
4048     return @$rows;
4049 }
4050
4051 sub _CalculateAndUpdateFine {
4052     my ($params) = @_;
4053
4054     my $borrower    = $params->{borrower};
4055     my $item        = $params->{item};
4056     my $issue       = $params->{issue};
4057     my $return_date = $params->{return_date};
4058
4059     unless ($borrower) { carp "No borrower passed in!" && return; }
4060     unless ($item)     { carp "No item passed in!"     && return; }
4061     unless ($issue)    { carp "No issue passed in!"    && return; }
4062
4063     my $datedue = $issue->{date_due};
4064
4065     # we only need to calculate and change the fines if we want to do that on return
4066     # Should be on for hourly loans
4067     my $control = C4::Context->preference('CircControl');
4068     my $control_branchcode =
4069         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4070       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4071       :                                     $issue->{branchcode};
4072
4073     my $date_returned = $return_date ? dt_from_string($return_date) : dt_from_string();
4074
4075     my ( $amount, $type, $unitcounttotal ) =
4076       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4077
4078     $type ||= q{};
4079
4080     if ( C4::Context->preference('finesMode') eq 'production' ) {
4081         if ( $amount > 0 ) {
4082             C4::Overdues::UpdateFine({
4083                 issue_id       => $issue->{issue_id},
4084                 itemnumber     => $issue->{itemnumber},
4085                 borrowernumber => $issue->{borrowernumber},
4086                 amount         => $amount,
4087                 type           => $type,
4088                 due            => output_pref($datedue),
4089             });
4090         }
4091         elsif ($return_date) {
4092
4093             # Backdated returns may have fines that shouldn't exist,
4094             # so in this case, we need to drop those fines to 0
4095
4096             C4::Overdues::UpdateFine({
4097                 issue_id       => $issue->{issue_id},
4098                 itemnumber     => $issue->{itemnumber},
4099                 borrowernumber => $issue->{borrowernumber},
4100                 amount         => 0,
4101                 type           => $type,
4102                 due            => output_pref($datedue),
4103             });
4104         }
4105     }
4106 }
4107
4108 1;
4109
4110 __END__
4111
4112 =head1 AUTHOR
4113
4114 Koha Development Team <http://koha-community.org/>
4115
4116 =cut