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