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 )->{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 $useDaysMode_value = Koha::CirculationRules->get_useDaysMode_effective_value(
1245             {
1246                 categorycode => $borrower->{categorycode},
1247                 itemtype     => $itype,
1248                 branchcode   => $branchcode,
1249             }
1250         );
1251         my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $useDaysMode_value );
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         borrowernumber => $borrowernumber,
2111         ccode          => $item->ccode,
2112     });
2113
2114     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2115     if ( $patron ) {
2116         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2117         my %conditions = (
2118             branchcode   => $branch,
2119             categorycode => $patron->categorycode,
2120             item_type    => $itemtype,
2121             notification => 'CHECKIN',
2122         );
2123         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2124             SendCirculationAlert({
2125                 type     => 'CHECKIN',
2126                 item     => $item->unblessed,
2127                 borrower => $patron->unblessed,
2128                 branch   => $branch,
2129             });
2130         }
2131
2132         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2133             if C4::Context->preference("ReturnLog");
2134         }
2135
2136     # Check if this item belongs to a biblio record that is attached to an
2137     # ILL request, if it is we need to update the ILL request's status
2138     if (C4::Context->preference('CirculateILL')) {
2139         my $request = Koha::Illrequests->find(
2140             { biblio_id => $item->biblio->biblionumber }
2141         );
2142         $request->status('RET') if $request;
2143     }
2144
2145     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2146     if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2147         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2148         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2149             (C4::Context->preference("UseBranchTransferLimits") and
2150              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2151            )) {
2152             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2153             $debug and warn "item: " . Dumper($item->unblessed);
2154             ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger);
2155             $messages->{'WasTransfered'} = 1;
2156         } else {
2157             $messages->{'NeedsTransfer'} = $returnbranch;
2158             $messages->{'TransferTrigger'} = $transfer_trigger;
2159         }
2160     }
2161
2162     if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2163         my $claims = Koha::Checkouts::ReturnClaims->search(
2164            {
2165                itemnumber => $item->id,
2166                resolution => undef,
2167            }
2168         );
2169
2170         if ( $claims->count ) {
2171             $messages->{ReturnClaims} = $claims;
2172         }
2173     }
2174
2175     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2176 }
2177
2178 =head2 MarkIssueReturned
2179
2180   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2181
2182 Unconditionally marks an issue as being returned by
2183 moving the C<issues> row to C<old_issues> and
2184 setting C<returndate> to the current date.
2185
2186 if C<$returndate> is specified (in iso format), it is used as the date
2187 of the return.
2188
2189 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2190 the old_issue is immediately anonymised
2191
2192 Ideally, this function would be internal to C<C4::Circulation>,
2193 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2194 and offline_circ/process_koc.pl.
2195
2196 =cut
2197
2198 sub MarkIssueReturned {
2199     my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2200
2201     # Retrieve the issue
2202     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2203
2204     return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2205
2206     my $issue_id = $issue->issue_id;
2207
2208     my $anonymouspatron;
2209     if ( $privacy && $privacy == 2 ) {
2210         # The default of 0 will not work due to foreign key constraints
2211         # The anonymisation will fail if AnonymousPatron is not a valid entry
2212         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2213         # Note that a warning should appear on the about page (System information tab).
2214         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2215         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."
2216             unless Koha::Patrons->find( $anonymouspatron );
2217     }
2218
2219     my $schema = Koha::Database->schema;
2220
2221     # FIXME Improve the return value and handle it from callers
2222     $schema->txn_do(sub {
2223
2224         my $patron = Koha::Patrons->find( $borrowernumber );
2225
2226         # Update the returndate value
2227         if ( $returndate ) {
2228             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2229         }
2230         else {
2231             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2232         }
2233
2234         # Create the old_issues entry
2235         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2236
2237         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2238         if ( $privacy && $privacy == 2) {
2239             $old_checkout->borrowernumber($anonymouspatron)->store;
2240         }
2241
2242         # And finally delete the issue
2243         $issue->delete;
2244
2245         $issue->item->onloan(undef)->store({ log_action => 0 });
2246
2247         if ( C4::Context->preference('StoreLastBorrower') ) {
2248             my $item = Koha::Items->find( $itemnumber );
2249             $item->last_returned_by( $patron );
2250         }
2251
2252         # Remove any OVERDUES related debarment if the borrower has no overdues
2253         if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2254           && $patron->debarred
2255           && !$patron->has_overdues
2256           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2257         ) {
2258             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2259         }
2260
2261     });
2262
2263     return $issue_id;
2264 }
2265
2266 =head2 _debar_user_on_return
2267
2268     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2269
2270 C<$borrower> borrower hashref
2271
2272 C<$item> item hashref
2273
2274 C<$datedue> date due DateTime object
2275
2276 C<$returndate> DateTime object representing the return time
2277
2278 Internal function, called only by AddReturn that calculates and updates
2279  the user fine days, and debars them if necessary.
2280
2281 Should only be called for overdue returns
2282
2283 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2284 to ease testing.
2285
2286 =cut
2287
2288 sub _calculate_new_debar_dt {
2289     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2290
2291     my $branchcode = _GetCircControlBranch( $item, $borrower );
2292     my $circcontrol = C4::Context->preference('CircControl');
2293     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2294         {   categorycode => $borrower->{categorycode},
2295             itemtype     => $item->{itype},
2296             branchcode   => $branchcode,
2297             rules => [
2298                 'finedays',
2299                 'lengthunit',
2300                 'firstremind',
2301                 'maxsuspensiondays',
2302                 'suspension_chargeperiod',
2303             ]
2304         }
2305     );
2306     my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2307     my $unit     = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2308     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2309
2310     return unless $finedays;
2311
2312     # finedays is in days, so hourly loans must multiply by 24
2313     # thus 1 hour late equals 1 day suspension * finedays rate
2314     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2315
2316     # grace period is measured in the same units as the loan
2317     my $grace =
2318       DateTime::Duration->new( $unit => $issuing_rule->{firstremind} );
2319
2320     my $deltadays = DateTime::Duration->new(
2321         days => $chargeable_units
2322     );
2323
2324     if ( $deltadays->subtract($grace)->is_positive() ) {
2325         my $suspension_days = $deltadays * $finedays;
2326
2327         if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2328             # No need to / 1 and do not consider / 0
2329             $suspension_days = DateTime::Duration->new(
2330                 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2331             );
2332         }
2333
2334         # If the max suspension days is < than the suspension days
2335         # the suspension days is limited to this maximum period.
2336         my $max_sd = $issuing_rule->{maxsuspensiondays};
2337         if ( defined $max_sd && $max_sd ne '' ) {
2338             $max_sd = DateTime::Duration->new( days => $max_sd );
2339             $suspension_days = $max_sd
2340               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2341         }
2342
2343         my ( $has_been_extended );
2344         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2345             my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2346             if ( $debarment ) {
2347                 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2348                 $has_been_extended = 1;
2349             }
2350         }
2351
2352         my $new_debar_dt;
2353         # Use the calendar or not to calculate the debarment date
2354         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2355             my $calendar = Koha::Calendar->new(
2356                 branchcode => $branchcode,
2357                 days_mode  => 'Calendar'
2358             );
2359             $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2360         }
2361         else {
2362             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2363         }
2364         return $new_debar_dt;
2365     }
2366     return;
2367 }
2368
2369 sub _debar_user_on_return {
2370     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2371
2372     $return_date //= dt_from_string();
2373
2374     my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2375
2376     return unless $new_debar_dt;
2377
2378     Koha::Patron::Debarments::AddUniqueDebarment({
2379         borrowernumber => $borrower->{borrowernumber},
2380         expiration     => $new_debar_dt->ymd(),
2381         type           => 'SUSPENSION',
2382     });
2383     # if borrower was already debarred but does not get an extra debarment
2384     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2385     my ($new_debarment_str, $is_a_reminder);
2386     if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2387         $is_a_reminder = 1;
2388         $new_debarment_str = $borrower->{debarred};
2389     } else {
2390         $new_debarment_str = $new_debar_dt->ymd();
2391     }
2392     # FIXME Should return a DateTime object
2393     return $new_debarment_str, $is_a_reminder;
2394 }
2395
2396 =head2 _FixOverduesOnReturn
2397
2398    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2399
2400 C<$borrowernumber> borrowernumber
2401
2402 C<$itemnumber> itemnumber
2403
2404 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2405
2406 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2407
2408 Internal function
2409
2410 =cut
2411
2412 sub _FixOverduesOnReturn {
2413     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2414     unless( $borrowernumber ) {
2415         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2416         return;
2417     }
2418     unless( $item ) {
2419         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2420         return;
2421     }
2422     unless( $status ) {
2423         warn "_FixOverduesOnReturn() not supplied valid status";
2424         return;
2425     }
2426
2427     my $schema = Koha::Database->schema;
2428
2429     my $result = $schema->txn_do(
2430         sub {
2431             # check for overdue fine
2432             my $accountlines = Koha::Account::Lines->search(
2433                 {
2434                     borrowernumber  => $borrowernumber,
2435                     itemnumber      => $item,
2436                     debit_type_code => 'OVERDUE',
2437                     status          => 'UNRETURNED'
2438                 }
2439             );
2440             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2441
2442             my $accountline = $accountlines->next;
2443
2444             my $amountoutstanding = $accountline->amountoutstanding;
2445             if ($exemptfine && ($amountoutstanding != 0)) {
2446                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2447                 my $credit = $account->add_credit(
2448                     {
2449                         amount     => $amountoutstanding,
2450                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2451                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2452                         interface  => C4::Context->interface,
2453                         type       => 'FORGIVEN',
2454                         item_id    => $item
2455                     }
2456                 );
2457
2458                 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2459
2460                 $accountline->status('FORGIVEN');
2461
2462                 if (C4::Context->preference("FinesLog")) {
2463                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2464                 }
2465             } else {
2466                 $accountline->status($status);
2467             }
2468
2469             return $accountline->store();
2470         }
2471     );
2472
2473     return $result;
2474 }
2475
2476 =head2 _FixAccountForLostAndFound
2477
2478   &_FixAccountForLostAndFound($itemnumber, [$borrowernumber, $barcode]);
2479
2480 Finds the most recent lost item charge for this item and refunds the borrower
2481 appropriatly, taking into account any payments or writeoffs already applied
2482 against the charge.
2483
2484 Internal function, not exported, called only by AddReturn.
2485
2486 =cut
2487
2488 sub _FixAccountForLostAndFound {
2489     my $itemnumber     = shift or return;
2490     my $borrowernumber = @_ ? shift : undef;
2491     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2492
2493     my $credit;
2494
2495     # check for charge made for lost book
2496     my $accountlines = Koha::Account::Lines->search(
2497         {
2498             itemnumber      => $itemnumber,
2499             debit_type_code => 'LOST',
2500             status          => [ undef, { '<>' => 'FOUND' } ]
2501         },
2502         {
2503             order_by => { -desc => [ 'date', 'accountlines_id' ] }
2504         }
2505     );
2506
2507     return unless $accountlines->count > 0;
2508     my $accountline     = $accountlines->next;
2509     my $total_to_refund = 0;
2510
2511     return unless $accountline->borrowernumber;
2512     my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2513     return unless $patron; # Patron has been deleted, nobody to credit the return to
2514
2515     my $account = $patron->account;
2516
2517     # Use cases
2518     if ( $accountline->amount > $accountline->amountoutstanding ) {
2519         # some amount has been cancelled. collect the offsets that are not writeoffs
2520         # this works because the only way to subtract from this kind of a debt is
2521         # using the UI buttons 'Pay' and 'Write off'
2522         my $credits_offsets = Koha::Account::Offsets->search({
2523             debit_id  => $accountline->id,
2524             credit_id => { '!=' => undef }, # it is not the debit itself
2525             type      => { '!=' => 'Writeoff' },
2526             amount    => { '<'  => 0 } # credits are negative on the DB
2527         });
2528
2529         $total_to_refund = ( $credits_offsets->count > 0 )
2530                             ? $credits_offsets->total * -1 # credits are negative on the DB
2531                             : 0;
2532     }
2533
2534     my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2535
2536     if ( $credit_total > 0 ) {
2537         my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2538         $credit = $account->add_credit(
2539             {
2540                 amount      => $credit_total,
2541                 description => 'Item found ' . $item_id,
2542                 type        => 'LOST_FOUND',
2543                 interface   => C4::Context->interface,
2544                 library_id  => $branchcode,
2545                 item_id     => $itemnumber
2546             }
2547         );
2548
2549         $credit->apply( { debits => [ $accountline ] } );
2550     }
2551
2552     # Update the account status
2553     $accountline->discard_changes->status('FOUND');
2554     $accountline->store;
2555
2556     $accountline->item->paidfor('')->store({ log_action => 0 });
2557
2558     if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2559         $account->reconcile_balance;
2560     }
2561
2562     return ($credit) ? $credit->id : undef;
2563 }
2564
2565 =head2 _GetCircControlBranch
2566
2567    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2568
2569 Internal function :
2570
2571 Return the library code to be used to determine which circulation
2572 policy applies to a transaction.  Looks up the CircControl and
2573 HomeOrHoldingBranch system preferences.
2574
2575 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2576
2577 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2578
2579 =cut
2580
2581 sub _GetCircControlBranch {
2582     my ($item, $borrower) = @_;
2583     my $circcontrol = C4::Context->preference('CircControl');
2584     my $branch;
2585
2586     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2587         $branch= C4::Context->userenv->{'branch'};
2588     } elsif ($circcontrol eq 'PatronLibrary') {
2589         $branch=$borrower->{branchcode};
2590     } else {
2591         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2592         $branch = $item->{$branchfield};
2593         # default to item home branch if holdingbranch is used
2594         # and is not defined
2595         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2596             $branch = $item->{homebranch};
2597         }
2598     }
2599     return $branch;
2600 }
2601
2602 =head2 GetOpenIssue
2603
2604   $issue = GetOpenIssue( $itemnumber );
2605
2606 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2607
2608 C<$itemnumber> is the item's itemnumber
2609
2610 Returns a hashref
2611
2612 =cut
2613
2614 sub GetOpenIssue {
2615   my ( $itemnumber ) = @_;
2616   return unless $itemnumber;
2617   my $dbh = C4::Context->dbh;
2618   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2619   $sth->execute( $itemnumber );
2620   return $sth->fetchrow_hashref();
2621
2622 }
2623
2624 =head2 GetBiblioIssues
2625
2626   $issues = GetBiblioIssues($biblionumber);
2627
2628 this function get all issues from a biblionumber.
2629
2630 Return:
2631 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2632 tables issues and the firstname,surname & cardnumber from borrowers.
2633
2634 =cut
2635
2636 sub GetBiblioIssues {
2637     my $biblionumber = shift;
2638     return unless $biblionumber;
2639     my $dbh   = C4::Context->dbh;
2640     my $query = "
2641         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2642         FROM issues
2643             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2644             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2645             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2646             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2647         WHERE biblio.biblionumber = ?
2648         UNION ALL
2649         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2650         FROM old_issues
2651             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2652             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2653             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2654             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2655         WHERE biblio.biblionumber = ?
2656         ORDER BY timestamp
2657     ";
2658     my $sth = $dbh->prepare($query);
2659     $sth->execute($biblionumber, $biblionumber);
2660
2661     my @issues;
2662     while ( my $data = $sth->fetchrow_hashref ) {
2663         push @issues, $data;
2664     }
2665     return \@issues;
2666 }
2667
2668 =head2 GetUpcomingDueIssues
2669
2670   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2671
2672 =cut
2673
2674 sub GetUpcomingDueIssues {
2675     my $params = shift;
2676
2677     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2678     my $dbh = C4::Context->dbh;
2679
2680     my $statement = <<END_SQL;
2681 SELECT *
2682 FROM (
2683     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2684     FROM issues
2685     LEFT JOIN items USING (itemnumber)
2686     LEFT OUTER JOIN branches USING (branchcode)
2687     WHERE returndate is NULL
2688 ) tmp
2689 WHERE days_until_due >= 0 AND days_until_due <= ?
2690 END_SQL
2691
2692     my @bind_parameters = ( $params->{'days_in_advance'} );
2693
2694     my $sth = $dbh->prepare( $statement );
2695     $sth->execute( @bind_parameters );
2696     my $upcoming_dues = $sth->fetchall_arrayref({});
2697
2698     return $upcoming_dues;
2699 }
2700
2701 =head2 CanBookBeRenewed
2702
2703   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2704
2705 Find out whether a borrowed item may be renewed.
2706
2707 C<$borrowernumber> is the borrower number of the patron who currently
2708 has the item on loan.
2709
2710 C<$itemnumber> is the number of the item to renew.
2711
2712 C<$override_limit>, if supplied with a true value, causes
2713 the limit on the number of times that the loan can be renewed
2714 (as controlled by the item type) to be ignored. Overriding also allows
2715 to renew sooner than "No renewal before" and to manually renew loans
2716 that are automatically renewed.
2717
2718 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2719 item must currently be on loan to the specified borrower; renewals
2720 must be allowed for the item's type; and the borrower must not have
2721 already renewed the loan. $error will contain the reason the renewal can not proceed
2722
2723 =cut
2724
2725 sub CanBookBeRenewed {
2726     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2727
2728     my $dbh    = C4::Context->dbh;
2729     my $renews = 1;
2730     my $auto_renew = 0;
2731
2732     my $item      = Koha::Items->find($itemnumber)      or return ( 0, 'no_item' );
2733     my $issue = $item->checkout or return ( 0, 'no_checkout' );
2734     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2735     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2736
2737     my $patron = $issue->patron or return;
2738
2739     # override_limit will override anything else except on_reserve
2740     unless ( $override_limit ){
2741         my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2742         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2743             {
2744                 categorycode => $patron->categorycode,
2745                 itemtype     => $item->effective_itemtype,
2746                 branchcode   => $branchcode,
2747                 rules => [
2748                     'renewalsallowed',
2749                     'no_auto_renewal_after',
2750                     'no_auto_renewal_after_hard_limit',
2751                     'lengthunit',
2752                     'norenewalbefore',
2753                 ]
2754             }
2755         );
2756
2757         return ( 0, "too_many" )
2758           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2759
2760         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2761         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2762         $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2763         my $restricted  = $patron->is_debarred;
2764         my $hasoverdues = $patron->has_overdues;
2765
2766         if ( $restricted and $restrictionblockrenewing ) {
2767             return ( 0, 'restriction');
2768         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2769             return ( 0, 'overdue');
2770         }
2771
2772         if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2773
2774             if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2775                 return ( 0, 'auto_account_expired' );
2776             }
2777
2778             if ( defined $issuing_rule->{no_auto_renewal_after}
2779                     and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2780                 # Get issue_date and add no_auto_renewal_after
2781                 # If this is greater than today, it's too late for renewal.
2782                 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2783                 $maximum_renewal_date->add(
2784                     $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2785                 );
2786                 my $now = dt_from_string;
2787                 if ( $now >= $maximum_renewal_date ) {
2788                     return ( 0, "auto_too_late" );
2789                 }
2790             }
2791             if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2792                           and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2793                 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2794                 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2795                     return ( 0, "auto_too_late" );
2796                 }
2797             }
2798
2799             if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2800                 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2801                 my $amountoutstanding =
2802                   C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2803                   ? $patron->account->balance
2804                   : $patron->account->outstanding_debits->total_outstanding;
2805                 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2806                     return ( 0, "auto_too_much_oweing" );
2807                 }
2808             }
2809         }
2810
2811         if ( defined $issuing_rule->{norenewalbefore}
2812             and $issuing_rule->{norenewalbefore} ne "" )
2813         {
2814
2815             # Calculate soonest renewal by subtracting 'No renewal before' from due date
2816             my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2817                 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2818
2819             # Depending on syspref reset the exact time, only check the date
2820             if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2821                 and $issuing_rule->{lengthunit} eq 'days' )
2822             {
2823                 $soonestrenewal->truncate( to => 'day' );
2824             }
2825
2826             if ( $soonestrenewal > dt_from_string() )
2827             {
2828                 return ( 0, "auto_too_soon" ) if $issue->auto_renew && $patron->autorenew_checkouts;
2829                 return ( 0, "too_soon" );
2830             }
2831             elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2832                 $auto_renew = 1;
2833             }
2834         }
2835
2836         # Fallback for automatic renewals:
2837         # If norenewalbefore is undef, don't renew before due date.
2838         if ( $issue->auto_renew && !$auto_renew && $patron->autorenew_checkouts ) {
2839             my $now = dt_from_string;
2840             if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2841                 $auto_renew = 1;
2842             } else {
2843                 return ( 0, "auto_too_soon" );
2844             }
2845         }
2846     }
2847
2848     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2849
2850     # This item can fill one or more unfilled reserve, can those unfilled reserves
2851     # all be filled by other available items?
2852     if ( $resfound
2853         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2854     {
2855         my $schema = Koha::Database->new()->schema();
2856
2857         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2858         if ($item_holds) {
2859             # There is an item level hold on this item, no other item can fill the hold
2860             $resfound = 1;
2861         }
2862         else {
2863
2864             # Get all other items that could possibly fill reserves
2865             my @itemnumbers = $schema->resultset('Item')->search(
2866                 {
2867                     biblionumber => $resrec->{biblionumber},
2868                     onloan       => undef,
2869                     notforloan   => 0,
2870                     -not         => { itemnumber => $itemnumber }
2871                 },
2872                 { columns => 'itemnumber' }
2873             )->get_column('itemnumber')->all();
2874
2875             # Get all other reserves that could have been filled by this item
2876             my @borrowernumbers;
2877             while (1) {
2878                 my ( $reserve_found, $reserve, undef ) =
2879                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2880
2881                 if ($reserve_found) {
2882                     push( @borrowernumbers, $reserve->{borrowernumber} );
2883                 }
2884                 else {
2885                     last;
2886                 }
2887             }
2888
2889             # If the count of the union of the lists of reservable items for each borrower
2890             # is equal or greater than the number of borrowers, we know that all reserves
2891             # can be filled with available items. We can get the union of the sets simply
2892             # by pushing all the elements onto an array and removing the duplicates.
2893             my @reservable;
2894             my %patrons;
2895             ITEM: foreach my $itemnumber (@itemnumbers) {
2896                 my $item = Koha::Items->find( $itemnumber );
2897                 next if IsItemOnHoldAndFound( $itemnumber );
2898                 for my $borrowernumber (@borrowernumbers) {
2899                     my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2900                     next unless IsAvailableForItemLevelRequest($item, $patron);
2901                     next unless CanItemBeReserved($borrowernumber,$itemnumber);
2902
2903                     push @reservable, $itemnumber;
2904                     if (@reservable >= @borrowernumbers) {
2905                         $resfound = 0;
2906                         last ITEM;
2907                     }
2908                     last;
2909                 }
2910             }
2911         }
2912     }
2913     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2914     return ( 0, "auto_renew" ) if $auto_renew && !$override_limit; # 0 if auto-renewal should not succeed
2915
2916     return ( 1, undef );
2917 }
2918
2919 =head2 AddRenewal
2920
2921   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2922
2923 Renews a loan.
2924
2925 C<$borrowernumber> is the borrower number of the patron who currently
2926 has the item.
2927
2928 C<$itemnumber> is the number of the item to renew.
2929
2930 C<$branch> is the library where the renewal took place (if any).
2931            The library that controls the circ policies for the renewal is retrieved from the issues record.
2932
2933 C<$datedue> can be a DateTime object used to set the due date.
2934
2935 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2936 this parameter is not supplied, lastreneweddate is set to the current date.
2937
2938 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2939 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2940 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2941 syspref)
2942
2943 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2944 from the book's item type.
2945
2946 =cut
2947
2948 sub AddRenewal {
2949     my $borrowernumber  = shift;
2950     my $itemnumber      = shift or return;
2951     my $branch          = shift;
2952     my $datedue         = shift;
2953     my $lastreneweddate = shift || dt_from_string();
2954     my $skipfinecalc    = shift;
2955
2956     my $item_object   = Koha::Items->find($itemnumber) or return;
2957     my $biblio = $item_object->biblio;
2958     my $issue  = $item_object->checkout;
2959     my $item_unblessed = $item_object->unblessed;
2960
2961     my $dbh = C4::Context->dbh;
2962
2963     return unless $issue;
2964
2965     $borrowernumber ||= $issue->borrowernumber;
2966
2967     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2968         carp 'Invalid date passed to AddRenewal.';
2969         return;
2970     }
2971
2972     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2973     my $patron_unblessed = $patron->unblessed;
2974
2975     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2976
2977     my $schema = Koha::Database->schema;
2978     $schema->txn_do(sub{
2979
2980         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
2981             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2982         }
2983         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2984
2985         # If the due date wasn't specified, calculate it by adding the
2986         # book's loan length to today's date or the current due date
2987         # based on the value of the RenewalPeriodBase syspref.
2988         my $itemtype = $item_object->effective_itemtype;
2989         unless ($datedue) {
2990
2991             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2992                                             dt_from_string( $issue->date_due, 'sql' ) :
2993                                             dt_from_string();
2994             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2995         }
2996
2997         my $fees = Koha::Charges::Fees->new(
2998             {
2999                 patron    => $patron,
3000                 library   => $circ_library,
3001                 item      => $item_object,
3002                 from_date => dt_from_string( $issue->date_due, 'sql' ),
3003                 to_date   => dt_from_string($datedue),
3004             }
3005         );
3006
3007         # Update the issues record to have the new due date, and a new count
3008         # of how many times it has been renewed.
3009         my $renews = ( $issue->renewals || 0 ) + 1;
3010         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3011                                 WHERE borrowernumber=?
3012                                 AND itemnumber=?"
3013         );
3014
3015         $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3016
3017         # Update the renewal count on the item, and tell zebra to reindex
3018         $renews = ( $item_object->renewals || 0 ) + 1;
3019         $item_object->renewals($renews);
3020         $item_object->onloan($datedue);
3021         $item_object->store({ log_action => 0 });
3022
3023         # Charge a new rental fee, if applicable
3024         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3025         if ( $charge > 0 ) {
3026             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3027         }
3028
3029         # Charge a new accumulate rental fee, if applicable
3030         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3031         if ( $itemtype_object ) {
3032             my $accumulate_charge = $fees->accumulate_rentalcharge();
3033             if ( $accumulate_charge > 0 ) {
3034                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3035             }
3036             $charge += $accumulate_charge;
3037         }
3038
3039         # Send a renewal slip according to checkout alert preferencei
3040         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3041             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3042             my %conditions        = (
3043                 branchcode   => $branch,
3044                 categorycode => $patron->categorycode,
3045                 item_type    => $itemtype,
3046                 notification => 'CHECKOUT',
3047             );
3048             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3049                 SendCirculationAlert(
3050                     {
3051                         type     => 'RENEWAL',
3052                         item     => $item_unblessed,
3053                         borrower => $patron->unblessed,
3054                         branch   => $branch,
3055                     }
3056                 );
3057             }
3058         }
3059
3060         # Remove any OVERDUES related debarment if the borrower has no overdues
3061         if ( $patron
3062           && $patron->is_debarred
3063           && ! $patron->has_overdues
3064           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3065         ) {
3066             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3067         }
3068
3069         # Add the renewal to stats
3070         UpdateStats(
3071             {
3072                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3073                 type           => 'renew',
3074                 amount         => $charge,
3075                 itemnumber     => $itemnumber,
3076                 itemtype       => $itemtype,
3077                 location       => $item_object->location,
3078                 borrowernumber => $borrowernumber,
3079                 ccode          => $item_object->ccode,
3080             }
3081         );
3082
3083         #Log the renewal
3084         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3085     });
3086
3087     return $datedue;
3088 }
3089
3090 sub GetRenewCount {
3091     # check renewal status
3092     my ( $bornum, $itemno ) = @_;
3093     my $dbh           = C4::Context->dbh;
3094     my $renewcount    = 0;
3095     my $renewsallowed = 0;
3096     my $renewsleft    = 0;
3097
3098     my $patron = Koha::Patrons->find( $bornum );
3099     my $item   = Koha::Items->find($itemno);
3100
3101     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3102
3103     # Look in the issues table for this item, lent to this borrower,
3104     # and not yet returned.
3105
3106     # FIXME - I think this function could be redone to use only one SQL call.
3107     my $sth = $dbh->prepare(
3108         "select * from issues
3109                                 where (borrowernumber = ?)
3110                                 and (itemnumber = ?)"
3111     );
3112     $sth->execute( $bornum, $itemno );
3113     my $data = $sth->fetchrow_hashref;
3114     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3115     # $item and $borrower should be calculated
3116     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3117
3118     my $rule = Koha::CirculationRules->get_effective_rule(
3119         {
3120             categorycode => $patron->categorycode,
3121             itemtype     => $item->effective_itemtype,
3122             branchcode   => $branchcode,
3123             rule_name    => 'renewalsallowed',
3124         }
3125     );
3126
3127     $renewsallowed = $rule ? $rule->rule_value : 0;
3128     $renewsleft    = $renewsallowed - $renewcount;
3129     if($renewsleft < 0){ $renewsleft = 0; }
3130     return ( $renewcount, $renewsallowed, $renewsleft );
3131 }
3132
3133 =head2 GetSoonestRenewDate
3134
3135   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3136
3137 Find out the soonest possible renew date of a borrowed item.
3138
3139 C<$borrowernumber> is the borrower number of the patron who currently
3140 has the item on loan.
3141
3142 C<$itemnumber> is the number of the item to renew.
3143
3144 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3145 renew date, based on the value "No renewal before" of the applicable
3146 issuing rule. Returns the current date if the item can already be
3147 renewed, and returns undefined if the borrower, loan, or item
3148 cannot be found.
3149
3150 =cut
3151
3152 sub GetSoonestRenewDate {
3153     my ( $borrowernumber, $itemnumber ) = @_;
3154
3155     my $dbh = C4::Context->dbh;
3156
3157     my $item      = Koha::Items->find($itemnumber)      or return;
3158     my $itemissue = $item->checkout or return;
3159
3160     $borrowernumber ||= $itemissue->borrowernumber;
3161     my $patron = Koha::Patrons->find( $borrowernumber )
3162       or return;
3163
3164     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3165     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3166         {   categorycode => $patron->categorycode,
3167             itemtype     => $item->effective_itemtype,
3168             branchcode   => $branchcode,
3169             rules => [
3170                 'norenewalbefore',
3171                 'lengthunit',
3172             ]
3173         }
3174     );
3175
3176     my $now = dt_from_string;
3177     return $now unless $issuing_rule;
3178
3179     if ( defined $issuing_rule->{norenewalbefore}
3180         and $issuing_rule->{norenewalbefore} ne "" )
3181     {
3182         my $soonestrenewal =
3183           dt_from_string( $itemissue->date_due )->subtract(
3184             $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3185
3186         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3187             and $issuing_rule->{lengthunit} eq 'days' )
3188         {
3189             $soonestrenewal->truncate( to => 'day' );
3190         }
3191         return $soonestrenewal if $now < $soonestrenewal;
3192     }
3193     return $now;
3194 }
3195
3196 =head2 GetLatestAutoRenewDate
3197
3198   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3199
3200 Find out the latest possible auto renew date of a borrowed item.
3201
3202 C<$borrowernumber> is the borrower number of the patron who currently
3203 has the item on loan.
3204
3205 C<$itemnumber> is the number of the item to renew.
3206
3207 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3208 auto renew date, based on the value "No auto renewal after" and the "No auto
3209 renewal after (hard limit) of the applicable issuing rule.
3210 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3211 or item cannot be found.
3212
3213 =cut
3214
3215 sub GetLatestAutoRenewDate {
3216     my ( $borrowernumber, $itemnumber ) = @_;
3217
3218     my $dbh = C4::Context->dbh;
3219
3220     my $item      = Koha::Items->find($itemnumber)  or return;
3221     my $itemissue = $item->checkout                 or return;
3222
3223     $borrowernumber ||= $itemissue->borrowernumber;
3224     my $patron = Koha::Patrons->find( $borrowernumber )
3225       or return;
3226
3227     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3228     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3229         {
3230             categorycode => $patron->categorycode,
3231             itemtype     => $item->effective_itemtype,
3232             branchcode   => $branchcode,
3233             rules => [
3234                 'no_auto_renewal_after',
3235                 'no_auto_renewal_after_hard_limit',
3236                 'lengthunit',
3237             ]
3238         }
3239     );
3240
3241     return unless $circulation_rules;
3242     return
3243       if ( not $circulation_rules->{no_auto_renewal_after}
3244             or $circulation_rules->{no_auto_renewal_after} eq '' )
3245       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3246              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3247
3248     my $maximum_renewal_date;
3249     if ( $circulation_rules->{no_auto_renewal_after} ) {
3250         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3251         $maximum_renewal_date->add(
3252             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3253         );
3254     }
3255
3256     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3257         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3258         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3259     }
3260     return $maximum_renewal_date;
3261 }
3262
3263
3264 =head2 GetIssuingCharges
3265
3266   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3267
3268 Calculate how much it would cost for a given patron to borrow a given
3269 item, including any applicable discounts.
3270
3271 C<$itemnumber> is the item number of item the patron wishes to borrow.
3272
3273 C<$borrowernumber> is the patron's borrower number.
3274
3275 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3276 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3277 if it's a video).
3278
3279 =cut
3280
3281 sub GetIssuingCharges {
3282
3283     # calculate charges due
3284     my ( $itemnumber, $borrowernumber ) = @_;
3285     my $charge = 0;
3286     my $dbh    = C4::Context->dbh;
3287     my $item_type;
3288
3289     # Get the book's item type and rental charge (via its biblioitem).
3290     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3291         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3292     $charge_query .= (C4::Context->preference('item-level_itypes'))
3293         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3294         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3295
3296     $charge_query .= ' WHERE items.itemnumber =?';
3297
3298     my $sth = $dbh->prepare($charge_query);
3299     $sth->execute($itemnumber);
3300     if ( my $item_data = $sth->fetchrow_hashref ) {
3301         $item_type = $item_data->{itemtype};
3302         $charge    = $item_data->{rentalcharge};
3303         my $branch = C4::Context::mybranch();
3304         my $patron = Koha::Patrons->find( $borrowernumber );
3305         my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3306         if ($discount) {
3307             # We may have multiple rules so get the most specific
3308             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3309         }
3310         if ($charge) {
3311             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3312         }
3313     }
3314
3315     return ( $charge, $item_type );
3316 }
3317
3318 # Select most appropriate discount rule from those returned
3319 sub _get_discount_from_rule {
3320     my ($categorycode, $branchcode, $itemtype) = @_;
3321
3322     # Set search precedences
3323     my @params = (
3324         {
3325             branchcode   => $branchcode,
3326             itemtype     => $itemtype,
3327             categorycode => $categorycode,
3328         },
3329         {
3330             branchcode   => undef,
3331             categorycode => $categorycode,
3332             itemtype     => $itemtype,
3333         },
3334         {
3335             branchcode   => $branchcode,
3336             categorycode => $categorycode,
3337             itemtype     => undef,
3338         },
3339         {
3340             branchcode   => undef,
3341             categorycode => $categorycode,
3342             itemtype     => undef,
3343         },
3344     );
3345
3346     foreach my $params (@params) {
3347         my $rule = Koha::CirculationRules->search(
3348             {
3349                 rule_name => 'rentaldiscount',
3350                 %$params,
3351             }
3352         )->next();
3353
3354         return $rule->rule_value if $rule;
3355     }
3356
3357     # none of the above
3358     return 0;
3359 }
3360
3361 =head2 AddIssuingCharge
3362
3363   &AddIssuingCharge( $checkout, $charge, $type )
3364
3365 =cut
3366
3367 sub AddIssuingCharge {
3368     my ( $checkout, $charge, $type ) = @_;
3369
3370     # FIXME What if checkout does not exist?
3371
3372     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3373     my $accountline = $account->add_debit(
3374         {
3375             amount      => $charge,
3376             note        => undef,
3377             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3378             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3379             interface   => C4::Context->interface,
3380             type        => $type,
3381             item_id     => $checkout->itemnumber,
3382             issue_id    => $checkout->issue_id,
3383         }
3384     );
3385 }
3386
3387 =head2 GetTransfers
3388
3389   GetTransfers($itemnumber);
3390
3391 =cut
3392
3393 sub GetTransfers {
3394     my ($itemnumber) = @_;
3395
3396     my $dbh = C4::Context->dbh;
3397
3398     my $query = '
3399         SELECT datesent,
3400                frombranch,
3401                tobranch,
3402                branchtransfer_id
3403         FROM branchtransfers
3404         WHERE itemnumber = ?
3405           AND datearrived IS NULL
3406         ';
3407     my $sth = $dbh->prepare($query);
3408     $sth->execute($itemnumber);
3409     my @row = $sth->fetchrow_array();
3410     return @row;
3411 }
3412
3413 =head2 GetTransfersFromTo
3414
3415   @results = GetTransfersFromTo($frombranch,$tobranch);
3416
3417 Returns the list of pending transfers between $from and $to branch
3418
3419 =cut
3420
3421 sub GetTransfersFromTo {
3422     my ( $frombranch, $tobranch ) = @_;
3423     return unless ( $frombranch && $tobranch );
3424     my $dbh   = C4::Context->dbh;
3425     my $query = "
3426         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3427         FROM   branchtransfers
3428         WHERE  frombranch=?
3429           AND  tobranch=?
3430           AND datearrived IS NULL
3431     ";
3432     my $sth = $dbh->prepare($query);
3433     $sth->execute( $frombranch, $tobranch );
3434     my @gettransfers;
3435
3436     while ( my $data = $sth->fetchrow_hashref ) {
3437         push @gettransfers, $data;
3438     }
3439     return (@gettransfers);
3440 }
3441
3442 =head2 DeleteTransfer
3443
3444   &DeleteTransfer($itemnumber);
3445
3446 =cut
3447
3448 sub DeleteTransfer {
3449     my ($itemnumber) = @_;
3450     return unless $itemnumber;
3451     my $dbh          = C4::Context->dbh;
3452     my $sth          = $dbh->prepare(
3453         "DELETE FROM branchtransfers
3454          WHERE itemnumber=?
3455          AND datearrived IS NULL "
3456     );
3457     return $sth->execute($itemnumber);
3458 }
3459
3460 =head2 SendCirculationAlert
3461
3462 Send out a C<check-in> or C<checkout> alert using the messaging system.
3463
3464 B<Parameters>:
3465
3466 =over 4
3467
3468 =item type
3469
3470 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3471
3472 =item item
3473
3474 Hashref of information about the item being checked in or out.
3475
3476 =item borrower
3477
3478 Hashref of information about the borrower of the item.
3479
3480 =item branch
3481
3482 The branchcode from where the checkout or check-in took place.
3483
3484 =back
3485
3486 B<Example>:
3487
3488     SendCirculationAlert({
3489         type     => 'CHECKOUT',
3490         item     => $item,
3491         borrower => $borrower,
3492         branch   => $branch,
3493     });
3494
3495 =cut
3496
3497 sub SendCirculationAlert {
3498     my ($opts) = @_;
3499     my ($type, $item, $borrower, $branch) =
3500         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3501     my %message_name = (
3502         CHECKIN  => 'Item_Check_in',
3503         CHECKOUT => 'Item_Checkout',
3504         RENEWAL  => 'Item_Checkout',
3505     );
3506     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3507         borrowernumber => $borrower->{borrowernumber},
3508         message_name   => $message_name{$type},
3509     });
3510     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3511
3512     my $schema = Koha::Database->new->schema;
3513     my @transports = keys %{ $borrower_preferences->{transports} };
3514
3515     # From the MySQL doc:
3516     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3517     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3518     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3519     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3520
3521     for my $mtt (@transports) {
3522         my $letter =  C4::Letters::GetPreparedLetter (
3523             module => 'circulation',
3524             letter_code => $type,
3525             branchcode => $branch,
3526             message_transport_type => $mtt,
3527             lang => $borrower->{lang},
3528             tables => {
3529                 $issues_table => $item->{itemnumber},
3530                 'items'       => $item->{itemnumber},
3531                 'biblio'      => $item->{biblionumber},
3532                 'biblioitems' => $item->{biblionumber},
3533                 'borrowers'   => $borrower,
3534                 'branches'    => $branch,
3535             }
3536         ) or next;
3537
3538         $schema->storage->txn_begin;
3539         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3540         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3541         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3542         unless ( $message ) {
3543             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3544             C4::Message->enqueue($letter, $borrower, $mtt);
3545         } else {
3546             $message->append($letter);
3547             $message->update;
3548         }
3549         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3550         $schema->storage->txn_commit;
3551     }
3552
3553     return;
3554 }
3555
3556 =head2 updateWrongTransfer
3557
3558   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3559
3560 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
3561
3562 =cut
3563
3564 sub updateWrongTransfer {
3565         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3566         my $dbh = C4::Context->dbh;
3567 # first step validate the actual line of transfert .
3568         my $sth =
3569                 $dbh->prepare(
3570                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3571                 );
3572                 $sth->execute($FromLibrary,$itemNumber);
3573
3574 # second step create a new line of branchtransfer to the right location .
3575         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3576
3577 #third step changing holdingbranch of item
3578     my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3579 }
3580
3581 =head2 CalcDateDue
3582
3583 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3584
3585 this function calculates the due date given the start date and configured circulation rules,
3586 checking against the holidays calendar as per the useDaysMode circulation rule.
3587 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3588 C<$itemtype>  = itemtype code of item in question
3589 C<$branch>  = location whose calendar to use
3590 C<$borrower> = Borrower object
3591 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3592
3593 =cut
3594
3595 sub CalcDateDue {
3596     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3597
3598     $isrenewal ||= 0;
3599
3600     # loanlength now a href
3601     my $loanlength =
3602             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3603
3604     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3605             ? qq{renewalperiod}
3606             : qq{issuelength};
3607
3608     my $datedue;
3609     if ( $startdate ) {
3610         if (ref $startdate ne 'DateTime' ) {
3611             $datedue = dt_from_string($datedue);
3612         } else {
3613             $datedue = $startdate->clone;
3614         }
3615     } else {
3616         $datedue = dt_from_string()->truncate( to => 'minute' );
3617     }
3618
3619
3620     my $useDaysMode_value = Koha::CirculationRules->get_useDaysMode_effective_value(
3621         {
3622             categorycode => $borrower->{categorycode},
3623             itemtype     => $itemtype,
3624             branchcode   => $branch,
3625         }
3626     );
3627
3628     # calculate the datedue as normal
3629     if ( $useDaysMode_value eq 'Days' )
3630     {    # ignoring calendar
3631         if ( $loanlength->{lengthunit} eq 'hours' ) {
3632             $datedue->add( hours => $loanlength->{$length_key} );
3633         } else {    # days
3634             $datedue->add( days => $loanlength->{$length_key} );
3635             $datedue->set_hour(23);
3636             $datedue->set_minute(59);
3637         }
3638     } else {
3639         my $dur;
3640         if ($loanlength->{lengthunit} eq 'hours') {
3641             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3642         }
3643         else { # days
3644             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3645         }
3646         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $useDaysMode_value );
3647         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3648         if ($loanlength->{lengthunit} eq 'days') {
3649             $datedue->set_hour(23);
3650             $datedue->set_minute(59);
3651         }
3652     }
3653
3654     # if Hard Due Dates are used, retrieve them and apply as necessary
3655     my ( $hardduedate, $hardduedatecompare ) =
3656       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3657     if ($hardduedate) {    # hardduedates are currently dates
3658         $hardduedate->truncate( to => 'minute' );
3659         $hardduedate->set_hour(23);
3660         $hardduedate->set_minute(59);
3661         my $cmp = DateTime->compare( $hardduedate, $datedue );
3662
3663 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3664 # if the calculated date is before the 'after' Hard Due Date (floor), override
3665 # if the hard due date is set to 'exactly', overrride
3666         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3667             $datedue = $hardduedate->clone;
3668         }
3669
3670         # in all other cases, keep the date due as it is
3671
3672     }
3673
3674     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3675     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3676         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3677         if( $expiry_dt ) { #skip empty expiry date..
3678             $expiry_dt->set( hour => 23, minute => 59);
3679             my $d1= $datedue->clone->set_time_zone('floating');
3680             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3681                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3682             }
3683         }
3684         if ( $useDaysMode_value ne 'Days' ) {
3685           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $useDaysMode_value );
3686           if ( $calendar->is_holiday($datedue) ) {
3687               # Don't return on a closed day
3688               $datedue = $calendar->prev_open_days( $datedue, 1 );
3689           }
3690         }
3691     }
3692
3693     return $datedue;
3694 }
3695
3696
3697 sub CheckValidBarcode{
3698 my ($barcode) = @_;
3699 my $dbh = C4::Context->dbh;
3700 my $query=qq|SELECT count(*)
3701              FROM items
3702              WHERE barcode=?
3703             |;
3704 my $sth = $dbh->prepare($query);
3705 $sth->execute($barcode);
3706 my $exist=$sth->fetchrow ;
3707 return $exist;
3708 }
3709
3710 =head2 IsBranchTransferAllowed
3711
3712   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3713
3714 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3715
3716 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3717 Koha::Item->can_be_transferred.
3718
3719 =cut
3720
3721 sub IsBranchTransferAllowed {
3722         my ( $toBranch, $fromBranch, $code ) = @_;
3723
3724         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3725
3726         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3727         my $dbh = C4::Context->dbh;
3728
3729         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3730         $sth->execute( $toBranch, $fromBranch, $code );
3731         my $limit = $sth->fetchrow_hashref();
3732
3733         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3734         if ( $limit->{'limitId'} ) {
3735                 return 0;
3736         } else {
3737                 return 1;
3738         }
3739 }
3740
3741 =head2 CreateBranchTransferLimit
3742
3743   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3744
3745 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3746
3747 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3748
3749 =cut
3750
3751 sub CreateBranchTransferLimit {
3752    my ( $toBranch, $fromBranch, $code ) = @_;
3753    return unless defined($toBranch) && defined($fromBranch);
3754    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3755
3756    my $dbh = C4::Context->dbh;
3757
3758    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3759    return $sth->execute( $code, $toBranch, $fromBranch );
3760 }
3761
3762 =head2 DeleteBranchTransferLimits
3763
3764     my $result = DeleteBranchTransferLimits($frombranch);
3765
3766 Deletes all the library transfer limits for one library.  Returns the
3767 number of limits deleted, 0e0 if no limits were deleted, or undef if
3768 no arguments are supplied.
3769
3770 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3771     fromBranch => $fromBranch
3772     })->delete.
3773
3774 =cut
3775
3776 sub DeleteBranchTransferLimits {
3777     my $branch = shift;
3778     return unless defined $branch;
3779     my $dbh    = C4::Context->dbh;
3780     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3781     return $sth->execute($branch);
3782 }
3783
3784 sub ReturnLostItem{
3785     my ( $borrowernumber, $itemnum ) = @_;
3786     MarkIssueReturned( $borrowernumber, $itemnum );
3787 }
3788
3789
3790 sub LostItem{
3791     my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3792
3793     unless ( $mark_lost_from ) {
3794         # Temporary check to avoid regressions
3795         die q|LostItem called without $mark_lost_from, check the API.|;
3796     }
3797
3798     my $mark_returned;
3799     if ( $force_mark_returned ) {
3800         $mark_returned = 1;
3801     } else {
3802         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3803         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3804     }
3805
3806     my $dbh = C4::Context->dbh();
3807     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3808                            FROM issues
3809                            JOIN items USING (itemnumber)
3810                            JOIN biblio USING (biblionumber)
3811                            WHERE issues.itemnumber=?");
3812     $sth->execute($itemnumber);
3813     my $issues=$sth->fetchrow_hashref();
3814
3815     # If a borrower lost the item, add a replacement cost to the their record
3816     if ( my $borrowernumber = $issues->{borrowernumber} ){
3817         my $patron = Koha::Patrons->find( $borrowernumber );
3818
3819         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3820         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3821
3822         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3823             C4::Accounts::chargelostitem(
3824                 $borrowernumber,
3825                 $itemnumber,
3826                 $issues->{'replacementprice'},
3827                 sprintf( "%s %s %s",
3828                     $issues->{'title'}          || q{},
3829                     $issues->{'barcode'}        || q{},
3830                     $issues->{'itemcallnumber'} || q{},
3831                 ),
3832             );
3833             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3834             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3835         }
3836
3837         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3838     }
3839
3840     #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3841     if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3842         Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store;
3843     }
3844     my $transferdeleted = DeleteTransfer($itemnumber);
3845 }
3846
3847 sub GetOfflineOperations {
3848     my $dbh = C4::Context->dbh;
3849     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3850     $sth->execute(C4::Context->userenv->{'branch'});
3851     my $results = $sth->fetchall_arrayref({});
3852     return $results;
3853 }
3854
3855 sub GetOfflineOperation {
3856     my $operationid = shift;
3857     return unless $operationid;
3858     my $dbh = C4::Context->dbh;
3859     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3860     $sth->execute( $operationid );
3861     return $sth->fetchrow_hashref;
3862 }
3863
3864 sub AddOfflineOperation {
3865     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3866     my $dbh = C4::Context->dbh;
3867     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3868     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3869     return "Added.";
3870 }
3871
3872 sub DeleteOfflineOperation {
3873     my $dbh = C4::Context->dbh;
3874     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3875     $sth->execute( shift );
3876     return "Deleted.";
3877 }
3878
3879 sub ProcessOfflineOperation {
3880     my $operation = shift;
3881
3882     my $report;
3883     if ( $operation->{action} eq 'return' ) {
3884         $report = ProcessOfflineReturn( $operation );
3885     } elsif ( $operation->{action} eq 'issue' ) {
3886         $report = ProcessOfflineIssue( $operation );
3887     } elsif ( $operation->{action} eq 'payment' ) {
3888         $report = ProcessOfflinePayment( $operation );
3889     }
3890
3891     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3892
3893     return $report;
3894 }
3895
3896 sub ProcessOfflineReturn {
3897     my $operation = shift;
3898
3899     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3900
3901     if ( $item ) {
3902         my $itemnumber = $item->itemnumber;
3903         my $issue = GetOpenIssue( $itemnumber );
3904         if ( $issue ) {
3905             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3906             ModDateLastSeen( $itemnumber, $leave_item_lost );
3907             MarkIssueReturned(
3908                 $issue->{borrowernumber},
3909                 $itemnumber,
3910                 $operation->{timestamp},
3911             );
3912             $item->renewals(0);
3913             $item->onloan(undef);
3914             $item->store({ log_action => 0 });
3915             return "Success.";
3916         } else {
3917             return "Item not issued.";
3918         }
3919     } else {
3920         return "Item not found.";
3921     }
3922 }
3923
3924 sub ProcessOfflineIssue {
3925     my $operation = shift;
3926
3927     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3928
3929     if ( $patron ) {
3930         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3931         unless ($item) {
3932             return "Barcode not found.";
3933         }
3934         my $itemnumber = $item->itemnumber;
3935         my $issue = GetOpenIssue( $itemnumber );
3936
3937         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3938             MarkIssueReturned(
3939                 $issue->{borrowernumber},
3940                 $itemnumber,
3941                 $operation->{timestamp},
3942             );
3943         }
3944         AddIssue(
3945             $patron->unblessed,
3946             $operation->{'barcode'},
3947             undef,
3948             1,
3949             $operation->{timestamp},
3950             undef,
3951         );
3952         return "Success.";
3953     } else {
3954         return "Borrower not found.";
3955     }
3956 }
3957
3958 sub ProcessOfflinePayment {
3959     my $operation = shift;
3960
3961     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3962
3963     $patron->account->pay(
3964         {
3965             amount     => $operation->{amount},
3966             library_id => $operation->{branchcode},
3967             interface  => 'koc'
3968         }
3969     );
3970
3971     return "Success.";
3972 }
3973
3974 =head2 TransferSlip
3975
3976   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3977
3978   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3979
3980 =cut
3981
3982 sub TransferSlip {
3983     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3984
3985     my $item =
3986       $itemnumber
3987       ? Koha::Items->find($itemnumber)
3988       : Koha::Items->find( { barcode => $barcode } );
3989
3990     $item or return;
3991
3992     return C4::Letters::GetPreparedLetter (
3993         module => 'circulation',
3994         letter_code => 'TRANSFERSLIP',
3995         branchcode => $branch,
3996         tables => {
3997             'branches'    => $to_branch,
3998             'biblio'      => $item->biblionumber,
3999             'items'       => $item->unblessed,
4000         },
4001     );
4002 }
4003
4004 =head2 CheckIfIssuedToPatron
4005
4006   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4007
4008   Return 1 if any record item is issued to patron, otherwise return 0
4009
4010 =cut
4011
4012 sub CheckIfIssuedToPatron {
4013     my ($borrowernumber, $biblionumber) = @_;
4014
4015     my $dbh = C4::Context->dbh;
4016     my $query = q|
4017         SELECT COUNT(*) FROM issues
4018         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4019         WHERE items.biblionumber = ?
4020         AND issues.borrowernumber = ?
4021     |;
4022     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4023     return 1 if $is_issued;
4024     return;
4025 }
4026
4027 =head2 IsItemIssued
4028
4029   IsItemIssued( $itemnumber )
4030
4031   Return 1 if the item is on loan, otherwise return 0
4032
4033 =cut
4034
4035 sub IsItemIssued {
4036     my $itemnumber = shift;
4037     my $dbh = C4::Context->dbh;
4038     my $sth = $dbh->prepare(q{
4039         SELECT COUNT(*)
4040         FROM issues
4041         WHERE itemnumber = ?
4042     });
4043     $sth->execute($itemnumber);
4044     return $sth->fetchrow;
4045 }
4046
4047 =head2 GetAgeRestriction
4048
4049   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4050   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4051
4052   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4053   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4054
4055 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4056 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4057 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4058          Negative days mean the borrower has gone past the age restriction age.
4059
4060 =cut
4061
4062 sub GetAgeRestriction {
4063     my ($record_restrictions, $borrower) = @_;
4064     my $markers = C4::Context->preference('AgeRestrictionMarker');
4065
4066     return unless $record_restrictions;
4067     # Split $record_restrictions to something like FSK 16 or PEGI 6
4068     my @values = split ' ', uc($record_restrictions);
4069     return unless @values;
4070
4071     # Search first occurrence of one of the markers
4072     my @markers = split /\|/, uc($markers);
4073     return unless @markers;
4074
4075     my $index            = 0;
4076     my $restriction_year = 0;
4077     for my $value (@values) {
4078         $index++;
4079         for my $marker (@markers) {
4080             $marker =~ s/^\s+//;    #remove leading spaces
4081             $marker =~ s/\s+$//;    #remove trailing spaces
4082             if ( $marker eq $value ) {
4083                 if ( $index <= $#values ) {
4084                     $restriction_year += $values[$index];
4085                 }
4086                 last;
4087             }
4088             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4089
4090                 # Perhaps it is something like "K16" (as in Finland)
4091                 $restriction_year += $1;
4092                 last;
4093             }
4094         }
4095         last if ( $restriction_year > 0 );
4096     }
4097
4098     #Check if the borrower is age restricted for this material and for how long.
4099     if ($restriction_year && $borrower) {
4100         if ( $borrower->{'dateofbirth'} ) {
4101             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4102             $alloweddate[0] += $restriction_year;
4103
4104             #Prevent runime eror on leap year (invalid date)
4105             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4106                 $alloweddate[2] = 28;
4107             }
4108
4109             #Get how many days the borrower has to reach the age restriction
4110             my @Today = split /-/, dt_from_string()->ymd();
4111             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4112             #Negative days means the borrower went past the age restriction age
4113             return ($restriction_year, $daysToAgeRestriction);
4114         }
4115     }
4116
4117     return ($restriction_year);
4118 }
4119
4120
4121 =head2 GetPendingOnSiteCheckouts
4122
4123 =cut
4124
4125 sub GetPendingOnSiteCheckouts {
4126     my $dbh = C4::Context->dbh;
4127     return $dbh->selectall_arrayref(q|
4128         SELECT
4129           items.barcode,
4130           items.biblionumber,
4131           items.itemnumber,
4132           items.itemnotes,
4133           items.itemcallnumber,
4134           items.location,
4135           issues.date_due,
4136           issues.branchcode,
4137           issues.date_due < NOW() AS is_overdue,
4138           biblio.author,
4139           biblio.title,
4140           borrowers.firstname,
4141           borrowers.surname,
4142           borrowers.cardnumber,
4143           borrowers.borrowernumber
4144         FROM items
4145         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4146         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4147         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4148         WHERE issues.onsite_checkout = 1
4149     |, { Slice => {} } );
4150 }
4151
4152 sub GetTopIssues {
4153     my ($params) = @_;
4154
4155     my ($count, $branch, $itemtype, $ccode, $newness)
4156         = @$params{qw(count branch itemtype ccode newness)};
4157
4158     my $dbh = C4::Context->dbh;
4159     my $query = q{
4160         SELECT * FROM (
4161         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4162           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4163           i.ccode, SUM(i.issues) AS count
4164         FROM biblio b
4165         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4166         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4167     };
4168
4169     my (@where_strs, @where_args);
4170
4171     if ($branch) {
4172         push @where_strs, 'i.homebranch = ?';
4173         push @where_args, $branch;
4174     }
4175     if ($itemtype) {
4176         if (C4::Context->preference('item-level_itypes')){
4177             push @where_strs, 'i.itype = ?';
4178             push @where_args, $itemtype;
4179         } else {
4180             push @where_strs, 'bi.itemtype = ?';
4181             push @where_args, $itemtype;
4182         }
4183     }
4184     if ($ccode) {
4185         push @where_strs, 'i.ccode = ?';
4186         push @where_args, $ccode;
4187     }
4188     if ($newness) {
4189         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4190         push @where_args, $newness;
4191     }
4192
4193     if (@where_strs) {
4194         $query .= 'WHERE ' . join(' AND ', @where_strs);
4195     }
4196
4197     $query .= q{
4198         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4199           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4200           i.ccode
4201         ORDER BY count DESC
4202     };
4203
4204     $query .= q{ ) xxx WHERE count > 0 };
4205     $count = int($count);
4206     if ($count > 0) {
4207         $query .= "LIMIT $count";
4208     }
4209
4210     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4211
4212     return @$rows;
4213 }
4214
4215 sub _CalculateAndUpdateFine {
4216     my ($params) = @_;
4217
4218     my $borrower    = $params->{borrower};
4219     my $item        = $params->{item};
4220     my $issue       = $params->{issue};
4221     my $return_date = $params->{return_date};
4222
4223     unless ($borrower) { carp "No borrower passed in!" && return; }
4224     unless ($item)     { carp "No item passed in!"     && return; }
4225     unless ($issue)    { carp "No issue passed in!"    && return; }
4226
4227     my $datedue = dt_from_string( $issue->date_due );
4228
4229     # we only need to calculate and change the fines if we want to do that on return
4230     # Should be on for hourly loans
4231     my $control = C4::Context->preference('CircControl');
4232     my $control_branchcode =
4233         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4234       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4235       :                                     $issue->branchcode;
4236
4237     my $date_returned = $return_date ? $return_date : dt_from_string();
4238
4239     my ( $amount, $unitcounttotal, $unitcount  ) =
4240       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4241
4242     if ( C4::Context->preference('finesMode') eq 'production' ) {
4243         if ( $amount > 0 ) {
4244             C4::Overdues::UpdateFine({
4245                 issue_id       => $issue->issue_id,
4246                 itemnumber     => $issue->itemnumber,
4247                 borrowernumber => $issue->borrowernumber,
4248                 amount         => $amount,
4249                 due            => output_pref($datedue),
4250             });
4251         }
4252         elsif ($return_date) {
4253
4254             # Backdated returns may have fines that shouldn't exist,
4255             # so in this case, we need to drop those fines to 0
4256
4257             C4::Overdues::UpdateFine({
4258                 issue_id       => $issue->issue_id,
4259                 itemnumber     => $issue->itemnumber,
4260                 borrowernumber => $issue->borrowernumber,
4261                 amount         => 0,
4262                 due            => output_pref($datedue),
4263             });
4264         }
4265     }
4266 }
4267
4268 sub _item_denied_renewal {
4269     my ($params) = @_;
4270
4271     my $item = $params->{item};
4272     return unless $item;
4273
4274     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4275     return unless $denyingrules;
4276     foreach my $field (keys %$denyingrules) {
4277         my $val = $item->$field;
4278         if( !defined $val) {
4279             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4280                 return 1;
4281             }
4282         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4283            # If the results matches the values in the syspref
4284            # We return true if match found
4285             return 1;
4286         }
4287     }
4288     return 0;
4289 }
4290
4291
4292 1;
4293
4294 __END__
4295
4296 =head1 AUTHOR
4297
4298 Koha Development Team <http://koha-community.org/>
4299
4300 =cut