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