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