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