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