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