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