C4/Circulation.pm

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