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