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