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