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