C4/Circulation.pm

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