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         my $block_lost_return = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
 830         my ( $stats_return, $stats_messages, $stats_iteminformation, $stats_borrower ) =
 831             AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
 832         ModDateLastSeen( $item_object->itemnumber, $block_lost_return );    # FIXME Move to Koha::Item
 833         return (
 834             {
 835                 STATS     => 1,
 836                 CHECKEDIN => $stats_return,
 837                 MESSAGES  => $stats_messages,
 838                 ITEM      => $stats_iteminformation,
 839                 BORROWER  => $stats_borrower,
 840             },
 841             {}
 842         );
 843     }
 844
 845     if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
 846         $issuingimpossible{GNA} = 1;
 847     }
 848
 849     if ( $patron->lost && $patron->lost == 1 ) {
 850         $issuingimpossible{CARD_LOST} = 1;
 851     }
 852     if ( $patron->is_debarred ) {
 853         $issuingimpossible{DEBARRED} = 1;
 854     }
 855
 856     if ( $patron->is_expired ) {
 857         $issuingimpossible{EXPIRED} = 1;
 858     }
 859
 860     #
 861     # BORROWER STATUS
 862     #
 863
 864     # DEBTS
 865     my $account = $patron->account;
 866     my $balance = $account->balance;
 867     my $non_issues_charges = $account->non_issues_charges;
 868     my $other_charges = $balance - $non_issues_charges;
 869
 870     my $amountlimit = C4::Context->preference("noissuescharge");
 871     my $allowfineoverride = C4::Context->preference("AllowFineOverride");
 872     my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
 873
 874     # Check the debt of this patrons guarantees
 875     my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
 876     $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
 877     if ( defined $no_issues_charge_guarantees ) {
 878         my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
 879         my $guarantees_non_issues_charges = 0;
 880         foreach my $g ( @guarantees ) {
 881             $guarantees_non_issues_charges += $g->account->non_issues_charges;
 882         }
 883
 884         if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
 885             $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
 886         } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
 887             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
 888         } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
 889             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
 890         }
 891     }
 892
 893     # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
 894     my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
 895     $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
 896     if ( defined $no_issues_charge_guarantors ) {
 897         my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
 898
 899         if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
 900             $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
 901         } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
 902             $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
 903         } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
 904             $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
 905         }
 906     }
 907
 908     if ( C4::Context->preference("IssuingInProcess") ) {
 909         if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
 910             $issuingimpossible{DEBT} = $non_issues_charges;
 911         } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
 912             $needsconfirmation{DEBT} = $non_issues_charges;
 913         } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
 914             $needsconfirmation{DEBT} = $non_issues_charges;
 915         }
 916     }
 917     else {
 918         if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
 919             $needsconfirmation{DEBT} = $non_issues_charges;
 920         } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
 921             $issuingimpossible{DEBT} = $non_issues_charges;
 922         } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
 923             $needsconfirmation{DEBT} = $non_issues_charges;
 924         }
 925     }
 926
 927     if ($balance > 0 && $other_charges > 0) {
 928         $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
 929     }
 930
 931     $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
 932     $patron_unblessed = $patron->unblessed;
 933
 934     if ( my $debarred_date = $patron->is_debarred ) {
 935          # patron has accrued fine days or has a restriction. $count is a date
 936         if ($debarred_date eq '9999-12-31') {
 937             $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
 938         }
 939         else {
 940             $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
 941         }
 942     } elsif ( my $num_overdues = $patron->has_overdues ) {
 943         ## patron has outstanding overdue loans
 944         if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
 945             $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
 946         }
 947         elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
 948             $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
 949         }
 950     }
 951
 952     # Additional Materials Check
 953     if ( C4::Context->preference("CircConfirmItemParts")
 954         && $item_object->materials )
 955     {
 956         $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
 957     }
 958
 959     #
 960     # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
 961     #
 962     if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
 963
 964         # Already issued to current borrower.
 965         # If it is an on-site checkout if it can be switched to a normal checkout
 966         # or ask whether the loan should be renewed
 967
 968         if ( $issue->onsite_checkout
 969                 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
 970             $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
 971         } else {
 972             my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed($patron, $issue);
 973             if ( $CanBookBeRenewed == 0 ) {    # no more renewals allowed
 974                 if ( $renewerror eq 'onsite_checkout' ) {
 975                     $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
 976                 }
 977                 else {
 978                     $issuingimpossible{NO_MORE_RENEWALS} = 1;
 979                 }
 980             }
 981             else {
 982                 $needsconfirmation{RENEW_ISSUE} = 1;
 983             }
 984         }
 985     }
 986     elsif ( $issue ) {
 987
 988         # issued to someone else
 989
 990         my $patron = Koha::Patrons->find( $issue->borrowernumber );
 991
 992         my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
 993
 994         if ( !$can_be_returned ) {
 995             $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
 996             $issuingimpossible{branch_to_return} = $message;
 997         } else {
 998             if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
 999                 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
1000             }
1001             else {
1002                 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
1003                 $needsconfirmation{issued_firstname} = $patron->firstname;
1004                 $needsconfirmation{issued_surname} = $patron->surname;
1005                 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
1006                 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
1007             }
1008         }
1009     }
1010
1011     # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1012     #
1013     my $switch_onsite_checkout = (
1014           C4::Context->preference('SwitchOnSiteCheckouts')
1015       and $issue
1016       and $issue->onsite_checkout
1017       and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1018     my $toomany = TooMany( $patron, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1019     # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1020     if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1021         if ( $toomany->{max_allowed} == 0 ) {
1022             $needsconfirmation{PATRON_CANT} = 1;
1023         }
1024         if ( C4::Context->preference("AllowTooManyOverride") ) {
1025             $needsconfirmation{TOO_MANY} = $toomany->{reason};
1026             $needsconfirmation{current_loan_count} = $toomany->{count};
1027             $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
1028         } else {
1029             $issuingimpossible{TOO_MANY} = $toomany->{reason};
1030             $issuingimpossible{current_loan_count} = $toomany->{count};
1031             $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
1032         }
1033     }
1034
1035     #
1036     # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1037     #
1038     $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1039     if ( $patron->wants_check_for_previous_checkout && $patron->do_check_for_previous_checkout($item_unblessed) ) {
1040         $needsconfirmation{PREVISSUE} = 1;
1041     }
1042
1043     #
1044     # ITEM CHECKING
1045     #
1046     if ( $item_object->notforloan )
1047     {
1048         if(!C4::Context->preference("AllowNotForLoanOverride")){
1049             $issuingimpossible{NOT_FOR_LOAN} = 1;
1050             $issuingimpossible{item_notforloan} = $item_object->notforloan;
1051         }else{
1052             $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1053             $needsconfirmation{item_notforloan} = $item_object->notforloan;
1054         }
1055     }
1056     else {
1057         # we have to check itemtypes.notforloan also
1058         if (C4::Context->preference('item-level_itypes')){
1059             # this should probably be a subroutine
1060             my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1061             $sth->execute($effective_itemtype);
1062             my $notforloan=$sth->fetchrow_hashref();
1063             if ($notforloan->{'notforloan'}) {
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         else {
1074             my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1075             if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1076                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1077                     $issuingimpossible{NOT_FOR_LOAN} = 1;
1078                     $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1079                 } else {
1080                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1081                     $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1082                 }
1083             }
1084         }
1085     }
1086     if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1087     {
1088         $issuingimpossible{WTHDRAWN} = 1;
1089     }
1090     if (   $item_object->restricted
1091         && $item_object->restricted == 1 )
1092     {
1093         $issuingimpossible{RESTRICTED} = 1;
1094     }
1095     if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1096         my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1097         my $code = $av->count ? $av->next->lib : '';
1098         $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1099         $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1100     }
1101     if ( C4::Context->preference("IndependentBranches") ) {
1102         my $userenv = C4::Context->userenv;
1103         unless ( C4::Context->IsSuperLibrarian() ) {
1104             my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1105             if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1106                 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1107                 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1108             }
1109             $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1110               if ( $patron->branchcode ne $userenv->{branch} );
1111         }
1112     }
1113
1114     #
1115     # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1116     #
1117     my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1118     if ($rentalConfirmation) {
1119         my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1120
1121         my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1122         if ($itemtype_object) {
1123             my $accumulate_charge = $fees->accumulate_rentalcharge();
1124             if ( $accumulate_charge > 0 ) {
1125                 $rentalCharge += $accumulate_charge;
1126             }
1127         }
1128
1129         if ( $rentalCharge > 0 ) {
1130             $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1131         }
1132     }
1133
1134     my $recall;
1135     # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1136     # Only bother doing this if UseRecalls is enabled and the item is recallable
1137     # Don't look at recalls that are in transit
1138     if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1139         my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1140
1141         foreach my $r ( @recalls ) {
1142             if ( $r->item_id and
1143                 $r->item_id == $item_object->itemnumber and
1144                 $r->patron_id == $patron->borrowernumber and
1145                 ( $r->waiting or $r->requested ) ) {
1146                 $messages{RECALLED} = $r->id;
1147                 $recall = $r;
1148                 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1149                 last;
1150             }
1151             elsif ( $r->item_id and
1152                 $r->item_id == $item_object->itemnumber and
1153                 $r->in_transit ) {
1154                 # recalled item is in transit
1155                 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1156             }
1157             elsif ( $r->item_level and
1158                 $r->item_id == $item_object->itemnumber and
1159                 $r->patron_id != $patron->borrowernumber and
1160                 !$r->in_transit ) {
1161                 # this specific item has been recalled by a different patron
1162                 $needsconfirmation{RECALLED} = $r;
1163                 $recall = $r;
1164                 last;
1165             }
1166             elsif ( !$r->item_level and
1167                 $r->patron_id != $patron->borrowernumber and
1168                 !$r->in_transit ) {
1169                 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1170                 $needsconfirmation{RECALLED} = $r;
1171                 $recall = $r;
1172                 last;
1173             }
1174         }
1175     }
1176
1177     unless ( $ignore_reserves and defined $recall ) {
1178         # See if the item is on reserve.
1179         my ( $restype, $res ) = CheckReserves( $item_object );
1180         if ($restype) {
1181             my $resbor = $res->{'borrowernumber'};
1182             if ( $resbor ne $patron->borrowernumber ) {
1183                 my $patron = Koha::Patrons->find( $resbor );
1184                 if ( $restype eq "Waiting" )
1185                 {
1186                     # The item is on reserve and waiting, but has been
1187                     # reserved by some other patron.
1188                     $needsconfirmation{RESERVE_WAITING} = 1;
1189                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1190                     $needsconfirmation{'ressurname'} = $patron->surname;
1191                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1192                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1193                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1194                     $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1195                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1196                 }
1197                 elsif ( $restype eq "Reserved" ) {
1198                     # The item is on reserve for someone else.
1199                     $needsconfirmation{RESERVED} = 1;
1200                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1201                     $needsconfirmation{'ressurname'} = $patron->surname;
1202                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1203                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1204                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1205                     $needsconfirmation{'resreservedate'} = $res->{reservedate};
1206                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1207                 }
1208                 elsif ( $restype eq "Transferred" ) {
1209                     # The item is determined hold being transferred for someone else.
1210                     $needsconfirmation{TRANSFERRED} = 1;
1211                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1212                     $needsconfirmation{'ressurname'} = $patron->surname;
1213                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1214                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1215                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1216                     $needsconfirmation{'resreservedate'} = $res->{reservedate};
1217                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1218                 }
1219                 elsif ( $restype eq "Processing" ) {
1220                     # The item is determined hold being processed for someone else.
1221                     $needsconfirmation{PROCESSING} = 1;
1222                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1223                     $needsconfirmation{'ressurname'} = $patron->surname;
1224                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1225                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1226                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1227                     $needsconfirmation{'resreservedate'} = $res->{reservedate};
1228                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1229                 }
1230             }
1231         }
1232     }
1233
1234     ## CHECK FOR BOOKINGS
1235     if (
1236         my $booking = $item_object->find_booking(
1237             {
1238                 checkout_date => $now,
1239                 due_date      => $duedate,
1240                 patron_id     => $patron->borrowernumber
1241             }
1242         )
1243         )
1244     {
1245         # Booked to this patron :)
1246         if ( $booking->patron_id == $patron->borrowernumber ) {
1247             if ( $now < dt_from_string( $booking->start_date ) ) {
1248                 $needsconfirmation{'BOOKED_EARLY'} = $booking;
1249             } else {
1250                 $alerts{'BOOKED'} = $booking;
1251             }
1252         }
1253
1254         # Booking starts before due date, reduce loan?
1255         elsif ( $duedate > dt_from_string( $booking->start_date ) ) {
1256             $needsconfirmation{'BOOKED_TO_ANOTHER'} = $booking;
1257         }
1258
1259         # Loan falls inside booking
1260         else {
1261             $issuingimpossible{'BOOKED_TO_ANOTHER'} = $booking;
1262         }
1263     }
1264
1265     ## CHECK AGE RESTRICTION
1266     my $agerestriction  = $biblioitem->agerestriction;
1267     my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $patron->unblessed );
1268     if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1269         if ( C4::Context->preference('AgeRestrictionOverride') ) {
1270             $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1271         }
1272         else {
1273             $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1274         }
1275     }
1276
1277     ## check for high holds decreasing loan period
1278     if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1279         my $check = checkHighHolds( $item_object, $patron );
1280
1281         if ( $check->{exceeded} ) {
1282             my $highholds = {
1283                 num_holds  => $check->{outstanding},
1284                 duration   => $check->{duration},
1285                 returndate => $check->{due_date},
1286             };
1287             if ($override_high_holds) {
1288                 $alerts{HIGHHOLDS} = $highholds;
1289             }
1290             else {
1291                 $needsconfirmation{HIGHHOLDS} = $highholds;
1292             }
1293         }
1294     }
1295
1296     if (
1297         !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1298         # don't do the multiple loans per bib check if we've
1299         # already determined that we've got a loan on the same item
1300         !$issuingimpossible{NO_MORE_RENEWALS} &&
1301         !$needsconfirmation{RENEW_ISSUE}
1302     ) {
1303         # Check if borrower has already issued an item from the same biblio
1304         # Only if it's not a subscription
1305         my $biblionumber = $item_object->biblionumber;
1306         require C4::Serials;
1307         my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1308         unless ($is_a_subscription) {
1309             # FIXME Should be $patron->checkouts($args);
1310             my $checkouts = Koha::Checkouts->search(
1311                 {
1312                     borrowernumber => $patron->borrowernumber,
1313                     biblionumber   => $biblionumber,
1314                 },
1315                 {
1316                     join => 'item',
1317                 }
1318             );
1319             # if we get here, we don't already have a loan on this item,
1320             # so if there are any loans on this bib, ask for confirmation
1321             if ( $checkouts->count ) {
1322                 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1323             }
1324         }
1325     }
1326
1327     return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1328 }
1329
1330 =head2 CanBookBeReturned
1331
1332   ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1333
1334 Check whether the item can be returned to the provided branch
1335
1336 =over 4
1337
1338 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1339
1340 =item C<$branch> is the branchcode where the return is taking place
1341
1342 =back
1343
1344 Returns:
1345
1346 =over 4
1347
1348 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1349
1350 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1351
1352 =back
1353
1354 =cut
1355
1356 sub CanBookBeReturned {
1357   my ($item, $branch) = @_;
1358   my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1359
1360   # assume return is allowed to start
1361   my $allowed = 1;
1362   my $message;
1363
1364   # identify all cases where return is forbidden
1365   if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1366      $allowed = 0;
1367      $message = $item->{'homebranch'};
1368   } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1369      $allowed = 0;
1370      $message = $item->{'holdingbranch'};
1371   } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1372      $allowed = 0;
1373      $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1374   }
1375
1376   return ($allowed, $message);
1377 }
1378
1379 =head2 CheckHighHolds
1380
1381     used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1382     decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1383     has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1384
1385 =cut
1386
1387 sub checkHighHolds {
1388     my ( $item, $patron ) = @_;
1389     my $branchcode = _GetCircControlBranch( $item, $patron );
1390
1391     my $return_data = {
1392         exceeded    => 0,
1393         outstanding => 0,
1394         duration    => 0,
1395         due_date    => undef,
1396     };
1397
1398
1399     # Count holds on this record, ignoring the borrowers own holds as they would be filled by the checkout
1400     my $holds = Koha::Holds->search({
1401         biblionumber => $item->biblionumber,
1402         borrowernumber => { '!=' => $patron->borrowernumber }
1403     });
1404
1405     if ( $holds->count() ) {
1406         $return_data->{outstanding} = $holds->count();
1407
1408         my $decreaseLoanHighHoldsControl        = C4::Context->preference('decreaseLoanHighHoldsControl');
1409         my $decreaseLoanHighHoldsValue          = C4::Context->preference('decreaseLoanHighHoldsValue');
1410         my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1411
1412         my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1413
1414         if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1415
1416             # static means just more than a given number of holds on the record
1417
1418             # If the number of holds is not above the threshold, we can stop here
1419             if ( $holds->count() <= $decreaseLoanHighHoldsValue ) {
1420                 return $return_data;
1421             }
1422         }
1423         elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1424
1425             # dynamic means X more than the number of holdable items on the record
1426
1427             # let's get the items
1428             my @items = $holds->next()->biblio()->items()->as_list;
1429
1430             # Remove any items with status defined to be ignored even if the would not make item unholdable
1431             foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1432                 @items = grep { !$_->$status } @items;
1433             }
1434
1435             # Remove any items that are not holdable for this patron
1436             # We need to ignore hold counts as the borrower's own hold that will be filled by the checkout
1437             # could prevent them from placing further holds
1438             @items = grep { CanItemBeReserved( $patron, $_, undef, { ignore_hold_counts => 1 } )->{status} eq 'OK' } @items;
1439
1440             my $items_count = scalar @items;
1441
1442             my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1443
1444             # If the number of holds is less than the count of items we have
1445             # plus the number of holds allowed above that count, we can stop here
1446             if ( $holds->count() <= $threshold ) {
1447                 return $return_data;
1448             }
1449         }
1450
1451         my $issuedate = dt_from_string();
1452
1453         my $itype = $item->effective_itemtype;
1454         my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1455             {
1456                 categorycode => $patron->categorycode,
1457                 itemtype     => $itype,
1458                 branchcode   => $branchcode,
1459             }
1460         );
1461         my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1462
1463         my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1464
1465         my $rule = Koha::CirculationRules->get_effective_rule_value(
1466             {
1467                 categorycode => $patron->categorycode,
1468                 itemtype     => $item->effective_itemtype,
1469                 branchcode   => $branchcode,
1470                 rule_name    => 'decreaseloanholds',
1471             }
1472         );
1473
1474         my $duration;
1475         if ( defined($rule) && $rule ne '' ){
1476             # overrides decreaseLoanHighHoldsDuration syspref
1477             $duration = $rule;
1478         } else {
1479             $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1480         }
1481         my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1482         $reduced_datedue->set_hour($orig_due->hour);
1483         $reduced_datedue->set_minute($orig_due->minute);
1484         $reduced_datedue->truncate( to => 'minute' );
1485
1486         if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1487             $return_data->{exceeded} = 1;
1488             $return_data->{duration} = $duration;
1489             $return_data->{due_date} = $reduced_datedue;
1490         }
1491     }
1492
1493     return $return_data;
1494 }
1495
1496 =head2 AddIssue
1497
1498   &AddIssue($patron, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1499
1500 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1501
1502 =over 4
1503
1504 =item C<$patron> is a patron object.
1505
1506 =item C<$barcode> is the barcode of the item being issued.
1507
1508 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1509 Calculated if empty.
1510
1511 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1512
1513 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1514 Defaults to today.
1515
1516 AddIssue does the following things :
1517
1518   - step 01: check that there is a borrowernumber & a barcode provided
1519   - check for RENEWAL (book issued & being issued to the same patron)
1520       - renewal YES = Calculate Charge & renew
1521       - renewal NO  =
1522           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1523           * RESERVE PLACED ?
1524               - fill reserve if reserve to this patron
1525               - cancel reserve or not, otherwise
1526           * RECALL PLACED ?
1527               - fill recall if recall to this patron
1528               - cancel recall or not
1529               - revert recall's waiting status or not
1530           * TRANSFERT PENDING ?
1531               - complete the transfert
1532           * ISSUE THE BOOK
1533
1534 =back
1535
1536 =cut
1537
1538 sub AddIssue {
1539     my ( $patron, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1540
1541     my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1542     my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1543     my $auto_renew = $params && $params->{auto_renew};
1544     my $cancel_recall = $params && $params->{cancel_recall};
1545     my $recall_id = $params && $params->{recall_id};
1546     my $dbh          = C4::Context->dbh;
1547     my $barcodecheck = CheckValidBarcode($barcode);
1548
1549     my $issue;
1550
1551     if ( $datedue && ref $datedue ne 'DateTime' ) {
1552         $datedue = dt_from_string($datedue);
1553     }
1554
1555     # $issuedate defaults to today.
1556     if ( !defined $issuedate ) {
1557         $issuedate = dt_from_string();
1558     }
1559     else {
1560         if ( ref $issuedate ne 'DateTime' ) {
1561             $issuedate = dt_from_string($issuedate);
1562
1563         }
1564     }
1565
1566     # Stop here if the patron or barcode doesn't exist
1567     if ( $patron && $barcode && $barcodecheck ) {
1568         # find which item we issue
1569         my $item_object = Koha::Items->find({ barcode => $barcode })
1570           or return;    # if we don't get an Item, abort.
1571         my $item_unblessed = $item_object->unblessed;
1572
1573         my $branchcode = _GetCircControlBranch( $item_object, $patron );
1574
1575         # get actual issuing if there is one
1576         my $actualissue = $item_object->checkout;
1577
1578         # check if we just renew the issue.
1579         if ( $actualissue and $actualissue->borrowernumber eq $patron->borrowernumber
1580                 and not $switch_onsite_checkout ) {
1581             $datedue = AddRenewal(
1582                 {
1583                     borrowernumber => $patron->borrowernumber,
1584                     itemnumber     => $item_object->itemnumber,
1585                     branch         => $branchcode,
1586                     datedue        => $datedue,
1587                     lastreneweddate =>
1588                       $issuedate,    # here interpreted as the renewal date
1589                 }
1590             );
1591             $issue = $item_object->checkout;
1592         }
1593         else {
1594
1595             unless ($datedue) {
1596                 my $itype = $item_object->effective_itemtype;
1597                 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1598
1599             }
1600
1601             # Check if we need to use an exact due date set by the ILL module
1602             if ( C4::Context->preference('ILLModule') ) {
1603                 # Check if there is an ILL connected with the biblio of the item we are issuing
1604                 my $ill_request = Koha::Illrequests->search({
1605                     biblio_id => $item_object->biblionumber,
1606                     borrowernumber => $patron->borrowernumber,
1607                     completed => undef,
1608                     due_date => { '!=', undef },
1609                 })->next;
1610
1611                 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1612                     my $ill_dt = dt_from_string( $ill_request->due_date );
1613                     $ill_dt->set_hour(23);
1614                     $ill_dt->set_minute(59);
1615                     $datedue = $ill_dt;
1616                 }
1617             }
1618
1619             $datedue->truncate( to => 'minute' );
1620
1621             my $library = Koha::Libraries->find( $branchcode );
1622             my $fees = Koha::Charges::Fees->new(
1623                 {
1624                     patron    => $patron,
1625                     library   => $library,
1626                     item      => $item_object,
1627                     to_date   => $datedue,
1628                 }
1629             );
1630
1631             # it's NOT a renewal
1632             if ( $actualissue and not $switch_onsite_checkout ) {
1633                 # This book is currently on loan, but not to the person
1634                 # who wants to borrow it now. mark it returned before issuing to the new borrower
1635                 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1636                 return unless $allowed;
1637                 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1638                 # AddReturn certainly has side-effects, like onloan => undef
1639                 $item_object->discard_changes;
1640             }
1641
1642             if ( C4::Context->preference('UseRecalls') ) {
1643                 Koha::Recalls->move_recall(
1644                     {
1645                         action         => $cancel_recall,
1646                         recall_id      => $recall_id,
1647                         item           => $item_object,
1648                         borrowernumber => $patron->borrowernumber,
1649                     }
1650                 );
1651             }
1652
1653             C4::Reserves::MoveReserve( $item_object->itemnumber, $patron->borrowernumber, $cancelreserve );
1654
1655             # Starting process for transfer job (checking transfert and validate it if we have one)
1656             if ( my $transfer = $item_object->get_transfer ) {
1657                 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1658                 $transfer->set(
1659                     {
1660                         datearrived => dt_from_string,
1661                         tobranch    => C4::Context->userenv->{branch},
1662                         comments    => 'Forced branchtransfer'
1663                     }
1664                 )->store;
1665                 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1666                     my $hold = $item_object->holds->search( { found => 'T' } )->next;
1667                     if ( $hold ) { # Is this really needed?
1668                         $hold->set( { found => undef } )->store;
1669                         C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1670                     }
1671                 }
1672             }
1673
1674             # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1675             unless ($auto_renew) {
1676                 my $rule = Koha::CirculationRules->get_effective_rule_value(
1677                     {
1678                         categorycode => $patron->categorycode,
1679                         itemtype     => $item_object->effective_itemtype,
1680                         branchcode   => $branchcode,
1681                         rule_name    => 'auto_renew'
1682                     }
1683                 );
1684
1685                 $auto_renew = $rule if defined $rule && $rule ne '';
1686             }
1687
1688             my $issue_attributes = {
1689                 borrowernumber  => $patron->borrowernumber,
1690                 issuedate       => $issuedate,
1691                 date_due        => $datedue,
1692                 branchcode      => C4::Context->userenv->{'branch'},
1693                 onsite_checkout => $onsite_checkout,
1694                 auto_renew      => $auto_renew ? 1 : 0,
1695             };
1696
1697             # Get ID of logged in user.  if called from a batch job,
1698             # no user session exists and C4::Context->userenv() returns
1699             # the scalar '0'. Only do this if the syspref says so
1700             if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1701                 my $userenv = C4::Context->userenv();
1702                 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1703                 if ($usernumber) {
1704                     $issue_attributes->{issuer_id} = $usernumber;
1705                 }
1706             }
1707
1708             # In the case that the borrower has an on-site checkout
1709             # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1710             $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1711             if ($issue) {
1712                 $issue->set($issue_attributes)->store;
1713             }
1714             else {
1715                 $issue = Koha::Checkout->new(
1716                     {
1717                         itemnumber => $item_object->itemnumber,
1718                         %$issue_attributes,
1719                     }
1720                 )->store;
1721             }
1722             $issue->discard_changes;
1723             $patron->update_lastseen('check_out');
1724             if ( $item_object->location && $item_object->location eq 'CART'
1725                 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1726             ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1727                 CartToShelf( $item_object->itemnumber );
1728             }
1729
1730             # Update item location
1731             $item_object->location_update_trigger( 'checkout' );
1732
1733             if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1734                 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1735             }
1736
1737             # Record if item was lost
1738             my $was_lost = $item_object->itemlost;
1739
1740             $item_object->issues( ( $item_object->issues || 0 ) + 1);
1741             $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1742             $item_object->itemlost(0);
1743             $item_object->onloan($datedue->ymd());
1744             $item_object->datelastborrowed( dt_from_string()->ymd() );
1745             $item_object->datelastseen( dt_from_string() );
1746             $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1747
1748             # If the item was lost, it has now been found, charge the overdue if necessary
1749             if ($was_lost) {
1750                 if ( $item_object->{_charge} ) {
1751                     $actualissue //= Koha::Old::Checkouts->search(
1752                         { itemnumber => $item_object->itemnumber },
1753                         {
1754                             order_by => { '-desc' => 'returndate' },
1755                             rows     => 1
1756                         }
1757                     )->single;
1758                     unless ( $patron->branchcode ) {
1759                         $patron = $actualissue->patron;
1760                     }
1761                     _CalculateAndUpdateFine(
1762                         {
1763                             issue       => $actualissue,
1764                             item        => $item_unblessed,
1765                             borrower    => $patron->unblessed,
1766                             return_date => $issuedate
1767                         }
1768                     );
1769                     _FixOverduesOnReturn( $patron->borrowernumber,
1770                         $item_object->itemnumber, undef, 'RENEWED' );
1771                 }
1772             }
1773
1774             # If it costs to borrow this book, charge it to the patron's account.
1775             my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1776             if ( $charge && $charge > 0 ) {
1777                 AddIssuingCharge( $issue, $charge, 'RENT' );
1778             }
1779
1780             my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1781             if ( $itemtype_object ) {
1782                 my $accumulate_charge = $fees->accumulate_rentalcharge();
1783                 if ( $accumulate_charge > 0 ) {
1784                     AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1785                     $charge += $accumulate_charge;
1786                     $item_unblessed->{charge} = $charge;
1787                 }
1788             }
1789
1790             my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckout');
1791             if ($yaml) {
1792                 $yaml = "$yaml\n\n";
1793
1794                 my $rules;
1795                 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
1796                 if ($@) {
1797                     warn "Unable to parse UpdateNotForLoanStatusOnCheckout syspref : $@";
1798                 }
1799                 else {
1800                     foreach my $key ( keys %$rules ) {
1801                         if ( $item_object->notforloan eq $key ) {
1802                             $item_object->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
1803                             last;
1804                         }
1805                     }
1806                 }
1807             }
1808
1809             # Record the fact that this book was issued.
1810             C4::Stats::UpdateStats(
1811                 {
1812                     branch => C4::Context->userenv->{'branch'},
1813                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1814                     amount         => $charge,
1815                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1816                     itemnumber     => $item_object->itemnumber,
1817                     itemtype       => $item_object->effective_itemtype,
1818                     location       => $item_object->location,
1819                     borrowernumber => $patron->borrowernumber,
1820                     ccode          => $item_object->ccode,
1821                     categorycode   => $patron->categorycode
1822                 }
1823             );
1824
1825             # Send a checkout slip.
1826             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1827             my %conditions        = (
1828                 branchcode   => $branchcode,
1829                 categorycode => $patron->categorycode,
1830                 item_type    => $item_object->effective_itemtype,
1831                 notification => 'CHECKOUT',
1832             );
1833             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1834                 SendCirculationAlert(
1835                     {
1836                         type     => 'CHECKOUT',
1837                         item     => $item_object->unblessed,
1838                         borrower => $patron->unblessed,
1839                         branch   => $branchcode,
1840                     }
1841                 );
1842             }
1843             logaction(
1844                 "CIRCULATION", "ISSUE",
1845                 $patron->borrowernumber,
1846                 $item_object->itemnumber,
1847             ) if C4::Context->preference("IssueLog");
1848
1849             Koha::Plugins->call('after_circ_action', {
1850                 action  => 'checkout',
1851                 payload => {
1852                     type     => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1853                     checkout => $issue->get_from_storage
1854                 }
1855             });
1856
1857             Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1858                 {
1859                     biblio_ids => [ $item_object->biblionumber ]
1860                 }
1861             ) if C4::Context->preference('RealTimeHoldsQueue');
1862         }
1863     }
1864     return $issue;
1865 }
1866
1867 =head2 GetLoanLength
1868
1869   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1870
1871 Get loan length for an itemtype, a borrower type and a branch
1872
1873 =cut
1874
1875 sub GetLoanLength {
1876     my ( $categorycode, $itemtype, $branchcode ) = @_;
1877
1878     # Initialize default values
1879     my $rules = {
1880         issuelength   => 0,
1881         renewalperiod => 0,
1882         lengthunit    => 'days',
1883     };
1884
1885     my $found = Koha::CirculationRules->get_effective_rules( {
1886         branchcode => $branchcode,
1887         categorycode => $categorycode,
1888         itemtype => $itemtype,
1889         rules => [
1890             'issuelength',
1891             'renewalperiod',
1892             'lengthunit'
1893         ],
1894     } );
1895
1896     # Search for rules!
1897     foreach my $rule_name (keys %$found) {
1898         $rules->{$rule_name} = $found->{$rule_name};
1899     }
1900
1901     return $rules;
1902 }
1903
1904
1905 =head2 GetHardDueDate
1906
1907   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1908
1909 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1910
1911 =cut
1912
1913 sub GetHardDueDate {
1914     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1915
1916     my $rules = Koha::CirculationRules->get_effective_rules(
1917         {
1918             categorycode => $borrowertype,
1919             itemtype     => $itemtype,
1920             branchcode   => $branchcode,
1921             rules        => [ 'hardduedate', 'hardduedatecompare' ],
1922         }
1923     );
1924
1925     if ( defined( $rules->{hardduedate} ) ) {
1926         if ( $rules->{hardduedate} ) {
1927             return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1928         }
1929         else {
1930             return ( undef, undef );
1931         }
1932     }
1933 }
1934
1935 =head2 GetBranchBorrowerCircRule
1936
1937   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1938
1939 Retrieves circulation rule attributes that apply to the given
1940 branch and patron category, regardless of item type.
1941 The return value is a hashref containing the following key:
1942
1943 patron_maxissueqty - maximum number of loans that a
1944 patron of the given category can have at the given
1945 branch.  If the value is undef, no limit.
1946
1947 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1948 patron of the given category can have at the given
1949 branch.  If the value is undef, no limit.
1950
1951 This will check for different branch/category combinations in the following order:
1952 branch and category
1953 branch only
1954 category only
1955 default branch and category
1956
1957 If no rule has been found in the database, it will default to
1958 the buillt in rule:
1959
1960 patron_maxissueqty - undef
1961 patron_maxonsiteissueqty - undef
1962
1963 C<$branchcode> and C<$categorycode> should contain the
1964 literal branch code and patron category code, respectively - no
1965 wildcards.
1966
1967 =cut
1968
1969 sub GetBranchBorrowerCircRule {
1970     my ( $branchcode, $categorycode ) = @_;
1971
1972     # Initialize default values
1973     my $rules = {
1974         patron_maxissueqty       => undef,
1975         patron_maxonsiteissueqty => undef,
1976     };
1977
1978     # Search for rules!
1979     foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1980         my $rule = Koha::CirculationRules->get_effective_rule(
1981             {
1982                 categorycode => $categorycode,
1983                 itemtype     => undef,
1984                 branchcode   => $branchcode,
1985                 rule_name    => $rule_name,
1986             }
1987         );
1988
1989         $rules->{$rule_name} = $rule->rule_value if defined $rule;
1990     }
1991
1992     return $rules;
1993 }
1994
1995 =head2 GetBranchItemRule
1996
1997   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1998
1999 Retrieves circulation rule attributes that apply to the given
2000 branch and item type, regardless of patron category.
2001
2002 The return value is a hashref containing the following keys:
2003
2004 holdallowed => Hold policy for this branch and itemtype. Possible values:
2005   not_allowed:           No holds allowed.
2006   from_home_library:     Holds allowed only by patrons that have the same homebranch as the item.
2007   from_any_library:      Holds allowed from any patron.
2008   from_local_hold_group: Holds allowed from libraries in hold group
2009
2010 This searches branchitemrules in the following order:
2011
2012   * Same branchcode and itemtype
2013   * Same branchcode, itemtype '*'
2014   * branchcode '*', same itemtype
2015   * branchcode and itemtype '*'
2016
2017 Neither C<$branchcode> nor C<$itemtype> should be '*'.
2018
2019 =cut
2020
2021 sub GetBranchItemRule {
2022     my ( $branchcode, $itemtype ) = @_;
2023
2024     # Search for rules!
2025     my $rules = Koha::CirculationRules->get_effective_rules({
2026         branchcode => $branchcode,
2027         itemtype => $itemtype,
2028         rules => ['holdallowed', 'hold_fulfillment_policy']
2029     });
2030
2031     # built-in default circulation rule
2032     $rules->{holdallowed} //= 'from_any_library';
2033     $rules->{hold_fulfillment_policy} //= 'any';
2034
2035     return $rules;
2036 }
2037
2038 =head2 AddReturn
2039
2040   ($doreturn, $messages, $iteminformation, $borrower) =
2041       &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
2042
2043 Returns a book.
2044
2045 =over 4
2046
2047 =item C<$barcode> is the bar code of the book being returned.
2048
2049 =item C<$branch> is the code of the branch where the book is being returned.
2050
2051 =item C<$exemptfine> indicates that overdue charges for the item will be
2052 removed. Optional.
2053
2054 =item C<$return_date> allows the default return date to be overridden
2055 by the given return date. Optional.
2056
2057 =back
2058
2059 C<&AddReturn> returns a list of four items:
2060
2061 C<$doreturn> is true iff the return succeeded.
2062
2063 C<$messages> is a reference-to-hash giving feedback on the operation.
2064 The keys of the hash are:
2065
2066 =over 4
2067
2068 =item C<BadBarcode>
2069
2070 No item with this barcode exists. The value is C<$barcode>.
2071
2072 =item C<NotIssued>
2073
2074 The book is not currently on loan. The value is C<$barcode>.
2075
2076 =item C<withdrawn>
2077
2078 This book has been withdrawn/cancelled. The value should be ignored.
2079
2080 =item C<Wrongbranch>
2081
2082 This book has was returned to the wrong branch.  The value is a hashref
2083 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2084 contain the branchcode of the incorrect and correct return library, respectively.
2085
2086 =item C<ResFound>
2087
2088 The item was reserved. The value is a reference-to-hash whose keys are
2089 fields from the reserves table of the Koha database, and
2090 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2091 either C<Waiting>, C<Reserved>, or 0.
2092
2093 =item C<WasReturned>
2094
2095 Value 1 if return is successful.
2096
2097 =item C<NeedsTransfer>
2098
2099 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2100
2101 =item C<RecallFound>
2102
2103 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2104 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2105 branchcode.
2106
2107 =item C<TransferredRecall>
2108
2109 This item has been transferred to this branch to fill a recall. The recall object is returned.
2110
2111 =back
2112
2113 C<$iteminformation> is a reference-to-hash, giving information about the
2114 returned item from the issues table.
2115
2116 C<$borrower> is a reference-to-hash, giving information about the
2117 patron who last borrowed the book.
2118
2119 =cut
2120
2121 sub AddReturn {
2122     my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
2123
2124     if ($branch and not Koha::Libraries->find($branch)) {
2125         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
2126         undef $branch;
2127     }
2128     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
2129     my $return_date_specified = !!$return_date;
2130     $return_date //= dt_from_string();
2131     my $messages;
2132     my $patron;
2133     my $doreturn       = 1;
2134     my $validTransfer = 1;
2135     my $stat_type = 'return';
2136
2137     # get information on item
2138     my $item = Koha::Items->find({ barcode => $barcode });
2139     unless ($item) {
2140         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
2141     }
2142
2143     my $itemnumber = $item->itemnumber;
2144     my $itemtype = $item->effective_itemtype;
2145
2146     my $issue  = $item->checkout;
2147     if ( $issue ) {
2148         $patron = $issue->patron
2149             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2150                 . Dumper($issue->unblessed) . "\n";
2151     } else {
2152         $messages->{'NotIssued'} = $barcode;
2153         $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2154
2155         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
2156         $doreturn = 0;
2157         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
2158         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2159         if (C4::Context->preference("RecordLocalUseOnReturn")) {
2160            $messages->{'LocalUse'} = 1;
2161            $stat_type = 'localuse';
2162         }
2163     }
2164
2165     if ( $item->withdrawn ) { # book has been cancelled
2166         $messages->{'withdrawn'} = 1;
2167
2168         # In the case where we block return of withdrawn, we should completely block the return
2169         # without updating item statuses, so we exit early
2170         return ( 0, $messages, $issue, ( $patron ? $patron->unblessed : {} ))
2171             if C4::Context->preference("BlockReturnOfWithdrawnItems");
2172     }
2173
2174
2175     # full item data, but no borrowernumber or checkout info (no issue)
2176     my $hbr = Koha::CirculationRules->get_return_branch_policy($item);
2177
2178     # check if returnbranch and homebranch belong to the same float group
2179     my $validate_float =
2180         Koha::Libraries->find( $item->homebranch )->validate_float_sibling( { branchcode => $branch } );
2181
2182     # get the proper branch to which to return the item
2183     my $returnbranch;
2184     if ( $hbr eq 'noreturn' ) {
2185         $returnbranch = $branch;
2186     } elsif ( $hbr eq 'returnbylibrarygroup' ) {
2187
2188         # if library isn't in same the float group, transfer item to homebranch
2189         $hbr          = 'homebranch';
2190         $returnbranch = $validate_float ? $branch : $item->$hbr;
2191     } else {
2192         $returnbranch = $item->$hbr;
2193     }
2194
2195     # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2196     my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2197
2198     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
2199     my $patron_unblessed = $patron ? $patron->unblessed : {};
2200
2201     # Update item location
2202     my $loc_messages = $item->location_update_trigger( 'checkin' );
2203     foreach my $loc_msg_key ( keys %$loc_messages ) {
2204         $messages->{ $loc_msg_key } = $loc_messages->{ $loc_msg_key };
2205     }
2206
2207     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2208     if ($yaml) {
2209         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
2210         my $rules;
2211         eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2212         if ($@) {
2213             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2214         }
2215         else {
2216             if ( defined $rules->{$item->itype} ) {
2217                 foreach my $notloan_rule_key (keys %{ $rules->{$item->itype}} ) {
2218                     if ( $item->notforloan eq $notloan_rule_key ) {
2219                         $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$item->itype}->{$notloan_rule_key} };
2220                         $item->notforloan($rules->{$item->itype}->{$notloan_rule_key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2221                         last;
2222                     }
2223                 }
2224             } elsif ( defined $rules->{'_ALL_'} ) {
2225                 foreach my $notloan_rule_key (keys %{ $rules->{'_ALL_'}} ) {
2226                     if ( $item->notforloan eq $notloan_rule_key ) {
2227                         $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{'_ALL_'}->{$notloan_rule_key} };
2228                         $item->notforloan($rules->{'_ALL_'}->{$notloan_rule_key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2229                         last;
2230                     }
2231                 }
2232             }
2233         }
2234     }
2235
2236     # check if the return is allowed at this branch
2237     my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2238     unless ($returnallowed){
2239         $messages->{'Wrongbranch'} = {
2240             Wrongbranch => $branch,
2241             Rightbranch => $message
2242         };
2243         $doreturn = 0;
2244         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2245         $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2246         return ( $doreturn, $messages, $issue, $patron_unblessed);
2247     }
2248
2249     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2250         $doreturn = 0;
2251     }
2252
2253     # case of a return of document (deal with issues and holdingbranch)
2254     if ($doreturn) {
2255         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2256         $patron or warn "AddReturn without current borrower";
2257
2258         if ($patron) {
2259             eval {
2260                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2261             };
2262             unless ( $@ ) {
2263                 if (
2264                     (
2265                         C4::Context->preference('CalculateFinesOnReturn')
2266                         || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2267                     )
2268                     && !$item->itemlost
2269                   )
2270                 {
2271                     _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2272                 }
2273             } else {
2274                 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 );
2275
2276                 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2277                 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2278
2279                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2280             }
2281
2282             # FIXME is the "= 1" right?  This could be the borrower hash.
2283             $messages->{'WasReturned'} = 1;
2284
2285         } else {
2286             $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2287         }
2288     }
2289
2290     # the holdingbranch is updated if the document is returned to another location.
2291     # this is always done regardless of whether the item was on loan or not
2292     if ($item->holdingbranch ne $branch) {
2293         $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2294     }
2295
2296     my $item_was_lost = $item->itemlost;
2297     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2298     my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2299
2300     # fix up the accounts.....
2301     if ($item_was_lost) {
2302         $messages->{'WasLost'} = 1;
2303         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2304             my @object_messages = @{ $updated_item->object_messages };
2305             for my $message (@object_messages) {
2306                 $messages->{'LostItemFeeRefunded'} = 1
2307                   if $message->message eq 'lost_refunded';
2308                 $messages->{'ProcessingFeeRefunded'} = 1
2309                   if $message->message eq 'processing_refunded';
2310                 $messages->{'LostItemFeeRestored'} = 1
2311                   if $message->message eq 'lost_restored';
2312
2313                 if ( $message->message eq 'lost_charge' ) {
2314                     $issue //= Koha::Old::Checkouts->search(
2315                         { itemnumber => $item->itemnumber },
2316                         { order_by   => { '-desc' => 'returndate' }, rows => 1 }
2317                     )->single;
2318                     unless ( exists( $patron_unblessed->{branchcode} ) ) {
2319                         my $patron = $issue->patron;
2320                         $patron_unblessed = $patron->unblessed;
2321                     }
2322                     _CalculateAndUpdateFine(
2323                         {
2324                             issue       => $issue,
2325                             item        => $item->unblessed,
2326                             borrower    => $patron_unblessed,
2327                             return_date => $return_date
2328                         }
2329                     );
2330                     _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2331                         $item->itemnumber, undef, 'RETURNED' );
2332                     $messages->{'LostItemFeeCharged'} = 1;
2333                 }
2334             }
2335         }
2336     }
2337
2338     # check if we have a transfer for this document
2339     my $transfer = $item->get_transfer;
2340
2341     # if we have a transfer to complete, we update the line of transfers with the datearrived
2342     if ($transfer) {
2343         $validTransfer = 0;
2344         if ( $transfer->in_transit ) {
2345             if ( $transfer->tobranch eq $branch ) {
2346                 $transfer->receive;
2347                 $messages->{'TransferArrived'} = $transfer->frombranch;
2348                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2349                 $validTransfer = 1
2350                   if defined $transfer->reason && $transfer->reason eq 'Reserve';
2351             }
2352             else {
2353                 $messages->{'WrongTransfer'}     = $transfer->tobranch;
2354                 $messages->{'WrongTransferItem'} = $item->itemnumber;
2355                 $messages->{'TransferTrigger'}   = $transfer->reason;
2356             }
2357         }
2358         else {
2359             if ( $transfer->tobranch eq $branch ) {
2360                 $transfer->receive;
2361                 $messages->{'TransferArrived'} = $transfer->frombranch;
2362                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2363                 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2364             }
2365             else {
2366                 $messages->{'TransferTrigger'} = $transfer->reason;
2367                 if ( $transfer->frombranch eq $branch ) {
2368                     $transfer->transit;
2369                     $messages->{'WasTransfered'}   = $transfer->tobranch;
2370                 }
2371                 else {
2372                     $messages->{'WrongTransfer'}     = $transfer->tobranch;
2373                     $messages->{'WrongTransferItem'} = $item->itemnumber;
2374                 }
2375             }
2376         }
2377     }
2378
2379     # fix up the overdues in accounts...
2380     if ($borrowernumber) {
2381         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2382         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!";  # zero is OK, check defined
2383
2384         if ( $issue and $issue->is_overdue($return_date) ) {
2385         # fix fine days
2386             my ($debardate,$reminder) = _debar_user_on_return( $patron, $item, dt_from_string($issue->date_due), $return_date );
2387             if ($debardate and $debardate ne "9999-12-31") {
2388                 if ($reminder){
2389                     $messages->{'PrevDebarred'} = $debardate;
2390                 } else {
2391                     $messages->{'Debarred'} = $debardate;
2392                 }
2393             } elsif ($patron->debarred) {
2394                 if ( $patron->debarred eq "9999-12-31") {
2395                     $messages->{'ForeverDebarred'} = $patron->debarred;
2396                 } else {
2397                     my $borrower_debar_dt = dt_from_string( $patron->debarred );
2398                     $borrower_debar_dt->truncate(to => 'day');
2399                     my $today_dt = $return_date->clone()->truncate(to => 'day');
2400                     if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2401                         $messages->{'PrevDebarred'} = $patron->debarred;
2402                     }
2403                 }
2404             }
2405         # there's no overdue on the item but borrower had been previously debarred
2406         } elsif ( $issue->date_due and $patron->debarred ) {
2407              if ( $patron->debarred eq "9999-12-31") {
2408                 $messages->{'ForeverDebarred'} = $patron->debarred;
2409              } else {
2410                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2411                   $borrower_debar_dt->truncate(to => 'day');
2412                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2413                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2414                       $messages->{'PrevDebarred'} = $patron->debarred;
2415                   }
2416              }
2417         }
2418     }
2419
2420     # find recalls...
2421     if ( C4::Context->preference('UseRecalls') ) {
2422         # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2423         my $recall = undef;
2424         $recall = $item->check_recalls if $item->can_be_waiting_recall;
2425         if ( defined $recall ) {
2426             $messages->{RecallFound} = $recall;
2427             if ( $recall->pickup_library_id ne $branch ) {
2428                 $messages->{RecallNeedsTransfer} = $branch;
2429             }
2430         }
2431     }
2432
2433     # find reserves.....
2434     # launch the Checkreserves routine to find any holds
2435     my ($resfound, $resrec);
2436     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2437     ($resfound, $resrec, undef) = CheckReserves( $item, $lookahead ) unless ( $item->withdrawn );
2438     # 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)
2439     if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2440         my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2441         $resfound = 'Reserved';
2442         $resrec = $hold->unblessed;
2443     }
2444     if ($resfound) {
2445           $resrec->{'ResFound'} = $resfound;
2446         $messages->{'ResFound'} = $resrec;
2447     }
2448
2449     # Record the fact that this book was returned.
2450     my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2451     C4::Stats::UpdateStats({
2452         branch         => $branch,
2453         type           => $stat_type,
2454         itemnumber     => $itemnumber,
2455         itemtype       => $itemtype,
2456         location       => $item->location,
2457         borrowernumber => $borrowernumber,
2458         ccode          => $item->ccode,
2459         categorycode   => $categorycode,
2460         interface      => C4::Context->interface,
2461     });
2462
2463     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2464     if ( $patron ) {
2465         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2466         my %conditions = (
2467             branchcode   => $branch,
2468             categorycode => $patron->categorycode,
2469             item_type    => $itemtype,
2470             notification => 'CHECKIN',
2471         );
2472         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2473             SendCirculationAlert({
2474                 type     => 'CHECKIN',
2475                 item     => $item->unblessed,
2476                 borrower => $patron->unblessed,
2477                 branch   => $branch,
2478                 issue    => $issue
2479             });
2480         }
2481
2482         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2483             if C4::Context->preference("ReturnLog");
2484
2485         #Update borrowers.lastseen
2486         $patron->update_lastseen('check_in');
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, $cron);
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<$cron> true or false, specifies if this check is being made
2947 by the automatic_renewals.pl cronscript
2948
2949 C<$override_limit>, if supplied with a true value, causes
2950 the limit on the number of times that the loan can be renewed
2951 (as controlled by the item type) to be ignored. Overriding also allows
2952 to renew sooner than "No renewal before" and to manually renew loans
2953 that are automatically renewed.
2954
2955 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2956 item must currently be on loan to the specified borrower; renewals
2957 must be allowed for the item's type; and the borrower must not have
2958 already renewed the loan.
2959     $error will contain the reason the renewal can not proceed
2960     $info will contain a hash of additional info
2961       currently 'soonest_renew_date' if error is 'too soon'
2962
2963 =cut
2964
2965 sub CanBookBeRenewed {
2966     my ( $patron, $issue, $override_limit, $cron ) = @_;
2967
2968     my $auto_renew = "no";
2969     my $soonest;
2970     my $item = $issue->item;
2971
2972     return ( 0, 'no_item' ) unless $item;
2973     return ( 0, 'no_checkout' ) unless $issue;
2974     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2975     return ( 0, 'item_issued_to_other_patron') if $issue->borrowernumber != $patron->borrowernumber;
2976     return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2977
2978     my $final_renewal        = 0;
2979     my $final_unseen_renewal = 0;
2980
2981     # override_limit will override anything else except on_reserve
2982     unless ( $override_limit ){
2983         my $branchcode = _GetCircControlBranch( $item, $patron );
2984         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2985             {
2986                 categorycode => $patron->categorycode,
2987                 itemtype     => $item->effective_itemtype,
2988                 branchcode   => $branchcode,
2989                 rules => [
2990                     'renewalsallowed',
2991                     'lengthunit',
2992                     'unseen_renewals_allowed'
2993                 ]
2994             }
2995         );
2996
2997         return ( 0, "too_many" )
2998           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2999
3000         return ( 0, "too_unseen" )
3001           if C4::Context->preference('UnseenRenewals') &&
3002             looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
3003             $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
3004
3005         $final_renewal        = $issuing_rule->{renewalsallowed} == ( $issue->renewals_count + 1 ) ? 1 : 0;
3006         $final_unseen_renewal = ( C4::Context->preference('UnseenRenewals')
3007                 && $issuing_rule->{unseen_renewals_allowed} == ( $issue->unseen_renewals + 1 ) ) ? 1 : 0;
3008
3009         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
3010         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
3011         my $restricted  = $patron->is_debarred;
3012         my $hasoverdues = $patron->has_overdues;
3013
3014         if ( $restricted and $restrictionblockrenewing ) {
3015             return ( 0, 'restriction');
3016         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
3017             return ( 0, 'overdue');
3018         }
3019
3020         ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
3021             patron     => $patron,
3022             item       => $item,
3023             branchcode => $branchcode,
3024             issue      => $issue
3025         });
3026         return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
3027         # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
3028         # extra notices being sent. Cron also implies no override
3029         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_account_expired';
3030         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_late';
3031         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_much_oweing';
3032     }
3033
3034     if ( C4::Context->preference('UseRecalls') ) {
3035         my $recall = undef;
3036         $recall = $item->check_recalls if $item->can_be_waiting_recall;
3037         if ( defined $recall ) {
3038             if ( $recall->item_level ) {
3039                 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
3040                 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
3041             } else {
3042                 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
3043                 return ( 0, 'recalled' ) unless ( $recall->waiting );
3044             }
3045         }
3046     }
3047
3048     # There is an item level hold on this item, no other item can fill the hold
3049     return ( 0, "on_reserve" )
3050       if ( $item->current_holds->search( { non_priority => 0 } )->count );
3051
3052     my $fillable_holds = Koha::Holds->search(
3053         {
3054             biblionumber => $item->biblionumber,
3055             non_priority => 0,
3056             found        => undef,
3057             reservedate  => { '<=' => \'NOW()' },
3058             suspend      => 0
3059         }
3060     );
3061     if ( $fillable_holds->count ) {
3062         if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
3063             my @possible_holds = $fillable_holds->as_list;
3064
3065             # Get all other items that could possibly fill reserves
3066             # FIXME We could join reserves (or more tables) here to eliminate some checks later
3067             my @other_items = Koha::Items->search({
3068                 biblionumber => $item->biblionumber,
3069                 onloan       => undef,
3070                 notforloan   => 0,
3071                 -not         => { itemnumber => $item->itemnumber } })->as_list;
3072
3073             return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
3074
3075             my %matched_items;
3076             foreach my $possible_hold (@possible_holds) {
3077                 my $fillable = 0;
3078                 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
3079
3080                 # FIXME: We are not checking whether the item we are renewing can fill the hold
3081
3082                 foreach my $other_item (@other_items) {
3083                   next if defined $matched_items{$other_item->itemnumber};
3084                   next if IsItemOnHoldAndFound( $other_item->itemnumber );
3085                   next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef);
3086                   next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3087                   # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3088                   # CanItemBeReserved checks 'rules' and 'policies' which means
3089                   # items will fill holds at checkin that are rejected here
3090                   $fillable = 1;
3091                   $matched_items{$other_item->itemnumber} = 1;
3092                   last;
3093                 }
3094                 return ( 0, "on_reserve" ) unless $fillable;
3095             }
3096         }
3097         else {
3098             my ($status, $matched_reserve, $possible_reserves) = CheckReserves($item);
3099             return ( 0, "on_reserve" ) if $status;
3100         }
3101     }
3102
3103     if ( $auto_renew eq 'auto_too_soon' ) {
3104
3105         # If its cron, tell it it's too soon for a an auto renewal
3106         return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $cron;
3107
3108         # Check if it's too soon for a manual renewal
3109         my $soonestManual = GetSoonestRenewDate( $patron, $issue );
3110         if ( $soonestManual > dt_from_string() ) {
3111             return ( 0, "too_soon", { soonest_renew_date => $soonestManual } ) unless $override_limit;
3112         }
3113     }
3114
3115     $soonest = GetSoonestRenewDate($patron, $issue);
3116     if ( $soonest > dt_from_string() ){
3117         return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3118     }
3119
3120     my $auto_renew_code = $final_renewal ? 'auto_renew_final' : $final_unseen_renewal ? 'auto_unseen_final' : 'auto_renew';
3121     return ( 1, $auto_renew_code ) if $auto_renew eq "ok" || $auto_renew eq "auto_too_soon" && !$override_limit;
3122
3123     return ( 1, undef );
3124 }
3125
3126 =head2 AddRenewal
3127
3128   $new_date_due = AddRenewal({
3129       borrowernumber   => $borrowernumber,
3130       itemnumber       => $itemnumber,
3131       branch           => $branch,
3132       [datedue         => $datedue],
3133       [lastreneweddate => $lastreneweddate],
3134       [skipfinecalc    => $skipfinecalc],
3135       [seen            => $seen],
3136       [automatic       => $automatic],
3137       [skip_record_index => $skip_record_index]
3138   });
3139
3140 Renews a loan, returns the updated due date upon success.
3141
3142 C<$borrowernumber> is the borrower number of the patron who currently
3143 has the item.
3144
3145 C<$itemnumber> is the number of the item to renew.
3146
3147 C<$branch> is the library where the renewal took place (if any).
3148            The library that controls the circ policies for the renewal is retrieved from the issues record.
3149
3150 C<$datedue> can be a DateTime object used to set the due date.
3151
3152 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
3153 this parameter is not supplied, lastreneweddate is set to the current date.
3154
3155 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3156 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3157 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3158 syspref)
3159
3160 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3161 from the book's item type.
3162
3163 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3164 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3165 fallback to a true value
3166
3167 C<$automatic> is a boolean flag indicating the renewal was triggered automatically and not by a person ( librarian or patron )
3168
3169 C<$skip_record_index> is an optional boolean flag to indicate whether queuing the search indexing
3170 should be skipped for this renewal.
3171
3172 =cut
3173
3174 sub AddRenewal {
3175     my $params = shift;
3176
3177     my $borrowernumber  = $params->{borrowernumber};
3178     my $itemnumber      = $params->{itemnumber};
3179     return unless $itemnumber;
3180
3181     my $branch            = $params->{branch};
3182     my $datedue           = $params->{datedue};
3183     my $lastreneweddate   = $params->{lastreneweddate} // dt_from_string();
3184     my $skipfinecalc      = $params->{skipfinecalc};
3185     my $seen              = $params->{seen};
3186     my $automatic         = $params->{automatic};
3187     my $skip_record_index = $params->{skip_record_index};
3188
3189     # Fallback on a 'seen' renewal
3190     $seen = defined $seen && $seen == 0 ? 0 : 1;
3191
3192     my $item_object   = Koha::Items->find($itemnumber) or return;
3193     my $biblio = $item_object->biblio;
3194     my $issue  = $item_object->checkout;
3195     my $item_unblessed = $item_object->unblessed;
3196
3197     my $renewal_type = $automatic ? "Automatic" : "Manual";
3198
3199     my $dbh = C4::Context->dbh;
3200
3201     return unless $issue;
3202
3203     $borrowernumber ||= $issue->borrowernumber;
3204
3205     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3206         $datedue = dt_from_string($datedue, 'sql');
3207     }
3208
3209     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3210     my $patron_unblessed = $patron->unblessed;
3211
3212     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
3213
3214     my $schema = Koha::Database->schema;
3215     $schema->txn_do(sub{
3216
3217         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3218             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3219         }
3220         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3221
3222         # If the due date wasn't specified, calculate it by adding the
3223         # book's loan length to today's date or the current due date
3224         # based on the value of the RenewalPeriodBase syspref.
3225         my $itemtype = $item_object->effective_itemtype;
3226         unless ($datedue) {
3227
3228             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3229                                             dt_from_string( $issue->date_due, 'sql' ) :
3230                                             dt_from_string();
3231             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron, 'is a renewal');
3232         }
3233
3234         my $fees = Koha::Charges::Fees->new(
3235             {
3236                 patron    => $patron,
3237                 library   => $circ_library,
3238                 item      => $item_object,
3239                 from_date => dt_from_string( $issue->date_due, 'sql' ),
3240                 to_date   => dt_from_string($datedue),
3241             }
3242         );
3243
3244         # Increment the unseen renewals, if appropriate
3245         # We only do so if the syspref is enabled and
3246         # a maximum value has been set in the circ rules
3247         my $unseen_renewals = $issue->unseen_renewals;
3248         if (C4::Context->preference('UnseenRenewals')) {
3249             my $rule = Koha::CirculationRules->get_effective_rule(
3250                 {   categorycode => $patron->categorycode,
3251                     itemtype     => $item_object->effective_itemtype,
3252                     branchcode   => $circ_library->branchcode,
3253                     rule_name    => 'unseen_renewals_allowed'
3254                 }
3255             );
3256             if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3257                 $unseen_renewals++;
3258             } else {
3259                 # If the renewal is seen, unseen should revert to 0
3260                 $unseen_renewals = 0;
3261             }
3262         }
3263
3264         # Update the issues record to have the new due date, and a new count
3265         # of how many times it has been renewed.
3266         my $renews = ( $issue->renewals_count || 0 ) + 1;
3267         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3268
3269         eval{
3270             $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3271         };
3272         if( $sth->err ){
3273             Koha::Exceptions::Checkout::FailedRenewal->throw(
3274                 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3275             );
3276         }
3277
3278         # Update the renewal count on the item, and tell zebra to reindex
3279         $renews = ( $item_object->renewals || 0 ) + 1;
3280         $item_object->renewals($renews);
3281         $item_object->onloan($datedue);
3282         # Don't index as we are in a transaction, skip hardcoded here
3283         $item_object->store({ log_action => 0, skip_record_index => 1 });
3284
3285         # Charge a new rental fee, if applicable
3286         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3287         if ( $charge > 0 ) {
3288             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3289         }
3290
3291         # Charge a new accumulate rental fee, if applicable
3292         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3293         if ( $itemtype_object ) {
3294             my $accumulate_charge = $fees->accumulate_rentalcharge();
3295             if ( $accumulate_charge > 0 ) {
3296                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3297             }
3298             $charge += $accumulate_charge;
3299         }
3300
3301         # Send a renewal slip according to checkout alert preferencei
3302         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3303             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3304             my %conditions        = (
3305                 branchcode   => $branch,
3306                 categorycode => $patron->categorycode,
3307                 item_type    => $itemtype,
3308                 notification => 'CHECKOUT',
3309             );
3310             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3311                 SendCirculationAlert(
3312                     {
3313                         type     => 'RENEWAL',
3314                         item     => $item_unblessed,
3315                         borrower => $patron->unblessed,
3316                         branch   => $branch,
3317                     }
3318                 );
3319             }
3320         }
3321
3322         # Remove any OVERDUES related debarment if the borrower has no overdues
3323         my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
3324         if ( $patron
3325           && $patron->is_debarred
3326           && ! $patron->has_overdues
3327           && $overdue_restrictions->count
3328         ) {
3329             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3330         }
3331
3332         # Add renewal record
3333         my $renewal = Koha::Checkouts::Renewal->new(
3334             {
3335                 checkout_id  => $issue->issue_id,
3336                 interface    => C4::Context->interface,
3337                 renewal_type => $renewal_type,
3338                 renewer_id   => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3339                 seen         => $seen,
3340             }
3341         )->store();
3342
3343         # Add the renewal to stats
3344         C4::Stats::UpdateStats(
3345             {
3346                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3347                 type           => 'renew',
3348                 amount         => $charge,
3349                 itemnumber     => $itemnumber,
3350                 itemtype       => $itemtype,
3351                 location       => $item_object->location,
3352                 borrowernumber => $borrowernumber,
3353                 ccode          => $item_object->ccode,
3354                 categorycode   => $patron->categorycode,
3355                 interface      => C4::Context->interface,
3356             }
3357         );
3358         #Update borrowers.lastseen
3359         $patron->update_lastseen('renewal');
3360
3361         #Log the renewal
3362         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3363
3364         Koha::Plugins->call('after_circ_action', {
3365             action  => 'renewal',
3366             payload => {
3367                 checkout  => $issue->get_from_storage
3368             }
3369         });
3370     });
3371
3372     unless( $skip_record_index ){
3373         # We index now, after the transaction is committed
3374         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
3375         $indexer->index_records( $item_object->biblionumber, "specialUpdate", "biblioserver" );
3376     }
3377
3378     return $datedue;
3379 }
3380
3381 sub GetRenewCount {
3382     # check renewal status
3383     my ( $borrowernumber_or_patron, $itemnumber_or_item ) = @_;
3384
3385     my $dbh           = C4::Context->dbh;
3386     my $renewcount    = 0;
3387     my $unseencount    = 0;
3388     my $renewsallowed = 0;
3389     my $unseenallowed = 0;
3390     my $renewsleft    = 0;
3391     my $unseenleft    = 0;
3392     my $patron = blessed $borrowernumber_or_patron ?
3393         $borrowernumber_or_patron : Koha::Patrons->find($borrowernumber_or_patron);
3394     my $item = blessed $itemnumber_or_item ?
3395         $itemnumber_or_item : Koha::Items->find($itemnumber_or_item);
3396
3397     return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3398
3399     # Look in the issues table for this item, lent to this borrower,
3400     # and not yet returned.
3401
3402     # FIXME - I think this function could be redone to use only one SQL call.
3403     my $sth = $dbh->prepare(q{
3404         SELECT * FROM issues
3405         WHERE  (borrowernumber = ?) AND (itemnumber = ?)
3406     });
3407     $sth->execute( $patron->borrowernumber, $item->itemnumber );
3408     my $data = $sth->fetchrow_hashref;
3409     $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3410     $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3411     # $item and $borrower should be calculated
3412     my $branchcode = _GetCircControlBranch($item, $patron);
3413
3414     my $rules = Koha::CirculationRules->get_effective_rules(
3415         {
3416             categorycode => $patron->categorycode,
3417             itemtype     => $item->effective_itemtype,
3418             branchcode   => $branchcode,
3419             rules        => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3420         }
3421     );
3422     $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3423     $unseenallowed = $rules->{unseen_renewals_allowed} ?
3424         $rules->{unseen_renewals_allowed} :
3425         0;
3426     $renewsleft    = $renewsallowed - $renewcount;
3427     $unseenleft    = $unseenallowed - $unseencount;
3428     if($renewsleft < 0){ $renewsleft = 0; }
3429     if($unseenleft < 0){ $unseenleft = 0; }
3430     return (
3431         $renewcount,
3432         $renewsallowed,
3433         $renewsleft,
3434         $unseencount,
3435         $unseenallowed,
3436         $unseenleft
3437     );
3438 }
3439
3440 =head2 GetSoonestRenewDate
3441
3442   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($patron, $issue);
3443
3444 Find out the soonest possible renew date of a borrowed item.
3445
3446 C<$patron> is the patron who currently has the item on loan.
3447
3448 C<$issue> is the the item issue.
3449
3450 C<$is_auto> is this soonest renew date for an auto renewal?
3451
3452 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3453 renew date, based on the value "No renewal before" of the applicable
3454 issuing rule. Returns the current date if the item can already be
3455 renewed, and returns undefined if the patron, item, or checkout
3456 cannot be found.
3457
3458 =cut
3459
3460 sub GetSoonestRenewDate {
3461     my ( $patron, $issue, $is_auto ) = @_;
3462     return unless $issue;
3463     return unless $patron;
3464
3465     my $item = $issue->item;
3466     return unless $item;
3467
3468     my $circ_rule = $is_auto ? 'noautorenewalbefore' : 'norenewalbefore';
3469
3470     my $dbh = C4::Context->dbh;
3471
3472     my $branchcode = _GetCircControlBranch( $item, $patron );
3473     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3474         {   categorycode => $patron->categorycode,
3475             itemtype     => $item->effective_itemtype,
3476             branchcode   => $branchcode,
3477             rules => [
3478                 $circ_rule,
3479                 'lengthunit',
3480             ]
3481         }
3482     );
3483
3484     my $now = dt_from_string;
3485
3486     if ( defined $issuing_rule->{$circ_rule}
3487         and $issuing_rule->{$circ_rule} ne "" )
3488     {
3489         my $soonestrenewal =
3490           dt_from_string( $issue->date_due )->subtract(
3491             $issuing_rule->{lengthunit} => $issuing_rule->{$circ_rule} );
3492
3493         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3494             and $issuing_rule->{lengthunit} eq 'days' )
3495         {
3496             $soonestrenewal->truncate( to => 'day' );
3497         }
3498         return $soonestrenewal;
3499     } elsif ( $is_auto && $issue->auto_renew && $patron->autorenew_checkouts ) {
3500         # Checkouts with auto-renewing fall back to due date if noautorenewalbefore is undef
3501         my $soonestrenewal = dt_from_string( $issue->date_due );
3502         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3503             and $issuing_rule->{lengthunit} eq 'days' )
3504         {
3505             $soonestrenewal->truncate( to => 'day' );
3506         }
3507         return $soonestrenewal;
3508     }
3509     return $now;
3510 }
3511
3512 =head2 GetLatestAutoRenewDate
3513
3514   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($patron, $issue);
3515
3516 Find out the latest possible auto renew date of a borrowed item.
3517
3518 C<$patron> is the patron who currently has the item on loan.
3519
3520 C<$issue> is the item issue.
3521
3522 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3523 auto renew date, based on the value "No auto renewal after" and the "No auto
3524 renewal after (hard limit) of the applicable issuing rule.
3525 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3526 or item cannot be found.
3527
3528 =cut
3529
3530 sub GetLatestAutoRenewDate {
3531     my ( $patron, $issue ) = @_;
3532     return unless $issue;
3533     return unless $patron;
3534
3535     my $item = $issue->item;
3536     return unless $item;
3537
3538     my $dbh = C4::Context->dbh;
3539     my $branchcode = _GetCircControlBranch( $item, $patron );
3540
3541     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3542         {
3543             categorycode => $patron->categorycode,
3544             itemtype     => $item->effective_itemtype,
3545             branchcode   => $branchcode,
3546             rules => [
3547                 'no_auto_renewal_after',
3548                 'no_auto_renewal_after_hard_limit',
3549                 'lengthunit',
3550             ]
3551         }
3552     );
3553
3554     return unless $circulation_rules;
3555     return
3556       if ( not $circulation_rules->{no_auto_renewal_after}
3557             or $circulation_rules->{no_auto_renewal_after} eq '' )
3558       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3559              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3560
3561     my $maximum_renewal_date;
3562     if ( $circulation_rules->{no_auto_renewal_after} ) {
3563         $maximum_renewal_date = dt_from_string($issue->issuedate);
3564         $maximum_renewal_date->add(
3565             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3566         );
3567     }
3568
3569     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3570         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3571         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3572     }
3573     return $maximum_renewal_date;
3574 }
3575
3576
3577 =head2 GetIssuingCharges
3578
3579   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3580
3581 Calculate how much it would cost for a given patron to borrow a given
3582 item, including any applicable discounts.
3583
3584 C<$itemnumber> is the item number of item the patron wishes to borrow.
3585
3586 C<$borrowernumber> is the patron's borrower number.
3587
3588 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3589 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3590 if it's a video).
3591
3592 =cut
3593
3594 sub GetIssuingCharges {
3595
3596     # calculate charges due
3597     my ( $itemnumber, $borrowernumber ) = @_;
3598     my $charge = 0;
3599     my $dbh    = C4::Context->dbh;
3600     my $item_type;
3601
3602     # Get the book's item type and rental charge (via its biblioitem).
3603     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3604         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3605     $charge_query .= (C4::Context->preference('item-level_itypes'))
3606         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3607         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3608
3609     $charge_query .= ' WHERE items.itemnumber =?';
3610
3611     my $sth = $dbh->prepare($charge_query);
3612     $sth->execute($itemnumber);
3613     my $patron;
3614     if ( my $item_data = $sth->fetchrow_hashref ) {
3615         $item_type = $item_data->{itemtype};
3616         $charge    = $item_data->{rentalcharge};
3617         if ($charge) {
3618             # FIXME This should follow CircControl
3619             my $branch = C4::Context::mybranch();
3620             $patron //= Koha::Patrons->find( $borrowernumber );
3621             my $discount = Koha::CirculationRules->get_effective_rule({
3622                 categorycode => $patron->categorycode,
3623                 branchcode   => $branch,
3624                 itemtype     => $item_type,
3625                 rule_name    => 'rentaldiscount'
3626             });
3627             if ($discount) {
3628                 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3629             }
3630             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3631         }
3632     }
3633
3634     return ( $charge, $item_type );
3635 }
3636
3637 =head2 AddIssuingCharge
3638
3639   &AddIssuingCharge( $checkout, $charge, $type )
3640
3641 =cut
3642
3643 sub AddIssuingCharge {
3644     my ( $checkout, $charge, $type ) = @_;
3645
3646     # FIXME What if checkout does not exist?
3647
3648     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3649     my $accountline = $account->add_debit(
3650         {
3651             amount      => $charge,
3652             note        => undef,
3653             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3654             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3655             interface   => C4::Context->interface,
3656             type        => $type,
3657             item_id     => $checkout->itemnumber,
3658             issue_id    => $checkout->issue_id,
3659         }
3660     );
3661 }
3662
3663 =head2 GetTransfersFromTo
3664
3665   @results = GetTransfersFromTo($frombranch,$tobranch);
3666
3667 Returns the list of pending transfers between $from and $to branch
3668
3669 =cut
3670
3671 sub GetTransfersFromTo {
3672     my ( $frombranch, $tobranch ) = @_;
3673     return unless ( $frombranch && $tobranch );
3674     my $dbh   = C4::Context->dbh;
3675     my $query = "
3676         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3677         FROM   branchtransfers
3678         WHERE  frombranch=?
3679           AND  tobranch=?
3680           AND datecancelled IS NULL
3681           AND datesent IS NOT NULL
3682           AND datearrived IS NULL
3683     ";
3684     my $sth = $dbh->prepare($query);
3685     $sth->execute( $frombranch, $tobranch );
3686     my @gettransfers;
3687
3688     while ( my $data = $sth->fetchrow_hashref ) {
3689         push @gettransfers, $data;
3690     }
3691     return (@gettransfers);
3692 }
3693
3694 =head2 SendCirculationAlert
3695
3696 Send out a C<check-in> or C<checkout> alert using the messaging system.
3697
3698 B<Parameters>:
3699
3700 =over 4
3701
3702 =item type
3703
3704 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3705
3706 =item item
3707
3708 Hashref of information about the item being checked in or out.
3709
3710 =item borrower
3711
3712 Hashref of information about the borrower of the item.
3713
3714 =item branch
3715
3716 The branchcode from where the checkout or check-in took place.
3717
3718 =back
3719
3720 B<Example>:
3721
3722     SendCirculationAlert({
3723         type     => 'CHECKOUT',
3724         item     => $item,
3725         borrower => $borrower,
3726         branch   => $branch,
3727     });
3728
3729 =cut
3730
3731 sub SendCirculationAlert {
3732     my ($opts) = @_;
3733     my ($type, $item, $borrower, $branch, $issue) =
3734         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3735     my %message_name = (
3736         CHECKIN  => 'Item_Check_in',
3737         CHECKOUT => 'Item_Checkout',
3738         RENEWAL  => 'Item_Checkout',
3739     );
3740     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3741         borrowernumber => $borrower->{borrowernumber},
3742         message_name   => $message_name{$type},
3743     });
3744
3745
3746     my $tables = {
3747         items => $item->{itemnumber},
3748         biblio      => $item->{biblionumber},
3749         biblioitems => $item->{biblionumber},
3750         borrowers   => $borrower,
3751         branches    => $branch,
3752     };
3753
3754     # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3755     # See C4::Letters:: _parseletter_sth
3756     if( $type eq 'CHECKIN' ){
3757         $tables->{old_issues} = $issue->issue_id;
3758     } else {
3759         $tables->{issues} = $item->{itemnumber};
3760     }
3761
3762     my $schema = Koha::Database->new->schema;
3763     my @transports = keys %{ $borrower_preferences->{transports} };
3764
3765     # From the MySQL doc:
3766     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3767     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3768     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3769     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3770
3771     for my $mtt (@transports) {
3772         my $letter =  C4::Letters::GetPreparedLetter (
3773             module => 'circulation',
3774             letter_code => $type,
3775             branchcode => $branch,
3776             message_transport_type => $mtt,
3777             lang => $borrower->{lang},
3778             tables => $tables,
3779         ) or next;
3780
3781         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3782         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3783         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3784         unless ( $message ) {
3785             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3786             my $patron = Koha::Patrons->find($borrower->{borrowernumber});
3787             C4::Message->enqueue($letter, $patron, $mtt);
3788         } else {
3789             $message->append($letter);
3790             $message->update;
3791         }
3792         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3793     }
3794
3795     return;
3796 }
3797
3798 =head2 updateWrongTransfer
3799
3800   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3801
3802 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
3803
3804 =cut
3805
3806 sub updateWrongTransfer {
3807         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3808
3809     # first step: cancel the original transfer
3810     my $item = Koha::Items->find($itemNumber);
3811     my $transfer = $item->get_transfer;
3812     $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3813
3814     # second step: create a new transfer to the right location
3815     my $new_transfer = $item->request_transfer(
3816         {
3817             to            => $transfer->to_library,
3818             reason        => $transfer->reason,
3819             comment       => $transfer->comments,
3820             ignore_limits => 1,
3821             enqueue       => 1
3822         }
3823     );
3824
3825     return $new_transfer;
3826 }
3827
3828 =head2 CalcDateDue
3829
3830 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3831
3832 this function calculates the due date given the start date and configured circulation rules,
3833 checking against the holidays calendar as per the daysmode circulation rule.
3834 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3835 C<$itemtype>  = itemtype code of item in question
3836 C<$branch>  = location whose calendar to use
3837 C<$patron> = Patron object
3838 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3839
3840 =cut
3841
3842 sub CalcDateDue {
3843     my ( $startdate, $itemtype, $branch, $patron, $isrenewal ) = @_;
3844
3845     $isrenewal ||= 0;
3846
3847     # loanlength now a href
3848     my $loanlength =
3849             GetLoanLength( $patron->categorycode, $itemtype, $branch );
3850
3851     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3852             ? qq{renewalperiod}
3853             : qq{issuelength};
3854
3855     my $datedue;
3856     if ( $startdate ) {
3857         if (ref $startdate ne 'DateTime' ) {
3858             $datedue = dt_from_string($datedue);
3859         } else {
3860             $datedue = $startdate->clone;
3861         }
3862     } else {
3863         $datedue = dt_from_string()->truncate( to => 'minute' );
3864     }
3865
3866
3867     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3868         {
3869             categorycode => $patron->categorycode,
3870             itemtype     => $itemtype,
3871             branchcode   => $branch,
3872         }
3873     );
3874
3875     # calculate the datedue as normal
3876     if ( $daysmode eq 'Days' )
3877     {    # ignoring calendar
3878         if ( $loanlength->{lengthunit} eq 'hours' ) {
3879             $datedue->add( hours => $loanlength->{$length_key} );
3880         } else {    # days
3881             $datedue->add( days => $loanlength->{$length_key} );
3882             $datedue->set_hour(23);
3883             $datedue->set_minute(59);
3884         }
3885     } else {
3886         my $dur;
3887         if ($loanlength->{lengthunit} eq 'hours') {
3888             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3889         }
3890         else { # days
3891             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3892         }
3893         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3894         $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3895         if ($loanlength->{lengthunit} eq 'days') {
3896             $datedue->set_hour(23);
3897             $datedue->set_minute(59);
3898         }
3899     }
3900
3901     # if Hard Due Dates are used, retrieve them and apply as necessary
3902     my ( $hardduedate, $hardduedatecompare ) =
3903       GetHardDueDate( $patron->categorycode, $itemtype, $branch );
3904     if ($hardduedate) {    # hardduedates are currently dates
3905         $hardduedate->truncate( to => 'minute' );
3906         $hardduedate->set_hour(23);
3907         $hardduedate->set_minute(59);
3908         my $cmp = DateTime->compare( $hardduedate, $datedue );
3909
3910 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3911 # if the calculated date is before the 'after' Hard Due Date (floor), override
3912 # if the hard due date is set to 'exactly', overrride
3913         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3914             $datedue = $hardduedate->clone;
3915         }
3916
3917         # in all other cases, keep the date due as it is
3918
3919     }
3920
3921     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3922     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3923         my $expiry_dt = dt_from_string( $patron->dateexpiry, 'iso', 'floating');
3924         if( $expiry_dt ) { #skip empty expiry date..
3925             $expiry_dt->set( hour => 23, minute => 59);
3926             my $d1= $datedue->clone->set_time_zone('floating');
3927             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3928                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3929             }
3930         }
3931         if ( $daysmode ne 'Days' ) {
3932           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3933           if ( $calendar->is_holiday($datedue) ) {
3934               # Don't return on a closed day
3935               $datedue = $calendar->prev_open_days( $datedue, 1 );
3936           }
3937         }
3938     }
3939
3940     return $datedue;
3941 }
3942
3943
3944 sub CheckValidBarcode{
3945 my ($barcode) = @_;
3946 my $dbh = C4::Context->dbh;
3947 my $query=qq|SELECT count(*)
3948              FROM items
3949              WHERE barcode=?
3950             |;
3951 my $sth = $dbh->prepare($query);
3952 $sth->execute($barcode);
3953 my $exist=$sth->fetchrow ;
3954 return $exist;
3955 }
3956
3957 =head2 IsBranchTransferAllowed
3958
3959   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3960
3961 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3962
3963 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3964 Koha::Item->can_be_transferred.
3965
3966 =cut
3967
3968 sub IsBranchTransferAllowed {
3969         my ( $toBranch, $fromBranch, $code ) = @_;
3970
3971         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3972
3973         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3974         my $dbh = C4::Context->dbh;
3975
3976         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3977         $sth->execute( $toBranch, $fromBranch, $code );
3978         my $limit = $sth->fetchrow_hashref();
3979
3980         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3981         if ( $limit->{'limitId'} ) {
3982                 return 0;
3983         } else {
3984                 return 1;
3985         }
3986 }
3987
3988 =head2 CreateBranchTransferLimit
3989
3990   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3991
3992 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3993
3994 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3995
3996 =cut
3997
3998 sub CreateBranchTransferLimit {
3999    my ( $toBranch, $fromBranch, $code ) = @_;
4000    return unless defined($toBranch) && defined($fromBranch);
4001    my $limitType = C4::Context->preference("BranchTransferLimitsType");
4002
4003    my $dbh = C4::Context->dbh;
4004
4005    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
4006    return $sth->execute( $code, $toBranch, $fromBranch );
4007 }
4008
4009 =head2 DeleteBranchTransferLimits
4010
4011     my $result = DeleteBranchTransferLimits($frombranch);
4012
4013 Deletes all the library transfer limits for one library.  Returns the
4014 number of limits deleted, 0e0 if no limits were deleted, or undef if
4015 no arguments are supplied.
4016
4017 Deprecated in favor of Koha::Item::Transfer::Limits->search({
4018     fromBranch => $fromBranch
4019     })->delete.
4020
4021 =cut
4022
4023 sub DeleteBranchTransferLimits {
4024     my $branch = shift;
4025     return unless defined $branch;
4026     my $dbh    = C4::Context->dbh;
4027     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
4028     return $sth->execute($branch);
4029 }
4030
4031 sub ReturnLostItem{
4032     my ( $borrowernumber, $itemnum ) = @_;
4033     MarkIssueReturned( $borrowernumber, $itemnum );
4034 }
4035
4036 =head2 LostItem
4037
4038   LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
4039
4040 The final optional parameter, C<$params>, expected to contain
4041 'skip_record_index' key, which relayed down to Koha::Item/store,
4042 there it prevents calling of ModZebra index_records,
4043 which takes most of the time in batch adds/deletes: index_records better
4044 to be called later in C<additem.pl> after the whole loop.
4045
4046 $params:
4047     skip_record_index => 1|0
4048
4049 =cut
4050
4051 sub LostItem{
4052     my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
4053
4054     unless ( $mark_lost_from ) {
4055         # Temporary check to avoid regressions
4056         die q|LostItem called without $mark_lost_from, check the API.|;
4057     }
4058
4059     my $mark_returned;
4060     if ( $force_mark_returned ) {
4061         $mark_returned = 1;
4062     } else {
4063         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
4064         $mark_returned = ( $pref =~ m|$mark_lost_from| );
4065     }
4066
4067     my $dbh = C4::Context->dbh();
4068     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
4069                            FROM issues
4070                            JOIN items USING (itemnumber)
4071                            JOIN biblio USING (biblionumber)
4072                            WHERE issues.itemnumber=?");
4073     $sth->execute($itemnumber);
4074     my $issues=$sth->fetchrow_hashref();
4075
4076     # If a borrower lost the item, add a replacement cost to the their record
4077     if ( my $borrowernumber = $issues->{borrowernumber} ){
4078         my $patron = Koha::Patrons->find( $borrowernumber );
4079
4080         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
4081         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
4082
4083         if (C4::Context->preference('WhenLostChargeReplacementFee')){
4084             C4::Accounts::chargelostitem(
4085                 $borrowernumber,
4086                 $itemnumber,
4087                 $issues->{'replacementprice'},
4088                 sprintf( "%s %s %s",
4089                     $issues->{'title'}          || q{},
4090                     $issues->{'barcode'}        || q{},
4091                     $issues->{'itemcallnumber'} || q{},
4092                 ),
4093             );
4094             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4095             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
4096         }
4097
4098         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4099     }
4100
4101     # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4102     my $item = Koha::Items->find($itemnumber);
4103     my $transfers = $item->get_transfers;
4104     while (my $transfer = $transfers->next) {
4105         $transfer->cancel({ reason => 'ItemLost', force => 1 });
4106     }
4107 }
4108
4109 sub GetOfflineOperations {
4110     my $dbh = C4::Context->dbh;
4111     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4112     $sth->execute(C4::Context->userenv->{'branch'});
4113     my $results = $sth->fetchall_arrayref({});
4114     return $results;
4115 }
4116
4117 sub GetOfflineOperation {
4118     my $operationid = shift;
4119     return unless $operationid;
4120     my $dbh = C4::Context->dbh;
4121     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4122     $sth->execute( $operationid );
4123     return $sth->fetchrow_hashref;
4124 }
4125
4126 sub AddOfflineOperation {
4127     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4128     my $dbh = C4::Context->dbh;
4129     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4130     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4131     return "Added.";
4132 }
4133
4134 sub DeleteOfflineOperation {
4135     my $dbh = C4::Context->dbh;
4136     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4137     $sth->execute( shift );
4138     return "Deleted.";
4139 }
4140
4141 sub ProcessOfflineOperation {
4142     my $operation = shift;
4143
4144     my $report;
4145     if ( $operation->{action} eq 'return' ) {
4146         $report = ProcessOfflineReturn( $operation );
4147     } elsif ( $operation->{action} eq 'issue' ) {
4148         $report = ProcessOfflineIssue( $operation );
4149     } elsif ( $operation->{action} eq 'payment' ) {
4150         $report = ProcessOfflinePayment( $operation );
4151     }
4152
4153     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4154
4155     return $report;
4156 }
4157
4158 sub ProcessOfflineReturn {
4159     my $operation = shift;
4160
4161     my $item = Koha::Items->find({barcode => $operation->{barcode}});
4162
4163     if ( $item ) {
4164         my $itemnumber = $item->itemnumber;
4165         my $issue = $item->checkout;
4166         if ( $issue ) {
4167             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4168             ModDateLastSeen( $itemnumber, $leave_item_lost );
4169             MarkIssueReturned(
4170                 $issue->borrowernumber,
4171                 $itemnumber,
4172                 $operation->{timestamp},
4173             );
4174             $item->onloan(undef);
4175             $item->store({ log_action => 0 });
4176             return "Success.";
4177         } else {
4178             return "Item not issued.";
4179         }
4180     } else {
4181         return "Item not found.";
4182     }
4183 }
4184
4185 sub ProcessOfflineIssue {
4186     my $operation = shift;
4187
4188     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4189     $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4190
4191     if ( $patron ) {
4192         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4193         unless ($item) {
4194             return "Barcode not found.";
4195         }
4196         my $itemnumber = $item->itemnumber;
4197         my $issue = $item->checkout;
4198
4199         if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4200             MarkIssueReturned(
4201                 $issue->borrowernumber,
4202                 $itemnumber,
4203                 $operation->{timestamp},
4204             );
4205         }
4206         AddIssue(
4207             $patron,
4208             $operation->{'barcode'},
4209             undef,
4210             undef,
4211             $operation->{timestamp},
4212             undef,
4213         );
4214         return "Success.";
4215     } else {
4216         return "Borrower not found.";
4217     }
4218 }
4219
4220 sub ProcessOfflinePayment {
4221     my $operation = shift;
4222
4223     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4224     $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4225
4226     $patron->account->pay(
4227         {
4228             amount     => $operation->{amount},
4229             library_id => $operation->{branchcode},
4230             interface  => 'koc'
4231         }
4232     );
4233
4234     return "Success.";
4235 }
4236
4237 =head2 TransferSlip
4238
4239   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4240
4241   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4242
4243 =cut
4244
4245 sub TransferSlip {
4246     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4247
4248     my $item =
4249       $itemnumber
4250       ? Koha::Items->find($itemnumber)
4251       : Koha::Items->find( { barcode => $barcode } );
4252
4253     $item or return;
4254
4255     return C4::Letters::GetPreparedLetter (
4256         module => 'circulation',
4257         letter_code => 'TRANSFERSLIP',
4258         branchcode => $branch,
4259         tables => {
4260             'branches'    => $to_branch,
4261             'biblio'      => $item->biblionumber,
4262             'items'       => $item->unblessed,
4263         },
4264     );
4265 }
4266
4267 =head2 CheckIfIssuedToPatron
4268
4269   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4270
4271   Return 1 if any record item is issued to patron, otherwise return 0
4272
4273 =cut
4274
4275 sub CheckIfIssuedToPatron {
4276     my ($borrowernumber, $biblionumber) = @_;
4277
4278     my $dbh = C4::Context->dbh;
4279     my $query = q|
4280         SELECT COUNT(*) FROM issues
4281         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4282         WHERE items.biblionumber = ?
4283         AND issues.borrowernumber = ?
4284     |;
4285     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4286     return 1 if $is_issued;
4287     return;
4288 }
4289
4290 =head2 IsItemIssued
4291
4292   IsItemIssued( $itemnumber )
4293
4294   Return 1 if the item is on loan, otherwise return 0
4295
4296 =cut
4297
4298 sub IsItemIssued {
4299     my $itemnumber = shift;
4300     my $dbh = C4::Context->dbh;
4301     my $sth = $dbh->prepare(q{
4302         SELECT COUNT(*)
4303         FROM issues
4304         WHERE itemnumber = ?
4305     });
4306     $sth->execute($itemnumber);
4307     return $sth->fetchrow;
4308 }
4309
4310 =head2 GetAgeRestriction
4311
4312   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4313   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4314
4315   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4316   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4317
4318 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4319 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4320 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4321          Negative days mean the borrower has gone past the age restriction age.
4322
4323 =cut
4324
4325 sub GetAgeRestriction {
4326     my ($record_restrictions, $borrower) = @_;
4327     my $markers = C4::Context->preference('AgeRestrictionMarker');
4328
4329     return unless $record_restrictions;
4330     # Split $record_restrictions to something like FSK 16 or PEGI 6
4331     my @values = split ' ', uc($record_restrictions);
4332     return unless @values;
4333
4334     # Search first occurrence of one of the markers
4335     my @markers = split /\|/, uc($markers);
4336     return unless @markers;
4337
4338     my $index            = 0;
4339     my $restriction_year = 0;
4340     for my $value (@values) {
4341         $index++;
4342         for my $marker (@markers) {
4343             $marker =~ s/^\s+//;    #remove leading spaces
4344             $marker =~ s/\s+$//;    #remove trailing spaces
4345             if ( $marker eq $value ) {
4346                 if ( $index <= $#values ) {
4347                     $restriction_year += $values[$index];
4348                 }
4349                 last;
4350             }
4351             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4352
4353                 # Perhaps it is something like "K16" (as in Finland)
4354                 $restriction_year += $1;
4355                 last;
4356             }
4357         }
4358         last if ( $restriction_year > 0 );
4359     }
4360
4361     #Check if the borrower is age restricted for this material and for how long.
4362     if ($restriction_year && $borrower) {
4363         if ( $borrower->{'dateofbirth'} ) {
4364             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4365             $alloweddate[0] += $restriction_year;
4366
4367             #Prevent runime eror on leap year (invalid date)
4368             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4369                 $alloweddate[2] = 28;
4370             }
4371
4372             #Get how many days the borrower has to reach the age restriction
4373             my @Today = split /-/, dt_from_string()->ymd();
4374             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4375             #Negative days means the borrower went past the age restriction age
4376             return ($restriction_year, $daysToAgeRestriction);
4377         }
4378     }
4379
4380     return ($restriction_year);
4381 }
4382
4383
4384 =head2 GetPendingOnSiteCheckouts
4385
4386 =cut
4387
4388 sub GetPendingOnSiteCheckouts {
4389     my $dbh = C4::Context->dbh;
4390     return $dbh->selectall_arrayref(q|
4391         SELECT
4392           items.barcode,
4393           items.biblionumber,
4394           items.itemnumber,
4395           items.itemnotes,
4396           items.itemcallnumber,
4397           items.location,
4398           issues.date_due,
4399           issues.branchcode,
4400           issues.date_due < NOW() AS is_overdue,
4401           biblio.author,
4402           biblio.title,
4403           borrowers.firstname,
4404           borrowers.surname,
4405           borrowers.cardnumber,
4406           borrowers.borrowernumber
4407         FROM items
4408         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4409         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4410         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4411         WHERE issues.onsite_checkout = 1
4412     |, { Slice => {} } );
4413 }
4414
4415 sub GetTopIssues {
4416     my ($params) = @_;
4417
4418     my ($count, $branch, $itemtype, $ccode, $newness)
4419         = @$params{qw(count branch itemtype ccode newness)};
4420
4421     my $dbh = C4::Context->dbh;
4422     my $query = q{
4423         SELECT * FROM (
4424         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4425           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4426           i.ccode, SUM(i.issues) AS count
4427         FROM biblio b
4428         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4429         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4430     };
4431
4432     my (@where_strs, @where_args);
4433
4434     if ($branch) {
4435         push @where_strs, 'i.homebranch = ?';
4436         push @where_args, $branch;
4437     }
4438     if ($itemtype) {
4439         if (C4::Context->preference('item-level_itypes')){
4440             push @where_strs, 'i.itype = ?';
4441             push @where_args, $itemtype;
4442         } else {
4443             push @where_strs, 'bi.itemtype = ?';
4444             push @where_args, $itemtype;
4445         }
4446     }
4447     if ($ccode) {
4448         push @where_strs, 'i.ccode = ?';
4449         push @where_args, $ccode;
4450     }
4451     if ($newness) {
4452         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4453         push @where_args, $newness;
4454     }
4455
4456     if (@where_strs) {
4457         $query .= 'WHERE ' . join(' AND ', @where_strs);
4458     }
4459
4460     $query .= q{
4461         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4462           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4463           i.ccode
4464         ORDER BY count DESC
4465     };
4466
4467     $query .= q{ ) xxx WHERE count > 0 };
4468     $count = int($count);
4469     if ($count > 0) {
4470         $query .= "LIMIT $count";
4471     }
4472
4473     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4474
4475     return @$rows;
4476 }
4477
4478 =head2 Internal methods
4479
4480 =cut
4481
4482 sub _CalculateAndUpdateFine {
4483     my ($params) = @_;
4484
4485     my $borrower    = $params->{borrower};
4486     my $item        = $params->{item};
4487     my $issue       = $params->{issue};
4488     my $return_date = $params->{return_date};
4489
4490     unless ($borrower) { carp "No borrower passed in!" && return; }
4491     unless ($item)     { carp "No item passed in!"     && return; }
4492     unless ($issue)    { carp "No issue passed in!"    && return; }
4493
4494     my $datedue = dt_from_string( $issue->date_due );
4495
4496     # we only need to calculate and change the fines if we want to do that on return
4497     # Should be on for hourly loans
4498     my $control = C4::Context->preference('CircControl');
4499     my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4500     my $control_branchcode =
4501         ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4502       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4503       :                                     $issue->branchcode;
4504
4505     my $date_returned = $return_date ? $return_date : dt_from_string();
4506
4507     my ( $amount, $unitcounttotal, $unitcount  ) =
4508       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4509
4510     if ( C4::Context->preference('finesMode') eq 'production' ) {
4511         if ( $amount > 0 ) {
4512             C4::Overdues::UpdateFine({
4513                 issue_id       => $issue->issue_id,
4514                 itemnumber     => $issue->itemnumber,
4515                 borrowernumber => $issue->borrowernumber,
4516                 amount         => $amount,
4517                 due            => $datedue,
4518             });
4519         }
4520         elsif ($return_date) {
4521
4522             # Backdated returns may have fines that shouldn't exist,
4523             # so in this case, we need to drop those fines to 0
4524
4525             C4::Overdues::UpdateFine({
4526                 issue_id       => $issue->issue_id,
4527                 itemnumber     => $issue->itemnumber,
4528                 borrowernumber => $issue->borrowernumber,
4529                 amount         => 0,
4530                 due            => $datedue,
4531             });
4532         }
4533     }
4534 }
4535
4536 sub _CanBookBeAutoRenewed {
4537     my ( $params ) = @_;
4538     my $patron = $params->{patron};
4539     my $item = $params->{item};
4540     my $branchcode = $params->{branchcode};
4541     my $issue = $params->{issue};
4542
4543     return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4544
4545     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4546         {
4547             categorycode => $patron->categorycode,
4548             itemtype     => $item->effective_itemtype,
4549             branchcode   => $branchcode,
4550             rules => [
4551                 'no_auto_renewal_after',
4552                 'no_auto_renewal_after_hard_limit',
4553                 'lengthunit',
4554                 'noautorenewalbefore',
4555             ]
4556         }
4557     );
4558
4559     if ( $patron->is_expired && $patron->category->effective_BlockExpiredPatronOpacActions ) {
4560         return 'auto_account_expired';
4561     }
4562
4563     if ( defined $issuing_rule->{no_auto_renewal_after}
4564             and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4565         # Get issue_date and add no_auto_renewal_after
4566         # If this is greater than today, it's too late for renewal.
4567         my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4568         $maximum_renewal_date->add(
4569             $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4570         );
4571         my $now = dt_from_string;
4572         if ( $now >= $maximum_renewal_date ) {
4573             return "auto_too_late";
4574         }
4575     }
4576     if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4577                   and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4578         # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4579         if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4580             return "auto_too_late";
4581         }
4582     }
4583
4584     if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4585         my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4586         my $amountoutstanding =
4587           C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4588           ? $patron->account->balance
4589           : $patron->account->outstanding_debits->total_outstanding;
4590         if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4591             return "auto_too_much_oweing";
4592         }
4593     }
4594
4595     my $soonest = GetSoonestRenewDate( $patron, $issue, 1 );
4596     if ( $soonest > dt_from_string() )
4597     {
4598         return ( "auto_too_soon", $soonest );
4599     }
4600
4601     return "ok";
4602 }
4603
4604
4605 1;
4606
4607 __END__
4608
4609 =head1 AUTHOR
4610
4611 Koha Development Team <http://koha-community.org/>
4612
4613 =cut