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             # Record if item was lost
1534             my $was_lost = $item_object->itemlost;
1535
1536             $item_object->issues( ( $item_object->issues || 0 ) + 1);
1537             $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1538             $item_object->itemlost(0);
1539             $item_object->onloan($datedue->ymd());
1540             $item_object->datelastborrowed( dt_from_string()->ymd() );
1541             $item_object->datelastseen( dt_from_string()->ymd() );
1542             $item_object->store({log_action => 0});
1543
1544             # If the item was lost, it has now been found, charge the overdue if necessary
1545             if ($was_lost) {
1546                 if ( $item_object->{_charge} ) {
1547                     $actualissue //= Koha::Old::Checkouts->search(
1548                         { itemnumber => $item_unblessed->{itemnumber} },
1549                         {
1550                             order_by => { '-desc' => 'returndate' },
1551                             rows     => 1
1552                         }
1553                     )->single;
1554                     unless ( exists( $borrower->{branchcode} ) ) {
1555                         my $patron = $actualissue->patron;
1556                         $borrower = $patron->unblessed;
1557                     }
1558                     _CalculateAndUpdateFine(
1559                         {
1560                             issue       => $actualissue,
1561                             item        => $item_unblessed,
1562                             borrower    => $borrower,
1563                             return_date => $issuedate
1564                         }
1565                     );
1566                     _FixOverduesOnReturn( $borrower->{borrowernumber},
1567                         $item_object->itemnumber, undef, 'RENEWED' );
1568                 }
1569             }
1570
1571             # If it costs to borrow this book, charge it to the patron's account.
1572             my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1573             if ( $charge && $charge > 0 ) {
1574                 AddIssuingCharge( $issue, $charge, 'RENT' );
1575             }
1576
1577             my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1578             if ( $itemtype_object ) {
1579                 my $accumulate_charge = $fees->accumulate_rentalcharge();
1580                 if ( $accumulate_charge > 0 ) {
1581                     AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1582                     $charge += $accumulate_charge;
1583                     $item_unblessed->{charge} = $charge;
1584                 }
1585             }
1586
1587             # Record the fact that this book was issued.
1588             &UpdateStats(
1589                 {
1590                     branch => C4::Context->userenv->{'branch'},
1591                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1592                     amount         => $charge,
1593                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1594                     itemnumber     => $item_object->itemnumber,
1595                     itemtype       => $item_object->effective_itemtype,
1596                     location       => $item_object->location,
1597                     borrowernumber => $borrower->{'borrowernumber'},
1598                     ccode          => $item_object->ccode,
1599                 }
1600             );
1601
1602             # Send a checkout slip.
1603             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1604             my %conditions        = (
1605                 branchcode   => $branchcode,
1606                 categorycode => $borrower->{categorycode},
1607                 item_type    => $item_object->effective_itemtype,
1608                 notification => 'CHECKOUT',
1609             );
1610             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1611                 SendCirculationAlert(
1612                     {
1613                         type     => 'CHECKOUT',
1614                         item     => $item_object->unblessed,
1615                         borrower => $borrower,
1616                         branch   => $branchcode,
1617                     }
1618                 );
1619             }
1620             logaction(
1621                 "CIRCULATION", "ISSUE",
1622                 $borrower->{'borrowernumber'},
1623                 $item_object->itemnumber,
1624             ) if C4::Context->preference("IssueLog");
1625
1626             Koha::Plugins->call('after_circ_action', {
1627                 action  => 'checkout',
1628                 payload => {
1629                     type     => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1630                     checkout => $issue->get_from_storage
1631                 }
1632             });
1633         }
1634     }
1635     return $issue;
1636 }
1637
1638 =head2 GetLoanLength
1639
1640   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1641
1642 Get loan length for an itemtype, a borrower type and a branch
1643
1644 =cut
1645
1646 sub GetLoanLength {
1647     my ( $categorycode, $itemtype, $branchcode ) = @_;
1648
1649     # Initialize default values
1650     my $rules = {
1651         issuelength   => 0,
1652         renewalperiod => 0,
1653         lengthunit    => 'days',
1654     };
1655
1656     my $found = Koha::CirculationRules->get_effective_rules( {
1657         branchcode => $branchcode,
1658         categorycode => $categorycode,
1659         itemtype => $itemtype,
1660         rules => [
1661             'issuelength',
1662             'renewalperiod',
1663             'lengthunit'
1664         ],
1665     } );
1666
1667     # Search for rules!
1668     foreach my $rule_name (keys %$found) {
1669         $rules->{$rule_name} = $found->{$rule_name};
1670     }
1671
1672     return $rules;
1673 }
1674
1675
1676 =head2 GetHardDueDate
1677
1678   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1679
1680 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1681
1682 =cut
1683
1684 sub GetHardDueDate {
1685     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1686
1687     my $rules = Koha::CirculationRules->get_effective_rules(
1688         {
1689             categorycode => $borrowertype,
1690             itemtype     => $itemtype,
1691             branchcode   => $branchcode,
1692             rules        => [ 'hardduedate', 'hardduedatecompare' ],
1693         }
1694     );
1695
1696     if ( defined( $rules->{hardduedate} ) ) {
1697         if ( $rules->{hardduedate} ) {
1698             return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1699         }
1700         else {
1701             return ( undef, undef );
1702         }
1703     }
1704 }
1705
1706 =head2 GetBranchBorrowerCircRule
1707
1708   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1709
1710 Retrieves circulation rule attributes that apply to the given
1711 branch and patron category, regardless of item type.
1712 The return value is a hashref containing the following key:
1713
1714 patron_maxissueqty - maximum number of loans that a
1715 patron of the given category can have at the given
1716 branch.  If the value is undef, no limit.
1717
1718 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1719 patron of the given category can have at the given
1720 branch.  If the value is undef, no limit.
1721
1722 This will check for different branch/category combinations in the following order:
1723 branch and category
1724 branch only
1725 category only
1726 default branch and category
1727
1728 If no rule has been found in the database, it will default to
1729 the buillt in rule:
1730
1731 patron_maxissueqty - undef
1732 patron_maxonsiteissueqty - undef
1733
1734 C<$branchcode> and C<$categorycode> should contain the
1735 literal branch code and patron category code, respectively - no
1736 wildcards.
1737
1738 =cut
1739
1740 sub GetBranchBorrowerCircRule {
1741     my ( $branchcode, $categorycode ) = @_;
1742
1743     # Initialize default values
1744     my $rules = {
1745         patron_maxissueqty       => undef,
1746         patron_maxonsiteissueqty => undef,
1747     };
1748
1749     # Search for rules!
1750     foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1751         my $rule = Koha::CirculationRules->get_effective_rule(
1752             {
1753                 categorycode => $categorycode,
1754                 itemtype     => undef,
1755                 branchcode   => $branchcode,
1756                 rule_name    => $rule_name,
1757             }
1758         );
1759
1760         $rules->{$rule_name} = $rule->rule_value if defined $rule;
1761     }
1762
1763     return $rules;
1764 }
1765
1766 =head2 GetBranchItemRule
1767
1768   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1769
1770 Retrieves circulation rule attributes that apply to the given
1771 branch and item type, regardless of patron category.
1772
1773 The return value is a hashref containing the following keys:
1774
1775 holdallowed => Hold policy for this branch and itemtype. Possible values:
1776   0: No holds allowed.
1777   1: Holds allowed only by patrons that have the same homebranch as the item.
1778   2: Holds allowed from any patron.
1779
1780 returnbranch => branch to which to return item.  Possible values:
1781   noreturn: do not return, let item remain where checked in (floating collections)
1782   homebranch: return to item's home branch
1783   holdingbranch: return to issuer branch
1784
1785 This searches branchitemrules in the following order:
1786
1787   * Same branchcode and itemtype
1788   * Same branchcode, itemtype '*'
1789   * branchcode '*', same itemtype
1790   * branchcode and itemtype '*'
1791
1792 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1793
1794 =cut
1795
1796 sub GetBranchItemRule {
1797     my ( $branchcode, $itemtype ) = @_;
1798
1799     # Search for rules!
1800     my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1801         {
1802             branchcode => $branchcode,
1803             itemtype => $itemtype,
1804             rule_name => 'holdallowed',
1805         }
1806     );
1807     my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1808         {
1809             branchcode => $branchcode,
1810             itemtype => $itemtype,
1811             rule_name => 'hold_fulfillment_policy',
1812         }
1813     );
1814     my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1815         {
1816             branchcode => $branchcode,
1817             itemtype => $itemtype,
1818             rule_name => 'returnbranch',
1819         }
1820     );
1821
1822     # built-in default circulation rule
1823     my $rules;
1824     $rules->{holdallowed} = defined $holdallowed_rule
1825         ? $holdallowed_rule->rule_value
1826         : 2;
1827     $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1828         ? $hold_fulfillment_policy_rule->rule_value
1829         : 'any';
1830     $rules->{returnbranch} = defined $returnbranch_rule
1831         ? $returnbranch_rule->rule_value
1832         : 'homebranch';
1833
1834     return $rules;
1835 }
1836
1837 =head2 AddReturn
1838
1839   ($doreturn, $messages, $iteminformation, $borrower) =
1840       &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1841
1842 Returns a book.
1843
1844 =over 4
1845
1846 =item C<$barcode> is the bar code of the book being returned.
1847
1848 =item C<$branch> is the code of the branch where the book is being returned.
1849
1850 =item C<$exemptfine> indicates that overdue charges for the item will be
1851 removed. Optional.
1852
1853 =item C<$return_date> allows the default return date to be overridden
1854 by the given return date. Optional.
1855
1856 =back
1857
1858 C<&AddReturn> returns a list of four items:
1859
1860 C<$doreturn> is true iff the return succeeded.
1861
1862 C<$messages> is a reference-to-hash giving feedback on the operation.
1863 The keys of the hash are:
1864
1865 =over 4
1866
1867 =item C<BadBarcode>
1868
1869 No item with this barcode exists. The value is C<$barcode>.
1870
1871 =item C<NotIssued>
1872
1873 The book is not currently on loan. The value is C<$barcode>.
1874
1875 =item C<withdrawn>
1876
1877 This book has been withdrawn/cancelled. The value should be ignored.
1878
1879 =item C<Wrongbranch>
1880
1881 This book has was returned to the wrong branch.  The value is a hashref
1882 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1883 contain the branchcode of the incorrect and correct return library, respectively.
1884
1885 =item C<ResFound>
1886
1887 The item was reserved. The value is a reference-to-hash whose keys are
1888 fields from the reserves table of the Koha database, and
1889 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1890 either C<Waiting>, C<Reserved>, or 0.
1891
1892 =item C<WasReturned>
1893
1894 Value 1 if return is successful.
1895
1896 =item C<NeedsTransfer>
1897
1898 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1899
1900 =back
1901
1902 C<$iteminformation> is a reference-to-hash, giving information about the
1903 returned item from the issues table.
1904
1905 C<$borrower> is a reference-to-hash, giving information about the
1906 patron who last borrowed the book.
1907
1908 =cut
1909
1910 sub AddReturn {
1911     my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1912
1913     if ($branch and not Koha::Libraries->find($branch)) {
1914         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1915         undef $branch;
1916     }
1917     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1918     my $return_date_specified = !!$return_date;
1919     $return_date //= dt_from_string();
1920     my $messages;
1921     my $patron;
1922     my $doreturn       = 1;
1923     my $validTransfer = 1;
1924     my $stat_type = 'return';
1925
1926     # get information on item
1927     my $item = Koha::Items->find({ barcode => $barcode });
1928     unless ($item) {
1929         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1930     }
1931
1932     my $itemnumber = $item->itemnumber;
1933     my $itemtype = $item->effective_itemtype;
1934
1935     my $issue  = $item->checkout;
1936     if ( $issue ) {
1937         $patron = $issue->patron
1938             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1939                 . Dumper($issue->unblessed) . "\n";
1940     } else {
1941         $messages->{'NotIssued'} = $barcode;
1942         $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
1943
1944         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1945         $doreturn = 0;
1946         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1947         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1948         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1949            $messages->{'LocalUse'} = 1;
1950            $stat_type = 'localuse';
1951         }
1952     }
1953
1954         # full item data, but no borrowernumber or checkout info (no issue)
1955     my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1956         # get the proper branch to which to return the item
1957     my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1958         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1959     my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1960
1961     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
1962     my $patron_unblessed = $patron ? $patron->unblessed : {};
1963
1964     my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1965     map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1966     if ($update_loc_rules) {
1967         if (defined $update_loc_rules->{_ALL_}) {
1968             if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1969             if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1970             if ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) {
1971                 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1972                 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
1973             }
1974         }
1975         else {
1976             foreach my $key ( keys %$update_loc_rules ) {
1977                 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1978                 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1979                 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1980                     $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1981                     $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
1982                     last;
1983                 }
1984             }
1985         }
1986     }
1987
1988     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1989     if ($yaml) {
1990         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
1991         my $rules;
1992         eval { $rules = YAML::Load($yaml); };
1993         if ($@) {
1994             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1995         }
1996         else {
1997             foreach my $key ( keys %$rules ) {
1998                 if ( $item->notforloan eq $key ) {
1999                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2000                     $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2001                     last;
2002                 }
2003             }
2004         }
2005     }
2006
2007     # check if the return is allowed at this branch
2008     my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2009     unless ($returnallowed){
2010         $messages->{'Wrongbranch'} = {
2011             Wrongbranch => $branch,
2012             Rightbranch => $message
2013         };
2014         $doreturn = 0;
2015         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2016         $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2017         return ( $doreturn, $messages, $issue, $patron_unblessed);
2018     }
2019
2020     if ( $item->withdrawn ) { # book has been cancelled
2021         $messages->{'withdrawn'} = 1;
2022         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2023     }
2024
2025     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2026         $doreturn = 0;
2027     }
2028
2029     # case of a return of document (deal with issues and holdingbranch)
2030     if ($doreturn) {
2031         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2032         $patron or warn "AddReturn without current borrower";
2033
2034         if ($patron) {
2035             eval {
2036                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2037             };
2038             unless ( $@ ) {
2039                 if (
2040                     (
2041                         C4::Context->preference('CalculateFinesOnReturn')
2042                         || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2043                     )
2044                     && !$item->itemlost
2045                   )
2046                 {
2047                     _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2048                 }
2049             } else {
2050                 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 );
2051
2052                 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2053                 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2054
2055                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2056             }
2057
2058             # FIXME is the "= 1" right?  This could be the borrower hash.
2059             $messages->{'WasReturned'} = 1;
2060
2061         } else {
2062             $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2063         }
2064     }
2065
2066     # the holdingbranch is updated if the document is returned to another location.
2067     # this is always done regardless of whether the item was on loan or not
2068     if ($item->holdingbranch ne $branch) {
2069         $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2070     }
2071
2072     my $item_was_lost = $item->itemlost;
2073     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2074     my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2075
2076     # fix up the accounts.....
2077     if ($item_was_lost) {
2078         $messages->{'WasLost'} = 1;
2079         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2080             $messages->{'LostItemFeeRefunded'} = $updated_item->{_refunded};
2081             $messages->{'LostItemFeeRestored'} = $updated_item->{_restored};
2082
2083             if ( $updated_item->{_charge} ) {
2084                 $issue //= Koha::Old::Checkouts->search(
2085                     { itemnumber => $item->itemnumber },
2086                     { order_by   => { '-desc' => 'returndate' }, rows => 1 } )
2087                   ->single;
2088                 unless ( exists( $patron_unblessed->{branchcode} ) ) {
2089                     my $patron = $issue->patron;
2090                     $patron_unblessed = $patron->unblessed;
2091                 }
2092                 _CalculateAndUpdateFine(
2093                     {
2094                         issue       => $issue,
2095                         item        => $item->unblessed,
2096                         borrower    => $patron_unblessed,
2097                         return_date => $return_date
2098                     }
2099                 );
2100                 _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2101                     $item->itemnumber, undef, 'RETURNED' );
2102                 $messages->{'LostItemFeeCharged'} = 1;
2103             }
2104         }
2105     }
2106
2107     # check if we have a transfer for this document
2108     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2109
2110     # if we have a transfer to complete, we update the line of transfers with the datearrived
2111     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2112     if ($datesent) {
2113         # At this point we will either fill the transfer or it is a wrong transfer
2114         # either way we should not now generate a new transfer
2115         $validTransfer = 0;
2116         if ( $tobranch eq $branch ) {
2117             my $sth = C4::Context->dbh->prepare(
2118                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2119             );
2120             $sth->execute( $item->itemnumber );
2121             $messages->{'TransferArrived'} = $frombranch;
2122         } else {
2123             $messages->{'WrongTransfer'}     = $tobranch;
2124             $messages->{'WrongTransferItem'} = $item->itemnumber;
2125         }
2126     }
2127
2128     # fix up the overdues in accounts...
2129     if ($borrowernumber) {
2130         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2131         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!";  # zero is OK, check defined
2132
2133         if ( $issue and $issue->is_overdue($return_date) ) {
2134         # fix fine days
2135             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2136             if ($reminder){
2137                 $messages->{'PrevDebarred'} = $debardate;
2138             } else {
2139                 $messages->{'Debarred'} = $debardate if $debardate;
2140             }
2141         # there's no overdue on the item but borrower had been previously debarred
2142         } elsif ( $issue->date_due and $patron->debarred ) {
2143              if ( $patron->debarred eq "9999-12-31") {
2144                 $messages->{'ForeverDebarred'} = $patron->debarred;
2145              } else {
2146                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2147                   $borrower_debar_dt->truncate(to => 'day');
2148                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2149                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2150                       $messages->{'PrevDebarred'} = $patron->debarred;
2151                   }
2152              }
2153         }
2154     }
2155
2156     # find reserves.....
2157     # launch the Checkreserves routine to find any holds
2158     my ($resfound, $resrec);
2159     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2160     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2161     # 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)
2162     if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2163         my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2164         $resfound = 'Reserved';
2165         $resrec = $hold->unblessed;
2166     }
2167     if ($resfound) {
2168           $resrec->{'ResFound'} = $resfound;
2169         $messages->{'ResFound'} = $resrec;
2170     }
2171
2172     # Record the fact that this book was returned.
2173     UpdateStats({
2174         branch         => $branch,
2175         type           => $stat_type,
2176         itemnumber     => $itemnumber,
2177         itemtype       => $itemtype,
2178         location       => $item->location,
2179         borrowernumber => $borrowernumber,
2180         ccode          => $item->ccode,
2181     });
2182
2183     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2184     if ( $patron ) {
2185         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2186         my %conditions = (
2187             branchcode   => $branch,
2188             categorycode => $patron->categorycode,
2189             item_type    => $itemtype,
2190             notification => 'CHECKIN',
2191         );
2192         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2193             SendCirculationAlert({
2194                 type     => 'CHECKIN',
2195                 item     => $item->unblessed,
2196                 borrower => $patron->unblessed,
2197                 branch   => $branch,
2198             });
2199         }
2200
2201         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2202             if C4::Context->preference("ReturnLog");
2203         }
2204
2205     # Check if this item belongs to a biblio record that is attached to an
2206     # ILL request, if it is we need to update the ILL request's status
2207     if ( $doreturn and C4::Context->preference('CirculateILL')) {
2208         my $request = Koha::Illrequests->find(
2209             { biblio_id => $item->biblio->biblionumber }
2210         );
2211         $request->status('RET') if $request;
2212     }
2213
2214     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2215     if ($validTransfer && !$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) ){
2216         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2217         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2218             (C4::Context->preference("UseBranchTransferLimits") and
2219              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2220            )) {
2221             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2222             $debug and warn "item: " . Dumper($item->unblessed);
2223             ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2224             $messages->{'WasTransfered'} = 1;
2225         } else {
2226             $messages->{'NeedsTransfer'} = $returnbranch;
2227             $messages->{'TransferTrigger'} = $transfer_trigger;
2228         }
2229     }
2230
2231     if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2232         my $claims = Koha::Checkouts::ReturnClaims->search(
2233            {
2234                itemnumber => $item->id,
2235                resolution => undef,
2236            }
2237         );
2238
2239         if ( $claims->count ) {
2240             $messages->{ReturnClaims} = $claims;
2241         }
2242     }
2243
2244     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2245     $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2246
2247     if ( $doreturn and $issue ) {
2248         my $checkin = Koha::Old::Checkouts->find($issue->id);
2249
2250         Koha::Plugins->call('after_circ_action', {
2251             action  => 'checkin',
2252             payload => {
2253                 checkout=> $checkin
2254             }
2255         });
2256     }
2257
2258     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2259 }
2260
2261 =head2 MarkIssueReturned
2262
2263   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2264
2265 Unconditionally marks an issue as being returned by
2266 moving the C<issues> row to C<old_issues> and
2267 setting C<returndate> to the current date.
2268
2269 if C<$returndate> is specified (in iso format), it is used as the date
2270 of the return.
2271
2272 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2273 the old_issue is immediately anonymised
2274
2275 Ideally, this function would be internal to C<C4::Circulation>,
2276 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2277 and offline_circ/process_koc.pl.
2278
2279 The last optional parameter allos passing skip_record_index to the item store call.
2280
2281 =cut
2282
2283 sub MarkIssueReturned {
2284     my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2285
2286     # Retrieve the issue
2287     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2288
2289     return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2290
2291     my $issue_id = $issue->issue_id;
2292
2293     my $anonymouspatron;
2294     if ( $privacy && $privacy == 2 ) {
2295         # The default of 0 will not work due to foreign key constraints
2296         # The anonymisation will fail if AnonymousPatron is not a valid entry
2297         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2298         # Note that a warning should appear on the about page (System information tab).
2299         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2300         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."
2301             unless Koha::Patrons->find( $anonymouspatron );
2302     }
2303
2304     my $schema = Koha::Database->schema;
2305
2306     # FIXME Improve the return value and handle it from callers
2307     $schema->txn_do(sub {
2308
2309         my $patron = Koha::Patrons->find( $borrowernumber );
2310
2311         # Update the returndate value
2312         if ( $returndate ) {
2313             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2314         }
2315         else {
2316             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2317         }
2318
2319         # Create the old_issues entry
2320         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2321
2322         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2323         if ( $privacy && $privacy == 2) {
2324             $old_checkout->borrowernumber($anonymouspatron)->store;
2325         }
2326
2327         # And finally delete the issue
2328         $issue->delete;
2329
2330         $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2331
2332         if ( C4::Context->preference('StoreLastBorrower') ) {
2333             my $item = Koha::Items->find( $itemnumber );
2334             $item->last_returned_by( $patron );
2335         }
2336
2337         # Remove any OVERDUES related debarment if the borrower has no overdues
2338         if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2339           && $patron->debarred
2340           && !$patron->has_overdues
2341           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2342         ) {
2343             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2344         }
2345
2346     });
2347
2348     return $issue_id;
2349 }
2350
2351 =head2 _debar_user_on_return
2352
2353     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2354
2355 C<$borrower> borrower hashref
2356
2357 C<$item> item hashref
2358
2359 C<$datedue> date due DateTime object
2360
2361 C<$returndate> DateTime object representing the return time
2362
2363 Internal function, called only by AddReturn that calculates and updates
2364  the user fine days, and debars them if necessary.
2365
2366 Should only be called for overdue returns
2367
2368 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2369 to ease testing.
2370
2371 =cut
2372
2373 sub _calculate_new_debar_dt {
2374     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2375
2376     my $branchcode = _GetCircControlBranch( $item, $borrower );
2377     my $circcontrol = C4::Context->preference('CircControl');
2378     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2379         {   categorycode => $borrower->{categorycode},
2380             itemtype     => $item->{itype},
2381             branchcode   => $branchcode,
2382             rules => [
2383                 'finedays',
2384                 'lengthunit',
2385                 'firstremind',
2386                 'maxsuspensiondays',
2387                 'suspension_chargeperiod',
2388             ]
2389         }
2390     );
2391     my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2392     my $unit     = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2393     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2394
2395     return unless $finedays;
2396
2397     # finedays is in days, so hourly loans must multiply by 24
2398     # thus 1 hour late equals 1 day suspension * finedays rate
2399     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2400
2401     # grace period is measured in the same units as the loan
2402     my $grace =
2403       DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2404
2405     my $deltadays = DateTime::Duration->new(
2406         days => $chargeable_units
2407     );
2408
2409     if ( $deltadays->subtract($grace)->is_positive() ) {
2410         my $suspension_days = $deltadays * $finedays;
2411
2412         if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2413             # No need to / 1 and do not consider / 0
2414             $suspension_days = DateTime::Duration->new(
2415                 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2416             );
2417         }
2418
2419         # If the max suspension days is < than the suspension days
2420         # the suspension days is limited to this maximum period.
2421         my $max_sd = $issuing_rule->{maxsuspensiondays};
2422         if ( defined $max_sd && $max_sd ne '' ) {
2423             $max_sd = DateTime::Duration->new( days => $max_sd );
2424             $suspension_days = $max_sd
2425               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2426         }
2427
2428         my ( $has_been_extended );
2429         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2430             my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2431             if ( $debarment ) {
2432                 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2433                 $has_been_extended = 1;
2434             }
2435         }
2436
2437         my $new_debar_dt;
2438         # Use the calendar or not to calculate the debarment date
2439         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2440             my $calendar = Koha::Calendar->new(
2441                 branchcode => $branchcode,
2442                 days_mode  => 'Calendar'
2443             );
2444             $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2445         }
2446         else {
2447             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2448         }
2449         return $new_debar_dt;
2450     }
2451     return;
2452 }
2453
2454 sub _debar_user_on_return {
2455     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2456
2457     $return_date //= dt_from_string();
2458
2459     my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2460
2461     return unless $new_debar_dt;
2462
2463     Koha::Patron::Debarments::AddUniqueDebarment({
2464         borrowernumber => $borrower->{borrowernumber},
2465         expiration     => $new_debar_dt->ymd(),
2466         type           => 'SUSPENSION',
2467     });
2468     # if borrower was already debarred but does not get an extra debarment
2469     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2470     my ($new_debarment_str, $is_a_reminder);
2471     if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2472         $is_a_reminder = 1;
2473         $new_debarment_str = $borrower->{debarred};
2474     } else {
2475         $new_debarment_str = $new_debar_dt->ymd();
2476     }
2477     # FIXME Should return a DateTime object
2478     return $new_debarment_str, $is_a_reminder;
2479 }
2480
2481 =head2 _FixOverduesOnReturn
2482
2483    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2484
2485 C<$borrowernumber> borrowernumber
2486
2487 C<$itemnumber> itemnumber
2488
2489 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2490
2491 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2492
2493 Internal function
2494
2495 =cut
2496
2497 sub _FixOverduesOnReturn {
2498     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2499     unless( $borrowernumber ) {
2500         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2501         return;
2502     }
2503     unless( $item ) {
2504         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2505         return;
2506     }
2507     unless( $status ) {
2508         warn "_FixOverduesOnReturn() not supplied valid status";
2509         return;
2510     }
2511
2512     my $schema = Koha::Database->schema;
2513
2514     my $result = $schema->txn_do(
2515         sub {
2516             # check for overdue fine
2517             my $accountlines = Koha::Account::Lines->search(
2518                 {
2519                     borrowernumber  => $borrowernumber,
2520                     itemnumber      => $item,
2521                     debit_type_code => 'OVERDUE',
2522                     status          => 'UNRETURNED'
2523                 }
2524             );
2525             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2526
2527             my $accountline = $accountlines->next;
2528             my $payments = $accountline->credits;
2529
2530             my $amountoutstanding = $accountline->amountoutstanding;
2531             if ( $accountline->amount == 0 && $payments->count == 0 ) {
2532                 $accountline->delete;
2533                 return 0; # no warning, we've just removed a zero value fine (backdated return)
2534             } elsif ($exemptfine && ($amountoutstanding != 0)) {
2535                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2536                 my $credit = $account->add_credit(
2537                     {
2538                         amount     => $amountoutstanding,
2539                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2540                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2541                         interface  => C4::Context->interface,
2542                         type       => 'FORGIVEN',
2543                         item_id    => $item
2544                     }
2545                 );
2546
2547                 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2548
2549                 if (C4::Context->preference("FinesLog")) {
2550                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2551                 }
2552             }
2553
2554             $accountline->status($status);
2555             return $accountline->store();
2556         }
2557     );
2558
2559     return $result;
2560 }
2561
2562 =head2 _GetCircControlBranch
2563
2564    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2565
2566 Internal function :
2567
2568 Return the library code to be used to determine which circulation
2569 policy applies to a transaction.  Looks up the CircControl and
2570 HomeOrHoldingBranch system preferences.
2571
2572 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2573
2574 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2575
2576 =cut
2577
2578 sub _GetCircControlBranch {
2579     my ($item, $borrower) = @_;
2580     my $circcontrol = C4::Context->preference('CircControl');
2581     my $branch;
2582
2583     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2584         $branch= C4::Context->userenv->{'branch'};
2585     } elsif ($circcontrol eq 'PatronLibrary') {
2586         $branch=$borrower->{branchcode};
2587     } else {
2588         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2589         $branch = $item->{$branchfield};
2590         # default to item home branch if holdingbranch is used
2591         # and is not defined
2592         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2593             $branch = $item->{homebranch};
2594         }
2595     }
2596     return $branch;
2597 }
2598
2599 =head2 GetOpenIssue
2600
2601   $issue = GetOpenIssue( $itemnumber );
2602
2603 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2604
2605 C<$itemnumber> is the item's itemnumber
2606
2607 Returns a hashref
2608
2609 =cut
2610
2611 sub GetOpenIssue {
2612   my ( $itemnumber ) = @_;
2613   return unless $itemnumber;
2614   my $dbh = C4::Context->dbh;
2615   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2616   $sth->execute( $itemnumber );
2617   return $sth->fetchrow_hashref();
2618
2619 }
2620
2621 =head2 GetBiblioIssues
2622
2623   $issues = GetBiblioIssues($biblionumber);
2624
2625 this function get all issues from a biblionumber.
2626
2627 Return:
2628 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2629 tables issues and the firstname,surname & cardnumber from borrowers.
2630
2631 =cut
2632
2633 sub GetBiblioIssues {
2634     my $biblionumber = shift;
2635     return unless $biblionumber;
2636     my $dbh   = C4::Context->dbh;
2637     my $query = "
2638         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2639         FROM issues
2640             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2641             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2642             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2643             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2644         WHERE biblio.biblionumber = ?
2645         UNION ALL
2646         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2647         FROM old_issues
2648             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2649             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2650             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2651             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2652         WHERE biblio.biblionumber = ?
2653         ORDER BY timestamp
2654     ";
2655     my $sth = $dbh->prepare($query);
2656     $sth->execute($biblionumber, $biblionumber);
2657
2658     my @issues;
2659     while ( my $data = $sth->fetchrow_hashref ) {
2660         push @issues, $data;
2661     }
2662     return \@issues;
2663 }
2664
2665 =head2 GetUpcomingDueIssues
2666
2667   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2668
2669 =cut
2670
2671 sub GetUpcomingDueIssues {
2672     my $params = shift;
2673
2674     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2675     my $dbh = C4::Context->dbh;
2676
2677     my $statement = <<END_SQL;
2678 SELECT *
2679 FROM (
2680     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2681     FROM issues
2682     LEFT JOIN items USING (itemnumber)
2683     LEFT OUTER JOIN branches USING (branchcode)
2684     WHERE returndate is NULL
2685 ) tmp
2686 WHERE days_until_due >= 0 AND days_until_due <= ?
2687 END_SQL
2688
2689     my @bind_parameters = ( $params->{'days_in_advance'} );
2690
2691     my $sth = $dbh->prepare( $statement );
2692     $sth->execute( @bind_parameters );
2693     my $upcoming_dues = $sth->fetchall_arrayref({});
2694
2695     return $upcoming_dues;
2696 }
2697
2698 =head2 CanBookBeRenewed
2699
2700   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2701
2702 Find out whether a borrowed item may be renewed.
2703
2704 C<$borrowernumber> is the borrower number of the patron who currently
2705 has the item on loan.
2706
2707 C<$itemnumber> is the number of the item to renew.
2708
2709 C<$override_limit>, if supplied with a true value, causes
2710 the limit on the number of times that the loan can be renewed
2711 (as controlled by the item type) to be ignored. Overriding also allows
2712 to renew sooner than "No renewal before" and to manually renew loans
2713 that are automatically renewed.
2714
2715 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2716 item must currently be on loan to the specified borrower; renewals
2717 must be allowed for the item's type; and the borrower must not have
2718 already renewed the loan. $error will contain the reason the renewal can not proceed
2719
2720 =cut
2721
2722 sub CanBookBeRenewed {
2723     my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2724
2725     my $dbh    = C4::Context->dbh;
2726     my $renews = 1;
2727     my $auto_renew = "no";
2728
2729     my $item      = Koha::Items->find($itemnumber)      or return ( 0, 'no_item' );
2730     my $issue = $item->checkout or return ( 0, 'no_checkout' );
2731     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2732     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2733
2734     my $patron = $issue->patron or return;
2735
2736     # override_limit will override anything else except on_reserve
2737     unless ( $override_limit ){
2738         my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2739         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2740             {
2741                 categorycode => $patron->categorycode,
2742                 itemtype     => $item->effective_itemtype,
2743                 branchcode   => $branchcode,
2744                 rules => [
2745                     'renewalsallowed',
2746                     'no_auto_renewal_after',
2747                     'no_auto_renewal_after_hard_limit',
2748                     'lengthunit',
2749                     'norenewalbefore',
2750                 ]
2751             }
2752         );
2753
2754         return ( 0, "too_many" )
2755           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2756
2757         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2758         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2759         $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2760         my $restricted  = $patron->is_debarred;
2761         my $hasoverdues = $patron->has_overdues;
2762
2763         if ( $restricted and $restrictionblockrenewing ) {
2764             return ( 0, 'restriction');
2765         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2766             return ( 0, 'overdue');
2767         }
2768
2769         if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2770
2771             if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2772                 return ( 0, 'auto_account_expired' );
2773             }
2774
2775             if ( defined $issuing_rule->{no_auto_renewal_after}
2776                     and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2777                 # Get issue_date and add no_auto_renewal_after
2778                 # If this is greater than today, it's too late for renewal.
2779                 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2780                 $maximum_renewal_date->add(
2781                     $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2782                 );
2783                 my $now = dt_from_string;
2784                 if ( $now >= $maximum_renewal_date ) {
2785                     return ( 0, "auto_too_late" );
2786                 }
2787             }
2788             if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2789                           and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2790                 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2791                 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2792                     return ( 0, "auto_too_late" );
2793                 }
2794             }
2795
2796             if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2797                 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2798                 my $amountoutstanding =
2799                   C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2800                   ? $patron->account->balance
2801                   : $patron->account->outstanding_debits->total_outstanding;
2802                 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2803                     return ( 0, "auto_too_much_oweing" );
2804                 }
2805             }
2806         }
2807
2808         if ( defined $issuing_rule->{norenewalbefore}
2809             and $issuing_rule->{norenewalbefore} ne "" )
2810         {
2811
2812             # Calculate soonest renewal by subtracting 'No renewal before' from due date
2813             my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2814                 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2815
2816             # Depending on syspref reset the exact time, only check the date
2817             if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2818                 and $issuing_rule->{lengthunit} eq 'days' )
2819             {
2820                 $soonestrenewal->truncate( to => 'day' );
2821             }
2822
2823             if ( $soonestrenewal > dt_from_string() )
2824             {
2825                 $auto_renew = ($issue->auto_renew && $patron->autorenew_checkouts) ? "auto_too_soon" : "too_soon";
2826             }
2827             elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2828                 $auto_renew = "ok";
2829             }
2830         }
2831
2832         # Fallback for automatic renewals:
2833         # If norenewalbefore is undef, don't renew before due date.
2834         if ( $issue->auto_renew && $auto_renew eq "no" && $patron->autorenew_checkouts ) {
2835             my $now = dt_from_string;
2836             if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2837                 $auto_renew = "ok";
2838             } else {
2839                 $auto_renew = "auto_too_soon";
2840             }
2841         }
2842     }
2843
2844     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2845
2846     # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2847     if ( $resfound && $resrec->{non_priority} ) {
2848         $resfound = Koha::Holds->search(
2849             { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2850           ->count > 0;
2851     }
2852
2853
2854
2855     # This item can fill one or more unfilled reserve, can those unfilled reserves
2856     # all be filled by other available items?
2857     if ( $resfound
2858         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2859     {
2860         my $schema = Koha::Database->new()->schema();
2861
2862         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2863         if ($item_holds) {
2864             # There is an item level hold on this item, no other item can fill the hold
2865             $resfound = 1;
2866         }
2867         else {
2868
2869             # Get all other items that could possibly fill reserves
2870             my @itemnumbers = $schema->resultset('Item')->search(
2871                 {
2872                     biblionumber => $resrec->{biblionumber},
2873                     onloan       => undef,
2874                     notforloan   => 0,
2875                     -not         => { itemnumber => $itemnumber }
2876                 },
2877                 { columns => 'itemnumber' }
2878             )->get_column('itemnumber')->all();
2879
2880             # Get all other reserves that could have been filled by this item
2881             my @borrowernumbers;
2882             while (1) {
2883                 my ( $reserve_found, $reserve, undef ) =
2884                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2885
2886                 if ($reserve_found) {
2887                     push( @borrowernumbers, $reserve->{borrowernumber} );
2888                 }
2889                 else {
2890                     last;
2891                 }
2892             }
2893
2894             # If the count of the union of the lists of reservable items for each borrower
2895             # is equal or greater than the number of borrowers, we know that all reserves
2896             # can be filled with available items. We can get the union of the sets simply
2897             # by pushing all the elements onto an array and removing the duplicates.
2898             my @reservable;
2899             my %patrons;
2900             ITEM: foreach my $itemnumber (@itemnumbers) {
2901                 my $item = Koha::Items->find( $itemnumber );
2902                 next if IsItemOnHoldAndFound( $itemnumber );
2903                 for my $borrowernumber (@borrowernumbers) {
2904                     my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2905                     next unless IsAvailableForItemLevelRequest($item, $patron);
2906                     next unless CanItemBeReserved($borrowernumber,$itemnumber);
2907
2908                     push @reservable, $itemnumber;
2909                     if (@reservable >= @borrowernumbers) {
2910                         $resfound = 0;
2911                         last ITEM;
2912                     }
2913                     last;
2914                 }
2915             }
2916         }
2917     }
2918     if( $cron ) { #The cron wants to return 'too_soon' over 'on_reserve'
2919         return ( 0, $auto_renew  ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2920         return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2921     } else { # For other purposes we want 'on_reserve' before 'too_soon'
2922         return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2923         return ( 0, $auto_renew  ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2924     }
2925
2926     return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2927
2928     return ( 1, undef );
2929 }
2930
2931 =head2 AddRenewal
2932
2933   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2934
2935 Renews a loan.
2936
2937 C<$borrowernumber> is the borrower number of the patron who currently
2938 has the item.
2939
2940 C<$itemnumber> is the number of the item to renew.
2941
2942 C<$branch> is the library where the renewal took place (if any).
2943            The library that controls the circ policies for the renewal is retrieved from the issues record.
2944
2945 C<$datedue> can be a DateTime object used to set the due date.
2946
2947 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2948 this parameter is not supplied, lastreneweddate is set to the current date.
2949
2950 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2951 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2952 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2953 syspref)
2954
2955 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2956 from the book's item type.
2957
2958 =cut
2959
2960 sub AddRenewal {
2961     my $borrowernumber  = shift;
2962     my $itemnumber      = shift or return;
2963     my $branch          = shift;
2964     my $datedue         = shift;
2965     my $lastreneweddate = shift || dt_from_string();
2966     my $skipfinecalc    = shift;
2967
2968     my $item_object   = Koha::Items->find($itemnumber) or return;
2969     my $biblio = $item_object->biblio;
2970     my $issue  = $item_object->checkout;
2971     my $item_unblessed = $item_object->unblessed;
2972
2973     my $dbh = C4::Context->dbh;
2974
2975     return unless $issue;
2976
2977     $borrowernumber ||= $issue->borrowernumber;
2978
2979     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2980         carp 'Invalid date passed to AddRenewal.';
2981         return;
2982     }
2983
2984     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2985     my $patron_unblessed = $patron->unblessed;
2986
2987     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2988
2989     my $schema = Koha::Database->schema;
2990     $schema->txn_do(sub{
2991
2992         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
2993             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2994         }
2995         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2996
2997         # If the due date wasn't specified, calculate it by adding the
2998         # book's loan length to today's date or the current due date
2999         # based on the value of the RenewalPeriodBase syspref.
3000         my $itemtype = $item_object->effective_itemtype;
3001         unless ($datedue) {
3002
3003             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3004                                             dt_from_string( $issue->date_due, 'sql' ) :
3005                                             dt_from_string();
3006             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3007         }
3008
3009         my $fees = Koha::Charges::Fees->new(
3010             {
3011                 patron    => $patron,
3012                 library   => $circ_library,
3013                 item      => $item_object,
3014                 from_date => dt_from_string( $issue->date_due, 'sql' ),
3015                 to_date   => dt_from_string($datedue),
3016             }
3017         );
3018
3019         # Update the issues record to have the new due date, and a new count
3020         # of how many times it has been renewed.
3021         my $renews = ( $issue->renewals || 0 ) + 1;
3022         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3023                                 WHERE borrowernumber=?
3024                                 AND itemnumber=?"
3025         );
3026
3027         $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3028
3029         # Update the renewal count on the item, and tell zebra to reindex
3030         $renews = ( $item_object->renewals || 0 ) + 1;
3031         $item_object->renewals($renews);
3032         $item_object->onloan($datedue);
3033         $item_object->store({ log_action => 0 });
3034
3035         # Charge a new rental fee, if applicable
3036         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3037         if ( $charge > 0 ) {
3038             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3039         }
3040
3041         # Charge a new accumulate rental fee, if applicable
3042         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3043         if ( $itemtype_object ) {
3044             my $accumulate_charge = $fees->accumulate_rentalcharge();
3045             if ( $accumulate_charge > 0 ) {
3046                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3047             }
3048             $charge += $accumulate_charge;
3049         }
3050
3051         # Send a renewal slip according to checkout alert preferencei
3052         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3053             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3054             my %conditions        = (
3055                 branchcode   => $branch,
3056                 categorycode => $patron->categorycode,
3057                 item_type    => $itemtype,
3058                 notification => 'CHECKOUT',
3059             );
3060             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3061                 SendCirculationAlert(
3062                     {
3063                         type     => 'RENEWAL',
3064                         item     => $item_unblessed,
3065                         borrower => $patron->unblessed,
3066                         branch   => $branch,
3067                     }
3068                 );
3069             }
3070         }
3071
3072         # Remove any OVERDUES related debarment if the borrower has no overdues
3073         if ( $patron
3074           && $patron->is_debarred
3075           && ! $patron->has_overdues
3076           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3077         ) {
3078             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3079         }
3080
3081         # Add the renewal to stats
3082         UpdateStats(
3083             {
3084                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3085                 type           => 'renew',
3086                 amount         => $charge,
3087                 itemnumber     => $itemnumber,
3088                 itemtype       => $itemtype,
3089                 location       => $item_object->location,
3090                 borrowernumber => $borrowernumber,
3091                 ccode          => $item_object->ccode,
3092             }
3093         );
3094
3095         #Log the renewal
3096         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3097
3098         Koha::Plugins->call('after_circ_action', {
3099             action  => 'renewal',
3100             payload => {
3101                 checkout  => $issue->get_from_storage
3102             }
3103         });
3104     });
3105
3106     return $datedue;
3107 }
3108
3109 sub GetRenewCount {
3110     # check renewal status
3111     my ( $bornum, $itemno ) = @_;
3112     my $dbh           = C4::Context->dbh;
3113     my $renewcount    = 0;
3114     my $renewsallowed = 0;
3115     my $renewsleft    = 0;
3116
3117     my $patron = Koha::Patrons->find( $bornum );
3118     my $item   = Koha::Items->find($itemno);
3119
3120     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3121
3122     # Look in the issues table for this item, lent to this borrower,
3123     # and not yet returned.
3124
3125     # FIXME - I think this function could be redone to use only one SQL call.
3126     my $sth = $dbh->prepare(
3127         "select * from issues
3128                                 where (borrowernumber = ?)
3129                                 and (itemnumber = ?)"
3130     );
3131     $sth->execute( $bornum, $itemno );
3132     my $data = $sth->fetchrow_hashref;
3133     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3134     # $item and $borrower should be calculated
3135     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3136
3137     my $rule = Koha::CirculationRules->get_effective_rule(
3138         {
3139             categorycode => $patron->categorycode,
3140             itemtype     => $item->effective_itemtype,
3141             branchcode   => $branchcode,
3142             rule_name    => 'renewalsallowed',
3143         }
3144     );
3145
3146     $renewsallowed = $rule ? $rule->rule_value : 0;
3147     $renewsleft    = $renewsallowed - $renewcount;
3148     if($renewsleft < 0){ $renewsleft = 0; }
3149     return ( $renewcount, $renewsallowed, $renewsleft );
3150 }
3151
3152 =head2 GetSoonestRenewDate
3153
3154   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3155
3156 Find out the soonest possible renew date of a borrowed item.
3157
3158 C<$borrowernumber> is the borrower number of the patron who currently
3159 has the item on loan.
3160
3161 C<$itemnumber> is the number of the item to renew.
3162
3163 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3164 renew date, based on the value "No renewal before" of the applicable
3165 issuing rule. Returns the current date if the item can already be
3166 renewed, and returns undefined if the borrower, loan, or item
3167 cannot be found.
3168
3169 =cut
3170
3171 sub GetSoonestRenewDate {
3172     my ( $borrowernumber, $itemnumber ) = @_;
3173
3174     my $dbh = C4::Context->dbh;
3175
3176     my $item      = Koha::Items->find($itemnumber)      or return;
3177     my $itemissue = $item->checkout or return;
3178
3179     $borrowernumber ||= $itemissue->borrowernumber;
3180     my $patron = Koha::Patrons->find( $borrowernumber )
3181       or return;
3182
3183     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3184     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3185         {   categorycode => $patron->categorycode,
3186             itemtype     => $item->effective_itemtype,
3187             branchcode   => $branchcode,
3188             rules => [
3189                 'norenewalbefore',
3190                 'lengthunit',
3191             ]
3192         }
3193     );
3194
3195     my $now = dt_from_string;
3196     return $now unless $issuing_rule;
3197
3198     if ( defined $issuing_rule->{norenewalbefore}
3199         and $issuing_rule->{norenewalbefore} ne "" )
3200     {
3201         my $soonestrenewal =
3202           dt_from_string( $itemissue->date_due )->subtract(
3203             $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3204
3205         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3206             and $issuing_rule->{lengthunit} eq 'days' )
3207         {
3208             $soonestrenewal->truncate( to => 'day' );
3209         }
3210         return $soonestrenewal if $now < $soonestrenewal;
3211     }
3212     return $now;
3213 }
3214
3215 =head2 GetLatestAutoRenewDate
3216
3217   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3218
3219 Find out the latest possible auto renew date of a borrowed item.
3220
3221 C<$borrowernumber> is the borrower number of the patron who currently
3222 has the item on loan.
3223
3224 C<$itemnumber> is the number of the item to renew.
3225
3226 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3227 auto renew date, based on the value "No auto renewal after" and the "No auto
3228 renewal after (hard limit) of the applicable issuing rule.
3229 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3230 or item cannot be found.
3231
3232 =cut
3233
3234 sub GetLatestAutoRenewDate {
3235     my ( $borrowernumber, $itemnumber ) = @_;
3236
3237     my $dbh = C4::Context->dbh;
3238
3239     my $item      = Koha::Items->find($itemnumber)  or return;
3240     my $itemissue = $item->checkout                 or return;
3241
3242     $borrowernumber ||= $itemissue->borrowernumber;
3243     my $patron = Koha::Patrons->find( $borrowernumber )
3244       or return;
3245
3246     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3247     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3248         {
3249             categorycode => $patron->categorycode,
3250             itemtype     => $item->effective_itemtype,
3251             branchcode   => $branchcode,
3252             rules => [
3253                 'no_auto_renewal_after',
3254                 'no_auto_renewal_after_hard_limit',
3255                 'lengthunit',
3256             ]
3257         }
3258     );
3259
3260     return unless $circulation_rules;
3261     return
3262       if ( not $circulation_rules->{no_auto_renewal_after}
3263             or $circulation_rules->{no_auto_renewal_after} eq '' )
3264       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3265              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3266
3267     my $maximum_renewal_date;
3268     if ( $circulation_rules->{no_auto_renewal_after} ) {
3269         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3270         $maximum_renewal_date->add(
3271             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3272         );
3273     }
3274
3275     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3276         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3277         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3278     }
3279     return $maximum_renewal_date;
3280 }
3281
3282
3283 =head2 GetIssuingCharges
3284
3285   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3286
3287 Calculate how much it would cost for a given patron to borrow a given
3288 item, including any applicable discounts.
3289
3290 C<$itemnumber> is the item number of item the patron wishes to borrow.
3291
3292 C<$borrowernumber> is the patron's borrower number.
3293
3294 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3295 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3296 if it's a video).
3297
3298 =cut
3299
3300 sub GetIssuingCharges {
3301
3302     # calculate charges due
3303     my ( $itemnumber, $borrowernumber ) = @_;
3304     my $charge = 0;
3305     my $dbh    = C4::Context->dbh;
3306     my $item_type;
3307
3308     # Get the book's item type and rental charge (via its biblioitem).
3309     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3310         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3311     $charge_query .= (C4::Context->preference('item-level_itypes'))
3312         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3313         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3314
3315     $charge_query .= ' WHERE items.itemnumber =?';
3316
3317     my $sth = $dbh->prepare($charge_query);
3318     $sth->execute($itemnumber);
3319     if ( my $item_data = $sth->fetchrow_hashref ) {
3320         $item_type = $item_data->{itemtype};
3321         $charge    = $item_data->{rentalcharge};
3322         my $branch = C4::Context::mybranch();
3323         my $patron = Koha::Patrons->find( $borrowernumber );
3324         my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3325         if ($discount) {
3326             # We may have multiple rules so get the most specific
3327             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3328         }
3329         if ($charge) {
3330             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3331         }
3332     }
3333
3334     return ( $charge, $item_type );
3335 }
3336
3337 # Select most appropriate discount rule from those returned
3338 sub _get_discount_from_rule {
3339     my ($categorycode, $branchcode, $itemtype) = @_;
3340
3341     # Set search precedences
3342     my @params = (
3343         {
3344             branchcode   => $branchcode,
3345             itemtype     => $itemtype,
3346             categorycode => $categorycode,
3347         },
3348         {
3349             branchcode   => undef,
3350             categorycode => $categorycode,
3351             itemtype     => $itemtype,
3352         },
3353         {
3354             branchcode   => $branchcode,
3355             categorycode => $categorycode,
3356             itemtype     => undef,
3357         },
3358         {
3359             branchcode   => undef,
3360             categorycode => $categorycode,
3361             itemtype     => undef,
3362         },
3363     );
3364
3365     foreach my $params (@params) {
3366         my $rule = Koha::CirculationRules->search(
3367             {
3368                 rule_name => 'rentaldiscount',
3369                 %$params,
3370             }
3371         )->next();
3372
3373         return $rule->rule_value if $rule;
3374     }
3375
3376     # none of the above
3377     return 0;
3378 }
3379
3380 =head2 AddIssuingCharge
3381
3382   &AddIssuingCharge( $checkout, $charge, $type )
3383
3384 =cut
3385
3386 sub AddIssuingCharge {
3387     my ( $checkout, $charge, $type ) = @_;
3388
3389     # FIXME What if checkout does not exist?
3390
3391     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3392     my $accountline = $account->add_debit(
3393         {
3394             amount      => $charge,
3395             note        => undef,
3396             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3397             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3398             interface   => C4::Context->interface,
3399             type        => $type,
3400             item_id     => $checkout->itemnumber,
3401             issue_id    => $checkout->issue_id,
3402         }
3403     );
3404 }
3405
3406 =head2 GetTransfers
3407
3408   GetTransfers($itemnumber);
3409
3410 =cut
3411
3412 sub GetTransfers {
3413     my ($itemnumber) = @_;
3414
3415     my $dbh = C4::Context->dbh;
3416
3417     my $query = '
3418         SELECT datesent,
3419                frombranch,
3420                tobranch,
3421                branchtransfer_id
3422         FROM branchtransfers
3423         WHERE itemnumber = ?
3424           AND datearrived IS NULL
3425         ';
3426     my $sth = $dbh->prepare($query);
3427     $sth->execute($itemnumber);
3428     my @row = $sth->fetchrow_array();
3429     return @row;
3430 }
3431
3432 =head2 GetTransfersFromTo
3433
3434   @results = GetTransfersFromTo($frombranch,$tobranch);
3435
3436 Returns the list of pending transfers between $from and $to branch
3437
3438 =cut
3439
3440 sub GetTransfersFromTo {
3441     my ( $frombranch, $tobranch ) = @_;
3442     return unless ( $frombranch && $tobranch );
3443     my $dbh   = C4::Context->dbh;
3444     my $query = "
3445         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3446         FROM   branchtransfers
3447         WHERE  frombranch=?
3448           AND  tobranch=?
3449           AND datearrived IS NULL
3450     ";
3451     my $sth = $dbh->prepare($query);
3452     $sth->execute( $frombranch, $tobranch );
3453     my @gettransfers;
3454
3455     while ( my $data = $sth->fetchrow_hashref ) {
3456         push @gettransfers, $data;
3457     }
3458     return (@gettransfers);
3459 }
3460
3461 =head2 DeleteTransfer
3462
3463   &DeleteTransfer($itemnumber);
3464
3465 =cut
3466
3467 sub DeleteTransfer {
3468     my ($itemnumber) = @_;
3469     return unless $itemnumber;
3470     my $dbh          = C4::Context->dbh;
3471     my $sth          = $dbh->prepare(
3472         "DELETE FROM branchtransfers
3473          WHERE itemnumber=?
3474          AND datearrived IS NULL "
3475     );
3476     return $sth->execute($itemnumber);
3477 }
3478
3479 =head2 SendCirculationAlert
3480
3481 Send out a C<check-in> or C<checkout> alert using the messaging system.
3482
3483 B<Parameters>:
3484
3485 =over 4
3486
3487 =item type
3488
3489 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3490
3491 =item item
3492
3493 Hashref of information about the item being checked in or out.
3494
3495 =item borrower
3496
3497 Hashref of information about the borrower of the item.
3498
3499 =item branch
3500
3501 The branchcode from where the checkout or check-in took place.
3502
3503 =back
3504
3505 B<Example>:
3506
3507     SendCirculationAlert({
3508         type     => 'CHECKOUT',
3509         item     => $item,
3510         borrower => $borrower,
3511         branch   => $branch,
3512     });
3513
3514 =cut
3515
3516 sub SendCirculationAlert {
3517     my ($opts) = @_;
3518     my ($type, $item, $borrower, $branch) =
3519         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3520     my %message_name = (
3521         CHECKIN  => 'Item_Check_in',
3522         CHECKOUT => 'Item_Checkout',
3523         RENEWAL  => 'Item_Checkout',
3524     );
3525     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3526         borrowernumber => $borrower->{borrowernumber},
3527         message_name   => $message_name{$type},
3528     });
3529     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3530
3531     my $schema = Koha::Database->new->schema;
3532     my @transports = keys %{ $borrower_preferences->{transports} };
3533
3534     # From the MySQL doc:
3535     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3536     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3537     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3538     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3539
3540     for my $mtt (@transports) {
3541         my $letter =  C4::Letters::GetPreparedLetter (
3542             module => 'circulation',
3543             letter_code => $type,
3544             branchcode => $branch,
3545             message_transport_type => $mtt,
3546             lang => $borrower->{lang},
3547             tables => {
3548                 $issues_table => $item->{itemnumber},
3549                 'items'       => $item->{itemnumber},
3550                 'biblio'      => $item->{biblionumber},
3551                 'biblioitems' => $item->{biblionumber},
3552                 'borrowers'   => $borrower,
3553                 'branches'    => $branch,
3554             }
3555         ) or next;
3556
3557         $schema->storage->txn_begin;
3558         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3559         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3560         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3561         unless ( $message ) {
3562             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3563             C4::Message->enqueue($letter, $borrower, $mtt);
3564         } else {
3565             $message->append($letter);
3566             $message->update;
3567         }
3568         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3569         $schema->storage->txn_commit;
3570     }
3571
3572     return;
3573 }
3574
3575 =head2 updateWrongTransfer
3576
3577   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3578
3579 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
3580
3581 =cut
3582
3583 sub updateWrongTransfer {
3584         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3585         my $dbh = C4::Context->dbh;
3586 # first step validate the actual line of transfert .
3587         my $sth =
3588                 $dbh->prepare(
3589                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3590                 );
3591                 $sth->execute($FromLibrary,$itemNumber);
3592
3593 # second step create a new line of branchtransfer to the right location .
3594         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3595
3596 #third step changing holdingbranch of item
3597     my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3598 }
3599
3600 =head2 CalcDateDue
3601
3602 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3603
3604 this function calculates the due date given the start date and configured circulation rules,
3605 checking against the holidays calendar as per the daysmode circulation rule.
3606 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3607 C<$itemtype>  = itemtype code of item in question
3608 C<$branch>  = location whose calendar to use
3609 C<$borrower> = Borrower object
3610 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3611
3612 =cut
3613
3614 sub CalcDateDue {
3615     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3616
3617     $isrenewal ||= 0;
3618
3619     # loanlength now a href
3620     my $loanlength =
3621             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3622
3623     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3624             ? qq{renewalperiod}
3625             : qq{issuelength};
3626
3627     my $datedue;
3628     if ( $startdate ) {
3629         if (ref $startdate ne 'DateTime' ) {
3630             $datedue = dt_from_string($datedue);
3631         } else {
3632             $datedue = $startdate->clone;
3633         }
3634     } else {
3635         $datedue = dt_from_string()->truncate( to => 'minute' );
3636     }
3637
3638
3639     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3640         {
3641             categorycode => $borrower->{categorycode},
3642             itemtype     => $itemtype,
3643             branchcode   => $branch,
3644         }
3645     );
3646
3647     # calculate the datedue as normal
3648     if ( $daysmode eq 'Days' )
3649     {    # ignoring calendar
3650         if ( $loanlength->{lengthunit} eq 'hours' ) {
3651             $datedue->add( hours => $loanlength->{$length_key} );
3652         } else {    # days
3653             $datedue->add( days => $loanlength->{$length_key} );
3654             $datedue->set_hour(23);
3655             $datedue->set_minute(59);
3656         }
3657     } else {
3658         my $dur;
3659         if ($loanlength->{lengthunit} eq 'hours') {
3660             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3661         }
3662         else { # days
3663             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3664         }
3665         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3666         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3667         if ($loanlength->{lengthunit} eq 'days') {
3668             $datedue->set_hour(23);
3669             $datedue->set_minute(59);
3670         }
3671     }
3672
3673     # if Hard Due Dates are used, retrieve them and apply as necessary
3674     my ( $hardduedate, $hardduedatecompare ) =
3675       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3676     if ($hardduedate) {    # hardduedates are currently dates
3677         $hardduedate->truncate( to => 'minute' );
3678         $hardduedate->set_hour(23);
3679         $hardduedate->set_minute(59);
3680         my $cmp = DateTime->compare( $hardduedate, $datedue );
3681
3682 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3683 # if the calculated date is before the 'after' Hard Due Date (floor), override
3684 # if the hard due date is set to 'exactly', overrride
3685         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3686             $datedue = $hardduedate->clone;
3687         }
3688
3689         # in all other cases, keep the date due as it is
3690
3691     }
3692
3693     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3694     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3695         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3696         if( $expiry_dt ) { #skip empty expiry date..
3697             $expiry_dt->set( hour => 23, minute => 59);
3698             my $d1= $datedue->clone->set_time_zone('floating');
3699             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3700                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3701             }
3702         }
3703         if ( $daysmode ne 'Days' ) {
3704           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3705           if ( $calendar->is_holiday($datedue) ) {
3706               # Don't return on a closed day
3707               $datedue = $calendar->prev_open_days( $datedue, 1 );
3708           }
3709         }
3710     }
3711
3712     return $datedue;
3713 }
3714
3715
3716 sub CheckValidBarcode{
3717 my ($barcode) = @_;
3718 my $dbh = C4::Context->dbh;
3719 my $query=qq|SELECT count(*)
3720              FROM items
3721              WHERE barcode=?
3722             |;
3723 my $sth = $dbh->prepare($query);
3724 $sth->execute($barcode);
3725 my $exist=$sth->fetchrow ;
3726 return $exist;
3727 }
3728
3729 =head2 IsBranchTransferAllowed
3730
3731   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3732
3733 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3734
3735 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3736 Koha::Item->can_be_transferred.
3737
3738 =cut
3739
3740 sub IsBranchTransferAllowed {
3741         my ( $toBranch, $fromBranch, $code ) = @_;
3742
3743         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3744
3745         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3746         my $dbh = C4::Context->dbh;
3747
3748         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3749         $sth->execute( $toBranch, $fromBranch, $code );
3750         my $limit = $sth->fetchrow_hashref();
3751
3752         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3753         if ( $limit->{'limitId'} ) {
3754                 return 0;
3755         } else {
3756                 return 1;
3757         }
3758 }
3759
3760 =head2 CreateBranchTransferLimit
3761
3762   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3763
3764 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3765
3766 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3767
3768 =cut
3769
3770 sub CreateBranchTransferLimit {
3771    my ( $toBranch, $fromBranch, $code ) = @_;
3772    return unless defined($toBranch) && defined($fromBranch);
3773    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3774
3775    my $dbh = C4::Context->dbh;
3776
3777    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3778    return $sth->execute( $code, $toBranch, $fromBranch );
3779 }
3780
3781 =head2 DeleteBranchTransferLimits
3782
3783     my $result = DeleteBranchTransferLimits($frombranch);
3784
3785 Deletes all the library transfer limits for one library.  Returns the
3786 number of limits deleted, 0e0 if no limits were deleted, or undef if
3787 no arguments are supplied.
3788
3789 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3790     fromBranch => $fromBranch
3791     })->delete.
3792
3793 =cut
3794
3795 sub DeleteBranchTransferLimits {
3796     my $branch = shift;
3797     return unless defined $branch;
3798     my $dbh    = C4::Context->dbh;
3799     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3800     return $sth->execute($branch);
3801 }
3802
3803 sub ReturnLostItem{
3804     my ( $borrowernumber, $itemnum ) = @_;
3805     MarkIssueReturned( $borrowernumber, $itemnum );
3806 }
3807
3808 =head2 LostItem
3809
3810   LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3811
3812 The final optional parameter, C<$params>, expected to contain
3813 'skip_record_index' key, which relayed down to Koha::Item/store,
3814 there it prevents calling of ModZebra index_records,
3815 which takes most of the time in batch adds/deletes: index_records better
3816 to be called later in C<additem.pl> after the whole loop.
3817
3818 $params:
3819     skip_record_index => 1|0
3820
3821 =cut
3822
3823 sub LostItem{
3824     my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3825
3826     unless ( $mark_lost_from ) {
3827         # Temporary check to avoid regressions
3828         die q|LostItem called without $mark_lost_from, check the API.|;
3829     }
3830
3831     my $mark_returned;
3832     if ( $force_mark_returned ) {
3833         $mark_returned = 1;
3834     } else {
3835         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3836         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3837     }
3838
3839     my $dbh = C4::Context->dbh();
3840     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3841                            FROM issues
3842                            JOIN items USING (itemnumber)
3843                            JOIN biblio USING (biblionumber)
3844                            WHERE issues.itemnumber=?");
3845     $sth->execute($itemnumber);
3846     my $issues=$sth->fetchrow_hashref();
3847
3848     # If a borrower lost the item, add a replacement cost to the their record
3849     if ( my $borrowernumber = $issues->{borrowernumber} ){
3850         my $patron = Koha::Patrons->find( $borrowernumber );
3851
3852         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3853         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3854
3855         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3856             C4::Accounts::chargelostitem(
3857                 $borrowernumber,
3858                 $itemnumber,
3859                 $issues->{'replacementprice'},
3860                 sprintf( "%s %s %s",
3861                     $issues->{'title'}          || q{},
3862                     $issues->{'barcode'}        || q{},
3863                     $issues->{'itemcallnumber'} || q{},
3864                 ),
3865             );
3866             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3867             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3868         }
3869
3870         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3871     }
3872
3873     #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3874     if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3875         Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store({ skip_record_index => $params->{skip_record_index} });
3876     }
3877     my $transferdeleted = DeleteTransfer($itemnumber);
3878 }
3879
3880 sub GetOfflineOperations {
3881     my $dbh = C4::Context->dbh;
3882     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3883     $sth->execute(C4::Context->userenv->{'branch'});
3884     my $results = $sth->fetchall_arrayref({});
3885     return $results;
3886 }
3887
3888 sub GetOfflineOperation {
3889     my $operationid = shift;
3890     return unless $operationid;
3891     my $dbh = C4::Context->dbh;
3892     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3893     $sth->execute( $operationid );
3894     return $sth->fetchrow_hashref;
3895 }
3896
3897 sub AddOfflineOperation {
3898     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3899     my $dbh = C4::Context->dbh;
3900     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3901     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3902     return "Added.";
3903 }
3904
3905 sub DeleteOfflineOperation {
3906     my $dbh = C4::Context->dbh;
3907     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3908     $sth->execute( shift );
3909     return "Deleted.";
3910 }
3911
3912 sub ProcessOfflineOperation {
3913     my $operation = shift;
3914
3915     my $report;
3916     if ( $operation->{action} eq 'return' ) {
3917         $report = ProcessOfflineReturn( $operation );
3918     } elsif ( $operation->{action} eq 'issue' ) {
3919         $report = ProcessOfflineIssue( $operation );
3920     } elsif ( $operation->{action} eq 'payment' ) {
3921         $report = ProcessOfflinePayment( $operation );
3922     }
3923
3924     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3925
3926     return $report;
3927 }
3928
3929 sub ProcessOfflineReturn {
3930     my $operation = shift;
3931
3932     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3933
3934     if ( $item ) {
3935         my $itemnumber = $item->itemnumber;
3936         my $issue = GetOpenIssue( $itemnumber );
3937         if ( $issue ) {
3938             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3939             ModDateLastSeen( $itemnumber, $leave_item_lost );
3940             MarkIssueReturned(
3941                 $issue->{borrowernumber},
3942                 $itemnumber,
3943                 $operation->{timestamp},
3944             );
3945             $item->renewals(0);
3946             $item->onloan(undef);
3947             $item->store({ log_action => 0 });
3948             return "Success.";
3949         } else {
3950             return "Item not issued.";
3951         }
3952     } else {
3953         return "Item not found.";
3954     }
3955 }
3956
3957 sub ProcessOfflineIssue {
3958     my $operation = shift;
3959
3960     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3961
3962     if ( $patron ) {
3963         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3964         unless ($item) {
3965             return "Barcode not found.";
3966         }
3967         my $itemnumber = $item->itemnumber;
3968         my $issue = GetOpenIssue( $itemnumber );
3969
3970         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3971             MarkIssueReturned(
3972                 $issue->{borrowernumber},
3973                 $itemnumber,
3974                 $operation->{timestamp},
3975             );
3976         }
3977         AddIssue(
3978             $patron->unblessed,
3979             $operation->{'barcode'},
3980             undef,
3981             1,
3982             $operation->{timestamp},
3983             undef,
3984         );
3985         return "Success.";
3986     } else {
3987         return "Borrower not found.";
3988     }
3989 }
3990
3991 sub ProcessOfflinePayment {
3992     my $operation = shift;
3993
3994     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3995
3996     $patron->account->pay(
3997         {
3998             amount     => $operation->{amount},
3999             library_id => $operation->{branchcode},
4000             interface  => 'koc'
4001         }
4002     );
4003
4004     return "Success.";
4005 }
4006
4007 =head2 TransferSlip
4008
4009   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4010
4011   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4012
4013 =cut
4014
4015 sub TransferSlip {
4016     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4017
4018     my $item =
4019       $itemnumber
4020       ? Koha::Items->find($itemnumber)
4021       : Koha::Items->find( { barcode => $barcode } );
4022
4023     $item or return;
4024
4025     return C4::Letters::GetPreparedLetter (
4026         module => 'circulation',
4027         letter_code => 'TRANSFERSLIP',
4028         branchcode => $branch,
4029         tables => {
4030             'branches'    => $to_branch,
4031             'biblio'      => $item->biblionumber,
4032             'items'       => $item->unblessed,
4033         },
4034     );
4035 }
4036
4037 =head2 CheckIfIssuedToPatron
4038
4039   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4040
4041   Return 1 if any record item is issued to patron, otherwise return 0
4042
4043 =cut
4044
4045 sub CheckIfIssuedToPatron {
4046     my ($borrowernumber, $biblionumber) = @_;
4047
4048     my $dbh = C4::Context->dbh;
4049     my $query = q|
4050         SELECT COUNT(*) FROM issues
4051         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4052         WHERE items.biblionumber = ?
4053         AND issues.borrowernumber = ?
4054     |;
4055     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4056     return 1 if $is_issued;
4057     return;
4058 }
4059
4060 =head2 IsItemIssued
4061
4062   IsItemIssued( $itemnumber )
4063
4064   Return 1 if the item is on loan, otherwise return 0
4065
4066 =cut
4067
4068 sub IsItemIssued {
4069     my $itemnumber = shift;
4070     my $dbh = C4::Context->dbh;
4071     my $sth = $dbh->prepare(q{
4072         SELECT COUNT(*)
4073         FROM issues
4074         WHERE itemnumber = ?
4075     });
4076     $sth->execute($itemnumber);
4077     return $sth->fetchrow;
4078 }
4079
4080 =head2 GetAgeRestriction
4081
4082   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4083   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4084
4085   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4086   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4087
4088 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4089 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4090 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4091          Negative days mean the borrower has gone past the age restriction age.
4092
4093 =cut
4094
4095 sub GetAgeRestriction {
4096     my ($record_restrictions, $borrower) = @_;
4097     my $markers = C4::Context->preference('AgeRestrictionMarker');
4098
4099     return unless $record_restrictions;
4100     # Split $record_restrictions to something like FSK 16 or PEGI 6
4101     my @values = split ' ', uc($record_restrictions);
4102     return unless @values;
4103
4104     # Search first occurrence of one of the markers
4105     my @markers = split /\|/, uc($markers);
4106     return unless @markers;
4107
4108     my $index            = 0;
4109     my $restriction_year = 0;
4110     for my $value (@values) {
4111         $index++;
4112         for my $marker (@markers) {
4113             $marker =~ s/^\s+//;    #remove leading spaces
4114             $marker =~ s/\s+$//;    #remove trailing spaces
4115             if ( $marker eq $value ) {
4116                 if ( $index <= $#values ) {
4117                     $restriction_year += $values[$index];
4118                 }
4119                 last;
4120             }
4121             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4122
4123                 # Perhaps it is something like "K16" (as in Finland)
4124                 $restriction_year += $1;
4125                 last;
4126             }
4127         }
4128         last if ( $restriction_year > 0 );
4129     }
4130
4131     #Check if the borrower is age restricted for this material and for how long.
4132     if ($restriction_year && $borrower) {
4133         if ( $borrower->{'dateofbirth'} ) {
4134             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4135             $alloweddate[0] += $restriction_year;
4136
4137             #Prevent runime eror on leap year (invalid date)
4138             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4139                 $alloweddate[2] = 28;
4140             }
4141
4142             #Get how many days the borrower has to reach the age restriction
4143             my @Today = split /-/, dt_from_string()->ymd();
4144             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4145             #Negative days means the borrower went past the age restriction age
4146             return ($restriction_year, $daysToAgeRestriction);
4147         }
4148     }
4149
4150     return ($restriction_year);
4151 }
4152
4153
4154 =head2 GetPendingOnSiteCheckouts
4155
4156 =cut
4157
4158 sub GetPendingOnSiteCheckouts {
4159     my $dbh = C4::Context->dbh;
4160     return $dbh->selectall_arrayref(q|
4161         SELECT
4162           items.barcode,
4163           items.biblionumber,
4164           items.itemnumber,
4165           items.itemnotes,
4166           items.itemcallnumber,
4167           items.location,
4168           issues.date_due,
4169           issues.branchcode,
4170           issues.date_due < NOW() AS is_overdue,
4171           biblio.author,
4172           biblio.title,
4173           borrowers.firstname,
4174           borrowers.surname,
4175           borrowers.cardnumber,
4176           borrowers.borrowernumber
4177         FROM items
4178         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4179         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4180         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4181         WHERE issues.onsite_checkout = 1
4182     |, { Slice => {} } );
4183 }
4184
4185 sub GetTopIssues {
4186     my ($params) = @_;
4187
4188     my ($count, $branch, $itemtype, $ccode, $newness)
4189         = @$params{qw(count branch itemtype ccode newness)};
4190
4191     my $dbh = C4::Context->dbh;
4192     my $query = q{
4193         SELECT * FROM (
4194         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4195           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4196           i.ccode, SUM(i.issues) AS count
4197         FROM biblio b
4198         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4199         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4200     };
4201
4202     my (@where_strs, @where_args);
4203
4204     if ($branch) {
4205         push @where_strs, 'i.homebranch = ?';
4206         push @where_args, $branch;
4207     }
4208     if ($itemtype) {
4209         if (C4::Context->preference('item-level_itypes')){
4210             push @where_strs, 'i.itype = ?';
4211             push @where_args, $itemtype;
4212         } else {
4213             push @where_strs, 'bi.itemtype = ?';
4214             push @where_args, $itemtype;
4215         }
4216     }
4217     if ($ccode) {
4218         push @where_strs, 'i.ccode = ?';
4219         push @where_args, $ccode;
4220     }
4221     if ($newness) {
4222         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4223         push @where_args, $newness;
4224     }
4225
4226     if (@where_strs) {
4227         $query .= 'WHERE ' . join(' AND ', @where_strs);
4228     }
4229
4230     $query .= q{
4231         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4232           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4233           i.ccode
4234         ORDER BY count DESC
4235     };
4236
4237     $query .= q{ ) xxx WHERE count > 0 };
4238     $count = int($count);
4239     if ($count > 0) {
4240         $query .= "LIMIT $count";
4241     }
4242
4243     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4244
4245     return @$rows;
4246 }
4247
4248 =head2 Internal methods
4249
4250 =cut
4251
4252 sub _CalculateAndUpdateFine {
4253     my ($params) = @_;
4254
4255     my $borrower    = $params->{borrower};
4256     my $item        = $params->{item};
4257     my $issue       = $params->{issue};
4258     my $return_date = $params->{return_date};
4259
4260     unless ($borrower) { carp "No borrower passed in!" && return; }
4261     unless ($item)     { carp "No item passed in!"     && return; }
4262     unless ($issue)    { carp "No issue passed in!"    && return; }
4263
4264     my $datedue = dt_from_string( $issue->date_due );
4265
4266     # we only need to calculate and change the fines if we want to do that on return
4267     # Should be on for hourly loans
4268     my $control = C4::Context->preference('CircControl');
4269     my $control_branchcode =
4270         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4271       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4272       :                                     $issue->branchcode;
4273
4274     my $date_returned = $return_date ? $return_date : dt_from_string();
4275
4276     my ( $amount, $unitcounttotal, $unitcount  ) =
4277       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4278
4279     if ( C4::Context->preference('finesMode') eq 'production' ) {
4280         if ( $amount > 0 ) {
4281             C4::Overdues::UpdateFine({
4282                 issue_id       => $issue->issue_id,
4283                 itemnumber     => $issue->itemnumber,
4284                 borrowernumber => $issue->borrowernumber,
4285                 amount         => $amount,
4286                 due            => output_pref($datedue),
4287             });
4288         }
4289         elsif ($return_date) {
4290
4291             # Backdated returns may have fines that shouldn't exist,
4292             # so in this case, we need to drop those fines to 0
4293
4294             C4::Overdues::UpdateFine({
4295                 issue_id       => $issue->issue_id,
4296                 itemnumber     => $issue->itemnumber,
4297                 borrowernumber => $issue->borrowernumber,
4298                 amount         => 0,
4299                 due            => output_pref($datedue),
4300             });
4301         }
4302     }
4303 }
4304
4305 sub _item_denied_renewal {
4306     my ($params) = @_;
4307
4308     my $item = $params->{item};
4309     return unless $item;
4310
4311     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4312     return unless $denyingrules;
4313     foreach my $field (keys %$denyingrules) {
4314         my $val = $item->$field;
4315         if( !defined $val) {
4316             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4317                 return 1;
4318             }
4319         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4320            # If the results matches the values in the syspref
4321            # We return true if match found
4322             return 1;
4323         }
4324     }
4325     return 0;
4326 }
4327
4328 1;
4329
4330 __END__
4331
4332 =head1 AUTHOR
4333
4334 Koha Development Team <http://koha-community.org/>
4335
4336 =cut