C4/Circulation.pm

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