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