C4/Circulation.pm

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