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