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::RefundLostItemFeeRule;
  58 use Koha::RefundLostItemFeeRules;
  59 use Koha::Account::Lines;
  60 use Koha::Account::Offsets;
  61 use Koha::Config::SysPrefs;
  62 use Koha::Charges::Fees;
  63 use Koha::Util::SystemPreferences;
  64 use Carp;
  65 use List::MoreUtils qw( uniq any );
  66 use Scalar::Util qw( looks_like_number );
  67 use Date::Calc qw(
  68   Today
  69   Today_and_Now
  70   Add_Delta_YM
  71   Add_Delta_DHMS
  72   Date_to_Days
  73   Day_of_Week
  74   Add_Delta_Days
  75 );
  76 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  77
  78 BEGIN {
  79         require Exporter;
  80         @ISA    = qw(Exporter);
  81
  82         # FIXME subs that should probably be elsewhere
  83         push @EXPORT, qw(
  84                 &barcodedecode
  85         &LostItem
  86         &ReturnLostItem
  87         &GetPendingOnSiteCheckouts
  88         );
  89
  90         # subs to deal with issuing a book
  91         push @EXPORT, qw(
  92                 &CanBookBeIssued
  93                 &CanBookBeRenewed
  94                 &AddIssue
  95                 &AddRenewal
  96                 &GetRenewCount
  97         &GetSoonestRenewDate
  98         &GetLatestAutoRenewDate
  99                 &GetIssuingCharges
 100         &GetBranchBorrowerCircRule
 101         &GetBranchItemRule
 102                 &GetBiblioIssues
 103                 &GetOpenIssue
 104         &CheckIfIssuedToPatron
 105         &IsItemIssued
 106         GetTopIssues
 107         );
 108
 109         # subs to deal with returns
 110         push @EXPORT, qw(
 111                 &AddReturn
 112         &MarkIssueReturned
 113         );
 114
 115         # subs to deal with transfers
 116         push @EXPORT, qw(
 117                 &transferbook
 118                 &GetTransfers
 119                 &GetTransfersFromTo
 120                 &updateWrongTransfer
 121                 &DeleteTransfer
 122                 &IsBranchTransferAllowed
 123                 &CreateBranchTransferLimit
 124                 &DeleteBranchTransferLimits
 125         &TransferSlip
 126         );
 127
 128     # subs to deal with offline circulation
 129     push @EXPORT, qw(
 130       &GetOfflineOperations
 131       &GetOfflineOperation
 132       &AddOfflineOperation
 133       &DeleteOfflineOperation
 134       &ProcessOfflineOperation
 135     );
 136 }
 137
 138 =head1 NAME
 139
 140 C4::Circulation - Koha circulation module
 141
 142 =head1 SYNOPSIS
 143
 144 use C4::Circulation;
 145
 146 =head1 DESCRIPTION
 147
 148 The functions in this module deal with circulation, issues, and
 149 returns, as well as general information about the library.
 150 Also deals with inventory.
 151
 152 =head1 FUNCTIONS
 153
 154 =head2 barcodedecode
 155
 156   $str = &barcodedecode($barcode, [$filter]);
 157
 158 Generic filter function for barcode string.
 159 Called on every circ if the System Pref itemBarcodeInputFilter is set.
 160 Will do some manipulation of the barcode for systems that deliver a barcode
 161 to circulation.pl that differs from the barcode stored for the item.
 162 For proper functioning of this filter, calling the function on the
 163 correct barcode string (items.barcode) should return an unaltered barcode.
 164
 165 The optional $filter argument is to allow for testing or explicit
 166 behavior that ignores the System Pref.  Valid values are the same as the
 167 System Pref options.
 168
 169 =cut
 170
 171 # FIXME -- the &decode fcn below should be wrapped into this one.
 172 # FIXME -- these plugins should be moved out of Circulation.pm
 173 #
 174 sub barcodedecode {
 175     my ($barcode, $filter) = @_;
 176     my $branch = C4::Context::mybranch();
 177     $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
 178     $filter or return $barcode;     # ensure filter is defined, else return untouched barcode
 179         if ($filter eq 'whitespace') {
 180                 $barcode =~ s/\s//g;
 181         } elsif ($filter eq 'cuecat') {
 182                 chomp($barcode);
 183             my @fields = split( /\./, $barcode );
 184             my @results = map( decode($_), @fields[ 1 .. $#fields ] );
 185             ($#results == 2) and return $results[2];
 186         } elsif ($filter eq 'T-prefix') {
 187                 if ($barcode =~ /^[Tt](\d)/) {
 188                         (defined($1) and $1 eq '0') and return $barcode;
 189             $barcode = substr($barcode, 2) + 0;     # FIXME: probably should be substr($barcode, 1)
 190                 }
 191         return sprintf("T%07d", $barcode);
 192         # FIXME: $barcode could be "T1", causing warning: substr outside of string
 193         # Why drop the nonzero digit after the T?
 194         # Why pass non-digits (or empty string) to "T%07d"?
 195         } elsif ($filter eq 'libsuite8') {
 196                 unless($barcode =~ m/^($branch)-/i){    #if barcode starts with branch code its in Koha style. Skip it.
 197                         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
 198                                 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
 199                         }else{
 200                                 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
 201                         }
 202                 }
 203     } elsif ($filter eq 'EAN13') {
 204         my $ean = CheckDigits('ean');
 205         if ( $ean->is_valid($barcode) ) {
 206             #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
 207             $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
 208         } else {
 209             warn "# [$barcode] not valid EAN-13/UPC-A\n";
 210         }
 211         }
 212     return $barcode;    # return barcode, modified or not
 213 }
 214
 215 =head2 decode
 216
 217   $str = &decode($chunk);
 218
 219 Decodes a segment of a string emitted by a CueCat barcode scanner and
 220 returns it.
 221
 222 FIXME: Should be replaced with Barcode::Cuecat from CPAN
 223 or Javascript based decoding on the client side.
 224
 225 =cut
 226
 227 sub decode {
 228     my ($encoded) = @_;
 229     my $seq =
 230       'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
 231     my @s = map { index( $seq, $_ ); } split( //, $encoded );
 232     my $l = ( $#s + 1 ) % 4;
 233     if ($l) {
 234         if ( $l == 1 ) {
 235             # warn "Error: Cuecat decode parsing failed!";
 236             return;
 237         }
 238         $l = 4 - $l;
 239         $#s += $l;
 240     }
 241     my $r = '';
 242     while ( $#s >= 0 ) {
 243         my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
 244         $r .=
 245             chr( ( $n >> 16 ) ^ 67 )
 246          .chr( ( $n >> 8 & 255 ) ^ 67 )
 247          .chr( ( $n & 255 ) ^ 67 );
 248         @s = @s[ 4 .. $#s ];
 249     }
 250     $r = substr( $r, 0, length($r) - $l );
 251     return $r;
 252 }
 253
 254 =head2 transferbook
 255
 256   ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
 257                                             $barcode, $ignore_reserves);
 258
 259 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
 260
 261 C<$newbranch> is the code for the branch to which the item should be transferred.
 262
 263 C<$barcode> is the barcode of the item to be transferred.
 264
 265 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
 266 Otherwise, if an item is reserved, the transfer fails.
 267
 268 Returns three values:
 269
 270 =over
 271
 272 =item $dotransfer
 273
 274 is true if the transfer was successful.
 275
 276 =item $messages
 277
 278 is a reference-to-hash which may have any of the following keys:
 279
 280 =over
 281
 282 =item C<BadBarcode>
 283
 284 There is no item in the catalog with the given barcode. The value is C<$barcode>.
 285
 286 =item C<DestinationEqualsHolding>
 287
 288 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.
 289
 290 =item C<WasReturned>
 291
 292 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.
 293
 294 =item C<ResFound>
 295
 296 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>.
 297
 298 =item C<WasTransferred>
 299
 300 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
 301
 302 =back
 303
 304 =back
 305
 306 =cut
 307
 308 sub transferbook {
 309     my ( $tbr, $barcode, $ignoreRs ) = @_;
 310     my $messages;
 311     my $dotransfer      = 1;
 312     my $item = Koha::Items->find( { barcode => $barcode } );
 313
 314     # bad barcode..
 315     unless ( $item ) {
 316         $messages->{'BadBarcode'} = $barcode;
 317         $dotransfer = 0;
 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 = $patron->guarantees();
 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                 my $description = "Rental";
1472                 AddIssuingCharge( $issue, $charge, $description );
1473             }
1474
1475             my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1476             if ( $itemtype_object ) {
1477                 my $accumulate_charge = $fees->accumulate_rentalcharge();
1478                 if ( $accumulate_charge > 0 ) {
1479                     AddIssuingCharge( $issue, $accumulate_charge, 'Daily rental' ) if $accumulate_charge > 0;
1480                     $charge += $accumulate_charge;
1481                     $item_unblessed->{charge} = $charge;
1482                 }
1483             }
1484
1485             # Record the fact that this book was issued.
1486             &UpdateStats(
1487                 {
1488                     branch => C4::Context->userenv->{'branch'},
1489                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1490                     amount         => $charge,
1491                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1492                     itemnumber     => $item_object->itemnumber,
1493                     itemtype       => $item_object->effective_itemtype,
1494                     location       => $item_object->location,
1495                     borrowernumber => $borrower->{'borrowernumber'},
1496                     ccode          => $item_object->ccode,
1497                 }
1498             );
1499
1500             # Send a checkout slip.
1501             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1502             my %conditions        = (
1503                 branchcode   => $branch,
1504                 categorycode => $borrower->{categorycode},
1505                 item_type    => $item_object->effective_itemtype,
1506                 notification => 'CHECKOUT',
1507             );
1508             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1509                 SendCirculationAlert(
1510                     {
1511                         type     => 'CHECKOUT',
1512                         item     => $item_object->unblessed,
1513                         borrower => $borrower,
1514                         branch   => $branch,
1515                     }
1516                 );
1517             }
1518             logaction(
1519                 "CIRCULATION", "ISSUE",
1520                 $borrower->{'borrowernumber'},
1521                 $item_object->itemnumber,
1522             ) if C4::Context->preference("IssueLog");
1523         }
1524     }
1525     return $issue;
1526 }
1527
1528 =head2 GetLoanLength
1529
1530   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1531
1532 Get loan length for an itemtype, a borrower type and a branch
1533
1534 =cut
1535
1536 sub GetLoanLength {
1537     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1538     my $dbh = C4::Context->dbh;
1539     my $sth = $dbh->prepare(qq{
1540         SELECT issuelength, lengthunit, renewalperiod
1541         FROM issuingrules
1542         WHERE   categorycode=?
1543             AND itemtype=?
1544             AND branchcode=?
1545             AND issuelength IS NOT NULL
1546     });
1547
1548     # try to find issuelength & return the 1st available.
1549     # check with borrowertype, itemtype and branchcode, then without one of those parameters
1550     $sth->execute( $borrowertype, $itemtype, $branchcode );
1551     my $loanlength = $sth->fetchrow_hashref;
1552
1553     return $loanlength
1554       if defined($loanlength) && defined $loanlength->{issuelength};
1555
1556     $sth->execute( $borrowertype, '*', $branchcode );
1557     $loanlength = $sth->fetchrow_hashref;
1558     return $loanlength
1559       if defined($loanlength) && defined $loanlength->{issuelength};
1560
1561     $sth->execute( '*', $itemtype, $branchcode );
1562     $loanlength = $sth->fetchrow_hashref;
1563     return $loanlength
1564       if defined($loanlength) && defined $loanlength->{issuelength};
1565
1566     $sth->execute( '*', '*', $branchcode );
1567     $loanlength = $sth->fetchrow_hashref;
1568     return $loanlength
1569       if defined($loanlength) && defined $loanlength->{issuelength};
1570
1571     $sth->execute( $borrowertype, $itemtype, '*' );
1572     $loanlength = $sth->fetchrow_hashref;
1573     return $loanlength
1574       if defined($loanlength) && defined $loanlength->{issuelength};
1575
1576     $sth->execute( $borrowertype, '*', '*' );
1577     $loanlength = $sth->fetchrow_hashref;
1578     return $loanlength
1579       if defined($loanlength) && defined $loanlength->{issuelength};
1580
1581     $sth->execute( '*', $itemtype, '*' );
1582     $loanlength = $sth->fetchrow_hashref;
1583     return $loanlength
1584       if defined($loanlength) && defined $loanlength->{issuelength};
1585
1586     $sth->execute( '*', '*', '*' );
1587     $loanlength = $sth->fetchrow_hashref;
1588     return $loanlength
1589       if defined($loanlength) && defined $loanlength->{issuelength};
1590
1591     # if no rule is set => 0 day (hardcoded)
1592     return {
1593         issuelength => 0,
1594         renewalperiod => 0,
1595         lengthunit => 'days',
1596     };
1597
1598 }
1599
1600
1601 =head2 GetHardDueDate
1602
1603   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1604
1605 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1606
1607 =cut
1608
1609 sub GetHardDueDate {
1610     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1611
1612     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1613         {   categorycode => $borrowertype,
1614             itemtype     => $itemtype,
1615             branchcode   => $branchcode
1616         }
1617     );
1618
1619
1620     if ( defined( $issuing_rule ) ) {
1621         if ( $issuing_rule->hardduedate ) {
1622             return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1623         } else {
1624             return (undef, undef);
1625         }
1626     }
1627 }
1628
1629 =head2 GetBranchBorrowerCircRule
1630
1631   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1632
1633 Retrieves circulation rule attributes that apply to the given
1634 branch and patron category, regardless of item type.
1635 The return value is a hashref containing the following key:
1636
1637 patron_maxissueqty - maximum number of loans that a
1638 patron of the given category can have at the given
1639 branch.  If the value is undef, no limit.
1640
1641 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1642 patron of the given category can have at the given
1643 branch.  If the value is undef, no limit.
1644
1645 This will check for different branch/category combinations in the following order:
1646 branch and category
1647 branch only
1648 category only
1649 default branch and category
1650
1651 If no rule has been found in the database, it will default to
1652 the buillt in rule:
1653
1654 patron_maxissueqty - undef
1655 patron_maxonsiteissueqty - undef
1656
1657 C<$branchcode> and C<$categorycode> should contain the
1658 literal branch code and patron category code, respectively - no
1659 wildcards.
1660
1661 =cut
1662
1663 sub GetBranchBorrowerCircRule {
1664     my ( $branchcode, $categorycode ) = @_;
1665
1666     # Initialize default values
1667     my $rules = {
1668         patron_maxissueqty       => undef,
1669         patron_maxonsiteissueqty => undef,
1670     };
1671
1672     # Search for rules!
1673     foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1674         my $rule = Koha::CirculationRules->get_effective_rule(
1675             {
1676                 categorycode => $categorycode,
1677                 itemtype     => undef,
1678                 branchcode   => $branchcode,
1679                 rule_name    => $rule_name,
1680             }
1681         );
1682
1683         $rules->{$rule_name} = $rule->rule_value if defined $rule;
1684     }
1685
1686     return $rules;
1687 }
1688
1689 =head2 GetBranchItemRule
1690
1691   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1692
1693 Retrieves circulation rule attributes that apply to the given
1694 branch and item type, regardless of patron category.
1695
1696 The return value is a hashref containing the following keys:
1697
1698 holdallowed => Hold policy for this branch and itemtype. Possible values:
1699   0: No holds allowed.
1700   1: Holds allowed only by patrons that have the same homebranch as the item.
1701   2: Holds allowed from any patron.
1702
1703 returnbranch => branch to which to return item.  Possible values:
1704   noreturn: do not return, let item remain where checked in (floating collections)
1705   homebranch: return to item's home branch
1706   holdingbranch: return to issuer branch
1707
1708 This searches branchitemrules in the following order:
1709
1710   * Same branchcode and itemtype
1711   * Same branchcode, itemtype '*'
1712   * branchcode '*', same itemtype
1713   * branchcode and itemtype '*'
1714
1715 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1716
1717 =cut
1718
1719 sub GetBranchItemRule {
1720     my ( $branchcode, $itemtype ) = @_;
1721     my $dbh = C4::Context->dbh();
1722     my $result = {};
1723
1724     my @attempts = (
1725         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1726             FROM branch_item_rules
1727             WHERE branchcode = ?
1728               AND itemtype = ?', $branchcode, $itemtype],
1729         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1730             FROM default_branch_circ_rules
1731             WHERE branchcode = ?', $branchcode],
1732         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1733             FROM default_branch_item_rules
1734             WHERE itemtype = ?', $itemtype],
1735         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1736             FROM default_circ_rules'],
1737     );
1738
1739     foreach my $attempt (@attempts) {
1740         my ($query, @bind_params) = @{$attempt};
1741         my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1742           or next;
1743
1744         # Since branch/category and branch/itemtype use the same per-branch
1745         # defaults tables, we have to check that the key we want is set, not
1746         # just that a row was returned
1747         $result->{'holdallowed'}  = $search_result->{'holdallowed'}  unless ( defined $result->{'holdallowed'} );
1748         $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1749         $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1750     }
1751
1752     # built-in default circulation rule
1753     $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1754     $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1755     $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1756
1757     return $result;
1758 }
1759
1760 =head2 AddReturn
1761
1762   ($doreturn, $messages, $iteminformation, $borrower) =
1763       &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1764
1765 Returns a book.
1766
1767 =over 4
1768
1769 =item C<$barcode> is the bar code of the book being returned.
1770
1771 =item C<$branch> is the code of the branch where the book is being returned.
1772
1773 =item C<$exemptfine> indicates that overdue charges for the item will be
1774 removed. Optional.
1775
1776 =item C<$return_date> allows the default return date to be overridden
1777 by the given return date. Optional.
1778
1779 =back
1780
1781 C<&AddReturn> returns a list of four items:
1782
1783 C<$doreturn> is true iff the return succeeded.
1784
1785 C<$messages> is a reference-to-hash giving feedback on the operation.
1786 The keys of the hash are:
1787
1788 =over 4
1789
1790 =item C<BadBarcode>
1791
1792 No item with this barcode exists. The value is C<$barcode>.
1793
1794 =item C<NotIssued>
1795
1796 The book is not currently on loan. The value is C<$barcode>.
1797
1798 =item C<withdrawn>
1799
1800 This book has been withdrawn/cancelled. The value should be ignored.
1801
1802 =item C<Wrongbranch>
1803
1804 This book has was returned to the wrong branch.  The value is a hashref
1805 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1806 contain the branchcode of the incorrect and correct return library, respectively.
1807
1808 =item C<ResFound>
1809
1810 The item was reserved. The value is a reference-to-hash whose keys are
1811 fields from the reserves table of the Koha database, and
1812 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1813 either C<Waiting>, C<Reserved>, or 0.
1814
1815 =item C<WasReturned>
1816
1817 Value 1 if return is successful.
1818
1819 =item C<NeedsTransfer>
1820
1821 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1822
1823 =back
1824
1825 C<$iteminformation> is a reference-to-hash, giving information about the
1826 returned item from the issues table.
1827
1828 C<$borrower> is a reference-to-hash, giving information about the
1829 patron who last borrowed the book.
1830
1831 =cut
1832
1833 sub AddReturn {
1834     my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1835
1836     if ($branch and not Koha::Libraries->find($branch)) {
1837         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1838         undef $branch;
1839     }
1840     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1841     $return_date //= dt_from_string();
1842     my $messages;
1843     my $patron;
1844     my $doreturn       = 1;
1845     my $validTransfert = 0;
1846     my $stat_type = 'return';
1847
1848     # get information on item
1849     my $item = Koha::Items->find({ barcode => $barcode });
1850     unless ($item) {
1851         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1852     }
1853
1854     my $itemnumber = $item->itemnumber;
1855     my $itemtype = $item->effective_itemtype;
1856
1857     my $issue  = $item->checkout;
1858     if ( $issue ) {
1859         $patron = $issue->patron
1860             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1861                 . Dumper($issue->unblessed) . "\n";
1862     } else {
1863         $messages->{'NotIssued'} = $barcode;
1864         ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1865         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1866         $doreturn = 0;
1867         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1868         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1869         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1870            $messages->{'LocalUse'} = 1;
1871            $stat_type = 'localuse';
1872         }
1873     }
1874
1875     my $item_unblessed = $item->unblessed;
1876         # full item data, but no borrowernumber or checkout info (no issue)
1877     my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1878         # get the proper branch to which to return the item
1879     my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1880         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1881
1882     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
1883     my $patron_unblessed = $patron ? $patron->unblessed : {};
1884
1885     my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1886     map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1887     if ($update_loc_rules) {
1888         if (defined $update_loc_rules->{_ALL_}) {
1889             if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1890             if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1891             if ( $item->location ne $update_loc_rules->{_ALL_}) {
1892                 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1893                 ModItem( { location => $update_loc_rules->{_ALL_} }, undef, $itemnumber );
1894             }
1895         }
1896         else {
1897             foreach my $key ( keys %$update_loc_rules ) {
1898                 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1899                 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1900                 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1901                     $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1902                     ModItem( { location => $update_loc_rules->{$key} }, undef, $itemnumber );
1903                     last;
1904                 }
1905             }
1906         }
1907     }
1908
1909     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1910     if ($yaml) {
1911         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
1912         my $rules;
1913         eval { $rules = YAML::Load($yaml); };
1914         if ($@) {
1915             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1916         }
1917         else {
1918             foreach my $key ( keys %$rules ) {
1919                 if ( $item->notforloan eq $key ) {
1920                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1921                     ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1922                     last;
1923                 }
1924             }
1925         }
1926     }
1927
1928     # check if the return is allowed at this branch
1929     my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1930     unless ($returnallowed){
1931         $messages->{'Wrongbranch'} = {
1932             Wrongbranch => $branch,
1933             Rightbranch => $message
1934         };
1935         $doreturn = 0;
1936         return ( $doreturn, $messages, $issue, $patron_unblessed);
1937     }
1938
1939     if ( $item->withdrawn ) { # book has been cancelled
1940         $messages->{'withdrawn'} = 1;
1941         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1942     }
1943
1944     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1945         $doreturn = 0;
1946     }
1947
1948     # case of a return of document (deal with issues and holdingbranch)
1949     if ($doreturn) {
1950         my $is_overdue;
1951         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1952         $patron or warn "AddReturn without current borrower";
1953         $is_overdue = $issue->is_overdue( $return_date );
1954
1955         if ($patron) {
1956             eval {
1957                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1958             };
1959             unless ( $@ ) {
1960                 if ( C4::Context->preference('CalculateFinesOnReturn') && $is_overdue && !$item->itemlost ) {
1961                     _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1962                 }
1963             } else {
1964                 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 );
1965
1966                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1967             }
1968
1969             # FIXME is the "= 1" right?  This could be the borrower hash.
1970             $messages->{'WasReturned'} = 1;
1971
1972         }
1973
1974         ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1975     }
1976
1977     # the holdingbranch is updated if the document is returned to another location.
1978     # this is always done regardless of whether the item was on loan or not
1979     my $item_holding_branch = $item->holdingbranch;
1980     if ($item->holdingbranch ne $branch) {
1981         UpdateHoldingbranch($branch, $item->itemnumber);
1982         $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1983     }
1984
1985     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1986     ModDateLastSeen( $item->itemnumber, $leave_item_lost );
1987
1988     # check if we have a transfer for this document
1989     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
1990
1991     # if we have a transfer to do, we update the line of transfers with the datearrived
1992     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
1993     if ($datesent) {
1994         if ( $tobranch eq $branch ) {
1995             my $sth = C4::Context->dbh->prepare(
1996                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1997             );
1998             $sth->execute( $item->itemnumber );
1999             # if we have a reservation with valid transfer, we can set it's status to 'W'
2000             C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2001         } else {
2002             $messages->{'WrongTransfer'}     = $tobranch;
2003             $messages->{'WrongTransferItem'} = $item->itemnumber;
2004         }
2005         $validTransfert = 1;
2006     }
2007
2008     # fix up the accounts.....
2009     if ( $item->itemlost ) {
2010         $messages->{'WasLost'} = 1;
2011         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2012             if (
2013                 Koha::RefundLostItemFeeRules->should_refund(
2014                     {
2015                         current_branch      => C4::Context->userenv->{branch},
2016                         item_home_branch    => $item->homebranch,
2017                         item_holding_branch => $item_holding_branch
2018                     }
2019                 )
2020               )
2021             {
2022                 _FixAccountForLostAndReturned( $item->itemnumber,
2023                     $borrowernumber, $barcode );
2024                 $messages->{'LostItemFeeRefunded'} = 1;
2025             }
2026         }
2027     }
2028
2029     # fix up the overdues in accounts...
2030     if ($borrowernumber) {
2031         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine );
2032         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!";  # zero is OK, check defined
2033
2034         if ( $issue and $issue->is_overdue ) {
2035         # fix fine days
2036             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $return_date );
2037             if ($reminder){
2038                 $messages->{'PrevDebarred'} = $debardate;
2039             } else {
2040                 $messages->{'Debarred'} = $debardate if $debardate;
2041             }
2042         # there's no overdue on the item but borrower had been previously debarred
2043         } elsif ( $issue->date_due and $patron->debarred ) {
2044              if ( $patron->debarred eq "9999-12-31") {
2045                 $messages->{'ForeverDebarred'} = $patron->debarred;
2046              } else {
2047                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2048                   $borrower_debar_dt->truncate(to => 'day');
2049                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2050                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2051                       $messages->{'PrevDebarred'} = $patron->debarred;
2052                   }
2053              }
2054         }
2055     }
2056
2057     # find reserves.....
2058     # if we don't have a reserve with the status W, we launch the Checkreserves routine
2059     my ($resfound, $resrec);
2060     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2061     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2062     if ($resfound) {
2063           $resrec->{'ResFound'} = $resfound;
2064         $messages->{'ResFound'} = $resrec;
2065     }
2066
2067     # Record the fact that this book was returned.
2068     UpdateStats({
2069         branch         => $branch,
2070         type           => $stat_type,
2071         itemnumber     => $itemnumber,
2072         itemtype       => $itemtype,
2073         borrowernumber => $borrowernumber,
2074         ccode          => $item->ccode,
2075     });
2076
2077     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2078     if ( $patron ) {
2079         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2080         my %conditions = (
2081             branchcode   => $branch,
2082             categorycode => $patron->categorycode,
2083             item_type    => $itemtype,
2084             notification => 'CHECKIN',
2085         );
2086         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2087             SendCirculationAlert({
2088                 type     => 'CHECKIN',
2089                 item     => $item_unblessed,
2090                 borrower => $patron->unblessed,
2091                 branch   => $branch,
2092             });
2093         }
2094
2095         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2096             if C4::Context->preference("ReturnLog");
2097         }
2098
2099     # Remove any OVERDUES related debarment if the borrower has no overdues
2100     if ( $borrowernumber
2101       && $patron->debarred
2102       && C4::Context->preference('AutoRemoveOverduesRestrictions')
2103       && !Koha::Patrons->find( $borrowernumber )->has_overdues
2104       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2105     ) {
2106         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2107     }
2108
2109     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2110     if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2111         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType");
2112         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2113             (C4::Context->preference("UseBranchTransferLimits") and
2114              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2115            )) {
2116             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2117             $debug and warn "item: " . Dumper($item_unblessed);
2118             ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2119             $messages->{'WasTransfered'} = 1;
2120         } else {
2121             $messages->{'NeedsTransfer'} = $returnbranch;
2122         }
2123     }
2124
2125     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2126 }
2127
2128 =head2 MarkIssueReturned
2129
2130   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2131
2132 Unconditionally marks an issue as being returned by
2133 moving the C<issues> row to C<old_issues> and
2134 setting C<returndate> to the current date.
2135
2136 if C<$returndate> is specified (in iso format), it is used as the date
2137 of the return.
2138
2139 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2140 the old_issue is immediately anonymised
2141
2142 Ideally, this function would be internal to C<C4::Circulation>,
2143 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2144 and offline_circ/process_koc.pl.
2145
2146 =cut
2147
2148 sub MarkIssueReturned {
2149     my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2150
2151     # Retrieve the issue
2152     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2153     my $issue_id = $issue->issue_id;
2154
2155     my $anonymouspatron;
2156     if ( $privacy == 2 ) {
2157         # The default of 0 will not work due to foreign key constraints
2158         # The anonymisation will fail if AnonymousPatron is not a valid entry
2159         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2160         # Note that a warning should appear on the about page (System information tab).
2161         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2162         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."
2163             unless Koha::Patrons->find( $anonymouspatron );
2164     }
2165
2166     my $schema = Koha::Database->schema;
2167
2168     # FIXME Improve the return value and handle it from callers
2169     $schema->txn_do(sub {
2170
2171         # Update the returndate value
2172         if ( $returndate ) {
2173             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2174         }
2175         else {
2176             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2177         }
2178
2179         # Create the old_issues entry
2180         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2181
2182         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2183         if ( $privacy == 2) {
2184             $old_checkout->borrowernumber($anonymouspatron)->store;
2185         }
2186
2187         # And finally delete the issue
2188         $issue->delete;
2189
2190         ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2191
2192         if ( C4::Context->preference('StoreLastBorrower') ) {
2193             my $item = Koha::Items->find( $itemnumber );
2194             my $patron = Koha::Patrons->find( $borrowernumber );
2195             $item->last_returned_by( $patron );
2196         }
2197     });
2198
2199     return $issue_id;
2200 }
2201
2202 =head2 _debar_user_on_return
2203
2204     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2205
2206 C<$borrower> borrower hashref
2207
2208 C<$item> item hashref
2209
2210 C<$datedue> date due DateTime object
2211
2212 C<$returndate> DateTime object representing the return time
2213
2214 Internal function, called only by AddReturn that calculates and updates
2215  the user fine days, and debars them if necessary.
2216
2217 Should only be called for overdue returns
2218
2219 =cut
2220
2221 sub _debar_user_on_return {
2222     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2223
2224     my $branchcode = _GetCircControlBranch( $item, $borrower );
2225     $return_date //= dt_from_string();
2226
2227     my $circcontrol = C4::Context->preference('CircControl');
2228     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2229         {   categorycode => $borrower->{categorycode},
2230             itemtype     => $item->{itype},
2231             branchcode   => $branchcode
2232         }
2233     );
2234     my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2235     my $unit     = $issuing_rule ? $issuing_rule->lengthunit : undef;
2236     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2237
2238     if ($finedays) {
2239
2240         # finedays is in days, so hourly loans must multiply by 24
2241         # thus 1 hour late equals 1 day suspension * finedays rate
2242         $finedays = $finedays * 24 if ( $unit eq 'hours' );
2243
2244         # grace period is measured in the same units as the loan
2245         my $grace =
2246           DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2247
2248         my $deltadays = DateTime::Duration->new(
2249             days => $chargeable_units
2250         );
2251         if ( $deltadays->subtract($grace)->is_positive() ) {
2252             my $suspension_days = $deltadays * $finedays;
2253
2254             # If the max suspension days is < than the suspension days
2255             # the suspension days is limited to this maximum period.
2256             my $max_sd = $issuing_rule->maxsuspensiondays;
2257             if ( defined $max_sd ) {
2258                 $max_sd = DateTime::Duration->new( days => $max_sd );
2259                 $suspension_days = $max_sd
2260                   if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2261             }
2262
2263             my ( $has_been_extended, $is_a_reminder );
2264             if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2265                 my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2266                 if ( $debarment ) {
2267                     $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2268                     $has_been_extended = 1;
2269                 }
2270             }
2271
2272             if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2273                 # No need to / 1 and do not consider / 0
2274                 $suspension_days = DateTime::Duration->new(
2275                     days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2276                 );
2277             }
2278
2279             my $new_debar_dt;
2280             # Use the calendar or not to calculate the debarment date
2281             if ( C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed' ) {
2282                 my $calendar = Koha::Calendar->new(
2283                     branchcode => $branchcode,
2284                     days_mode  => 'Calendar'
2285                 );
2286                 $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2287             }
2288             else {
2289                 $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2290             }
2291
2292             Koha::Patron::Debarments::AddUniqueDebarment({
2293                 borrowernumber => $borrower->{borrowernumber},
2294                 expiration     => $new_debar_dt->ymd(),
2295                 type           => 'SUSPENSION',
2296             });
2297             # if borrower was already debarred but does not get an extra debarment
2298             my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2299             my $new_debarment_str;
2300             if ( $borrower->{debarred} eq $patron->is_debarred ) {
2301                 $is_a_reminder = 1;
2302                 $new_debarment_str = $borrower->{debarred};
2303             } else {
2304                 $new_debarment_str = $new_debar_dt->ymd();
2305             }
2306             # FIXME Should return a DateTime object
2307             return $new_debarment_str, $is_a_reminder;
2308         }
2309     }
2310     return;
2311 }
2312
2313 =head2 _FixOverduesOnReturn
2314
2315    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine);
2316
2317 C<$borrowernumber> borrowernumber
2318
2319 C<$itemnumber> itemnumber
2320
2321 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2322
2323 Internal function
2324
2325 =cut
2326
2327 sub _FixOverduesOnReturn {
2328     my ( $borrowernumber, $item, $exemptfine ) = @_;
2329     unless( $borrowernumber ) {
2330         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2331         return;
2332     }
2333     unless( $item ) {
2334         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2335         return;
2336     }
2337
2338     my $schema = Koha::Database->schema;
2339
2340     my $result = $schema->txn_do(
2341         sub {
2342             # check for overdue fine
2343             my $accountlines = Koha::Account::Lines->search(
2344                 {
2345                     borrowernumber => $borrowernumber,
2346                     itemnumber     => $item,
2347                     accounttype    => 'OVERDUE',
2348                     status         => 'UNRETURNED'
2349                 }
2350             );
2351             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2352
2353             my $accountline = $accountlines->next;
2354             if ($exemptfine) {
2355                 my $amountoutstanding = $accountline->amountoutstanding;
2356
2357                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2358                 my $credit = $account->add_credit(
2359                     {
2360                         amount     => $amountoutstanding,
2361                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2362                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2363                         interface  => C4::Context->interface,
2364                         type       => 'forgiven',
2365                         item_id    => $item
2366                     }
2367                 );
2368
2369                 $credit->apply({ debits => $accountlines->reset, offset_type => 'Forgiven' });
2370
2371                 $accountline->status('FORGIVEN');
2372
2373                 if (C4::Context->preference("FinesLog")) {
2374                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2375                 }
2376             } else {
2377                 $accountline->status('RETURNED');
2378             }
2379
2380             return $accountline->store();
2381         }
2382     );
2383
2384     return $result;
2385 }
2386
2387 =head2 _FixAccountForLostAndReturned
2388
2389   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2390
2391 Calculates the charge for a book lost and returned.
2392
2393 Internal function, not exported, called only by AddReturn.
2394
2395 =cut
2396
2397 sub _FixAccountForLostAndReturned {
2398     my $itemnumber     = shift or return;
2399     my $borrowernumber = @_ ? shift : undef;
2400     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2401
2402     my $credit;
2403
2404     # check for charge made for lost book
2405     my $accountlines = Koha::Account::Lines->search(
2406         {
2407             itemnumber  => $itemnumber,
2408             accounttype => 'L',
2409         },
2410         {
2411             order_by => { -desc => [ 'date', 'accountlines_id' ] }
2412         }
2413     );
2414
2415     return unless $accountlines->count > 0;
2416     my $accountline     = $accountlines->next;
2417     my $total_to_refund = 0;
2418
2419     return unless $accountline->borrowernumber;
2420     my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2421     return unless $patron; # Patron has been deleted, nobody to credit the return to
2422
2423     my $account = $patron->account;
2424
2425     # Use cases
2426     if ( $accountline->amount > $accountline->amountoutstanding ) {
2427         # some amount has been cancelled. collect the offsets that are not writeoffs
2428         # this works because the only way to subtract from this kind of a debt is
2429         # using the UI buttons 'Pay' and 'Write off'
2430         my $credits_offsets = Koha::Account::Offsets->search({
2431             debit_id  => $accountline->id,
2432             credit_id => { '!=' => undef }, # it is not the debit itself
2433             type      => { '!=' => 'Writeoff' },
2434             amount    => { '<'  => 0 } # credits are negative on the DB
2435         });
2436
2437         $total_to_refund = ( $credits_offsets->count > 0 )
2438                             ? $credits_offsets->total * -1 # credits are negative on the DB
2439                             : 0;
2440     }
2441
2442     my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2443
2444     if ( $credit_total > 0 ) {
2445         my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2446         $credit = $account->add_credit(
2447             {   amount      => $credit_total,
2448                 description => 'Item Returned ' . $item_id,
2449                 type        => 'lost_item_return',
2450                 interface   => C4::Context->interface,
2451                 library_id  => $branchcode
2452             }
2453         );
2454
2455         # TODO: ->apply should just accept the accountline
2456         $credit->apply( { debits => $accountlines->reset } );
2457     }
2458
2459     # Manually set the accounttype
2460     $accountline->discard_changes->accounttype('LR');
2461     $accountline->store;
2462
2463     ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2464
2465     if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2466         $account->reconcile_balance;
2467     }
2468
2469     return ($credit) ? $credit->id : undef;
2470 }
2471
2472 =head2 _GetCircControlBranch
2473
2474    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2475
2476 Internal function :
2477
2478 Return the library code to be used to determine which circulation
2479 policy applies to a transaction.  Looks up the CircControl and
2480 HomeOrHoldingBranch system preferences.
2481
2482 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2483
2484 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2485
2486 =cut
2487
2488 sub _GetCircControlBranch {
2489     my ($item, $borrower) = @_;
2490     my $circcontrol = C4::Context->preference('CircControl');
2491     my $branch;
2492
2493     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2494         $branch= C4::Context->userenv->{'branch'};
2495     } elsif ($circcontrol eq 'PatronLibrary') {
2496         $branch=$borrower->{branchcode};
2497     } else {
2498         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2499         $branch = $item->{$branchfield};
2500         # default to item home branch if holdingbranch is used
2501         # and is not defined
2502         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2503             $branch = $item->{homebranch};
2504         }
2505     }
2506     return $branch;
2507 }
2508
2509 =head2 GetOpenIssue
2510
2511   $issue = GetOpenIssue( $itemnumber );
2512
2513 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2514
2515 C<$itemnumber> is the item's itemnumber
2516
2517 Returns a hashref
2518
2519 =cut
2520
2521 sub GetOpenIssue {
2522   my ( $itemnumber ) = @_;
2523   return unless $itemnumber;
2524   my $dbh = C4::Context->dbh;
2525   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2526   $sth->execute( $itemnumber );
2527   return $sth->fetchrow_hashref();
2528
2529 }
2530
2531 =head2 GetBiblioIssues
2532
2533   $issues = GetBiblioIssues($biblionumber);
2534
2535 this function get all issues from a biblionumber.
2536
2537 Return:
2538 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2539 tables issues and the firstname,surname & cardnumber from borrowers.
2540
2541 =cut
2542
2543 sub GetBiblioIssues {
2544     my $biblionumber = shift;
2545     return unless $biblionumber;
2546     my $dbh   = C4::Context->dbh;
2547     my $query = "
2548         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2549         FROM issues
2550             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2551             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2552             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2553             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2554         WHERE biblio.biblionumber = ?
2555         UNION ALL
2556         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2557         FROM old_issues
2558             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2559             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2560             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2561             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2562         WHERE biblio.biblionumber = ?
2563         ORDER BY timestamp
2564     ";
2565     my $sth = $dbh->prepare($query);
2566     $sth->execute($biblionumber, $biblionumber);
2567
2568     my @issues;
2569     while ( my $data = $sth->fetchrow_hashref ) {
2570         push @issues, $data;
2571     }
2572     return \@issues;
2573 }
2574
2575 =head2 GetUpcomingDueIssues
2576
2577   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2578
2579 =cut
2580
2581 sub GetUpcomingDueIssues {
2582     my $params = shift;
2583
2584     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2585     my $dbh = C4::Context->dbh;
2586
2587     my $statement = <<END_SQL;
2588 SELECT *
2589 FROM (
2590     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2591     FROM issues
2592     LEFT JOIN items USING (itemnumber)
2593     LEFT OUTER JOIN branches USING (branchcode)
2594     WHERE returndate is NULL
2595 ) tmp
2596 WHERE days_until_due >= 0 AND days_until_due <= ?
2597 END_SQL
2598
2599     my @bind_parameters = ( $params->{'days_in_advance'} );
2600
2601     my $sth = $dbh->prepare( $statement );
2602     $sth->execute( @bind_parameters );
2603     my $upcoming_dues = $sth->fetchall_arrayref({});
2604
2605     return $upcoming_dues;
2606 }
2607
2608 =head2 CanBookBeRenewed
2609
2610   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2611
2612 Find out whether a borrowed item may be renewed.
2613
2614 C<$borrowernumber> is the borrower number of the patron who currently
2615 has the item on loan.
2616
2617 C<$itemnumber> is the number of the item to renew.
2618
2619 C<$override_limit>, if supplied with a true value, causes
2620 the limit on the number of times that the loan can be renewed
2621 (as controlled by the item type) to be ignored. Overriding also allows
2622 to renew sooner than "No renewal before" and to manually renew loans
2623 that are automatically renewed.
2624
2625 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2626 item must currently be on loan to the specified borrower; renewals
2627 must be allowed for the item's type; and the borrower must not have
2628 already renewed the loan. $error will contain the reason the renewal can not proceed
2629
2630 =cut
2631
2632 sub CanBookBeRenewed {
2633     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2634
2635     my $dbh    = C4::Context->dbh;
2636     my $renews = 1;
2637
2638     my $item      = Koha::Items->find($itemnumber)      or return ( 0, 'no_item' );
2639     my $issue = $item->checkout or return ( 0, 'no_checkout' );
2640     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2641     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2642
2643     my $patron = $issue->patron or return;
2644
2645     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2646
2647     # This item can fill one or more unfilled reserve, can those unfilled reserves
2648     # all be filled by other available items?
2649     if ( $resfound
2650         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2651     {
2652         my $schema = Koha::Database->new()->schema();
2653
2654         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2655         if ($item_holds) {
2656             # There is an item level hold on this item, no other item can fill the hold
2657             $resfound = 1;
2658         }
2659         else {
2660
2661             # Get all other items that could possibly fill reserves
2662             my @itemnumbers = $schema->resultset('Item')->search(
2663                 {
2664                     biblionumber => $resrec->{biblionumber},
2665                     onloan       => undef,
2666                     notforloan   => 0,
2667                     -not         => { itemnumber => $itemnumber }
2668                 },
2669                 { columns => 'itemnumber' }
2670             )->get_column('itemnumber')->all();
2671
2672             # Get all other reserves that could have been filled by this item
2673             my @borrowernumbers;
2674             while (1) {
2675                 my ( $reserve_found, $reserve, undef ) =
2676                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2677
2678                 if ($reserve_found) {
2679                     push( @borrowernumbers, $reserve->{borrowernumber} );
2680                 }
2681                 else {
2682                     last;
2683                 }
2684             }
2685
2686             # If the count of the union of the lists of reservable items for each borrower
2687             # is equal or greater than the number of borrowers, we know that all reserves
2688             # can be filled with available items. We can get the union of the sets simply
2689             # by pushing all the elements onto an array and removing the duplicates.
2690             my @reservable;
2691             my %patrons;
2692             ITEM: foreach my $itemnumber (@itemnumbers) {
2693                 my $item = Koha::Items->find( $itemnumber );
2694                 next if IsItemOnHoldAndFound( $itemnumber );
2695                 for my $borrowernumber (@borrowernumbers) {
2696                     my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2697                     next unless IsAvailableForItemLevelRequest($item, $patron);
2698                     next unless CanItemBeReserved($borrowernumber,$itemnumber);
2699
2700                     push @reservable, $itemnumber;
2701                     if (@reservable >= @borrowernumbers) {
2702                         $resfound = 0;
2703                         last ITEM;
2704                     }
2705                     last;
2706                 }
2707             }
2708         }
2709     }
2710     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2711
2712     return ( 1, undef ) if $override_limit;
2713
2714     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2715     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2716         {   categorycode => $patron->categorycode,
2717             itemtype     => $item->effective_itemtype,
2718             branchcode   => $branchcode
2719         }
2720     );
2721
2722     return ( 0, "too_many" )
2723       if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2724
2725     my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2726     my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2727     $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2728     my $restricted  = $patron->is_debarred;
2729     my $hasoverdues = $patron->has_overdues;
2730
2731     if ( $restricted and $restrictionblockrenewing ) {
2732         return ( 0, 'restriction');
2733     } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2734         return ( 0, 'overdue');
2735     }
2736
2737     if ( $issue->auto_renew ) {
2738
2739         if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2740             return ( 0, 'auto_account_expired' );
2741         }
2742
2743         if ( defined $issuing_rule->no_auto_renewal_after
2744                 and $issuing_rule->no_auto_renewal_after ne "" ) {
2745             # Get issue_date and add no_auto_renewal_after
2746             # If this is greater than today, it's too late for renewal.
2747             my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2748             $maximum_renewal_date->add(
2749                 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2750             );
2751             my $now = dt_from_string;
2752             if ( $now >= $maximum_renewal_date ) {
2753                 return ( 0, "auto_too_late" );
2754             }
2755         }
2756         if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2757                       and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2758             # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2759             if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2760                 return ( 0, "auto_too_late" );
2761             }
2762         }
2763
2764         if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2765             my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2766             my $amountoutstanding = $patron->account->balance;
2767             if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2768                 return ( 0, "auto_too_much_oweing" );
2769             }
2770         }
2771     }
2772
2773     if ( defined $issuing_rule->norenewalbefore
2774         and $issuing_rule->norenewalbefore ne "" )
2775     {
2776
2777         # Calculate soonest renewal by subtracting 'No renewal before' from due date
2778         my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2779             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2780
2781         # Depending on syspref reset the exact time, only check the date
2782         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2783             and $issuing_rule->lengthunit eq 'days' )
2784         {
2785             $soonestrenewal->truncate( to => 'day' );
2786         }
2787
2788         if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2789         {
2790             return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2791             return ( 0, "too_soon" );
2792         }
2793         elsif ( $issue->auto_renew ) {
2794             return ( 0, "auto_renew" );
2795         }
2796     }
2797
2798     # Fallback for automatic renewals:
2799     # If norenewalbefore is undef, don't renew before due date.
2800     if ( $issue->auto_renew ) {
2801         my $now = dt_from_string;
2802         return ( 0, "auto_renew" )
2803           if $now >= dt_from_string( $issue->date_due, 'sql' );
2804         return ( 0, "auto_too_soon" );
2805     }
2806
2807     return ( 1, undef );
2808 }
2809
2810 =head2 AddRenewal
2811
2812   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2813
2814 Renews a loan.
2815
2816 C<$borrowernumber> is the borrower number of the patron who currently
2817 has the item.
2818
2819 C<$itemnumber> is the number of the item to renew.
2820
2821 C<$branch> is the library where the renewal took place (if any).
2822            The library that controls the circ policies for the renewal is retrieved from the issues record.
2823
2824 C<$datedue> can be a DateTime object used to set the due date.
2825
2826 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2827 this parameter is not supplied, lastreneweddate is set to the current date.
2828
2829 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2830 from the book's item type.
2831
2832 =cut
2833
2834 sub AddRenewal {
2835     my $borrowernumber  = shift;
2836     my $itemnumber      = shift or return;
2837     my $branch          = shift;
2838     my $datedue         = shift;
2839     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2840
2841     my $item_object   = Koha::Items->find($itemnumber) or return;
2842     my $biblio = $item_object->biblio;
2843     my $issue  = $item_object->checkout;
2844     my $item_unblessed = $item_object->unblessed;
2845
2846     my $dbh = C4::Context->dbh;
2847
2848     return unless $issue;
2849
2850     $borrowernumber ||= $issue->borrowernumber;
2851
2852     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2853         carp 'Invalid date passed to AddRenewal.';
2854         return;
2855     }
2856
2857     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2858     my $patron_unblessed = $patron->unblessed;
2859
2860     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2861
2862     if ( C4::Context->preference('CalculateFinesOnReturn') && $issue->is_overdue ) {
2863         _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2864     }
2865     _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2866
2867     # If the due date wasn't specified, calculate it by adding the
2868     # book's loan length to today's date or the current due date
2869     # based on the value of the RenewalPeriodBase syspref.
2870     my $itemtype = $item_object->effective_itemtype;
2871     unless ($datedue) {
2872
2873         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2874                                         dt_from_string( $issue->date_due, 'sql' ) :
2875                                         DateTime->now( time_zone => C4::Context->tz());
2876         $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2877     }
2878
2879     my $fees = Koha::Charges::Fees->new(
2880         {
2881             patron    => $patron,
2882             library   => $circ_library,
2883             item      => $item_object,
2884             from_date => dt_from_string( $issue->date_due, 'sql' ),
2885             to_date   => dt_from_string($datedue),
2886         }
2887     );
2888
2889     # Update the issues record to have the new due date, and a new count
2890     # of how many times it has been renewed.
2891     my $renews = $issue->renewals + 1;
2892     my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2893                             WHERE borrowernumber=?
2894                             AND itemnumber=?"
2895     );
2896
2897     $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2898
2899     # Update the renewal count on the item, and tell zebra to reindex
2900     $renews = $item_object->renewals + 1;
2901     ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2902
2903     # Charge a new rental fee, if applicable
2904     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2905     if ( $charge > 0 ) {
2906         my $description = "Renewal of Rental Item " . $biblio->title . " " .$item_object->barcode;
2907         AddIssuingCharge($issue, $charge, $description);
2908     }
2909
2910     # Charge a new accumulate rental fee, if applicable
2911     my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2912     if ( $itemtype_object ) {
2913         my $accumulate_charge = $fees->accumulate_rentalcharge();
2914         if ( $accumulate_charge > 0 ) {
2915             my $type_desc = "Renewal of Daily Rental Item " . $biblio->title . " $item_unblessed->{'barcode'}";
2916             AddIssuingCharge( $issue, $accumulate_charge, $type_desc )
2917         }
2918         $charge += $accumulate_charge;
2919     }
2920
2921     # Send a renewal slip according to checkout alert preferencei
2922     if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2923         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2924         my %conditions        = (
2925             branchcode   => $branch,
2926             categorycode => $patron->categorycode,
2927             item_type    => $itemtype,
2928             notification => 'CHECKOUT',
2929         );
2930         if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2931             SendCirculationAlert(
2932                 {
2933                     type     => 'RENEWAL',
2934                     item     => $item_unblessed,
2935                     borrower => $patron->unblessed,
2936                     branch   => $branch,
2937                 }
2938             );
2939         }
2940     }
2941
2942     # Remove any OVERDUES related debarment if the borrower has no overdues
2943     if ( $patron
2944       && $patron->is_debarred
2945       && ! $patron->has_overdues
2946       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2947     ) {
2948         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2949     }
2950
2951     unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2952         $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2953     }
2954
2955     # Add the renewal to stats
2956     UpdateStats(
2957         {
2958             branch         => $branch,
2959             type           => 'renew',
2960             amount         => $charge,
2961             itemnumber     => $itemnumber,
2962             itemtype       => $itemtype,
2963             location       => $item_object->location,
2964             borrowernumber => $borrowernumber,
2965             ccode          => $item_object->ccode,
2966         }
2967     );
2968
2969     #Log the renewal
2970     logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2971     return $datedue;
2972 }
2973
2974 sub GetRenewCount {
2975     # check renewal status
2976     my ( $bornum, $itemno ) = @_;
2977     my $dbh           = C4::Context->dbh;
2978     my $renewcount    = 0;
2979     my $renewsallowed = 0;
2980     my $renewsleft    = 0;
2981
2982     my $patron = Koha::Patrons->find( $bornum );
2983     my $item   = Koha::Items->find($itemno);
2984
2985     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
2986
2987     # Look in the issues table for this item, lent to this borrower,
2988     # and not yet returned.
2989
2990     # FIXME - I think this function could be redone to use only one SQL call.
2991     my $sth = $dbh->prepare(
2992         "select * from issues
2993                                 where (borrowernumber = ?)
2994                                 and (itemnumber = ?)"
2995     );
2996     $sth->execute( $bornum, $itemno );
2997     my $data = $sth->fetchrow_hashref;
2998     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2999     # $item and $borrower should be calculated
3000     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3001
3002     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3003         {   categorycode => $patron->categorycode,
3004             itemtype     => $item->effective_itemtype,
3005             branchcode   => $branchcode
3006         }
3007     );
3008
3009     $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3010     $renewsleft    = $renewsallowed - $renewcount;
3011     if($renewsleft < 0){ $renewsleft = 0; }
3012     return ( $renewcount, $renewsallowed, $renewsleft );
3013 }
3014
3015 =head2 GetSoonestRenewDate
3016
3017   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3018
3019 Find out the soonest possible renew date of a borrowed item.
3020
3021 C<$borrowernumber> is the borrower number of the patron who currently
3022 has the item on loan.
3023
3024 C<$itemnumber> is the number of the item to renew.
3025
3026 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3027 renew date, based on the value "No renewal before" of the applicable
3028 issuing rule. Returns the current date if the item can already be
3029 renewed, and returns undefined if the borrower, loan, or item
3030 cannot be found.
3031
3032 =cut
3033
3034 sub GetSoonestRenewDate {
3035     my ( $borrowernumber, $itemnumber ) = @_;
3036
3037     my $dbh = C4::Context->dbh;
3038
3039     my $item      = Koha::Items->find($itemnumber)      or return;
3040     my $itemissue = $item->checkout or return;
3041
3042     $borrowernumber ||= $itemissue->borrowernumber;
3043     my $patron = Koha::Patrons->find( $borrowernumber )
3044       or return;
3045
3046     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3047     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3048         {   categorycode => $patron->categorycode,
3049             itemtype     => $item->effective_itemtype,
3050             branchcode   => $branchcode
3051         }
3052     );
3053
3054     my $now = dt_from_string;
3055     return $now unless $issuing_rule;
3056
3057     if ( defined $issuing_rule->norenewalbefore
3058         and $issuing_rule->norenewalbefore ne "" )
3059     {
3060         my $soonestrenewal =
3061           dt_from_string( $itemissue->date_due )->subtract(
3062             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3063
3064         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3065             and $issuing_rule->lengthunit eq 'days' )
3066         {
3067             $soonestrenewal->truncate( to => 'day' );
3068         }
3069         return $soonestrenewal if $now < $soonestrenewal;
3070     }
3071     return $now;
3072 }
3073
3074 =head2 GetLatestAutoRenewDate
3075
3076   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3077
3078 Find out the latest possible auto renew date of a borrowed item.
3079
3080 C<$borrowernumber> is the borrower number of the patron who currently
3081 has the item on loan.
3082
3083 C<$itemnumber> is the number of the item to renew.
3084
3085 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3086 auto renew date, based on the value "No auto renewal after" and the "No auto
3087 renewal after (hard limit) of the applicable issuing rule.
3088 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3089 or item cannot be found.
3090
3091 =cut
3092
3093 sub GetLatestAutoRenewDate {
3094     my ( $borrowernumber, $itemnumber ) = @_;
3095
3096     my $dbh = C4::Context->dbh;
3097
3098     my $item      = Koha::Items->find($itemnumber)  or return;
3099     my $itemissue = $item->checkout                 or return;
3100
3101     $borrowernumber ||= $itemissue->borrowernumber;
3102     my $patron = Koha::Patrons->find( $borrowernumber )
3103       or return;
3104
3105     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3106     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3107         {   categorycode => $patron->categorycode,
3108             itemtype     => $item->effective_itemtype,
3109             branchcode   => $branchcode
3110         }
3111     );
3112
3113     return unless $issuing_rule;
3114     return
3115       if ( not $issuing_rule->no_auto_renewal_after
3116             or $issuing_rule->no_auto_renewal_after eq '' )
3117       and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3118              or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3119
3120     my $maximum_renewal_date;
3121     if ( $issuing_rule->no_auto_renewal_after ) {
3122         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3123         $maximum_renewal_date->add(
3124             $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3125         );
3126     }
3127
3128     if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3129         my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3130         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3131     }
3132     return $maximum_renewal_date;
3133 }
3134
3135
3136 =head2 GetIssuingCharges
3137
3138   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3139
3140 Calculate how much it would cost for a given patron to borrow a given
3141 item, including any applicable discounts.
3142
3143 C<$itemnumber> is the item number of item the patron wishes to borrow.
3144
3145 C<$borrowernumber> is the patron's borrower number.
3146
3147 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3148 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3149 if it's a video).
3150
3151 =cut
3152
3153 sub GetIssuingCharges {
3154
3155     # calculate charges due
3156     my ( $itemnumber, $borrowernumber ) = @_;
3157     my $charge = 0;
3158     my $dbh    = C4::Context->dbh;
3159     my $item_type;
3160
3161     # Get the book's item type and rental charge (via its biblioitem).
3162     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3163         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3164     $charge_query .= (C4::Context->preference('item-level_itypes'))
3165         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3166         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3167
3168     $charge_query .= ' WHERE items.itemnumber =?';
3169
3170     my $sth = $dbh->prepare($charge_query);
3171     $sth->execute($itemnumber);
3172     if ( my $item_data = $sth->fetchrow_hashref ) {
3173         $item_type = $item_data->{itemtype};
3174         $charge    = $item_data->{rentalcharge};
3175         my $branch = C4::Context::mybranch();
3176         my $discount_query = q|SELECT rentaldiscount,
3177             issuingrules.itemtype, issuingrules.branchcode
3178             FROM borrowers
3179             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3180             WHERE borrowers.borrowernumber = ?
3181             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3182             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3183         my $discount_sth = $dbh->prepare($discount_query);
3184         $discount_sth->execute( $borrowernumber, $item_type, $branch );
3185         my $discount_rules = $discount_sth->fetchall_arrayref({});
3186         if (@{$discount_rules}) {
3187             # We may have multiple rules so get the most specific
3188             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3189             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3190         }
3191         if ($charge) {
3192             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3193         }
3194     }
3195
3196     return ( $charge, $item_type );
3197 }
3198
3199 # Select most appropriate discount rule from those returned
3200 sub _get_discount_from_rule {
3201     my ($rules_ref, $branch, $itemtype) = @_;
3202     my $discount;
3203
3204     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3205         $discount = $rules_ref->[0]->{rentaldiscount};
3206         return (defined $discount) ? $discount : 0;
3207     }
3208     # could have up to 4 does one match $branch and $itemtype
3209     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3210     if (@d) {
3211         $discount = $d[0]->{rentaldiscount};
3212         return (defined $discount) ? $discount : 0;
3213     }
3214     # do we have item type + all branches
3215     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3216     if (@d) {
3217         $discount = $d[0]->{rentaldiscount};
3218         return (defined $discount) ? $discount : 0;
3219     }
3220     # do we all item types + this branch
3221     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3222     if (@d) {
3223         $discount = $d[0]->{rentaldiscount};
3224         return (defined $discount) ? $discount : 0;
3225     }
3226     # so all and all (surely we wont get here)
3227     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3228     if (@d) {
3229         $discount = $d[0]->{rentaldiscount};
3230         return (defined $discount) ? $discount : 0;
3231     }
3232     # none of the above
3233     return 0;
3234 }
3235
3236 =head2 AddIssuingCharge
3237
3238   &AddIssuingCharge( $checkout, $charge, [$description] )
3239
3240 =cut
3241
3242 sub AddIssuingCharge {
3243     my ( $checkout, $charge, $description ) = @_;
3244
3245     # FIXME What if checkout does not exist?
3246
3247     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3248     my $accountline = $account->add_debit(
3249         {
3250             amount      => $charge,
3251             description => $description,
3252             note        => undef,
3253             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3254             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3255             interface   => C4::Context->interface,
3256             type        => 'rent',
3257             item_id     => $checkout->itemnumber,
3258             issue_id    => $checkout->issue_id,
3259         }
3260     );
3261 }
3262
3263 =head2 GetTransfers
3264
3265   GetTransfers($itemnumber);
3266
3267 =cut
3268
3269 sub GetTransfers {
3270     my ($itemnumber) = @_;
3271
3272     my $dbh = C4::Context->dbh;
3273
3274     my $query = '
3275         SELECT datesent,
3276                frombranch,
3277                tobranch,
3278                branchtransfer_id
3279         FROM branchtransfers
3280         WHERE itemnumber = ?
3281           AND datearrived IS NULL
3282         ';
3283     my $sth = $dbh->prepare($query);
3284     $sth->execute($itemnumber);
3285     my @row = $sth->fetchrow_array();
3286     return @row;
3287 }
3288
3289 =head2 GetTransfersFromTo
3290
3291   @results = GetTransfersFromTo($frombranch,$tobranch);
3292
3293 Returns the list of pending transfers between $from and $to branch
3294
3295 =cut
3296
3297 sub GetTransfersFromTo {
3298     my ( $frombranch, $tobranch ) = @_;
3299     return unless ( $frombranch && $tobranch );
3300     my $dbh   = C4::Context->dbh;
3301     my $query = "
3302         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3303         FROM   branchtransfers
3304         WHERE  frombranch=?
3305           AND  tobranch=?
3306           AND datearrived IS NULL
3307     ";
3308     my $sth = $dbh->prepare($query);
3309     $sth->execute( $frombranch, $tobranch );
3310     my @gettransfers;
3311
3312     while ( my $data = $sth->fetchrow_hashref ) {
3313         push @gettransfers, $data;
3314     }
3315     return (@gettransfers);
3316 }
3317
3318 =head2 DeleteTransfer
3319
3320   &DeleteTransfer($itemnumber);
3321
3322 =cut
3323
3324 sub DeleteTransfer {
3325     my ($itemnumber) = @_;
3326     return unless $itemnumber;
3327     my $dbh          = C4::Context->dbh;
3328     my $sth          = $dbh->prepare(
3329         "DELETE FROM branchtransfers
3330          WHERE itemnumber=?
3331          AND datearrived IS NULL "
3332     );
3333     return $sth->execute($itemnumber);
3334 }
3335
3336 =head2 SendCirculationAlert
3337
3338 Send out a C<check-in> or C<checkout> alert using the messaging system.
3339
3340 B<Parameters>:
3341
3342 =over 4
3343
3344 =item type
3345
3346 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3347
3348 =item item
3349
3350 Hashref of information about the item being checked in or out.
3351
3352 =item borrower
3353
3354 Hashref of information about the borrower of the item.
3355
3356 =item branch
3357
3358 The branchcode from where the checkout or check-in took place.
3359
3360 =back
3361
3362 B<Example>:
3363
3364     SendCirculationAlert({
3365         type     => 'CHECKOUT',
3366         item     => $item,
3367         borrower => $borrower,
3368         branch   => $branch,
3369     });
3370
3371 =cut
3372
3373 sub SendCirculationAlert {
3374     my ($opts) = @_;
3375     my ($type, $item, $borrower, $branch) =
3376         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3377     my %message_name = (
3378         CHECKIN  => 'Item_Check_in',
3379         CHECKOUT => 'Item_Checkout',
3380         RENEWAL  => 'Item_Checkout',
3381     );
3382     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3383         borrowernumber => $borrower->{borrowernumber},
3384         message_name   => $message_name{$type},
3385     });
3386     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3387
3388     my $schema = Koha::Database->new->schema;
3389     my @transports = keys %{ $borrower_preferences->{transports} };
3390
3391     # From the MySQL doc:
3392     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3393     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3394     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3395     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3396
3397     for my $mtt (@transports) {
3398         my $letter =  C4::Letters::GetPreparedLetter (
3399             module => 'circulation',
3400             letter_code => $type,
3401             branchcode => $branch,
3402             message_transport_type => $mtt,
3403             lang => $borrower->{lang},
3404             tables => {
3405                 $issues_table => $item->{itemnumber},
3406                 'items'       => $item->{itemnumber},
3407                 'biblio'      => $item->{biblionumber},
3408                 'biblioitems' => $item->{biblionumber},
3409                 'borrowers'   => $borrower,
3410                 'branches'    => $branch,
3411             }
3412         ) or next;
3413
3414         $schema->storage->txn_begin;
3415         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3416         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3417         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3418         unless ( $message ) {
3419             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3420             C4::Message->enqueue($letter, $borrower, $mtt);
3421         } else {
3422             $message->append($letter);
3423             $message->update;
3424         }
3425         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3426         $schema->storage->txn_commit;
3427     }
3428
3429     return;
3430 }
3431
3432 =head2 updateWrongTransfer
3433
3434   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3435
3436 This function validate the line of brachtransfer but with the wrong destination (mistake from a librarian ...), and create a new line in branchtransfer from the actual library to the original library of reservation
3437
3438 =cut
3439
3440 sub updateWrongTransfer {
3441         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3442         my $dbh = C4::Context->dbh;
3443 # first step validate the actual line of transfert .
3444         my $sth =
3445                 $dbh->prepare(
3446                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3447                 );
3448                 $sth->execute($FromLibrary,$itemNumber);
3449
3450 # second step create a new line of branchtransfer to the right location .
3451         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3452
3453 #third step changing holdingbranch of item
3454         UpdateHoldingbranch($FromLibrary,$itemNumber);
3455 }
3456
3457 =head2 UpdateHoldingbranch
3458
3459   $items = UpdateHoldingbranch($branch,$itmenumber);
3460
3461 Simple methode for updating hodlingbranch in items BDD line
3462
3463 =cut
3464
3465 sub UpdateHoldingbranch {
3466         my ( $branch,$itemnumber ) = @_;
3467     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3468 }
3469
3470 =head2 CalcDateDue
3471
3472 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3473
3474 this function calculates the due date given the start date and configured circulation rules,
3475 checking against the holidays calendar as per the 'useDaysMode' syspref.
3476 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3477 C<$itemtype>  = itemtype code of item in question
3478 C<$branch>  = location whose calendar to use
3479 C<$borrower> = Borrower object
3480 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3481
3482 =cut
3483
3484 sub CalcDateDue {
3485     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3486
3487     $isrenewal ||= 0;
3488
3489     # loanlength now a href
3490     my $loanlength =
3491             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3492
3493     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3494             ? qq{renewalperiod}
3495             : qq{issuelength};
3496
3497     my $datedue;
3498     if ( $startdate ) {
3499         if (ref $startdate ne 'DateTime' ) {
3500             $datedue = dt_from_string($datedue);
3501         } else {
3502             $datedue = $startdate->clone;
3503         }
3504     } else {
3505         $datedue =
3506           DateTime->now( time_zone => C4::Context->tz() )
3507           ->truncate( to => 'minute' );
3508     }
3509
3510
3511     # calculate the datedue as normal
3512     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3513     {    # ignoring calendar
3514         if ( $loanlength->{lengthunit} eq 'hours' ) {
3515             $datedue->add( hours => $loanlength->{$length_key} );
3516         } else {    # days
3517             $datedue->add( days => $loanlength->{$length_key} );
3518             $datedue->set_hour(23);
3519             $datedue->set_minute(59);
3520         }
3521     } else {
3522         my $dur;
3523         if ($loanlength->{lengthunit} eq 'hours') {
3524             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3525         }
3526         else { # days
3527             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3528         }
3529         my $calendar = Koha::Calendar->new( branchcode => $branch );
3530         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3531         if ($loanlength->{lengthunit} eq 'days') {
3532             $datedue->set_hour(23);
3533             $datedue->set_minute(59);
3534         }
3535     }
3536
3537     # if Hard Due Dates are used, retrieve them and apply as necessary
3538     my ( $hardduedate, $hardduedatecompare ) =
3539       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3540     if ($hardduedate) {    # hardduedates are currently dates
3541         $hardduedate->truncate( to => 'minute' );
3542         $hardduedate->set_hour(23);
3543         $hardduedate->set_minute(59);
3544         my $cmp = DateTime->compare( $hardduedate, $datedue );
3545
3546 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3547 # if the calculated date is before the 'after' Hard Due Date (floor), override
3548 # if the hard due date is set to 'exactly', overrride
3549         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3550             $datedue = $hardduedate->clone;
3551         }
3552
3553         # in all other cases, keep the date due as it is
3554
3555     }
3556
3557     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3558     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3559         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3560         if( $expiry_dt ) { #skip empty expiry date..
3561             $expiry_dt->set( hour => 23, minute => 59);
3562             my $d1= $datedue->clone->set_time_zone('floating');
3563             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3564                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3565             }
3566         }
3567         if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3568           my $calendar = Koha::Calendar->new( branchcode => $branch );
3569           if ( $calendar->is_holiday($datedue) ) {
3570               # Don't return on a closed day
3571               $datedue = $calendar->prev_open_day( $datedue );
3572           }
3573         }
3574     }
3575
3576     return $datedue;
3577 }
3578
3579
3580 sub CheckValidBarcode{
3581 my ($barcode) = @_;
3582 my $dbh = C4::Context->dbh;
3583 my $query=qq|SELECT count(*)
3584              FROM items
3585              WHERE barcode=?
3586             |;
3587 my $sth = $dbh->prepare($query);
3588 $sth->execute($barcode);
3589 my $exist=$sth->fetchrow ;
3590 return $exist;
3591 }
3592
3593 =head2 IsBranchTransferAllowed
3594
3595   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3596
3597 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3598
3599 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3600 Koha::Item->can_be_transferred.
3601
3602 =cut
3603
3604 sub IsBranchTransferAllowed {
3605         my ( $toBranch, $fromBranch, $code ) = @_;
3606
3607         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3608
3609         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3610         my $dbh = C4::Context->dbh;
3611
3612         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3613         $sth->execute( $toBranch, $fromBranch, $code );
3614         my $limit = $sth->fetchrow_hashref();
3615
3616         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3617         if ( $limit->{'limitId'} ) {
3618                 return 0;
3619         } else {
3620                 return 1;
3621         }
3622 }
3623
3624 =head2 CreateBranchTransferLimit
3625
3626   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3627
3628 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3629
3630 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3631
3632 =cut
3633
3634 sub CreateBranchTransferLimit {
3635    my ( $toBranch, $fromBranch, $code ) = @_;
3636    return unless defined($toBranch) && defined($fromBranch);
3637    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3638
3639    my $dbh = C4::Context->dbh;
3640
3641    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3642    return $sth->execute( $code, $toBranch, $fromBranch );
3643 }
3644
3645 =head2 DeleteBranchTransferLimits
3646
3647     my $result = DeleteBranchTransferLimits($frombranch);
3648
3649 Deletes all the library transfer limits for one library.  Returns the
3650 number of limits deleted, 0e0 if no limits were deleted, or undef if
3651 no arguments are supplied.
3652
3653 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3654     fromBranch => $fromBranch
3655     })->delete.
3656
3657 =cut
3658
3659 sub DeleteBranchTransferLimits {
3660     my $branch = shift;
3661     return unless defined $branch;
3662     my $dbh    = C4::Context->dbh;
3663     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3664     return $sth->execute($branch);
3665 }
3666
3667 sub ReturnLostItem{
3668     my ( $borrowernumber, $itemnum ) = @_;
3669
3670     MarkIssueReturned( $borrowernumber, $itemnum );
3671     my $patron = Koha::Patrons->find( $borrowernumber );
3672     my $item = Koha::Items->find($itemnum);
3673     my $old_note = ($item->paidfor && ($item->paidfor ne q{})) ? $item->paidfor.' / ' : q{};
3674     my @datearr = localtime(time);
3675     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3676     my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3677     ModItem({ paidfor =>  $old_note."Paid for by $bor $date" }, undef, $itemnum);
3678 }
3679
3680
3681 sub LostItem{
3682     my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3683
3684     unless ( $mark_lost_from ) {
3685         # Temporary check to avoid regressions
3686         die q|LostItem called without $mark_lost_from, check the API.|;
3687     }
3688
3689     my $mark_returned;
3690     if ( $force_mark_returned ) {
3691         $mark_returned = 1;
3692     } else {
3693         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3694         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3695     }
3696
3697     my $dbh = C4::Context->dbh();
3698     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3699                            FROM issues
3700                            JOIN items USING (itemnumber)
3701                            JOIN biblio USING (biblionumber)
3702                            WHERE issues.itemnumber=?");
3703     $sth->execute($itemnumber);
3704     my $issues=$sth->fetchrow_hashref();
3705
3706     # If a borrower lost the item, add a replacement cost to the their record
3707     if ( my $borrowernumber = $issues->{borrowernumber} ){
3708         my $patron = Koha::Patrons->find( $borrowernumber );
3709
3710         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 0); # 1, 0 = exemptfine, no-dropbox
3711         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3712
3713         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3714             C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "$issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3715             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3716             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3717         }
3718
3719         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3720     }
3721
3722     #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3723     if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3724         ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3725     }
3726     my $transferdeleted = DeleteTransfer($itemnumber);
3727 }
3728
3729 sub GetOfflineOperations {
3730     my $dbh = C4::Context->dbh;
3731     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3732     $sth->execute(C4::Context->userenv->{'branch'});
3733     my $results = $sth->fetchall_arrayref({});
3734     return $results;
3735 }
3736
3737 sub GetOfflineOperation {
3738     my $operationid = shift;
3739     return unless $operationid;
3740     my $dbh = C4::Context->dbh;
3741     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3742     $sth->execute( $operationid );
3743     return $sth->fetchrow_hashref;
3744 }
3745
3746 sub AddOfflineOperation {
3747     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3748     my $dbh = C4::Context->dbh;
3749     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3750     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3751     return "Added.";
3752 }
3753
3754 sub DeleteOfflineOperation {
3755     my $dbh = C4::Context->dbh;
3756     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3757     $sth->execute( shift );
3758     return "Deleted.";
3759 }
3760
3761 sub ProcessOfflineOperation {
3762     my $operation = shift;
3763
3764     my $report;
3765     if ( $operation->{action} eq 'return' ) {
3766         $report = ProcessOfflineReturn( $operation );
3767     } elsif ( $operation->{action} eq 'issue' ) {
3768         $report = ProcessOfflineIssue( $operation );
3769     } elsif ( $operation->{action} eq 'payment' ) {
3770         $report = ProcessOfflinePayment( $operation );
3771     }
3772
3773     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3774
3775     return $report;
3776 }
3777
3778 sub ProcessOfflineReturn {
3779     my $operation = shift;
3780
3781     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3782
3783     if ( $item ) {
3784         my $itemnumber = $item->itemnumber;
3785         my $issue = GetOpenIssue( $itemnumber );
3786         if ( $issue ) {
3787             MarkIssueReturned(
3788                 $issue->{borrowernumber},
3789                 $itemnumber,
3790                 $operation->{timestamp},
3791             );
3792             ModItem(
3793                 { renewals => 0, onloan => undef },
3794                 $issue->{'biblionumber'},
3795                 $itemnumber,
3796                 { log_action => 0 }
3797             );
3798             return "Success.";
3799         } else {
3800             return "Item not issued.";
3801         }
3802     } else {
3803         return "Item not found.";
3804     }
3805 }
3806
3807 sub ProcessOfflineIssue {
3808     my $operation = shift;
3809
3810     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3811
3812     if ( $patron ) {
3813         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3814         unless ($item) {
3815             return "Barcode not found.";
3816         }
3817         my $itemnumber = $item->itemnumber;
3818         my $issue = GetOpenIssue( $itemnumber );
3819
3820         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3821             MarkIssueReturned(
3822                 $issue->{borrowernumber},
3823                 $itemnumber,
3824                 $operation->{timestamp},
3825             );
3826         }
3827         AddIssue(
3828             $patron->unblessed,
3829             $operation->{'barcode'},
3830             undef,
3831             1,
3832             $operation->{timestamp},
3833             undef,
3834         );
3835         return "Success.";
3836     } else {
3837         return "Borrower not found.";
3838     }
3839 }
3840
3841 sub ProcessOfflinePayment {
3842     my $operation = shift;
3843
3844     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3845
3846     $patron->account->pay(
3847         {
3848             amount     => $operation->{amount},
3849             library_id => $operation->{branchcode},
3850             interface  => 'koc'
3851         }
3852     );
3853
3854     return "Success.";
3855 }
3856
3857 =head2 TransferSlip
3858
3859   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3860
3861   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3862
3863 =cut
3864
3865 sub TransferSlip {
3866     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3867
3868     my $item =
3869       $itemnumber
3870       ? Koha::Items->find($itemnumber)
3871       : Koha::Items->find( { barcode => $barcode } );
3872
3873     $item or return;
3874
3875     return C4::Letters::GetPreparedLetter (
3876         module => 'circulation',
3877         letter_code => 'TRANSFERSLIP',
3878         branchcode => $branch,
3879         tables => {
3880             'branches'    => $to_branch,
3881             'biblio'      => $item->biblionumber,
3882             'items'       => $item->unblessed,
3883         },
3884     );
3885 }
3886
3887 =head2 CheckIfIssuedToPatron
3888
3889   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3890
3891   Return 1 if any record item is issued to patron, otherwise return 0
3892
3893 =cut
3894
3895 sub CheckIfIssuedToPatron {
3896     my ($borrowernumber, $biblionumber) = @_;
3897
3898     my $dbh = C4::Context->dbh;
3899     my $query = q|
3900         SELECT COUNT(*) FROM issues
3901         LEFT JOIN items ON items.itemnumber = issues.itemnumber
3902         WHERE items.biblionumber = ?
3903         AND issues.borrowernumber = ?
3904     |;
3905     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3906     return 1 if $is_issued;
3907     return;
3908 }
3909
3910 =head2 IsItemIssued
3911
3912   IsItemIssued( $itemnumber )
3913
3914   Return 1 if the item is on loan, otherwise return 0
3915
3916 =cut
3917
3918 sub IsItemIssued {
3919     my $itemnumber = shift;
3920     my $dbh = C4::Context->dbh;
3921     my $sth = $dbh->prepare(q{
3922         SELECT COUNT(*)
3923         FROM issues
3924         WHERE itemnumber = ?
3925     });
3926     $sth->execute($itemnumber);
3927     return $sth->fetchrow;
3928 }
3929
3930 =head2 GetAgeRestriction
3931
3932   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3933   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3934
3935   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3936   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3937
3938 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3939 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3940 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3941          Negative days mean the borrower has gone past the age restriction age.
3942
3943 =cut
3944
3945 sub GetAgeRestriction {
3946     my ($record_restrictions, $borrower) = @_;
3947     my $markers = C4::Context->preference('AgeRestrictionMarker');
3948
3949     # Split $record_restrictions to something like FSK 16 or PEGI 6
3950     my @values = split ' ', uc($record_restrictions);
3951     return unless @values;
3952
3953     # Search first occurrence of one of the markers
3954     my @markers = split /\|/, uc($markers);
3955     return unless @markers;
3956
3957     my $index            = 0;
3958     my $restriction_year = 0;
3959     for my $value (@values) {
3960         $index++;
3961         for my $marker (@markers) {
3962             $marker =~ s/^\s+//;    #remove leading spaces
3963             $marker =~ s/\s+$//;    #remove trailing spaces
3964             if ( $marker eq $value ) {
3965                 if ( $index <= $#values ) {
3966                     $restriction_year += $values[$index];
3967                 }
3968                 last;
3969             }
3970             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3971
3972                 # Perhaps it is something like "K16" (as in Finland)
3973                 $restriction_year += $1;
3974                 last;
3975             }
3976         }
3977         last if ( $restriction_year > 0 );
3978     }
3979
3980     #Check if the borrower is age restricted for this material and for how long.
3981     if ($restriction_year && $borrower) {
3982         if ( $borrower->{'dateofbirth'} ) {
3983             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3984             $alloweddate[0] += $restriction_year;
3985
3986             #Prevent runime eror on leap year (invalid date)
3987             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3988                 $alloweddate[2] = 28;
3989             }
3990
3991             #Get how many days the borrower has to reach the age restriction
3992             my @Today = split /-/, DateTime->today->ymd();
3993             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
3994             #Negative days means the borrower went past the age restriction age
3995             return ($restriction_year, $daysToAgeRestriction);
3996         }
3997     }
3998
3999     return ($restriction_year);
4000 }
4001
4002
4003 =head2 GetPendingOnSiteCheckouts
4004
4005 =cut
4006
4007 sub GetPendingOnSiteCheckouts {
4008     my $dbh = C4::Context->dbh;
4009     return $dbh->selectall_arrayref(q|
4010         SELECT
4011           items.barcode,
4012           items.biblionumber,
4013           items.itemnumber,
4014           items.itemnotes,
4015           items.itemcallnumber,
4016           items.location,
4017           issues.date_due,
4018           issues.branchcode,
4019           issues.date_due < NOW() AS is_overdue,
4020           biblio.author,
4021           biblio.title,
4022           borrowers.firstname,
4023           borrowers.surname,
4024           borrowers.cardnumber,
4025           borrowers.borrowernumber
4026         FROM items
4027         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4028         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4029         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4030         WHERE issues.onsite_checkout = 1
4031     |, { Slice => {} } );
4032 }
4033
4034 sub GetTopIssues {
4035     my ($params) = @_;
4036
4037     my ($count, $branch, $itemtype, $ccode, $newness)
4038         = @$params{qw(count branch itemtype ccode newness)};
4039
4040     my $dbh = C4::Context->dbh;
4041     my $query = q{
4042         SELECT * FROM (
4043         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4044           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4045           i.ccode, SUM(i.issues) AS count
4046         FROM biblio b
4047         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4048         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4049     };
4050
4051     my (@where_strs, @where_args);
4052
4053     if ($branch) {
4054         push @where_strs, 'i.homebranch = ?';
4055         push @where_args, $branch;
4056     }
4057     if ($itemtype) {
4058         if (C4::Context->preference('item-level_itypes')){
4059             push @where_strs, 'i.itype = ?';
4060             push @where_args, $itemtype;
4061         } else {
4062             push @where_strs, 'bi.itemtype = ?';
4063             push @where_args, $itemtype;
4064         }
4065     }
4066     if ($ccode) {
4067         push @where_strs, 'i.ccode = ?';
4068         push @where_args, $ccode;
4069     }
4070     if ($newness) {
4071         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4072         push @where_args, $newness;
4073     }
4074
4075     if (@where_strs) {
4076         $query .= 'WHERE ' . join(' AND ', @where_strs);
4077     }
4078
4079     $query .= q{
4080         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4081           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4082           i.ccode
4083         ORDER BY count DESC
4084     };
4085
4086     $query .= q{ ) xxx WHERE count > 0 };
4087     $count = int($count);
4088     if ($count > 0) {
4089         $query .= "LIMIT $count";
4090     }
4091
4092     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4093
4094     return @$rows;
4095 }
4096
4097 sub _CalculateAndUpdateFine {
4098     my ($params) = @_;
4099
4100     my $borrower    = $params->{borrower};
4101     my $item        = $params->{item};
4102     my $issue       = $params->{issue};
4103     my $return_date = $params->{return_date};
4104
4105     unless ($borrower) { carp "No borrower passed in!" && return; }
4106     unless ($item)     { carp "No item passed in!"     && return; }
4107     unless ($issue)    { carp "No issue passed in!"    && return; }
4108
4109     my $datedue = dt_from_string( $issue->date_due );
4110
4111     # we only need to calculate and change the fines if we want to do that on return
4112     # Should be on for hourly loans
4113     my $control = C4::Context->preference('CircControl');
4114     my $control_branchcode =
4115         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4116       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4117       :                                     $issue->branchcode;
4118
4119     my $date_returned = $return_date ? $return_date : dt_from_string();
4120
4121     my ( $amount, $unitcounttotal, $unitcount  ) =
4122       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4123
4124     if ( C4::Context->preference('finesMode') eq 'production' ) {
4125         if ( $amount > 0 ) {
4126             C4::Overdues::UpdateFine({
4127                 issue_id       => $issue->issue_id,
4128                 itemnumber     => $issue->itemnumber,
4129                 borrowernumber => $issue->borrowernumber,
4130                 amount         => $amount,
4131                 due            => output_pref($datedue),
4132             });
4133         }
4134         elsif ($return_date) {
4135
4136             # Backdated returns may have fines that shouldn't exist,
4137             # so in this case, we need to drop those fines to 0
4138
4139             C4::Overdues::UpdateFine({
4140                 issue_id       => $issue->issue_id,
4141                 itemnumber     => $issue->itemnumber,
4142                 borrowernumber => $issue->borrowernumber,
4143                 amount         => 0,
4144                 due            => output_pref($datedue),
4145             });
4146         }
4147     }
4148 }
4149
4150 sub _item_denied_renewal {
4151     my ($params) = @_;
4152
4153     my $item = $params->{item};
4154     return unless $item;
4155
4156     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4157     return unless $denyingrules;
4158     foreach my $field (keys %$denyingrules) {
4159         my $val = $item->$field;
4160         if( !defined $val) {
4161             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4162                 return 1;
4163             }
4164         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4165            # If the results matches the values in the syspref
4166            # We return true if match found
4167             return 1;
4168         }
4169     }
4170     return 0;
4171 }
4172
4173
4174 1;
4175
4176 __END__
4177
4178 =head1 AUTHOR
4179
4180 Koha Development Team <http://koha-community.org/>
4181
4182 =cut