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