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