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
2132     # check if returnbranch and homebranch belong to the same float group
2133     my $validate_float =
2134         Koha::Libraries->find( $item->homebranch )->validate_float_sibling( { branchcode => $branch } );
2135
2136     # get the proper branch to which to return the item
2137     my $returnbranch;
2138     if ( $hbr eq 'noreturn' ) {
2139         $returnbranch = $branch;
2140     } elsif ( $hbr eq 'returnbylibrarygroup' ) {
2141
2142         # if library isn't in same the float group, transfer item to homebranch
2143         $hbr          = 'homebranch';
2144         $returnbranch = $validate_float ? $branch : $item->$hbr;
2145     } else {
2146         $returnbranch = $item->$hbr;
2147     }
2148
2149     # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2150     my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2151
2152     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
2153     my $patron_unblessed = $patron ? $patron->unblessed : {};
2154
2155     my $update_loc_rules = C4::Context->yaml_preference('UpdateItemLocationOnCheckin');
2156     if ($update_loc_rules) {
2157         if ( defined $update_loc_rules->{_ALL_} ) {
2158             if ( $update_loc_rules->{_ALL_} eq '_PERM_' ) {
2159                 $update_loc_rules->{_ALL_} = $item->permanent_location;
2160             }
2161             if ( $update_loc_rules->{_ALL_} eq '_BLANK_' ) {
2162                 $update_loc_rules->{_ALL_} = '';
2163             }
2164             if (
2165                 (
2166                     defined $item->location
2167                     && $item->location ne $update_loc_rules->{_ALL_}
2168                 )
2169                 || ( !defined $item->location
2170                     && $update_loc_rules->{_ALL_} ne "" )
2171               )
2172             {
2173                 $messages->{'ItemLocationUpdated'} =
2174                   { from => $item->location, to => $update_loc_rules->{_ALL_} };
2175                 $item->location( $update_loc_rules->{_ALL_} )->store(
2176                     {
2177                         log_action        => 0,
2178                         skip_record_index => 1,
2179                         skip_holds_queue  => 1
2180                     }
2181                 );
2182             }
2183         }
2184         else {
2185             foreach my $key ( keys %$update_loc_rules ) {
2186                 if ( $update_loc_rules->{$key} eq '_PERM_' ) {
2187                     $update_loc_rules->{$key} = $item->permanent_location;
2188                 }
2189                 elsif ( $update_loc_rules->{$key} eq '_BLANK_' ) {
2190                     $update_loc_rules->{$key} = '';
2191                 }
2192                 if (
2193                     (
2194                            defined $item->location
2195                         && $item->location eq $key
2196                         && $item->location ne $update_loc_rules->{$key}
2197                     )
2198                     || (   $key eq '_BLANK_'
2199                         && ( !defined $item->location || $item->location eq '' )
2200                         && $update_loc_rules->{$key} ne '' )
2201                   )
2202                 {
2203                     $messages->{'ItemLocationUpdated'} = {
2204                         from => $item->location,
2205                         to   => $update_loc_rules->{$key}
2206                     };
2207                     $item->location( $update_loc_rules->{$key} )->store(
2208                         {
2209                             log_action        => 0,
2210                             skip_record_index => 1,
2211                             skip_holds_queue  => 1
2212                         }
2213                     );
2214                     last;
2215                 }
2216             }
2217         }
2218     }
2219
2220     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2221     if ($yaml) {
2222         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
2223         my $rules;
2224         eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2225         if ($@) {
2226             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2227         }
2228         else {
2229             foreach my $key ( keys %$rules ) {
2230                 if ( $item->notforloan eq $key ) {
2231                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2232                     $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 }) unless $rules->{$key} eq 'ONLYMESSAGE';
2233                     last;
2234                 }
2235             }
2236         }
2237     }
2238
2239     # check if the return is allowed at this branch
2240     my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2241     unless ($returnallowed){
2242         $messages->{'Wrongbranch'} = {
2243             Wrongbranch => $branch,
2244             Rightbranch => $message
2245         };
2246         $doreturn = 0;
2247         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2248         $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2249         return ( $doreturn, $messages, $issue, $patron_unblessed);
2250     }
2251
2252     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2253         $doreturn = 0;
2254     }
2255
2256     # case of a return of document (deal with issues and holdingbranch)
2257     if ($doreturn) {
2258         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2259         $patron or warn "AddReturn without current borrower";
2260
2261         if ($patron) {
2262             eval {
2263                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2264             };
2265             unless ( $@ ) {
2266                 if (
2267                     (
2268                         C4::Context->preference('CalculateFinesOnReturn')
2269                         || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2270                     )
2271                     && !$item->itemlost
2272                   )
2273                 {
2274                     _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2275                 }
2276             } else {
2277                 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 );
2278
2279                 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2280                 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2281
2282                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2283             }
2284
2285             # FIXME is the "= 1" right?  This could be the borrower hash.
2286             $messages->{'WasReturned'} = 1;
2287
2288         } else {
2289             $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2290         }
2291     }
2292
2293     # the holdingbranch is updated if the document is returned to another location.
2294     # this is always done regardless of whether the item was on loan or not
2295     if ($item->holdingbranch ne $branch) {
2296         $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2297     }
2298
2299     my $item_was_lost = $item->itemlost;
2300     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2301     my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2302
2303     # fix up the accounts.....
2304     if ($item_was_lost) {
2305         $messages->{'WasLost'} = 1;
2306         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2307             my @object_messages = @{ $updated_item->object_messages };
2308             for my $message (@object_messages) {
2309                 $messages->{'LostItemFeeRefunded'} = 1
2310                   if $message->message eq 'lost_refunded';
2311                 $messages->{'ProcessingFeeRefunded'} = 1
2312                   if $message->message eq 'processing_refunded';
2313                 $messages->{'LostItemFeeRestored'} = 1
2314                   if $message->message eq 'lost_restored';
2315
2316                 if ( $message->message eq 'lost_charge' ) {
2317                     $issue //= Koha::Old::Checkouts->search(
2318                         { itemnumber => $item->itemnumber },
2319                         { order_by   => { '-desc' => 'returndate' }, rows => 1 }
2320                     )->single;
2321                     unless ( exists( $patron_unblessed->{branchcode} ) ) {
2322                         my $patron = $issue->patron;
2323                         $patron_unblessed = $patron->unblessed;
2324                     }
2325                     _CalculateAndUpdateFine(
2326                         {
2327                             issue       => $issue,
2328                             item        => $item->unblessed,
2329                             borrower    => $patron_unblessed,
2330                             return_date => $return_date
2331                         }
2332                     );
2333                     _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2334                         $item->itemnumber, undef, 'RETURNED' );
2335                     $messages->{'LostItemFeeCharged'} = 1;
2336                 }
2337             }
2338         }
2339     }
2340
2341     # check if we have a transfer for this document
2342     my $transfer = $item->get_transfer;
2343
2344     # if we have a transfer to complete, we update the line of transfers with the datearrived
2345     if ($transfer) {
2346         $validTransfer = 0;
2347         if ( $transfer->in_transit ) {
2348             if ( $transfer->tobranch eq $branch ) {
2349                 $transfer->receive;
2350                 $messages->{'TransferArrived'} = $transfer->frombranch;
2351                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2352                 $validTransfer = 1
2353                   if defined $transfer->reason && $transfer->reason eq 'Reserve';
2354             }
2355             else {
2356                 $messages->{'WrongTransfer'}     = $transfer->tobranch;
2357                 $messages->{'WrongTransferItem'} = $item->itemnumber;
2358                 $messages->{'TransferTrigger'}   = $transfer->reason;
2359             }
2360         }
2361         else {
2362             if ( $transfer->tobranch eq $branch ) {
2363                 $transfer->receive;
2364                 $messages->{'TransferArrived'} = $transfer->frombranch;
2365                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2366                 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2367             }
2368             else {
2369                 $messages->{'TransferTrigger'} = $transfer->reason;
2370                 if ( $transfer->frombranch eq $branch ) {
2371                     $transfer->transit;
2372                     $messages->{'WasTransfered'}   = $transfer->tobranch;
2373                 }
2374                 else {
2375                     $messages->{'WrongTransfer'}     = $transfer->tobranch;
2376                     $messages->{'WrongTransferItem'} = $item->itemnumber;
2377                 }
2378             }
2379         }
2380     }
2381
2382     # fix up the overdues in accounts...
2383     if ($borrowernumber) {
2384         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2385         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!";  # zero is OK, check defined
2386
2387         if ( $issue and $issue->is_overdue($return_date) ) {
2388         # fix fine days
2389             my ($debardate,$reminder) = _debar_user_on_return( $patron, $item, dt_from_string($issue->date_due), $return_date );
2390             if ($debardate and $debardate ne "9999-12-31") {
2391                 if ($reminder){
2392                     $messages->{'PrevDebarred'} = $debardate;
2393                 } else {
2394                     $messages->{'Debarred'} = $debardate;
2395                 }
2396             } elsif ($patron->debarred) {
2397                 if ( $patron->debarred eq "9999-12-31") {
2398                     $messages->{'ForeverDebarred'} = $patron->debarred;
2399                 } else {
2400                     my $borrower_debar_dt = dt_from_string( $patron->debarred );
2401                     $borrower_debar_dt->truncate(to => 'day');
2402                     my $today_dt = $return_date->clone()->truncate(to => 'day');
2403                     if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2404                         $messages->{'PrevDebarred'} = $patron->debarred;
2405                     }
2406                 }
2407             }
2408         # there's no overdue on the item but borrower had been previously debarred
2409         } elsif ( $issue->date_due and $patron->debarred ) {
2410              if ( $patron->debarred eq "9999-12-31") {
2411                 $messages->{'ForeverDebarred'} = $patron->debarred;
2412              } else {
2413                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2414                   $borrower_debar_dt->truncate(to => 'day');
2415                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2416                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2417                       $messages->{'PrevDebarred'} = $patron->debarred;
2418                   }
2419              }
2420         }
2421     }
2422
2423     # find recalls...
2424     if ( C4::Context->preference('UseRecalls') ) {
2425         # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2426         my $recall = undef;
2427         $recall = $item->check_recalls if $item->can_be_waiting_recall;
2428         if ( defined $recall ) {
2429             $messages->{RecallFound} = $recall;
2430             if ( $recall->pickup_library_id ne $branch ) {
2431                 $messages->{RecallNeedsTransfer} = $branch;
2432             }
2433         }
2434     }
2435
2436     # find reserves.....
2437     # launch the Checkreserves routine to find any holds
2438     my ($resfound, $resrec);
2439     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2440     ($resfound, $resrec, undef) = CheckReserves( $item, $lookahead ) unless ( $item->withdrawn );
2441     # 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)
2442     if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2443         my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2444         $resfound = 'Reserved';
2445         $resrec = $hold->unblessed;
2446     }
2447     if ($resfound) {
2448           $resrec->{'ResFound'} = $resfound;
2449         $messages->{'ResFound'} = $resrec;
2450     }
2451
2452     # Record the fact that this book was returned.
2453     my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2454     C4::Stats::UpdateStats({
2455         branch         => $branch,
2456         type           => $stat_type,
2457         itemnumber     => $itemnumber,
2458         itemtype       => $itemtype,
2459         location       => $item->location,
2460         borrowernumber => $borrowernumber,
2461         ccode          => $item->ccode,
2462         categorycode   => $categorycode,
2463         interface      => C4::Context->interface,
2464     });
2465
2466     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2467     if ( $patron ) {
2468         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2469         my %conditions = (
2470             branchcode   => $branch,
2471             categorycode => $patron->categorycode,
2472             item_type    => $itemtype,
2473             notification => 'CHECKIN',
2474         );
2475         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2476             SendCirculationAlert({
2477                 type     => 'CHECKIN',
2478                 item     => $item->unblessed,
2479                 borrower => $patron->unblessed,
2480                 branch   => $branch,
2481                 issue    => $issue
2482             });
2483         }
2484
2485         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2486             if C4::Context->preference("ReturnLog");
2487         }
2488
2489     # Check if this item belongs to a biblio record that is attached to an
2490     # ILL request, if it is we need to update the ILL request's status
2491     if ( $doreturn and C4::Context->preference('CirculateILL')) {
2492         my $request = Koha::Illrequests->find(
2493             { biblio_id => $item->biblio->biblionumber }
2494         );
2495         $request->status('RET') if $request;
2496     }
2497
2498     if ( C4::Context->preference('UseRecalls') ) {
2499         # all recalls that have triggered a transfer will have an allocated itemnumber
2500         my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2501         if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2502             $messages->{TransferredRecall} = $transfer_recall;
2503         }
2504     }
2505
2506     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2507     if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2508         && ( $doreturn or $messages->{'NotIssued'} )
2509         and !$resfound
2510         and ( $branch ne $returnbranch )
2511         and not $messages->{'WrongTransfer'}
2512         and not $messages->{'WasTransfered'}
2513         and not $messages->{TransferredRecall}
2514         and not $messages->{RecallNeedsTransfer} )
2515     {
2516         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2517         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2518             (C4::Context->preference("UseBranchTransferLimits") and
2519              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2520            )) {
2521             ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2522             $messages->{'WasTransfered'} = $returnbranch;
2523             $messages->{'TransferTrigger'} = $transfer_trigger;
2524         } else {
2525             $messages->{'NeedsTransfer'} = $returnbranch;
2526             $messages->{'TransferTrigger'} = $transfer_trigger;
2527         }
2528     }
2529
2530     if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2531         my $claims = Koha::Checkouts::ReturnClaims->search(
2532            {
2533                itemnumber => $item->id,
2534                resolution => undef,
2535            }
2536         );
2537
2538         if ( $claims->count ) {
2539             $messages->{ReturnClaims} = $claims;
2540         }
2541     }
2542
2543     # Check for bundle status
2544     if ( $item->in_bundle ) {
2545         my $host = $item->bundle_host;
2546         $messages->{InBundle} = $host;
2547     }
2548
2549     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2550     $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2551
2552     if ( $doreturn and $issue ) {
2553         my $checkin = Koha::Old::Checkouts->find($issue->id);
2554
2555         Koha::Plugins->call('after_circ_action', {
2556             action  => 'checkin',
2557             payload => {
2558                 checkout=> $checkin
2559             }
2560         });
2561
2562         Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2563             {
2564                 biblio_ids => [ $item->biblionumber ]
2565             }
2566         ) if C4::Context->preference('RealTimeHoldsQueue');
2567     }
2568
2569     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2570 }
2571
2572 =head2 MarkIssueReturned
2573
2574   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2575
2576 Unconditionally marks an issue as being returned by
2577 moving the C<issues> row to C<old_issues> and
2578 setting C<returndate> to the current date.
2579
2580 if C<$returndate> is specified (in iso format), it is used as the date
2581 of the return.
2582
2583 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2584 the old_issue is immediately anonymised
2585
2586 Ideally, this function would be internal to C<C4::Circulation>,
2587 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2588 and offline_circ/process_koc.pl.
2589
2590 The last optional parameter allos passing skip_record_index to the item store call.
2591
2592 =cut
2593
2594 sub MarkIssueReturned {
2595     my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2596
2597     # Retrieve the issue
2598     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2599     my $issue_branchcode = $issue->branchcode;
2600
2601     return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2602
2603     my $issue_id = $issue->issue_id;
2604
2605     my $schema = Koha::Database->schema;
2606
2607     # FIXME Improve the return value and handle it from callers
2608     $schema->txn_do(sub {
2609
2610         my $patron = Koha::Patrons->find( $borrowernumber );
2611
2612         # Update the returndate value
2613         if ( $returndate ) {
2614             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2615         }
2616         else {
2617             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2618         }
2619
2620         # Create the old_issues entry
2621         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2622
2623         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2624         if ( $privacy && $privacy == 2) {
2625             $old_checkout->anonymize;
2626         }
2627
2628         # And finally delete the issue
2629         $issue->delete;
2630
2631         $issue->item->onloan(undef)->store(
2632             {   log_action        => 0,
2633                 skip_record_index => $params->{skip_record_index},
2634                 skip_holds_queue  => $params->{skip_holds_queue}
2635             }
2636         );
2637
2638         if ( C4::Context->preference('StoreLastBorrower') ) {
2639             my $item = Koha::Items->find( $itemnumber );
2640             $item->last_returned_by( $patron->borrowernumber )->store;
2641         }
2642
2643         # Possibly remove any OVERDUES related debarment
2644         my $overdue_restrictions = $patron->restrictions->search( { type => 'OVERDUES' } );
2645         if ( C4::Context->preference('AutoRemoveOverduesRestrictions') ne 'no' && $patron->is_debarred ) {
2646             my $remove_restrictions =
2647                 C4::Context->preference('AutoRemoveOverduesRestrictions') eq 'when_no_overdue_causing_debarment'
2648                 ? !$patron->has_restricting_overdues( { issue_branchcode => $issue_branchcode } )
2649                 : !$patron->has_overdues;
2650             if ( $remove_restrictions && $overdue_restrictions->count ) {
2651                 DelUniqueDebarment( { borrowernumber => $borrowernumber, type => 'OVERDUES' } );
2652             }
2653         }
2654
2655     });
2656
2657     return $issue_id;
2658 }
2659
2660 =head2 _debar_user_on_return
2661
2662     _debar_user_on_return($patron, $item, $datedue, $returndate);
2663
2664 C<$patron> patron object
2665
2666 C<$item> item object
2667
2668 C<$datedue> date due DateTime object
2669
2670 C<$returndate> DateTime object representing the return time
2671
2672 Internal function, called only by AddReturn that calculates and updates
2673  the user fine days, and debars them if necessary.
2674
2675 Should only be called for overdue returns
2676
2677 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2678 to ease testing.
2679
2680 =cut
2681
2682 sub _calculate_new_debar_dt {
2683     my ( $patron, $item, $dt_due, $return_date ) = @_;
2684
2685     my $branchcode = _GetCircControlBranch( $item, $patron );
2686     my $circcontrol = C4::Context->preference('CircControl');
2687     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2688         {   categorycode => $patron->categorycode,
2689             itemtype     => $item->effective_itemtype,
2690             branchcode   => $branchcode,
2691             rules => [
2692                 'finedays',
2693                 'lengthunit',
2694                 'firstremind',
2695                 'maxsuspensiondays',
2696                 'suspension_chargeperiod',
2697             ]
2698         }
2699     );
2700     my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2701     my $unit     = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2702     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2703
2704     return unless $finedays;
2705
2706     # finedays is in days, so hourly loans must multiply by 24
2707     # thus 1 hour late equals 1 day suspension * finedays rate
2708     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2709
2710     # grace period is measured in the same units as the loan
2711     my $grace =
2712       DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2713
2714     my $deltadays = DateTime::Duration->new(
2715         days => $chargeable_units
2716     );
2717
2718     if ( $deltadays->subtract($grace)->is_positive() ) {
2719         my $suspension_days = $deltadays * $finedays;
2720
2721         if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2722             # No need to / 1 and do not consider / 0
2723             $suspension_days = DateTime::Duration->new(
2724                 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2725             );
2726         }
2727
2728         # If the max suspension days is < than the suspension days
2729         # the suspension days is limited to this maximum period.
2730         my $max_sd = $issuing_rule->{maxsuspensiondays};
2731         if ( defined $max_sd && $max_sd ne '' ) {
2732             $max_sd = DateTime::Duration->new( days => $max_sd );
2733             $suspension_days = $max_sd
2734               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2735         }
2736
2737         my ( $has_been_extended );
2738         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $patron->is_debarred ) {
2739             my $debarment = $patron->restrictions->search({type => 'SUSPENSION' },{rows => 1})->single;
2740             if ( $debarment ) {
2741                 $return_date = dt_from_string( $debarment->expiration, 'sql' );
2742                 $has_been_extended = 1;
2743             }
2744         }
2745
2746         my $new_debar_dt;
2747         # Use the calendar or not to calculate the debarment date
2748         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2749             my $calendar = Koha::Calendar->new(
2750                 branchcode => $branchcode,
2751                 days_mode  => 'Calendar'
2752             );
2753             $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2754         }
2755         else {
2756             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2757         }
2758         return $new_debar_dt;
2759     }
2760     return;
2761 }
2762
2763 sub _debar_user_on_return {
2764     my ( $patron, $item, $dt_due, $return_date ) = @_;
2765
2766     $return_date //= dt_from_string();
2767
2768     my $new_debar_dt = _calculate_new_debar_dt($patron, $item, $dt_due, $return_date);
2769
2770     return unless $new_debar_dt;
2771
2772     Koha::Patron::Debarments::AddUniqueDebarment({
2773         borrowernumber => $patron->borrowernumber,
2774         expiration     => $new_debar_dt->ymd(),
2775         type           => 'SUSPENSION',
2776     });
2777     # if borrower was already debarred but does not get an extra debarment
2778     my ($new_debarment_str, $is_a_reminder);
2779     if ( $patron->is_debarred ) {
2780         $is_a_reminder = 1;
2781         $new_debarment_str = $patron->debarred;
2782     } else {
2783         $new_debarment_str = $new_debar_dt->ymd();
2784     }
2785     # FIXME Should return a DateTime object
2786     return $new_debarment_str, $is_a_reminder;
2787 }
2788
2789 =head2 _FixOverduesOnReturn
2790
2791    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2792
2793 C<$borrowernumber> borrowernumber
2794
2795 C<$itemnumber> itemnumber
2796
2797 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2798
2799 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2800
2801 Internal function
2802
2803 =cut
2804
2805 sub _FixOverduesOnReturn {
2806     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2807     unless( $borrowernumber ) {
2808         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2809         return;
2810     }
2811     unless( $item ) {
2812         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2813         return;
2814     }
2815     unless( $status ) {
2816         warn "_FixOverduesOnReturn() not supplied valid status";
2817         return;
2818     }
2819
2820     my $schema = Koha::Database->schema;
2821
2822     my $result = $schema->txn_do(
2823         sub {
2824             # check for overdue fine
2825             my $accountlines = Koha::Account::Lines->search(
2826                 {
2827                     borrowernumber  => $borrowernumber,
2828                     itemnumber      => $item,
2829                     debit_type_code => 'OVERDUE',
2830                     status          => 'UNRETURNED'
2831                 }
2832             );
2833             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2834
2835             my $accountline = $accountlines->next;
2836             my $payments = $accountline->credits;
2837
2838             my $amountoutstanding = $accountline->amountoutstanding;
2839             if ( $accountline->amount == 0 && $payments->count == 0 ) {
2840                 $accountline->delete;
2841                 return 0; # no warning, we've just removed a zero value fine (backdated return)
2842             } elsif ($exemptfine && ($amountoutstanding != 0)) {
2843                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2844                 my $credit = $account->add_credit(
2845                     {
2846                         amount     => $amountoutstanding,
2847                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2848                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2849                         interface  => C4::Context->interface,
2850                         type       => 'FORGIVEN',
2851                         item_id    => $item
2852                     }
2853                 );
2854
2855                 $credit->apply({ debits => [ $accountline ] });
2856
2857                 if (C4::Context->preference("FinesLog")) {
2858                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2859                 }
2860             }
2861
2862             $accountline->status($status);
2863             return $accountline->store();
2864         }
2865     );
2866
2867     return $result;
2868 }
2869
2870 =head2 _GetCircControlBranch
2871
2872    my $circ_control_branch = _GetCircControlBranch($item, $patron);
2873
2874 Internal function :
2875
2876 Return the library code to be used to determine which circulation
2877 policy applies to a transaction.  Looks up the CircControl and
2878 HomeOrHoldingBranch system preferences.
2879
2880 C<$item> is an item object.
2881
2882 C<$patron> is a patron object.
2883
2884 =cut
2885
2886 sub _GetCircControlBranch {
2887     my ($item, $patron) = @_;
2888     my $circcontrol = C4::Context->preference('CircControl');
2889     my $branch;
2890
2891     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2892         $branch = C4::Context->userenv->{'branch'};
2893     } elsif ($circcontrol eq 'PatronLibrary') {
2894         $branch = $patron->branchcode;
2895     } else {
2896         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2897         $branch = $item->get_column($branchfield);
2898         # default to item home branch if holdingbranch is used
2899         # and is not defined
2900         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2901             $branch = $item->homebranch;
2902         }
2903     }
2904     return $branch;
2905 }
2906
2907 =head2 GetUpcomingDueIssues
2908
2909   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2910
2911 =cut
2912
2913 sub GetUpcomingDueIssues {
2914     my $params = shift;
2915
2916     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2917     my $dbh = C4::Context->dbh;
2918     my $statement;
2919     $statement = q{
2920         SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2921         FROM issues
2922         LEFT JOIN items USING (itemnumber)
2923         LEFT JOIN branches ON branches.branchcode =
2924     };
2925     $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2926     $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2927     my @bind_parameters = ( $params->{'days_in_advance'} );
2928
2929     my $sth = $dbh->prepare( $statement );
2930     $sth->execute( @bind_parameters );
2931     my $upcoming_dues = $sth->fetchall_arrayref({});
2932
2933     return $upcoming_dues;
2934 }
2935
2936 =head2 CanBookBeRenewed
2937
2938   ($ok,$error,$info) = &CanBookBeRenewed($patron, $issue, $override_limit);
2939
2940 Find out whether a borrowed item may be renewed.
2941
2942 C<$patron> is the patron who currently has the issue.
2943
2944 C<$issue> is the checkout to renew.
2945
2946 C<$override_limit>, if supplied with a true value, causes
2947 the limit on the number of times that the loan can be renewed
2948 (as controlled by the item type) to be ignored. Overriding also allows
2949 to renew sooner than "No renewal before" and to manually renew loans
2950 that are automatically renewed.
2951
2952 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2953 item must currently be on loan to the specified borrower; renewals
2954 must be allowed for the item's type; and the borrower must not have
2955 already renewed the loan.
2956     $error will contain the reason the renewal can not proceed
2957     $info will contain a hash of additional info
2958       currently 'soonest_renew_date' if error is 'too soon'
2959
2960 =cut
2961
2962 sub CanBookBeRenewed {
2963     my ( $patron, $issue, $override_limit, $cron ) = @_;
2964
2965     my $auto_renew = "no";
2966     my $soonest;
2967     my $item = $issue->item;
2968
2969     return ( 0, 'no_item' ) unless $item;
2970     return ( 0, 'no_checkout' ) unless $issue;
2971     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2972     return ( 0, 'item_issued_to_other_patron') if $issue->borrowernumber != $patron->borrowernumber;
2973     return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2974
2975        # override_limit will override anything else except on_reserve
2976     unless ( $override_limit ){
2977         my $branchcode = _GetCircControlBranch( $item, $patron );
2978         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2979             {
2980                 categorycode => $patron->categorycode,
2981                 itemtype     => $item->effective_itemtype,
2982                 branchcode   => $branchcode,
2983                 rules => [
2984                     'renewalsallowed',
2985                     'lengthunit',
2986                     'unseen_renewals_allowed'
2987                 ]
2988             }
2989         );
2990
2991         return ( 0, "too_many" )
2992           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2993
2994         return ( 0, "too_unseen" )
2995           if C4::Context->preference('UnseenRenewals') &&
2996             looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
2997             $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2998
2999         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
3000         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
3001         my $restricted  = $patron->is_debarred;
3002         my $hasoverdues = $patron->has_overdues;
3003
3004         if ( $restricted and $restrictionblockrenewing ) {
3005             return ( 0, 'restriction');
3006         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
3007             return ( 0, 'overdue');
3008         }
3009
3010         ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
3011             patron     => $patron,
3012             item       => $item,
3013             branchcode => $branchcode,
3014             issue      => $issue
3015         });
3016         return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
3017         # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
3018         # extra notices being sent. Cron also implies no override
3019         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_account_expired';
3020         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_late';
3021         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_much_oweing';
3022     }
3023
3024     if ( C4::Context->preference('UseRecalls') ) {
3025         my $recall = undef;
3026         $recall = $item->check_recalls if $item->can_be_waiting_recall;
3027         if ( defined $recall ) {
3028             if ( $recall->item_level ) {
3029                 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
3030                 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
3031             } else {
3032                 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
3033                 return ( 0, 'recalled' ) unless ( $recall->waiting );
3034             }
3035         }
3036     }
3037
3038     # There is an item level hold on this item, no other item can fill the hold
3039     return ( 0, "on_reserve" )
3040       if ( $item->current_holds->search( { non_priority => 0 } )->count );
3041
3042     my $fillable_holds = Koha::Holds->search(
3043         {
3044             biblionumber => $item->biblionumber,
3045             non_priority => 0,
3046             found        => undef,
3047             reservedate  => { '<=' => \'NOW()' },
3048             suspend      => 0
3049         }
3050     );
3051     if ( $fillable_holds->count ) {
3052         if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
3053             my @possible_holds = $fillable_holds->as_list;
3054
3055             # Get all other items that could possibly fill reserves
3056             # FIXME We could join reserves (or more tables) here to eliminate some checks later
3057             my @other_items = Koha::Items->search({
3058                 biblionumber => $item->biblionumber,
3059                 onloan       => undef,
3060                 notforloan   => 0,
3061                 -not         => { itemnumber => $item->itemnumber } })->as_list;
3062
3063             return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
3064
3065             my %matched_items;
3066             foreach my $possible_hold (@possible_holds) {
3067                 my $fillable = 0;
3068                 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
3069
3070                 # FIXME: We are not checking whether the item we are renewing can fill the hold
3071
3072                 foreach my $other_item (@other_items) {
3073                   next if defined $matched_items{$other_item->itemnumber};
3074                   next if IsItemOnHoldAndFound( $other_item->itemnumber );
3075                   next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef);
3076                   next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3077                   # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3078                   # CanItemBeReserved checks 'rules' and 'policies' which means
3079                   # items will fill holds at checkin that are rejected here
3080                   $fillable = 1;
3081                   $matched_items{$other_item->itemnumber} = 1;
3082                   last;
3083                 }
3084                 return ( 0, "on_reserve" ) unless $fillable;
3085             }
3086         }
3087         else {
3088             my ($status, $matched_reserve, $possible_reserves) = CheckReserves($item);
3089             return ( 0, "on_reserve" ) if $status;
3090         }
3091     }
3092
3093     return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3094     $soonest = GetSoonestRenewDate($patron, $issue);
3095     if ( $soonest > dt_from_string() ){
3096         return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3097     }
3098
3099     return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3100
3101     return ( 1, undef );
3102 }
3103
3104 =head2 AddRenewal
3105
3106   $new_date_due = AddRenewal({
3107       borrowernumber   => $borrowernumber,
3108       itemnumber       => $itemnumber,
3109       branch           => $branch,
3110       [datedue         => $datedue],
3111       [lastreneweddate => $lastreneweddate],
3112       [skipfinecalc    => $skipfinecalc],
3113       [seen            => $seen],
3114       [automatic       => $automatic],
3115       [skip_record_index => $skip_record_index]
3116   });
3117
3118 Renews a loan, returns the updated due date upon success.
3119
3120 C<$borrowernumber> is the borrower number of the patron who currently
3121 has the item.
3122
3123 C<$itemnumber> is the number of the item to renew.
3124
3125 C<$branch> is the library where the renewal took place (if any).
3126            The library that controls the circ policies for the renewal is retrieved from the issues record.
3127
3128 C<$datedue> can be a DateTime object used to set the due date.
3129
3130 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
3131 this parameter is not supplied, lastreneweddate is set to the current date.
3132
3133 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3134 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3135 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3136 syspref)
3137
3138 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3139 from the book's item type.
3140
3141 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3142 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3143 fallback to a true value
3144
3145 C<$automatic> is a boolean flag indicating the renewal was triggered automatically and not by a person ( librarian or patron )
3146
3147 C<$skip_record_index> is an optional boolean flag to indicate whether queuing the search indexing
3148 should be skipped for this renewal.
3149
3150 =cut
3151
3152 sub AddRenewal {
3153     my $params = shift;
3154
3155     my $borrowernumber  = $params->{borrowernumber};
3156     my $itemnumber      = $params->{itemnumber};
3157     return unless $itemnumber;
3158
3159     my $branch            = $params->{branch};
3160     my $datedue           = $params->{datedue};
3161     my $lastreneweddate   = $params->{lastreneweddate} // dt_from_string();
3162     my $skipfinecalc      = $params->{skipfinecalc};
3163     my $seen              = $params->{seen};
3164     my $automatic         = $params->{automatic};
3165     my $skip_record_index = $params->{skip_record_index};
3166
3167     # Fallback on a 'seen' renewal
3168     $seen = defined $seen && $seen == 0 ? 0 : 1;
3169
3170     my $item_object   = Koha::Items->find($itemnumber) or return;
3171     my $biblio = $item_object->biblio;
3172     my $issue  = $item_object->checkout;
3173     my $item_unblessed = $item_object->unblessed;
3174
3175     my $renewal_type = $automatic ? "Automatic" : "Manual";
3176
3177     my $dbh = C4::Context->dbh;
3178
3179     return unless $issue;
3180
3181     $borrowernumber ||= $issue->borrowernumber;
3182
3183     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3184         $datedue = dt_from_string($datedue, 'sql');
3185     }
3186
3187     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3188     my $patron_unblessed = $patron->unblessed;
3189
3190     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
3191
3192     my $schema = Koha::Database->schema;
3193     $schema->txn_do(sub{
3194
3195         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3196             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3197         }
3198         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3199
3200         # If the due date wasn't specified, calculate it by adding the
3201         # book's loan length to today's date or the current due date
3202         # based on the value of the RenewalPeriodBase syspref.
3203         my $itemtype = $item_object->effective_itemtype;
3204         unless ($datedue) {
3205
3206             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3207                                             dt_from_string( $issue->date_due, 'sql' ) :
3208                                             dt_from_string();
3209             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron, 'is a renewal');
3210         }
3211
3212         my $fees = Koha::Charges::Fees->new(
3213             {
3214                 patron    => $patron,
3215                 library   => $circ_library,
3216                 item      => $item_object,
3217                 from_date => dt_from_string( $issue->date_due, 'sql' ),
3218                 to_date   => dt_from_string($datedue),
3219             }
3220         );
3221
3222         # Increment the unseen renewals, if appropriate
3223         # We only do so if the syspref is enabled and
3224         # a maximum value has been set in the circ rules
3225         my $unseen_renewals = $issue->unseen_renewals;
3226         if (C4::Context->preference('UnseenRenewals')) {
3227             my $rule = Koha::CirculationRules->get_effective_rule(
3228                 {   categorycode => $patron->categorycode,
3229                     itemtype     => $item_object->effective_itemtype,
3230                     branchcode   => $circ_library->branchcode,
3231                     rule_name    => 'unseen_renewals_allowed'
3232                 }
3233             );
3234             if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3235                 $unseen_renewals++;
3236             } else {
3237                 # If the renewal is seen, unseen should revert to 0
3238                 $unseen_renewals = 0;
3239             }
3240         }
3241
3242         # Update the issues record to have the new due date, and a new count
3243         # of how many times it has been renewed.
3244         my $renews = ( $issue->renewals_count || 0 ) + 1;
3245         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3246
3247         eval{
3248             $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3249         };
3250         if( $sth->err ){
3251             Koha::Exceptions::Checkout::FailedRenewal->throw(
3252                 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3253             );
3254         }
3255
3256         # Update the renewal count on the item, and tell zebra to reindex
3257         $renews = ( $item_object->renewals || 0 ) + 1;
3258         $item_object->renewals($renews);
3259         $item_object->onloan($datedue);
3260         # Don't index as we are in a transaction, skip hardcoded here
3261         $item_object->store({ log_action => 0, skip_record_index => 1 });
3262
3263         # Charge a new rental fee, if applicable
3264         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3265         if ( $charge > 0 ) {
3266             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3267         }
3268
3269         # Charge a new accumulate rental fee, if applicable
3270         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3271         if ( $itemtype_object ) {
3272             my $accumulate_charge = $fees->accumulate_rentalcharge();
3273             if ( $accumulate_charge > 0 ) {
3274                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3275             }
3276             $charge += $accumulate_charge;
3277         }
3278
3279         # Send a renewal slip according to checkout alert preferencei
3280         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3281             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3282             my %conditions        = (
3283                 branchcode   => $branch,
3284                 categorycode => $patron->categorycode,
3285                 item_type    => $itemtype,
3286                 notification => 'CHECKOUT',
3287             );
3288             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3289                 SendCirculationAlert(
3290                     {
3291                         type     => 'RENEWAL',
3292                         item     => $item_unblessed,
3293                         borrower => $patron->unblessed,
3294                         branch   => $branch,
3295                     }
3296                 );
3297             }
3298         }
3299
3300         # Remove any OVERDUES related debarment if the borrower has no overdues
3301         my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
3302         if ( $patron
3303           && $patron->is_debarred
3304           && ! $patron->has_overdues
3305           && $overdue_restrictions->count
3306         ) {
3307             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3308         }
3309
3310         # Add renewal record
3311         my $renewal = Koha::Checkouts::Renewal->new(
3312             {
3313                 checkout_id  => $issue->issue_id,
3314                 interface    => C4::Context->interface,
3315                 renewal_type => $renewal_type,
3316                 renewer_id   => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3317                 seen         => $seen,
3318             }
3319         )->store();
3320
3321         # Add the renewal to stats
3322         C4::Stats::UpdateStats(
3323             {
3324                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3325                 type           => 'renew',
3326                 amount         => $charge,
3327                 itemnumber     => $itemnumber,
3328                 itemtype       => $itemtype,
3329                 location       => $item_object->location,
3330                 borrowernumber => $borrowernumber,
3331                 ccode          => $item_object->ccode,
3332                 categorycode   => $patron->categorycode,
3333                 interface      => C4::Context->interface,
3334             }
3335         );
3336
3337         #Log the renewal
3338         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3339
3340         Koha::Plugins->call('after_circ_action', {
3341             action  => 'renewal',
3342             payload => {
3343                 checkout  => $issue->get_from_storage
3344             }
3345         });
3346     });
3347
3348     unless( $skip_record_index ){
3349         # We index now, after the transaction is committed
3350         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
3351         $indexer->index_records( $item_object->biblionumber, "specialUpdate", "biblioserver" );
3352     }
3353
3354     return $datedue;
3355 }
3356
3357 sub GetRenewCount {
3358     # check renewal status
3359     my ( $borrowernumber_or_patron, $itemnumber_or_item ) = @_;
3360
3361     my $dbh           = C4::Context->dbh;
3362     my $renewcount    = 0;
3363     my $unseencount    = 0;
3364     my $renewsallowed = 0;
3365     my $unseenallowed = 0;
3366     my $renewsleft    = 0;
3367     my $unseenleft    = 0;
3368     my $patron = blessed $borrowernumber_or_patron ?
3369         $borrowernumber_or_patron : Koha::Patrons->find($borrowernumber_or_patron);
3370     my $item = blessed $itemnumber_or_item ?
3371         $itemnumber_or_item : Koha::Items->find($itemnumber_or_item);
3372
3373     return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3374
3375     # Look in the issues table for this item, lent to this borrower,
3376     # and not yet returned.
3377
3378     # FIXME - I think this function could be redone to use only one SQL call.
3379     my $sth = $dbh->prepare(q{
3380         SELECT * FROM issues
3381         WHERE  (borrowernumber = ?) AND (itemnumber = ?)
3382     });
3383     $sth->execute( $patron->borrowernumber, $item->itemnumber );
3384     my $data = $sth->fetchrow_hashref;
3385     $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3386     $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3387     # $item and $borrower should be calculated
3388     my $branchcode = _GetCircControlBranch($item, $patron);
3389
3390     my $rules = Koha::CirculationRules->get_effective_rules(
3391         {
3392             categorycode => $patron->categorycode,
3393             itemtype     => $item->effective_itemtype,
3394             branchcode   => $branchcode,
3395             rules        => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3396         }
3397     );
3398     $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3399     $unseenallowed = $rules->{unseen_renewals_allowed} ?
3400         $rules->{unseen_renewals_allowed} :
3401         0;
3402     $renewsleft    = $renewsallowed - $renewcount;
3403     $unseenleft    = $unseenallowed - $unseencount;
3404     if($renewsleft < 0){ $renewsleft = 0; }
3405     if($unseenleft < 0){ $unseenleft = 0; }
3406     return (
3407         $renewcount,
3408         $renewsallowed,
3409         $renewsleft,
3410         $unseencount,
3411         $unseenallowed,
3412         $unseenleft
3413     );
3414 }
3415
3416 =head2 GetSoonestRenewDate
3417
3418   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($patron, $issue);
3419
3420 Find out the soonest possible renew date of a borrowed item.
3421
3422 C<$patron> is the patron who currently has the item on loan.
3423
3424 C<$issue> is the the item issue.
3425
3426 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3427 renew date, based on the value "No renewal before" of the applicable
3428 issuing rule. Returns the current date if the item can already be
3429 renewed, and returns undefined if the patron, item, or checkout
3430 cannot be found.
3431
3432 =cut
3433
3434 sub GetSoonestRenewDate {
3435     my ( $patron, $issue ) = @_;
3436     return unless $issue;
3437     return unless $patron;
3438
3439     my $item = $issue->item;
3440     return unless $item;
3441
3442     my $dbh = C4::Context->dbh;
3443
3444     my $branchcode = _GetCircControlBranch( $item, $patron );
3445     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3446         {   categorycode => $patron->categorycode,
3447             itemtype     => $item->effective_itemtype,
3448             branchcode   => $branchcode,
3449             rules => [
3450                 'norenewalbefore',
3451                 'lengthunit',
3452             ]
3453         }
3454     );
3455
3456     my $now = dt_from_string;
3457
3458     if ( defined $issuing_rule->{norenewalbefore}
3459         and $issuing_rule->{norenewalbefore} ne "" )
3460     {
3461         my $soonestrenewal =
3462           dt_from_string( $issue->date_due )->subtract(
3463             $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3464
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     } elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
3472         # Checkouts with auto-renewing fall back to due date
3473         my $soonestrenewal = dt_from_string( $issue->date_due );
3474         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3475             and $issuing_rule->{lengthunit} eq 'days' )
3476         {
3477             $soonestrenewal->truncate( to => 'day' );
3478         }
3479         return $soonestrenewal;
3480     }
3481     return $now;
3482 }
3483
3484 =head2 GetLatestAutoRenewDate
3485
3486   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($patron, $issue);
3487
3488 Find out the latest possible auto renew date of a borrowed item.
3489
3490 C<$patron> is the patron who currently has the item on loan.
3491
3492 C<$issue> is the item issue.
3493
3494 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3495 auto renew date, based on the value "No auto renewal after" and the "No auto
3496 renewal after (hard limit) of the applicable issuing rule.
3497 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3498 or item cannot be found.
3499
3500 =cut
3501
3502 sub GetLatestAutoRenewDate {
3503     my ( $patron, $issue ) = @_;
3504     return unless $issue;
3505     return unless $patron;
3506
3507     my $item = $issue->item;
3508     return unless $item;
3509
3510     my $dbh = C4::Context->dbh;
3511     my $branchcode = _GetCircControlBranch( $item, $patron );
3512
3513     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3514         {
3515             categorycode => $patron->categorycode,
3516             itemtype     => $item->effective_itemtype,
3517             branchcode   => $branchcode,
3518             rules => [
3519                 'no_auto_renewal_after',
3520                 'no_auto_renewal_after_hard_limit',
3521                 'lengthunit',
3522             ]
3523         }
3524     );
3525
3526     return unless $circulation_rules;
3527     return
3528       if ( not $circulation_rules->{no_auto_renewal_after}
3529             or $circulation_rules->{no_auto_renewal_after} eq '' )
3530       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3531              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3532
3533     my $maximum_renewal_date;
3534     if ( $circulation_rules->{no_auto_renewal_after} ) {
3535         $maximum_renewal_date = dt_from_string($issue->issuedate);
3536         $maximum_renewal_date->add(
3537             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3538         );
3539     }
3540
3541     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3542         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3543         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3544     }
3545     return $maximum_renewal_date;
3546 }
3547
3548
3549 =head2 GetIssuingCharges
3550
3551   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3552
3553 Calculate how much it would cost for a given patron to borrow a given
3554 item, including any applicable discounts.
3555
3556 C<$itemnumber> is the item number of item the patron wishes to borrow.
3557
3558 C<$borrowernumber> is the patron's borrower number.
3559
3560 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3561 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3562 if it's a video).
3563
3564 =cut
3565
3566 sub GetIssuingCharges {
3567
3568     # calculate charges due
3569     my ( $itemnumber, $borrowernumber ) = @_;
3570     my $charge = 0;
3571     my $dbh    = C4::Context->dbh;
3572     my $item_type;
3573
3574     # Get the book's item type and rental charge (via its biblioitem).
3575     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3576         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3577     $charge_query .= (C4::Context->preference('item-level_itypes'))
3578         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3579         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3580
3581     $charge_query .= ' WHERE items.itemnumber =?';
3582
3583     my $sth = $dbh->prepare($charge_query);
3584     $sth->execute($itemnumber);
3585     my $patron;
3586     if ( my $item_data = $sth->fetchrow_hashref ) {
3587         $item_type = $item_data->{itemtype};
3588         $charge    = $item_data->{rentalcharge};
3589         if ($charge) {
3590             # FIXME This should follow CircControl
3591             my $branch = C4::Context::mybranch();
3592             $patron //= Koha::Patrons->find( $borrowernumber );
3593             my $discount = Koha::CirculationRules->get_effective_rule({
3594                 categorycode => $patron->categorycode,
3595                 branchcode   => $branch,
3596                 itemtype     => $item_type,
3597                 rule_name    => 'rentaldiscount'
3598             });
3599             if ($discount) {
3600                 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3601             }
3602             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3603         }
3604     }
3605
3606     return ( $charge, $item_type );
3607 }
3608
3609 =head2 AddIssuingCharge
3610
3611   &AddIssuingCharge( $checkout, $charge, $type )
3612
3613 =cut
3614
3615 sub AddIssuingCharge {
3616     my ( $checkout, $charge, $type ) = @_;
3617
3618     # FIXME What if checkout does not exist?
3619
3620     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3621     my $accountline = $account->add_debit(
3622         {
3623             amount      => $charge,
3624             note        => undef,
3625             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3626             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3627             interface   => C4::Context->interface,
3628             type        => $type,
3629             item_id     => $checkout->itemnumber,
3630             issue_id    => $checkout->issue_id,
3631         }
3632     );
3633 }
3634
3635 =head2 GetTransfersFromTo
3636
3637   @results = GetTransfersFromTo($frombranch,$tobranch);
3638
3639 Returns the list of pending transfers between $from and $to branch
3640
3641 =cut
3642
3643 sub GetTransfersFromTo {
3644     my ( $frombranch, $tobranch ) = @_;
3645     return unless ( $frombranch && $tobranch );
3646     my $dbh   = C4::Context->dbh;
3647     my $query = "
3648         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3649         FROM   branchtransfers
3650         WHERE  frombranch=?
3651           AND  tobranch=?
3652           AND datecancelled IS NULL
3653           AND datesent IS NOT NULL
3654           AND datearrived IS NULL
3655     ";
3656     my $sth = $dbh->prepare($query);
3657     $sth->execute( $frombranch, $tobranch );
3658     my @gettransfers;
3659
3660     while ( my $data = $sth->fetchrow_hashref ) {
3661         push @gettransfers, $data;
3662     }
3663     return (@gettransfers);
3664 }
3665
3666 =head2 SendCirculationAlert
3667
3668 Send out a C<check-in> or C<checkout> alert using the messaging system.
3669
3670 B<Parameters>:
3671
3672 =over 4
3673
3674 =item type
3675
3676 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3677
3678 =item item
3679
3680 Hashref of information about the item being checked in or out.
3681
3682 =item borrower
3683
3684 Hashref of information about the borrower of the item.
3685
3686 =item branch
3687
3688 The branchcode from where the checkout or check-in took place.
3689
3690 =back
3691
3692 B<Example>:
3693
3694     SendCirculationAlert({
3695         type     => 'CHECKOUT',
3696         item     => $item,
3697         borrower => $borrower,
3698         branch   => $branch,
3699     });
3700
3701 =cut
3702
3703 sub SendCirculationAlert {
3704     my ($opts) = @_;
3705     my ($type, $item, $borrower, $branch, $issue) =
3706         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3707     my %message_name = (
3708         CHECKIN  => 'Item_Check_in',
3709         CHECKOUT => 'Item_Checkout',
3710         RENEWAL  => 'Item_Checkout',
3711     );
3712     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3713         borrowernumber => $borrower->{borrowernumber},
3714         message_name   => $message_name{$type},
3715     });
3716
3717
3718     my $tables = {
3719         items => $item->{itemnumber},
3720         biblio      => $item->{biblionumber},
3721         biblioitems => $item->{biblionumber},
3722         borrowers   => $borrower,
3723         branches    => $branch,
3724     };
3725
3726     # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3727     # See C4::Letters:: _parseletter_sth
3728     if( $type eq 'CHECKIN' ){
3729         $tables->{old_issues} = $issue->issue_id;
3730     } else {
3731         $tables->{issues} = $item->{itemnumber};
3732     }
3733
3734     my $schema = Koha::Database->new->schema;
3735     my @transports = keys %{ $borrower_preferences->{transports} };
3736
3737     # From the MySQL doc:
3738     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3739     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3740     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3741     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3742
3743     for my $mtt (@transports) {
3744         my $letter =  C4::Letters::GetPreparedLetter (
3745             module => 'circulation',
3746             letter_code => $type,
3747             branchcode => $branch,
3748             message_transport_type => $mtt,
3749             lang => $borrower->{lang},
3750             tables => $tables,
3751         ) or next;
3752
3753         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3754         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3755         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3756         unless ( $message ) {
3757             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3758             my $patron = Koha::Patrons->find($borrower->{borrowernumber});
3759             C4::Message->enqueue($letter, $patron, $mtt);
3760         } else {
3761             $message->append($letter);
3762             $message->update;
3763         }
3764         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3765     }
3766
3767     return;
3768 }
3769
3770 =head2 updateWrongTransfer
3771
3772   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3773
3774 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
3775
3776 =cut
3777
3778 sub updateWrongTransfer {
3779         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3780
3781     # first step: cancel the original transfer
3782     my $item = Koha::Items->find($itemNumber);
3783     my $transfer = $item->get_transfer;
3784     $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3785
3786     # second step: create a new transfer to the right location
3787     my $new_transfer = $item->request_transfer(
3788         {
3789             to            => $transfer->to_library,
3790             reason        => $transfer->reason,
3791             comment       => $transfer->comments,
3792             ignore_limits => 1,
3793             enqueue       => 1
3794         }
3795     );
3796
3797     return $new_transfer;
3798 }
3799
3800 =head2 CalcDateDue
3801
3802 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3803
3804 this function calculates the due date given the start date and configured circulation rules,
3805 checking against the holidays calendar as per the daysmode circulation rule.
3806 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3807 C<$itemtype>  = itemtype code of item in question
3808 C<$branch>  = location whose calendar to use
3809 C<$patron> = Patron object
3810 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3811
3812 =cut
3813
3814 sub CalcDateDue {
3815     my ( $startdate, $itemtype, $branch, $patron, $isrenewal ) = @_;
3816
3817     $isrenewal ||= 0;
3818
3819     # loanlength now a href
3820     my $loanlength =
3821             GetLoanLength( $patron->categorycode, $itemtype, $branch );
3822
3823     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3824             ? qq{renewalperiod}
3825             : qq{issuelength};
3826
3827     my $datedue;
3828     if ( $startdate ) {
3829         if (ref $startdate ne 'DateTime' ) {
3830             $datedue = dt_from_string($datedue);
3831         } else {
3832             $datedue = $startdate->clone;
3833         }
3834     } else {
3835         $datedue = dt_from_string()->truncate( to => 'minute' );
3836     }
3837
3838
3839     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3840         {
3841             categorycode => $patron->categorycode,
3842             itemtype     => $itemtype,
3843             branchcode   => $branch,
3844         }
3845     );
3846
3847     # calculate the datedue as normal
3848     if ( $daysmode eq 'Days' )
3849     {    # ignoring calendar
3850         if ( $loanlength->{lengthunit} eq 'hours' ) {
3851             $datedue->add( hours => $loanlength->{$length_key} );
3852         } else {    # days
3853             $datedue->add( days => $loanlength->{$length_key} );
3854             $datedue->set_hour(23);
3855             $datedue->set_minute(59);
3856         }
3857     } else {
3858         my $dur;
3859         if ($loanlength->{lengthunit} eq 'hours') {
3860             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3861         }
3862         else { # days
3863             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3864         }
3865         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3866         $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3867         if ($loanlength->{lengthunit} eq 'days') {
3868             $datedue->set_hour(23);
3869             $datedue->set_minute(59);
3870         }
3871     }
3872
3873     # if Hard Due Dates are used, retrieve them and apply as necessary
3874     my ( $hardduedate, $hardduedatecompare ) =
3875       GetHardDueDate( $patron->categorycode, $itemtype, $branch );
3876     if ($hardduedate) {    # hardduedates are currently dates
3877         $hardduedate->truncate( to => 'minute' );
3878         $hardduedate->set_hour(23);
3879         $hardduedate->set_minute(59);
3880         my $cmp = DateTime->compare( $hardduedate, $datedue );
3881
3882 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3883 # if the calculated date is before the 'after' Hard Due Date (floor), override
3884 # if the hard due date is set to 'exactly', overrride
3885         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3886             $datedue = $hardduedate->clone;
3887         }
3888
3889         # in all other cases, keep the date due as it is
3890
3891     }
3892
3893     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3894     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3895         my $expiry_dt = dt_from_string( $patron->dateexpiry, 'iso', 'floating');
3896         if( $expiry_dt ) { #skip empty expiry date..
3897             $expiry_dt->set( hour => 23, minute => 59);
3898             my $d1= $datedue->clone->set_time_zone('floating');
3899             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3900                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3901             }
3902         }
3903         if ( $daysmode ne 'Days' ) {
3904           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3905           if ( $calendar->is_holiday($datedue) ) {
3906               # Don't return on a closed day
3907               $datedue = $calendar->prev_open_days( $datedue, 1 );
3908           }
3909         }
3910     }
3911
3912     return $datedue;
3913 }
3914
3915
3916 sub CheckValidBarcode{
3917 my ($barcode) = @_;
3918 my $dbh = C4::Context->dbh;
3919 my $query=qq|SELECT count(*)
3920              FROM items
3921              WHERE barcode=?
3922             |;
3923 my $sth = $dbh->prepare($query);
3924 $sth->execute($barcode);
3925 my $exist=$sth->fetchrow ;
3926 return $exist;
3927 }
3928
3929 =head2 IsBranchTransferAllowed
3930
3931   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3932
3933 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3934
3935 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3936 Koha::Item->can_be_transferred.
3937
3938 =cut
3939
3940 sub IsBranchTransferAllowed {
3941         my ( $toBranch, $fromBranch, $code ) = @_;
3942
3943         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3944
3945         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3946         my $dbh = C4::Context->dbh;
3947
3948         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3949         $sth->execute( $toBranch, $fromBranch, $code );
3950         my $limit = $sth->fetchrow_hashref();
3951
3952         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3953         if ( $limit->{'limitId'} ) {
3954                 return 0;
3955         } else {
3956                 return 1;
3957         }
3958 }
3959
3960 =head2 CreateBranchTransferLimit
3961
3962   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3963
3964 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3965
3966 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3967
3968 =cut
3969
3970 sub CreateBranchTransferLimit {
3971    my ( $toBranch, $fromBranch, $code ) = @_;
3972    return unless defined($toBranch) && defined($fromBranch);
3973    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3974
3975    my $dbh = C4::Context->dbh;
3976
3977    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3978    return $sth->execute( $code, $toBranch, $fromBranch );
3979 }
3980
3981 =head2 DeleteBranchTransferLimits
3982
3983     my $result = DeleteBranchTransferLimits($frombranch);
3984
3985 Deletes all the library transfer limits for one library.  Returns the
3986 number of limits deleted, 0e0 if no limits were deleted, or undef if
3987 no arguments are supplied.
3988
3989 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3990     fromBranch => $fromBranch
3991     })->delete.
3992
3993 =cut
3994
3995 sub DeleteBranchTransferLimits {
3996     my $branch = shift;
3997     return unless defined $branch;
3998     my $dbh    = C4::Context->dbh;
3999     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
4000     return $sth->execute($branch);
4001 }
4002
4003 sub ReturnLostItem{
4004     my ( $borrowernumber, $itemnum ) = @_;
4005     MarkIssueReturned( $borrowernumber, $itemnum );
4006 }
4007
4008 =head2 LostItem
4009
4010   LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
4011
4012 The final optional parameter, C<$params>, expected to contain
4013 'skip_record_index' key, which relayed down to Koha::Item/store,
4014 there it prevents calling of ModZebra index_records,
4015 which takes most of the time in batch adds/deletes: index_records better
4016 to be called later in C<additem.pl> after the whole loop.
4017
4018 $params:
4019     skip_record_index => 1|0
4020
4021 =cut
4022
4023 sub LostItem{
4024     my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
4025
4026     unless ( $mark_lost_from ) {
4027         # Temporary check to avoid regressions
4028         die q|LostItem called without $mark_lost_from, check the API.|;
4029     }
4030
4031     my $mark_returned;
4032     if ( $force_mark_returned ) {
4033         $mark_returned = 1;
4034     } else {
4035         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
4036         $mark_returned = ( $pref =~ m|$mark_lost_from| );
4037     }
4038
4039     my $dbh = C4::Context->dbh();
4040     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
4041                            FROM issues
4042                            JOIN items USING (itemnumber)
4043                            JOIN biblio USING (biblionumber)
4044                            WHERE issues.itemnumber=?");
4045     $sth->execute($itemnumber);
4046     my $issues=$sth->fetchrow_hashref();
4047
4048     # If a borrower lost the item, add a replacement cost to the their record
4049     if ( my $borrowernumber = $issues->{borrowernumber} ){
4050         my $patron = Koha::Patrons->find( $borrowernumber );
4051
4052         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
4053         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
4054
4055         if (C4::Context->preference('WhenLostChargeReplacementFee')){
4056             C4::Accounts::chargelostitem(
4057                 $borrowernumber,
4058                 $itemnumber,
4059                 $issues->{'replacementprice'},
4060                 sprintf( "%s %s %s",
4061                     $issues->{'title'}          || q{},
4062                     $issues->{'barcode'}        || q{},
4063                     $issues->{'itemcallnumber'} || q{},
4064                 ),
4065             );
4066             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4067             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
4068         }
4069
4070         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4071     }
4072
4073     # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4074     my $item = Koha::Items->find($itemnumber);
4075     my $transfers = $item->get_transfers;
4076     while (my $transfer = $transfers->next) {
4077         $transfer->cancel({ reason => 'ItemLost', force => 1 });
4078     }
4079 }
4080
4081 sub GetOfflineOperations {
4082     my $dbh = C4::Context->dbh;
4083     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4084     $sth->execute(C4::Context->userenv->{'branch'});
4085     my $results = $sth->fetchall_arrayref({});
4086     return $results;
4087 }
4088
4089 sub GetOfflineOperation {
4090     my $operationid = shift;
4091     return unless $operationid;
4092     my $dbh = C4::Context->dbh;
4093     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4094     $sth->execute( $operationid );
4095     return $sth->fetchrow_hashref;
4096 }
4097
4098 sub AddOfflineOperation {
4099     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4100     my $dbh = C4::Context->dbh;
4101     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4102     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4103     return "Added.";
4104 }
4105
4106 sub DeleteOfflineOperation {
4107     my $dbh = C4::Context->dbh;
4108     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4109     $sth->execute( shift );
4110     return "Deleted.";
4111 }
4112
4113 sub ProcessOfflineOperation {
4114     my $operation = shift;
4115
4116     my $report;
4117     if ( $operation->{action} eq 'return' ) {
4118         $report = ProcessOfflineReturn( $operation );
4119     } elsif ( $operation->{action} eq 'issue' ) {
4120         $report = ProcessOfflineIssue( $operation );
4121     } elsif ( $operation->{action} eq 'payment' ) {
4122         $report = ProcessOfflinePayment( $operation );
4123     }
4124
4125     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4126
4127     return $report;
4128 }
4129
4130 sub ProcessOfflineReturn {
4131     my $operation = shift;
4132
4133     my $item = Koha::Items->find({barcode => $operation->{barcode}});
4134
4135     if ( $item ) {
4136         my $itemnumber = $item->itemnumber;
4137         my $issue = $item->checkout;
4138         if ( $issue ) {
4139             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4140             ModDateLastSeen( $itemnumber, $leave_item_lost );
4141             MarkIssueReturned(
4142                 $issue->borrowernumber,
4143                 $itemnumber,
4144                 $operation->{timestamp},
4145             );
4146             $item->onloan(undef);
4147             $item->store({ log_action => 0 });
4148             return "Success.";
4149         } else {
4150             return "Item not issued.";
4151         }
4152     } else {
4153         return "Item not found.";
4154     }
4155 }
4156
4157 sub ProcessOfflineIssue {
4158     my $operation = shift;
4159
4160     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4161
4162     if ( $patron ) {
4163         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4164         unless ($item) {
4165             return "Barcode not found.";
4166         }
4167         my $itemnumber = $item->itemnumber;
4168         my $issue = $item->checkout;
4169
4170         if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4171             MarkIssueReturned(
4172                 $issue->borrowernumber,
4173                 $itemnumber,
4174                 $operation->{timestamp},
4175             );
4176         }
4177         AddIssue(
4178             $patron,
4179             $operation->{'barcode'},
4180             undef,
4181             undef,
4182             $operation->{timestamp},
4183             undef,
4184         );
4185         return "Success.";
4186     } else {
4187         return "Borrower not found.";
4188     }
4189 }
4190
4191 sub ProcessOfflinePayment {
4192     my $operation = shift;
4193
4194     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4195
4196     $patron->account->pay(
4197         {
4198             amount     => $operation->{amount},
4199             library_id => $operation->{branchcode},
4200             interface  => 'koc'
4201         }
4202     );
4203
4204     return "Success.";
4205 }
4206
4207 =head2 TransferSlip
4208
4209   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4210
4211   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4212
4213 =cut
4214
4215 sub TransferSlip {
4216     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4217
4218     my $item =
4219       $itemnumber
4220       ? Koha::Items->find($itemnumber)
4221       : Koha::Items->find( { barcode => $barcode } );
4222
4223     $item or return;
4224
4225     return C4::Letters::GetPreparedLetter (
4226         module => 'circulation',
4227         letter_code => 'TRANSFERSLIP',
4228         branchcode => $branch,
4229         tables => {
4230             'branches'    => $to_branch,
4231             'biblio'      => $item->biblionumber,
4232             'items'       => $item->unblessed,
4233         },
4234     );
4235 }
4236
4237 =head2 CheckIfIssuedToPatron
4238
4239   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4240
4241   Return 1 if any record item is issued to patron, otherwise return 0
4242
4243 =cut
4244
4245 sub CheckIfIssuedToPatron {
4246     my ($borrowernumber, $biblionumber) = @_;
4247
4248     my $dbh = C4::Context->dbh;
4249     my $query = q|
4250         SELECT COUNT(*) FROM issues
4251         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4252         WHERE items.biblionumber = ?
4253         AND issues.borrowernumber = ?
4254     |;
4255     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4256     return 1 if $is_issued;
4257     return;
4258 }
4259
4260 =head2 IsItemIssued
4261
4262   IsItemIssued( $itemnumber )
4263
4264   Return 1 if the item is on loan, otherwise return 0
4265
4266 =cut
4267
4268 sub IsItemIssued {
4269     my $itemnumber = shift;
4270     my $dbh = C4::Context->dbh;
4271     my $sth = $dbh->prepare(q{
4272         SELECT COUNT(*)
4273         FROM issues
4274         WHERE itemnumber = ?
4275     });
4276     $sth->execute($itemnumber);
4277     return $sth->fetchrow;
4278 }
4279
4280 =head2 GetAgeRestriction
4281
4282   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4283   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4284
4285   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4286   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4287
4288 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4289 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4290 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4291          Negative days mean the borrower has gone past the age restriction age.
4292
4293 =cut
4294
4295 sub GetAgeRestriction {
4296     my ($record_restrictions, $borrower) = @_;
4297     my $markers = C4::Context->preference('AgeRestrictionMarker');
4298
4299     return unless $record_restrictions;
4300     # Split $record_restrictions to something like FSK 16 or PEGI 6
4301     my @values = split ' ', uc($record_restrictions);
4302     return unless @values;
4303
4304     # Search first occurrence of one of the markers
4305     my @markers = split /\|/, uc($markers);
4306     return unless @markers;
4307
4308     my $index            = 0;
4309     my $restriction_year = 0;
4310     for my $value (@values) {
4311         $index++;
4312         for my $marker (@markers) {
4313             $marker =~ s/^\s+//;    #remove leading spaces
4314             $marker =~ s/\s+$//;    #remove trailing spaces
4315             if ( $marker eq $value ) {
4316                 if ( $index <= $#values ) {
4317                     $restriction_year += $values[$index];
4318                 }
4319                 last;
4320             }
4321             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4322
4323                 # Perhaps it is something like "K16" (as in Finland)
4324                 $restriction_year += $1;
4325                 last;
4326             }
4327         }
4328         last if ( $restriction_year > 0 );
4329     }
4330
4331     #Check if the borrower is age restricted for this material and for how long.
4332     if ($restriction_year && $borrower) {
4333         if ( $borrower->{'dateofbirth'} ) {
4334             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4335             $alloweddate[0] += $restriction_year;
4336
4337             #Prevent runime eror on leap year (invalid date)
4338             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4339                 $alloweddate[2] = 28;
4340             }
4341
4342             #Get how many days the borrower has to reach the age restriction
4343             my @Today = split /-/, dt_from_string()->ymd();
4344             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4345             #Negative days means the borrower went past the age restriction age
4346             return ($restriction_year, $daysToAgeRestriction);
4347         }
4348     }
4349
4350     return ($restriction_year);
4351 }
4352
4353
4354 =head2 GetPendingOnSiteCheckouts
4355
4356 =cut
4357
4358 sub GetPendingOnSiteCheckouts {
4359     my $dbh = C4::Context->dbh;
4360     return $dbh->selectall_arrayref(q|
4361         SELECT
4362           items.barcode,
4363           items.biblionumber,
4364           items.itemnumber,
4365           items.itemnotes,
4366           items.itemcallnumber,
4367           items.location,
4368           issues.date_due,
4369           issues.branchcode,
4370           issues.date_due < NOW() AS is_overdue,
4371           biblio.author,
4372           biblio.title,
4373           borrowers.firstname,
4374           borrowers.surname,
4375           borrowers.cardnumber,
4376           borrowers.borrowernumber
4377         FROM items
4378         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4379         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4380         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4381         WHERE issues.onsite_checkout = 1
4382     |, { Slice => {} } );
4383 }
4384
4385 sub GetTopIssues {
4386     my ($params) = @_;
4387
4388     my ($count, $branch, $itemtype, $ccode, $newness)
4389         = @$params{qw(count branch itemtype ccode newness)};
4390
4391     my $dbh = C4::Context->dbh;
4392     my $query = q{
4393         SELECT * FROM (
4394         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4395           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4396           i.ccode, SUM(i.issues) AS count
4397         FROM biblio b
4398         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4399         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4400     };
4401
4402     my (@where_strs, @where_args);
4403
4404     if ($branch) {
4405         push @where_strs, 'i.homebranch = ?';
4406         push @where_args, $branch;
4407     }
4408     if ($itemtype) {
4409         if (C4::Context->preference('item-level_itypes')){
4410             push @where_strs, 'i.itype = ?';
4411             push @where_args, $itemtype;
4412         } else {
4413             push @where_strs, 'bi.itemtype = ?';
4414             push @where_args, $itemtype;
4415         }
4416     }
4417     if ($ccode) {
4418         push @where_strs, 'i.ccode = ?';
4419         push @where_args, $ccode;
4420     }
4421     if ($newness) {
4422         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4423         push @where_args, $newness;
4424     }
4425
4426     if (@where_strs) {
4427         $query .= 'WHERE ' . join(' AND ', @where_strs);
4428     }
4429
4430     $query .= q{
4431         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4432           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4433           i.ccode
4434         ORDER BY count DESC
4435     };
4436
4437     $query .= q{ ) xxx WHERE count > 0 };
4438     $count = int($count);
4439     if ($count > 0) {
4440         $query .= "LIMIT $count";
4441     }
4442
4443     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4444
4445     return @$rows;
4446 }
4447
4448 =head2 Internal methods
4449
4450 =cut
4451
4452 sub _CalculateAndUpdateFine {
4453     my ($params) = @_;
4454
4455     my $borrower    = $params->{borrower};
4456     my $item        = $params->{item};
4457     my $issue       = $params->{issue};
4458     my $return_date = $params->{return_date};
4459
4460     unless ($borrower) { carp "No borrower passed in!" && return; }
4461     unless ($item)     { carp "No item passed in!"     && return; }
4462     unless ($issue)    { carp "No issue passed in!"    && return; }
4463
4464     my $datedue = dt_from_string( $issue->date_due );
4465
4466     # we only need to calculate and change the fines if we want to do that on return
4467     # Should be on for hourly loans
4468     my $control = C4::Context->preference('CircControl');
4469     my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4470     my $control_branchcode =
4471         ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4472       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4473       :                                     $issue->branchcode;
4474
4475     my $date_returned = $return_date ? $return_date : dt_from_string();
4476
4477     my ( $amount, $unitcounttotal, $unitcount  ) =
4478       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4479
4480     if ( C4::Context->preference('finesMode') eq 'production' ) {
4481         if ( $amount > 0 ) {
4482             C4::Overdues::UpdateFine({
4483                 issue_id       => $issue->issue_id,
4484                 itemnumber     => $issue->itemnumber,
4485                 borrowernumber => $issue->borrowernumber,
4486                 amount         => $amount,
4487                 due            => $datedue,
4488             });
4489         }
4490         elsif ($return_date) {
4491
4492             # Backdated returns may have fines that shouldn't exist,
4493             # so in this case, we need to drop those fines to 0
4494
4495             C4::Overdues::UpdateFine({
4496                 issue_id       => $issue->issue_id,
4497                 itemnumber     => $issue->itemnumber,
4498                 borrowernumber => $issue->borrowernumber,
4499                 amount         => 0,
4500                 due            => $datedue,
4501             });
4502         }
4503     }
4504 }
4505
4506 sub _CanBookBeAutoRenewed {
4507     my ( $params ) = @_;
4508     my $patron = $params->{patron};
4509     my $item = $params->{item};
4510     my $branchcode = $params->{branchcode};
4511     my $issue = $params->{issue};
4512
4513     return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4514
4515     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4516         {
4517             categorycode => $patron->categorycode,
4518             itemtype     => $item->effective_itemtype,
4519             branchcode   => $branchcode,
4520             rules => [
4521                 'no_auto_renewal_after',
4522                 'no_auto_renewal_after_hard_limit',
4523                 'lengthunit',
4524                 'norenewalbefore',
4525             ]
4526         }
4527     );
4528
4529     if ( $patron->is_expired && $patron->category->effective_BlockExpiredPatronOpacActions ) {
4530         return 'auto_account_expired';
4531     }
4532
4533     if ( defined $issuing_rule->{no_auto_renewal_after}
4534             and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4535         # Get issue_date and add no_auto_renewal_after
4536         # If this is greater than today, it's too late for renewal.
4537         my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4538         $maximum_renewal_date->add(
4539             $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4540         );
4541         my $now = dt_from_string;
4542         if ( $now >= $maximum_renewal_date ) {
4543             return "auto_too_late";
4544         }
4545     }
4546     if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4547                   and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4548         # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4549         if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4550             return "auto_too_late";
4551         }
4552     }
4553
4554     if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4555         my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4556         my $amountoutstanding =
4557           C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4558           ? $patron->account->balance
4559           : $patron->account->outstanding_debits->total_outstanding;
4560         if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4561             return "auto_too_much_oweing";
4562         }
4563     }
4564
4565     my $soonest = GetSoonestRenewDate($patron, $issue);
4566     if ( $soonest > dt_from_string() )
4567     {
4568         return ( "auto_too_soon", $soonest );
4569     }
4570
4571     return "ok";
4572 }
4573
4574
4575 1;
4576
4577 __END__
4578
4579 =head1 AUTHOR
4580
4581 Koha Development Team <http://koha-community.org/>
4582
4583 =cut