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