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