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