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