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