C4/Circulation.pm

   1 package C4::Circulation;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 # copyright 2010 BibLibre
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21 use Modern::Perl;
  22 use DateTime;
  23 use POSIX qw( floor );
  24 use YAML::XS;
  25 use Encode;
  26
  27 use C4::Context;
  28 use C4::Stats qw( UpdateStats );
  29 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest ItemsAnyAvailableAndNotRestricted );
  30 use C4::Biblio qw( UpdateTotalIssues );
  31 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
  32 use C4::Accounts;
  33 use C4::ItemCirculationAlertPreference;
  34 use C4::Message;
  35 use C4::Log qw( logaction ); # logaction
  36 use C4::Overdues;
  37 use C4::RotatingCollections qw(GetCollectionItemBranches);
  38 use Algorithm::CheckDigits qw( CheckDigits );
  39
  40 use Data::Dumper qw( Dumper );
  41 use Koha::Account;
  42 use Koha::AuthorisedValues;
  43 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
  44 use Koha::Biblioitems;
  45 use Koha::DateUtils qw( dt_from_string );
  46 use Koha::Calendar;
  47 use Koha::Checkouts;
  48 use Koha::Illrequests;
  49 use Koha::Items;
  50 use Koha::Patrons;
  51 use Koha::Patron::Debarments qw( DelUniqueDebarment AddUniqueDebarment );
  52 use Koha::Database;
  53 use Koha::Libraries;
  54 use Koha::Account::Lines;
  55 use Koha::Holds;
  56 use Koha::Account::Lines;
  57 use Koha::Account::Offsets;
  58 use Koha::Config::SysPrefs;
  59 use Koha::Charges::Fees;
  60 use Koha::Config::SysPref;
  61 use Koha::Checkouts::ReturnClaims;
  62 use Koha::SearchEngine::Indexer;
  63 use Koha::Exceptions::Checkout;
  64 use Koha::Plugins;
  65 use Koha::Recalls;
  66 use Carp qw( carp );
  67 use List::MoreUtils qw( any );
  68 use Scalar::Util qw( looks_like_number 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 = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2141     map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2142     if ($update_loc_rules) {
2143         if (defined $update_loc_rules->{_ALL_}) {
2144             if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2145             if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2146             if (
2147                 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2148                 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2149                ) {
2150                 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2151                 $item->location($update_loc_rules->{_ALL_})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2152             }
2153         }
2154         else {
2155             foreach my $key ( keys %$update_loc_rules ) {
2156                 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2157                 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2158                 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2159                     $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2160                     $item->location($update_loc_rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1});
2161                     last;
2162                 }
2163             }
2164         }
2165     }
2166
2167     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2168     if ($yaml) {
2169         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
2170         my $rules;
2171         eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2172         if ($@) {
2173             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2174         }
2175         else {
2176             foreach my $key ( keys %$rules ) {
2177                 if ( $item->notforloan eq $key ) {
2178                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2179                     $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 }) unless $rules->{$key} eq 'ONLYMESSAGE';
2180                     last;
2181                 }
2182             }
2183         }
2184     }
2185
2186     # check if the return is allowed at this branch
2187     my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2188     unless ($returnallowed){
2189         $messages->{'Wrongbranch'} = {
2190             Wrongbranch => $branch,
2191             Rightbranch => $message
2192         };
2193         $doreturn = 0;
2194         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2195         $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2196         return ( $doreturn, $messages, $issue, $patron_unblessed);
2197     }
2198
2199     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2200         $doreturn = 0;
2201     }
2202
2203     # case of a return of document (deal with issues and holdingbranch)
2204     if ($doreturn) {
2205         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2206         $patron or warn "AddReturn without current borrower";
2207
2208         if ($patron) {
2209             eval {
2210                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2211             };
2212             unless ( $@ ) {
2213                 if (
2214                     (
2215                         C4::Context->preference('CalculateFinesOnReturn')
2216                         || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2217                     )
2218                     && !$item->itemlost
2219                   )
2220                 {
2221                     _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2222                 }
2223             } else {
2224                 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 );
2225
2226                 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2227                 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2228
2229                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2230             }
2231
2232             # FIXME is the "= 1" right?  This could be the borrower hash.
2233             $messages->{'WasReturned'} = 1;
2234
2235         } else {
2236             $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2237         }
2238     }
2239
2240     # the holdingbranch is updated if the document is returned to another location.
2241     # this is always done regardless of whether the item was on loan or not
2242     if ($item->holdingbranch ne $branch) {
2243         $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2244     }
2245
2246     my $item_was_lost = $item->itemlost;
2247     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2248     my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2249
2250     # fix up the accounts.....
2251     if ($item_was_lost) {
2252         $messages->{'WasLost'} = 1;
2253         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2254             my @object_messages = @{ $updated_item->object_messages };
2255             for my $message (@object_messages) {
2256                 $messages->{'LostItemFeeRefunded'} = 1
2257                   if $message->message eq 'lost_refunded';
2258                 $messages->{'ProcessingFeeRefunded'} = 1
2259                   if $message->message eq 'processing_refunded';
2260                 $messages->{'LostItemFeeRestored'} = 1
2261                   if $message->message eq 'lost_restored';
2262
2263                 if ( $message->message eq 'lost_charge' ) {
2264                     $issue //= Koha::Old::Checkouts->search(
2265                         { itemnumber => $item->itemnumber },
2266                         { order_by   => { '-desc' => 'returndate' }, rows => 1 }
2267                     )->single;
2268                     unless ( exists( $patron_unblessed->{branchcode} ) ) {
2269                         my $patron = $issue->patron;
2270                         $patron_unblessed = $patron->unblessed;
2271                     }
2272                     _CalculateAndUpdateFine(
2273                         {
2274                             issue       => $issue,
2275                             item        => $item->unblessed,
2276                             borrower    => $patron_unblessed,
2277                             return_date => $return_date
2278                         }
2279                     );
2280                     _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2281                         $item->itemnumber, undef, 'RETURNED' );
2282                     $messages->{'LostItemFeeCharged'} = 1;
2283                 }
2284             }
2285         }
2286     }
2287
2288     # check if we have a transfer for this document
2289     my $transfer = $item->get_transfer;
2290
2291     # if we have a transfer to complete, we update the line of transfers with the datearrived
2292     if ($transfer) {
2293         $validTransfer = 0;
2294         if ( $transfer->in_transit ) {
2295             if ( $transfer->tobranch eq $branch ) {
2296                 $transfer->receive;
2297                 $messages->{'TransferArrived'} = $transfer->frombranch;
2298                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2299                 $validTransfer = 1
2300                   if defined $transfer->reason && $transfer->reason eq 'Reserve';
2301             }
2302             else {
2303                 $messages->{'WrongTransfer'}     = $transfer->tobranch;
2304                 $messages->{'WrongTransferItem'} = $item->itemnumber;
2305                 $messages->{'TransferTrigger'}   = $transfer->reason;
2306             }
2307         }
2308         else {
2309             if ( $transfer->tobranch eq $branch ) {
2310                 $transfer->receive;
2311                 $messages->{'TransferArrived'} = $transfer->frombranch;
2312                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2313                 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2314             }
2315             else {
2316                 $messages->{'TransferTrigger'} = $transfer->reason;
2317                 if ( $transfer->frombranch eq $branch ) {
2318                     $transfer->transit;
2319                     $messages->{'WasTransfered'}   = $transfer->tobranch;
2320                 }
2321                 else {
2322                     $messages->{'WrongTransfer'}     = $transfer->tobranch;
2323                     $messages->{'WrongTransferItem'} = $item->itemnumber;
2324                 }
2325             }
2326         }
2327     }
2328
2329     # fix up the overdues in accounts...
2330     if ($borrowernumber) {
2331         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2332         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!";  # zero is OK, check defined
2333
2334         if ( $issue and $issue->is_overdue($return_date) ) {
2335         # fix fine days
2336             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2337             if ($debardate and $debardate ne "9999-12-31") {
2338                 if ($reminder){
2339                     $messages->{'PrevDebarred'} = $debardate;
2340                 } else {
2341                     $messages->{'Debarred'} = $debardate;
2342                 }
2343             } elsif ($patron->debarred) {
2344                 if ( $patron->debarred eq "9999-12-31") {
2345                     $messages->{'ForeverDebarred'} = $patron->debarred;
2346                 } else {
2347                     my $borrower_debar_dt = dt_from_string( $patron->debarred );
2348                     $borrower_debar_dt->truncate(to => 'day');
2349                     my $today_dt = $return_date->clone()->truncate(to => 'day');
2350                     if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2351                         $messages->{'PrevDebarred'} = $patron->debarred;
2352                     }
2353                 }
2354             }
2355         # there's no overdue on the item but borrower had been previously debarred
2356         } elsif ( $issue->date_due and $patron->debarred ) {
2357              if ( $patron->debarred eq "9999-12-31") {
2358                 $messages->{'ForeverDebarred'} = $patron->debarred;
2359              } else {
2360                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2361                   $borrower_debar_dt->truncate(to => 'day');
2362                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2363                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2364                       $messages->{'PrevDebarred'} = $patron->debarred;
2365                   }
2366              }
2367         }
2368     }
2369
2370     # find recalls...
2371     if ( C4::Context->preference('UseRecalls') ) {
2372         # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2373         my $recall = undef;
2374         $recall = $item->check_recalls if $item->can_be_waiting_recall;
2375         if ( defined $recall ) {
2376             $messages->{RecallFound} = $recall;
2377             if ( $recall->pickup_library_id ne $branch ) {
2378                 $messages->{RecallNeedsTransfer} = $branch;
2379             }
2380         }
2381     }
2382
2383     # find reserves.....
2384     # launch the Checkreserves routine to find any holds
2385     my ($resfound, $resrec);
2386     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2387     ($resfound, $resrec, undef) = CheckReserves( $item, $lookahead ) unless ( $item->withdrawn );
2388     # 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)
2389     if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2390         my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2391         $resfound = 'Reserved';
2392         $resrec = $hold->unblessed;
2393     }
2394     if ($resfound) {
2395           $resrec->{'ResFound'} = $resfound;
2396         $messages->{'ResFound'} = $resrec;
2397     }
2398
2399     # Record the fact that this book was returned.
2400     my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2401     C4::Stats::UpdateStats({
2402         branch         => $branch,
2403         type           => $stat_type,
2404         itemnumber     => $itemnumber,
2405         itemtype       => $itemtype,
2406         location       => $item->location,
2407         borrowernumber => $borrowernumber,
2408         ccode          => $item->ccode,
2409         categorycode   => $categorycode,
2410         interface      => C4::Context->interface,
2411     });
2412
2413     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2414     if ( $patron ) {
2415         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2416         my %conditions = (
2417             branchcode   => $branch,
2418             categorycode => $patron->categorycode,
2419             item_type    => $itemtype,
2420             notification => 'CHECKIN',
2421         );
2422         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2423             SendCirculationAlert({
2424                 type     => 'CHECKIN',
2425                 item     => $item->unblessed,
2426                 borrower => $patron->unblessed,
2427                 branch   => $branch,
2428                 issue    => $issue
2429             });
2430         }
2431
2432         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2433             if C4::Context->preference("ReturnLog");
2434         }
2435
2436     # Check if this item belongs to a biblio record that is attached to an
2437     # ILL request, if it is we need to update the ILL request's status
2438     if ( $doreturn and C4::Context->preference('CirculateILL')) {
2439         my $request = Koha::Illrequests->find(
2440             { biblio_id => $item->biblio->biblionumber }
2441         );
2442         $request->status('RET') if $request;
2443     }
2444
2445     if ( C4::Context->preference('UseRecalls') ) {
2446         # all recalls that have triggered a transfer will have an allocated itemnumber
2447         my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2448         if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2449             $messages->{TransferredRecall} = $transfer_recall;
2450         }
2451     }
2452
2453     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2454     if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2455         && ( $doreturn or $messages->{'NotIssued'} )
2456         and !$resfound
2457         and ( $branch ne $returnbranch )
2458         and not $messages->{'WrongTransfer'}
2459         and not $messages->{'WasTransfered'}
2460         and not $messages->{TransferredRecall}
2461         and not $messages->{RecallNeedsTransfer} )
2462     {
2463         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2464         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2465             (C4::Context->preference("UseBranchTransferLimits") and
2466              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2467            )) {
2468             ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2469             $messages->{'WasTransfered'} = $returnbranch;
2470             $messages->{'TransferTrigger'} = $transfer_trigger;
2471         } else {
2472             $messages->{'NeedsTransfer'} = $returnbranch;
2473             $messages->{'TransferTrigger'} = $transfer_trigger;
2474         }
2475     }
2476
2477     if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2478         my $claims = Koha::Checkouts::ReturnClaims->search(
2479            {
2480                itemnumber => $item->id,
2481                resolution => undef,
2482            }
2483         );
2484
2485         if ( $claims->count ) {
2486             $messages->{ReturnClaims} = $claims;
2487         }
2488     }
2489
2490     # Check for bundle status
2491     if ( $item->in_bundle ) {
2492         my $host = $item->bundle_host;
2493         $messages->{InBundle} = $host;
2494     }
2495
2496     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2497     $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2498
2499     if ( $doreturn and $issue ) {
2500         my $checkin = Koha::Old::Checkouts->find($issue->id);
2501
2502         Koha::Plugins->call('after_circ_action', {
2503             action  => 'checkin',
2504             payload => {
2505                 checkout=> $checkin
2506             }
2507         });
2508
2509         Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2510             {
2511                 biblio_ids => [ $item->biblionumber ]
2512             }
2513         ) if C4::Context->preference('RealTimeHoldsQueue');
2514     }
2515
2516     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2517 }
2518
2519 =head2 MarkIssueReturned
2520
2521   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2522
2523 Unconditionally marks an issue as being returned by
2524 moving the C<issues> row to C<old_issues> and
2525 setting C<returndate> to the current date.
2526
2527 if C<$returndate> is specified (in iso format), it is used as the date
2528 of the return.
2529
2530 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2531 the old_issue is immediately anonymised
2532
2533 Ideally, this function would be internal to C<C4::Circulation>,
2534 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2535 and offline_circ/process_koc.pl.
2536
2537 The last optional parameter allos passing skip_record_index to the item store call.
2538
2539 =cut
2540
2541 sub MarkIssueReturned {
2542     my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2543
2544     # Retrieve the issue
2545     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2546
2547     return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2548
2549     my $issue_id = $issue->issue_id;
2550
2551     my $schema = Koha::Database->schema;
2552
2553     # FIXME Improve the return value and handle it from callers
2554     $schema->txn_do(sub {
2555
2556         my $patron = Koha::Patrons->find( $borrowernumber );
2557
2558         # Update the returndate value
2559         if ( $returndate ) {
2560             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2561         }
2562         else {
2563             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2564         }
2565
2566         # Create the old_issues entry
2567         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2568
2569         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2570         if ( $privacy && $privacy == 2) {
2571             $old_checkout->anonymize;
2572         }
2573
2574         # And finally delete the issue
2575         $issue->delete;
2576
2577         $issue->item->onloan(undef)->store(
2578             {   log_action        => 0,
2579                 skip_record_index => $params->{skip_record_index},
2580                 skip_holds_queue  => $params->{skip_holds_queue}
2581             }
2582         );
2583
2584         if ( C4::Context->preference('StoreLastBorrower') ) {
2585             my $item = Koha::Items->find( $itemnumber );
2586             $item->last_returned_by( $patron );
2587         }
2588
2589         # Remove any OVERDUES related debarment if the borrower has no overdues
2590         my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
2591         if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2592           && $patron->debarred
2593           && !$patron->has_overdues
2594           && $overdue_restrictions->count
2595         ) {
2596             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2597         }
2598
2599     });
2600
2601     return $issue_id;
2602 }
2603
2604 =head2 _debar_user_on_return
2605
2606     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2607
2608 C<$borrower> borrower hashref
2609
2610 C<$item> item hashref
2611
2612 C<$datedue> date due DateTime object
2613
2614 C<$returndate> DateTime object representing the return time
2615
2616 Internal function, called only by AddReturn that calculates and updates
2617  the user fine days, and debars them if necessary.
2618
2619 Should only be called for overdue returns
2620
2621 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2622 to ease testing.
2623
2624 =cut
2625
2626 sub _calculate_new_debar_dt {
2627     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2628
2629     my $branchcode = _GetCircControlBranch( $item, $borrower );
2630     my $circcontrol = C4::Context->preference('CircControl');
2631     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2632         {   categorycode => $borrower->{categorycode},
2633             itemtype     => $item->{itype},
2634             branchcode   => $branchcode,
2635             rules => [
2636                 'finedays',
2637                 'lengthunit',
2638                 'firstremind',
2639                 'maxsuspensiondays',
2640                 'suspension_chargeperiod',
2641             ]
2642         }
2643     );
2644     my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2645     my $unit     = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2646     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2647
2648     return unless $finedays;
2649
2650     # finedays is in days, so hourly loans must multiply by 24
2651     # thus 1 hour late equals 1 day suspension * finedays rate
2652     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2653
2654     # grace period is measured in the same units as the loan
2655     my $grace =
2656       DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2657
2658     my $deltadays = DateTime::Duration->new(
2659         days => $chargeable_units
2660     );
2661
2662     if ( $deltadays->subtract($grace)->is_positive() ) {
2663         my $suspension_days = $deltadays * $finedays;
2664
2665         if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2666             # No need to / 1 and do not consider / 0
2667             $suspension_days = DateTime::Duration->new(
2668                 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2669             );
2670         }
2671
2672         # If the max suspension days is < than the suspension days
2673         # the suspension days is limited to this maximum period.
2674         my $max_sd = $issuing_rule->{maxsuspensiondays};
2675         if ( defined $max_sd && $max_sd ne '' ) {
2676             $max_sd = DateTime::Duration->new( days => $max_sd );
2677             $suspension_days = $max_sd
2678               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2679         }
2680
2681         my ( $has_been_extended );
2682         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2683             my $patron = Koha::Patrons->find($borrower->{borrowernumber});
2684             my $debarment = $patron->restrictions->search({type => 'SUSPENSION' },{rows => 1})->single;
2685             if ( $debarment ) {
2686                 $return_date = dt_from_string( $debarment->expiration, 'sql' );
2687                 $has_been_extended = 1;
2688             }
2689         }
2690
2691         my $new_debar_dt;
2692         # Use the calendar or not to calculate the debarment date
2693         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2694             my $calendar = Koha::Calendar->new(
2695                 branchcode => $branchcode,
2696                 days_mode  => 'Calendar'
2697             );
2698             $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2699         }
2700         else {
2701             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2702         }
2703         return $new_debar_dt;
2704     }
2705     return;
2706 }
2707
2708 sub _debar_user_on_return {
2709     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2710
2711     $return_date //= dt_from_string();
2712
2713     my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2714
2715     return unless $new_debar_dt;
2716
2717     Koha::Patron::Debarments::AddUniqueDebarment({
2718         borrowernumber => $borrower->{borrowernumber},
2719         expiration     => $new_debar_dt->ymd(),
2720         type           => 'SUSPENSION',
2721     });
2722     # if borrower was already debarred but does not get an extra debarment
2723     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2724     my ($new_debarment_str, $is_a_reminder);
2725     if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2726         $is_a_reminder = 1;
2727         $new_debarment_str = $borrower->{debarred};
2728     } else {
2729         $new_debarment_str = $new_debar_dt->ymd();
2730     }
2731     # FIXME Should return a DateTime object
2732     return $new_debarment_str, $is_a_reminder;
2733 }
2734
2735 =head2 _FixOverduesOnReturn
2736
2737    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2738
2739 C<$borrowernumber> borrowernumber
2740
2741 C<$itemnumber> itemnumber
2742
2743 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2744
2745 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2746
2747 Internal function
2748
2749 =cut
2750
2751 sub _FixOverduesOnReturn {
2752     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2753     unless( $borrowernumber ) {
2754         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2755         return;
2756     }
2757     unless( $item ) {
2758         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2759         return;
2760     }
2761     unless( $status ) {
2762         warn "_FixOverduesOnReturn() not supplied valid status";
2763         return;
2764     }
2765
2766     my $schema = Koha::Database->schema;
2767
2768     my $result = $schema->txn_do(
2769         sub {
2770             # check for overdue fine
2771             my $accountlines = Koha::Account::Lines->search(
2772                 {
2773                     borrowernumber  => $borrowernumber,
2774                     itemnumber      => $item,
2775                     debit_type_code => 'OVERDUE',
2776                     status          => 'UNRETURNED'
2777                 }
2778             );
2779             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2780
2781             my $accountline = $accountlines->next;
2782             my $payments = $accountline->credits;
2783
2784             my $amountoutstanding = $accountline->amountoutstanding;
2785             if ( $accountline->amount == 0 && $payments->count == 0 ) {
2786                 $accountline->delete;
2787                 return 0; # no warning, we've just removed a zero value fine (backdated return)
2788             } elsif ($exemptfine && ($amountoutstanding != 0)) {
2789                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2790                 my $credit = $account->add_credit(
2791                     {
2792                         amount     => $amountoutstanding,
2793                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2794                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2795                         interface  => C4::Context->interface,
2796                         type       => 'FORGIVEN',
2797                         item_id    => $item
2798                     }
2799                 );
2800
2801                 $credit->apply({ debits => [ $accountline ] });
2802
2803                 if (C4::Context->preference("FinesLog")) {
2804                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2805                 }
2806             }
2807
2808             $accountline->status($status);
2809             return $accountline->store();
2810         }
2811     );
2812
2813     return $result;
2814 }
2815
2816 =head2 _GetCircControlBranch
2817
2818    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2819
2820 Internal function :
2821
2822 Return the library code to be used to determine which circulation
2823 policy applies to a transaction.  Looks up the CircControl and
2824 HomeOrHoldingBranch system preferences.
2825
2826 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2827
2828 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2829
2830 =cut
2831
2832 sub _GetCircControlBranch {
2833     my ($item, $borrower) = @_;
2834     my $circcontrol = C4::Context->preference('CircControl');
2835     my $branch;
2836
2837     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2838         $branch= C4::Context->userenv->{'branch'};
2839     } elsif ($circcontrol eq 'PatronLibrary') {
2840         $branch=$borrower->{branchcode};
2841     } else {
2842         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2843         $branch = $item->{$branchfield};
2844         # default to item home branch if holdingbranch is used
2845         # and is not defined
2846         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2847             $branch = $item->{homebranch};
2848         }
2849     }
2850     return $branch;
2851 }
2852
2853 =head2 GetUpcomingDueIssues
2854
2855   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2856
2857 =cut
2858
2859 sub GetUpcomingDueIssues {
2860     my $params = shift;
2861
2862     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2863     my $dbh = C4::Context->dbh;
2864     my $statement;
2865     $statement = q{
2866         SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2867         FROM issues
2868         LEFT JOIN items USING (itemnumber)
2869         LEFT JOIN branches ON branches.branchcode =
2870     };
2871     $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2872     $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2873     my @bind_parameters = ( $params->{'days_in_advance'} );
2874
2875     my $sth = $dbh->prepare( $statement );
2876     $sth->execute( @bind_parameters );
2877     my $upcoming_dues = $sth->fetchall_arrayref({});
2878
2879     return $upcoming_dues;
2880 }
2881
2882 =head2 CanBookBeRenewed
2883
2884   ($ok,$error,$info) = &CanBookBeRenewed($patron, $issue, $override_limit);
2885
2886 Find out whether a borrowed item may be renewed.
2887
2888 C<$patron> is the patron who currently has the issue.
2889
2890 C<$issue> is the checkout to renew.
2891
2892 C<$override_limit>, if supplied with a true value, causes
2893 the limit on the number of times that the loan can be renewed
2894 (as controlled by the item type) to be ignored. Overriding also allows
2895 to renew sooner than "No renewal before" and to manually renew loans
2896 that are automatically renewed.
2897
2898 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2899 item must currently be on loan to the specified borrower; renewals
2900 must be allowed for the item's type; and the borrower must not have
2901 already renewed the loan.
2902     $error will contain the reason the renewal can not proceed
2903     $info will contain a hash of additional info
2904       currently 'soonest_renew_date' if error is 'too soon'
2905
2906 =cut
2907
2908 sub CanBookBeRenewed {
2909     my ( $patron, $issue, $override_limit, $cron ) = @_;
2910
2911     my $auto_renew = "no";
2912     my $soonest;
2913     my $item = $issue->item;
2914
2915     return ( 0, 'no_item' ) unless $item;
2916     return ( 0, 'no_checkout' ) unless $issue;
2917     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2918     return ( 0, 'item_issued_to_other_patron') if $issue->borrowernumber != $patron->borrowernumber;
2919     return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2920
2921        # override_limit will override anything else except on_reserve
2922     unless ( $override_limit ){
2923         my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2924         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2925             {
2926                 categorycode => $patron->categorycode,
2927                 itemtype     => $item->effective_itemtype,
2928                 branchcode   => $branchcode,
2929                 rules => [
2930                     'renewalsallowed',
2931                     'lengthunit',
2932                     'unseen_renewals_allowed'
2933                 ]
2934             }
2935         );
2936
2937         return ( 0, "too_many" )
2938           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
2939
2940         return ( 0, "too_unseen" )
2941           if C4::Context->preference('UnseenRenewals') &&
2942             looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
2943             $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2944
2945         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2946         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2947         my $restricted  = $patron->is_debarred;
2948         my $hasoverdues = $patron->has_overdues;
2949
2950         if ( $restricted and $restrictionblockrenewing ) {
2951             return ( 0, 'restriction');
2952         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2953             return ( 0, 'overdue');
2954         }
2955
2956         ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
2957             patron     => $patron,
2958             item       => $item,
2959             branchcode => $branchcode,
2960             issue      => $issue
2961         });
2962         return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
2963         # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2964         # extra notices being sent. Cron also implies no override
2965         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_account_expired';
2966         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_late';
2967         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_much_oweing';
2968     }
2969
2970     if ( C4::Context->preference('UseRecalls') ) {
2971         my $recall = undef;
2972         $recall = $item->check_recalls if $item->can_be_waiting_recall;
2973         if ( defined $recall ) {
2974             if ( $recall->item_level ) {
2975                 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
2976                 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
2977             } else {
2978                 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
2979                 return ( 0, 'recalled' ) unless ( $recall->waiting );
2980             }
2981         }
2982     }
2983
2984     # There is an item level hold on this item, no other item can fill the hold
2985     return ( 0, "on_reserve" )
2986       if ( $item->current_holds->search( { non_priority => 0 } )->count );
2987
2988     my $fillable_holds = Koha::Holds->search(
2989         {
2990             biblionumber => $item->biblionumber,
2991             non_priority => 0,
2992             found        => undef,
2993             reservedate  => { '<=' => \'NOW()' },
2994             suspend      => 0
2995         }
2996     );
2997     if ( $fillable_holds->count ) {
2998         if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
2999             my @possible_holds = $fillable_holds->as_list;
3000
3001             # Get all other items that could possibly fill reserves
3002             # FIXME We could join reserves (or more tables) here to eliminate some checks later
3003             my @other_items = Koha::Items->search({
3004                 biblionumber => $item->biblionumber,
3005                 onloan       => undef,
3006                 notforloan   => 0,
3007                 -not         => { itemnumber => $item->itemnumber } })->as_list;
3008
3009             return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
3010
3011             my %matched_items;
3012             foreach my $possible_hold (@possible_holds) {
3013                 my $fillable = 0;
3014                 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
3015                 my $items_any_available = ItemsAnyAvailableAndNotRestricted({
3016                     biblionumber => $item->biblionumber,
3017                     patron => $patron_with_reserve
3018                 });
3019
3020                 # FIXME: We are not checking whether the item we are renewing can fill the hold
3021
3022                 foreach my $other_item (@other_items) {
3023                   next if defined $matched_items{$other_item->itemnumber};
3024                   next if IsItemOnHoldAndFound( $other_item->itemnumber );
3025                   next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef, $items_any_available);
3026                   next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3027                   # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3028                   # CanItemBeReserved checks 'rules' and 'policies' which means
3029                   # items will fill holds at checkin that are rejected here
3030                   $fillable = 1;
3031                   $matched_items{$other_item->itemnumber} = 1;
3032                   last;
3033                 }
3034                 return ( 0, "on_reserve" ) unless $fillable;
3035             }
3036         }
3037         else {
3038             my ($status, $matched_reserve, $possible_reserves) = CheckReserves($item);
3039             return ( 0, "on_reserve" ) if $status;
3040         }
3041     }
3042
3043     return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3044     $soonest = GetSoonestRenewDate($patron, $issue);
3045     if ( $soonest > dt_from_string() ){
3046         return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3047     }
3048
3049     return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3050
3051     return ( 1, undef );
3052 }
3053
3054 =head2 AddRenewal
3055
3056   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen], [$automatic]);
3057
3058 Renews a loan.
3059
3060 C<$borrowernumber> is the borrower number of the patron who currently
3061 has the item.
3062
3063 C<$itemnumber> is the number of the item to renew.
3064
3065 C<$branch> is the library where the renewal took place (if any).
3066            The library that controls the circ policies for the renewal is retrieved from the issues record.
3067
3068 C<$datedue> can be a DateTime object used to set the due date.
3069
3070 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
3071 this parameter is not supplied, lastreneweddate is set to the current date.
3072
3073 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3074 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3075 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3076 syspref)
3077
3078 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3079 from the book's item type.
3080
3081 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3082 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3083 fallback to a true value
3084
3085 C<$automatic> is a boolean flag indicating the renewal was triggered automatically and not by a person ( librarian or patron )
3086
3087 C<$skip_record_index> is an optional boolean flag to indicate whether queuing the search indexing
3088 should be skipped for this renewal.
3089
3090 =cut
3091
3092 sub AddRenewal {
3093     my $borrowernumber  = shift;
3094     my $itemnumber      = shift or return;
3095     my $branch          = shift;
3096     my $datedue         = shift;
3097     my $lastreneweddate = shift || dt_from_string();
3098     my $skipfinecalc    = shift;
3099     my $seen            = shift;
3100     my $automatic       = shift;
3101     my $skip_record_index = shift;
3102
3103     # Fallback on a 'seen' renewal
3104     $seen = defined $seen && $seen == 0 ? 0 : 1;
3105
3106     my $item_object   = Koha::Items->find($itemnumber) or return;
3107     my $biblio = $item_object->biblio;
3108     my $issue  = $item_object->checkout;
3109     my $item_unblessed = $item_object->unblessed;
3110
3111     my $renewal_type = $automatic ? "Automatic" : "Manual";
3112
3113     my $dbh = C4::Context->dbh;
3114
3115     return unless $issue;
3116
3117     $borrowernumber ||= $issue->borrowernumber;
3118
3119     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3120         $datedue = dt_from_string($datedue, 'sql');
3121     }
3122
3123     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3124     my $patron_unblessed = $patron->unblessed;
3125
3126     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3127
3128     my $schema = Koha::Database->schema;
3129     $schema->txn_do(sub{
3130
3131         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3132             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3133         }
3134         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3135
3136         # If the due date wasn't specified, calculate it by adding the
3137         # book's loan length to today's date or the current due date
3138         # based on the value of the RenewalPeriodBase syspref.
3139         my $itemtype = $item_object->effective_itemtype;
3140         unless ($datedue) {
3141
3142             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3143                                             dt_from_string( $issue->date_due, 'sql' ) :
3144                                             dt_from_string();
3145             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3146         }
3147
3148         my $fees = Koha::Charges::Fees->new(
3149             {
3150                 patron    => $patron,
3151                 library   => $circ_library,
3152                 item      => $item_object,
3153                 from_date => dt_from_string( $issue->date_due, 'sql' ),
3154                 to_date   => dt_from_string($datedue),
3155             }
3156         );
3157
3158         # Increment the unseen renewals, if appropriate
3159         # We only do so if the syspref is enabled and
3160         # a maximum value has been set in the circ rules
3161         my $unseen_renewals = $issue->unseen_renewals;
3162         if (C4::Context->preference('UnseenRenewals')) {
3163             my $rule = Koha::CirculationRules->get_effective_rule(
3164                 {   categorycode => $patron->categorycode,
3165                     itemtype     => $item_object->effective_itemtype,
3166                     branchcode   => $circ_library->branchcode,
3167                     rule_name    => 'unseen_renewals_allowed'
3168                 }
3169             );
3170             if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3171                 $unseen_renewals++;
3172             } else {
3173                 # If the renewal is seen, unseen should revert to 0
3174                 $unseen_renewals = 0;
3175             }
3176         }
3177
3178         # Update the issues record to have the new due date, and a new count
3179         # of how many times it has been renewed.
3180         my $renews = ( $issue->renewals_count || 0 ) + 1;
3181         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3182
3183         eval{
3184             $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3185         };
3186         if( $sth->err ){
3187             Koha::Exceptions::Checkout::FailedRenewal->throw(
3188                 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3189             );
3190         }
3191
3192         # Update the renewal count on the item, and tell zebra to reindex
3193         $renews = ( $item_object->renewals || 0 ) + 1;
3194         $item_object->renewals($renews);
3195         $item_object->onloan($datedue);
3196         # Don't index as we are in a transaction, skip hardcoded here
3197         $item_object->store({ log_action => 0, skip_record_index => 1 });
3198
3199         # Charge a new rental fee, if applicable
3200         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3201         if ( $charge > 0 ) {
3202             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3203         }
3204
3205         # Charge a new accumulate rental fee, if applicable
3206         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3207         if ( $itemtype_object ) {
3208             my $accumulate_charge = $fees->accumulate_rentalcharge();
3209             if ( $accumulate_charge > 0 ) {
3210                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3211             }
3212             $charge += $accumulate_charge;
3213         }
3214
3215         # Send a renewal slip according to checkout alert preferencei
3216         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3217             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3218             my %conditions        = (
3219                 branchcode   => $branch,
3220                 categorycode => $patron->categorycode,
3221                 item_type    => $itemtype,
3222                 notification => 'CHECKOUT',
3223             );
3224             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3225                 SendCirculationAlert(
3226                     {
3227                         type     => 'RENEWAL',
3228                         item     => $item_unblessed,
3229                         borrower => $patron->unblessed,
3230                         branch   => $branch,
3231                     }
3232                 );
3233             }
3234         }
3235
3236         # Remove any OVERDUES related debarment if the borrower has no overdues
3237         my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
3238         if ( $patron
3239           && $patron->is_debarred
3240           && ! $patron->has_overdues
3241           && $overdue_restrictions->count
3242         ) {
3243             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3244         }
3245
3246         # Add renewal record
3247         my $renewal = Koha::Checkouts::Renewal->new(
3248             {
3249                 checkout_id  => $issue->issue_id,
3250                 interface    => C4::Context->interface,
3251                 renewal_type => $renewal_type,
3252                 renewer_id   => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3253                 seen         => $seen,
3254             }
3255         )->store();
3256
3257         # Add the renewal to stats
3258         C4::Stats::UpdateStats(
3259             {
3260                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3261                 type           => 'renew',
3262                 amount         => $charge,
3263                 itemnumber     => $itemnumber,
3264                 itemtype       => $itemtype,
3265                 location       => $item_object->location,
3266                 borrowernumber => $borrowernumber,
3267                 ccode          => $item_object->ccode,
3268                 categorycode   => $patron->categorycode,
3269                 interface      => C4::Context->interface,
3270             }
3271         );
3272
3273         #Log the renewal
3274         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3275
3276         Koha::Plugins->call('after_circ_action', {
3277             action  => 'renewal',
3278             payload => {
3279                 checkout  => $issue->get_from_storage
3280             }
3281         });
3282     });
3283
3284     unless( $skip_record_index ){
3285         # We index now, after the transaction is committed
3286         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
3287         $indexer->index_records( $item_object->biblionumber, "specialUpdate", "biblioserver" );
3288     }
3289
3290     return $datedue;
3291 }
3292
3293 sub GetRenewCount {
3294     # check renewal status
3295     my ( $borrowernumber_or_patron, $itemnumber_or_item ) = @_;
3296
3297     my $dbh           = C4::Context->dbh;
3298     my $renewcount    = 0;
3299     my $unseencount    = 0;
3300     my $renewsallowed = 0;
3301     my $unseenallowed = 0;
3302     my $renewsleft    = 0;
3303     my $unseenleft    = 0;
3304     my $patron = blessed $borrowernumber_or_patron ?
3305         $borrowernumber_or_patron : Koha::Patrons->find($borrowernumber_or_patron);
3306     my $item = blessed $itemnumber_or_item ?
3307         $itemnumber_or_item : Koha::Items->find($itemnumber_or_item);
3308
3309     return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3310
3311     # Look in the issues table for this item, lent to this borrower,
3312     # and not yet returned.
3313
3314     # FIXME - I think this function could be redone to use only one SQL call.
3315     my $sth = $dbh->prepare(q{
3316         SELECT * FROM issues
3317         WHERE  (borrowernumber = ?) AND (itemnumber = ?)
3318     });
3319     $sth->execute( $patron->borrowernumber, $item->itemnumber );
3320     my $data = $sth->fetchrow_hashref;
3321     $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3322     $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3323     # $item and $borrower should be calculated
3324     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3325
3326     my $rules = Koha::CirculationRules->get_effective_rules(
3327         {
3328             categorycode => $patron->categorycode,
3329             itemtype     => $item->effective_itemtype,
3330             branchcode   => $branchcode,
3331             rules        => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3332         }
3333     );
3334     $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3335     $unseenallowed = $rules->{unseen_renewals_allowed} ?
3336         $rules->{unseen_renewals_allowed} :
3337         0;
3338     $renewsleft    = $renewsallowed - $renewcount;
3339     $unseenleft    = $unseenallowed - $unseencount;
3340     if($renewsleft < 0){ $renewsleft = 0; }
3341     if($unseenleft < 0){ $unseenleft = 0; }
3342     return (
3343         $renewcount,
3344         $renewsallowed,
3345         $renewsleft,
3346         $unseencount,
3347         $unseenallowed,
3348         $unseenleft
3349     );
3350 }
3351
3352 =head2 GetSoonestRenewDate
3353
3354   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($patron, $issue);
3355
3356 Find out the soonest possible renew date of a borrowed item.
3357
3358 C<$patron> is the patron who currently has the item on loan.
3359
3360 C<$issue> is the the item issue.
3361
3362 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3363 renew date, based on the value "No renewal before" of the applicable
3364 issuing rule. Returns the current date if the item can already be
3365 renewed, and returns undefined if the patron, item, or checkout
3366 cannot be found.
3367
3368 =cut
3369
3370 sub GetSoonestRenewDate {
3371     my ( $patron, $issue ) = @_;
3372     return unless $issue;
3373     return unless $patron;
3374
3375     my $item = $issue->item;
3376     return unless $item;
3377
3378     my $dbh = C4::Context->dbh;
3379
3380     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3381     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3382         {   categorycode => $patron->categorycode,
3383             itemtype     => $item->effective_itemtype,
3384             branchcode   => $branchcode,
3385             rules => [
3386                 'norenewalbefore',
3387                 'lengthunit',
3388             ]
3389         }
3390     );
3391
3392     my $now = dt_from_string;
3393
3394     if ( defined $issuing_rule->{norenewalbefore}
3395         and $issuing_rule->{norenewalbefore} ne "" )
3396     {
3397         my $soonestrenewal =
3398           dt_from_string( $issue->date_due )->subtract(
3399             $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3400
3401         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3402             and $issuing_rule->{lengthunit} eq 'days' )
3403         {
3404             $soonestrenewal->truncate( to => 'day' );
3405         }
3406         return $soonestrenewal if $now < $soonestrenewal;
3407     } elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
3408         # Checkouts with auto-renewing fall back to due date
3409         my $soonestrenewal = dt_from_string( $issue->date_due );
3410         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3411             and $issuing_rule->{lengthunit} eq 'days' )
3412         {
3413             $soonestrenewal->truncate( to => 'day' );
3414         }
3415         return $soonestrenewal;
3416     }
3417     return $now;
3418 }
3419
3420 =head2 GetLatestAutoRenewDate
3421
3422   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($patron, $issue);
3423
3424 Find out the latest possible auto renew date of a borrowed item.
3425
3426 C<$patron> is the patron who currently has the item on loan.
3427
3428 C<$issue> is the item issue.
3429
3430 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3431 auto renew date, based on the value "No auto renewal after" and the "No auto
3432 renewal after (hard limit) of the applicable issuing rule.
3433 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3434 or item cannot be found.
3435
3436 =cut
3437
3438 sub GetLatestAutoRenewDate {
3439     my ( $patron, $issue ) = @_;
3440     return unless $issue;
3441     return unless $patron;
3442
3443     my $item = $issue->item;
3444     return unless $item;
3445
3446     my $dbh = C4::Context->dbh;
3447
3448     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3449     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3450         {
3451             categorycode => $patron->categorycode,
3452             itemtype     => $item->effective_itemtype,
3453             branchcode   => $branchcode,
3454             rules => [
3455                 'no_auto_renewal_after',
3456                 'no_auto_renewal_after_hard_limit',
3457                 'lengthunit',
3458             ]
3459         }
3460     );
3461
3462     return unless $circulation_rules;
3463     return
3464       if ( not $circulation_rules->{no_auto_renewal_after}
3465             or $circulation_rules->{no_auto_renewal_after} eq '' )
3466       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3467              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3468
3469     my $maximum_renewal_date;
3470     if ( $circulation_rules->{no_auto_renewal_after} ) {
3471         $maximum_renewal_date = dt_from_string($issue->issuedate);
3472         $maximum_renewal_date->add(
3473             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3474         );
3475     }
3476
3477     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3478         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3479         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3480     }
3481     return $maximum_renewal_date;
3482 }
3483
3484
3485 =head2 GetIssuingCharges
3486
3487   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3488
3489 Calculate how much it would cost for a given patron to borrow a given
3490 item, including any applicable discounts.
3491
3492 C<$itemnumber> is the item number of item the patron wishes to borrow.
3493
3494 C<$borrowernumber> is the patron's borrower number.
3495
3496 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3497 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3498 if it's a video).
3499
3500 =cut
3501
3502 sub GetIssuingCharges {
3503
3504     # calculate charges due
3505     my ( $itemnumber, $borrowernumber ) = @_;
3506     my $charge = 0;
3507     my $dbh    = C4::Context->dbh;
3508     my $item_type;
3509
3510     # Get the book's item type and rental charge (via its biblioitem).
3511     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3512         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3513     $charge_query .= (C4::Context->preference('item-level_itypes'))
3514         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3515         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3516
3517     $charge_query .= ' WHERE items.itemnumber =?';
3518
3519     my $sth = $dbh->prepare($charge_query);
3520     $sth->execute($itemnumber);
3521     my $patron;
3522     if ( my $item_data = $sth->fetchrow_hashref ) {
3523         $item_type = $item_data->{itemtype};
3524         $charge    = $item_data->{rentalcharge};
3525         if ($charge) {
3526             # FIXME This should follow CircControl
3527             my $branch = C4::Context::mybranch();
3528             $patron //= Koha::Patrons->find( $borrowernumber );
3529             my $discount = Koha::CirculationRules->get_effective_rule({
3530                 categorycode => $patron->categorycode,
3531                 branchcode   => $branch,
3532                 itemtype     => $item_type,
3533                 rule_name    => 'rentaldiscount'
3534             });
3535             if ($discount) {
3536                 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3537             }
3538             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3539         }
3540     }
3541
3542     return ( $charge, $item_type );
3543 }
3544
3545 =head2 AddIssuingCharge
3546
3547   &AddIssuingCharge( $checkout, $charge, $type )
3548
3549 =cut
3550
3551 sub AddIssuingCharge {
3552     my ( $checkout, $charge, $type ) = @_;
3553
3554     # FIXME What if checkout does not exist?
3555
3556     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3557     my $accountline = $account->add_debit(
3558         {
3559             amount      => $charge,
3560             note        => undef,
3561             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3562             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3563             interface   => C4::Context->interface,
3564             type        => $type,
3565             item_id     => $checkout->itemnumber,
3566             issue_id    => $checkout->issue_id,
3567         }
3568     );
3569 }
3570
3571 =head2 GetTransfersFromTo
3572
3573   @results = GetTransfersFromTo($frombranch,$tobranch);
3574
3575 Returns the list of pending transfers between $from and $to branch
3576
3577 =cut
3578
3579 sub GetTransfersFromTo {
3580     my ( $frombranch, $tobranch ) = @_;
3581     return unless ( $frombranch && $tobranch );
3582     my $dbh   = C4::Context->dbh;
3583     my $query = "
3584         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3585         FROM   branchtransfers
3586         WHERE  frombranch=?
3587           AND  tobranch=?
3588           AND datecancelled IS NULL
3589           AND datesent IS NOT NULL
3590           AND datearrived IS NULL
3591     ";
3592     my $sth = $dbh->prepare($query);
3593     $sth->execute( $frombranch, $tobranch );
3594     my @gettransfers;
3595
3596     while ( my $data = $sth->fetchrow_hashref ) {
3597         push @gettransfers, $data;
3598     }
3599     return (@gettransfers);
3600 }
3601
3602 =head2 SendCirculationAlert
3603
3604 Send out a C<check-in> or C<checkout> alert using the messaging system.
3605
3606 B<Parameters>:
3607
3608 =over 4
3609
3610 =item type
3611
3612 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3613
3614 =item item
3615
3616 Hashref of information about the item being checked in or out.
3617
3618 =item borrower
3619
3620 Hashref of information about the borrower of the item.
3621
3622 =item branch
3623
3624 The branchcode from where the checkout or check-in took place.
3625
3626 =back
3627
3628 B<Example>:
3629
3630     SendCirculationAlert({
3631         type     => 'CHECKOUT',
3632         item     => $item,
3633         borrower => $borrower,
3634         branch   => $branch,
3635     });
3636
3637 =cut
3638
3639 sub SendCirculationAlert {
3640     my ($opts) = @_;
3641     my ($type, $item, $borrower, $branch, $issue) =
3642         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3643     my %message_name = (
3644         CHECKIN  => 'Item_Check_in',
3645         CHECKOUT => 'Item_Checkout',
3646         RENEWAL  => 'Item_Checkout',
3647     );
3648     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3649         borrowernumber => $borrower->{borrowernumber},
3650         message_name   => $message_name{$type},
3651     });
3652
3653
3654     my $tables = {
3655         items => $item->{itemnumber},
3656         biblio      => $item->{biblionumber},
3657         biblioitems => $item->{biblionumber},
3658         borrowers   => $borrower,
3659         branches    => $branch,
3660     };
3661
3662     # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3663     # See C4::Letters:: _parseletter_sth
3664     if( $type eq 'CHECKIN' ){
3665         $tables->{old_issues} = $issue->issue_id;
3666     } else {
3667         $tables->{issues} = $item->{itemnumber};
3668     }
3669
3670     my $schema = Koha::Database->new->schema;
3671     my @transports = keys %{ $borrower_preferences->{transports} };
3672
3673     # From the MySQL doc:
3674     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3675     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3676     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3677     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3678
3679     for my $mtt (@transports) {
3680         my $letter =  C4::Letters::GetPreparedLetter (
3681             module => 'circulation',
3682             letter_code => $type,
3683             branchcode => $branch,
3684             message_transport_type => $mtt,
3685             lang => $borrower->{lang},
3686             tables => $tables,
3687         ) or next;
3688
3689         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3690         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3691         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3692         unless ( $message ) {
3693             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3694             my $patron = Koha::Patrons->find($borrower->{borrowernumber});
3695             C4::Message->enqueue($letter, $patron, $mtt);
3696         } else {
3697             $message->append($letter);
3698             $message->update;
3699         }
3700         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3701     }
3702
3703     return;
3704 }
3705
3706 =head2 updateWrongTransfer
3707
3708   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3709
3710 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
3711
3712 =cut
3713
3714 sub updateWrongTransfer {
3715         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3716
3717     # first step: cancel the original transfer
3718     my $item = Koha::Items->find($itemNumber);
3719     my $transfer = $item->get_transfer;
3720     $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3721
3722     # second step: create a new transfer to the right location
3723     my $new_transfer = $item->request_transfer(
3724         {
3725             to            => $transfer->to_library,
3726             reason        => $transfer->reason,
3727             comment       => $transfer->comments,
3728             ignore_limits => 1,
3729             enqueue       => 1
3730         }
3731     );
3732
3733     return $new_transfer;
3734 }
3735
3736 =head2 CalcDateDue
3737
3738 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3739
3740 this function calculates the due date given the start date and configured circulation rules,
3741 checking against the holidays calendar as per the daysmode circulation rule.
3742 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3743 C<$itemtype>  = itemtype code of item in question
3744 C<$branch>  = location whose calendar to use
3745 C<$borrower> = Borrower object
3746 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3747
3748 =cut
3749
3750 sub CalcDateDue {
3751     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3752
3753     $isrenewal ||= 0;
3754
3755     # loanlength now a href
3756     my $loanlength =
3757             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3758
3759     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3760             ? qq{renewalperiod}
3761             : qq{issuelength};
3762
3763     my $datedue;
3764     if ( $startdate ) {
3765         if (ref $startdate ne 'DateTime' ) {
3766             $datedue = dt_from_string($datedue);
3767         } else {
3768             $datedue = $startdate->clone;
3769         }
3770     } else {
3771         $datedue = dt_from_string()->truncate( to => 'minute' );
3772     }
3773
3774
3775     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3776         {
3777             categorycode => $borrower->{categorycode},
3778             itemtype     => $itemtype,
3779             branchcode   => $branch,
3780         }
3781     );
3782
3783     # calculate the datedue as normal
3784     if ( $daysmode eq 'Days' )
3785     {    # ignoring calendar
3786         if ( $loanlength->{lengthunit} eq 'hours' ) {
3787             $datedue->add( hours => $loanlength->{$length_key} );
3788         } else {    # days
3789             $datedue->add( days => $loanlength->{$length_key} );
3790             $datedue->set_hour(23);
3791             $datedue->set_minute(59);
3792         }
3793     } else {
3794         my $dur;
3795         if ($loanlength->{lengthunit} eq 'hours') {
3796             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3797         }
3798         else { # days
3799             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3800         }
3801         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3802         $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3803         if ($loanlength->{lengthunit} eq 'days') {
3804             $datedue->set_hour(23);
3805             $datedue->set_minute(59);
3806         }
3807     }
3808
3809     # if Hard Due Dates are used, retrieve them and apply as necessary
3810     my ( $hardduedate, $hardduedatecompare ) =
3811       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3812     if ($hardduedate) {    # hardduedates are currently dates
3813         $hardduedate->truncate( to => 'minute' );
3814         $hardduedate->set_hour(23);
3815         $hardduedate->set_minute(59);
3816         my $cmp = DateTime->compare( $hardduedate, $datedue );
3817
3818 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3819 # if the calculated date is before the 'after' Hard Due Date (floor), override
3820 # if the hard due date is set to 'exactly', overrride
3821         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3822             $datedue = $hardduedate->clone;
3823         }
3824
3825         # in all other cases, keep the date due as it is
3826
3827     }
3828
3829     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3830     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3831         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3832         if( $expiry_dt ) { #skip empty expiry date..
3833             $expiry_dt->set( hour => 23, minute => 59);
3834             my $d1= $datedue->clone->set_time_zone('floating');
3835             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3836                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3837             }
3838         }
3839         if ( $daysmode ne 'Days' ) {
3840           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3841           if ( $calendar->is_holiday($datedue) ) {
3842               # Don't return on a closed day
3843               $datedue = $calendar->prev_open_days( $datedue, 1 );
3844           }
3845         }
3846     }
3847
3848     return $datedue;
3849 }
3850
3851
3852 sub CheckValidBarcode{
3853 my ($barcode) = @_;
3854 my $dbh = C4::Context->dbh;
3855 my $query=qq|SELECT count(*)
3856              FROM items
3857              WHERE barcode=?
3858             |;
3859 my $sth = $dbh->prepare($query);
3860 $sth->execute($barcode);
3861 my $exist=$sth->fetchrow ;
3862 return $exist;
3863 }
3864
3865 =head2 IsBranchTransferAllowed
3866
3867   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3868
3869 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3870
3871 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3872 Koha::Item->can_be_transferred.
3873
3874 =cut
3875
3876 sub IsBranchTransferAllowed {
3877         my ( $toBranch, $fromBranch, $code ) = @_;
3878
3879         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3880
3881         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3882         my $dbh = C4::Context->dbh;
3883
3884         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3885         $sth->execute( $toBranch, $fromBranch, $code );
3886         my $limit = $sth->fetchrow_hashref();
3887
3888         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3889         if ( $limit->{'limitId'} ) {
3890                 return 0;
3891         } else {
3892                 return 1;
3893         }
3894 }
3895
3896 =head2 CreateBranchTransferLimit
3897
3898   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3899
3900 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3901
3902 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3903
3904 =cut
3905
3906 sub CreateBranchTransferLimit {
3907    my ( $toBranch, $fromBranch, $code ) = @_;
3908    return unless defined($toBranch) && defined($fromBranch);
3909    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3910
3911    my $dbh = C4::Context->dbh;
3912
3913    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3914    return $sth->execute( $code, $toBranch, $fromBranch );
3915 }
3916
3917 =head2 DeleteBranchTransferLimits
3918
3919     my $result = DeleteBranchTransferLimits($frombranch);
3920
3921 Deletes all the library transfer limits for one library.  Returns the
3922 number of limits deleted, 0e0 if no limits were deleted, or undef if
3923 no arguments are supplied.
3924
3925 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3926     fromBranch => $fromBranch
3927     })->delete.
3928
3929 =cut
3930
3931 sub DeleteBranchTransferLimits {
3932     my $branch = shift;
3933     return unless defined $branch;
3934     my $dbh    = C4::Context->dbh;
3935     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3936     return $sth->execute($branch);
3937 }
3938
3939 sub ReturnLostItem{
3940     my ( $borrowernumber, $itemnum ) = @_;
3941     MarkIssueReturned( $borrowernumber, $itemnum );
3942 }
3943
3944 =head2 LostItem
3945
3946   LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3947
3948 The final optional parameter, C<$params>, expected to contain
3949 'skip_record_index' key, which relayed down to Koha::Item/store,
3950 there it prevents calling of ModZebra index_records,
3951 which takes most of the time in batch adds/deletes: index_records better
3952 to be called later in C<additem.pl> after the whole loop.
3953
3954 $params:
3955     skip_record_index => 1|0
3956
3957 =cut
3958
3959 sub LostItem{
3960     my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3961
3962     unless ( $mark_lost_from ) {
3963         # Temporary check to avoid regressions
3964         die q|LostItem called without $mark_lost_from, check the API.|;
3965     }
3966
3967     my $mark_returned;
3968     if ( $force_mark_returned ) {
3969         $mark_returned = 1;
3970     } else {
3971         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3972         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3973     }
3974
3975     my $dbh = C4::Context->dbh();
3976     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3977                            FROM issues
3978                            JOIN items USING (itemnumber)
3979                            JOIN biblio USING (biblionumber)
3980                            WHERE issues.itemnumber=?");
3981     $sth->execute($itemnumber);
3982     my $issues=$sth->fetchrow_hashref();
3983
3984     # If a borrower lost the item, add a replacement cost to the their record
3985     if ( my $borrowernumber = $issues->{borrowernumber} ){
3986         my $patron = Koha::Patrons->find( $borrowernumber );
3987
3988         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3989         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3990
3991         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3992             C4::Accounts::chargelostitem(
3993                 $borrowernumber,
3994                 $itemnumber,
3995                 $issues->{'replacementprice'},
3996                 sprintf( "%s %s %s",
3997                     $issues->{'title'}          || q{},
3998                     $issues->{'barcode'}        || q{},
3999                     $issues->{'itemcallnumber'} || q{},
4000                 ),
4001             );
4002             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4003             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
4004         }
4005
4006         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4007     }
4008
4009     # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4010     my $item = Koha::Items->find($itemnumber);
4011     my $transfers = $item->get_transfers;
4012     while (my $transfer = $transfers->next) {
4013         $transfer->cancel({ reason => 'ItemLost', force => 1 });
4014     }
4015 }
4016
4017 sub GetOfflineOperations {
4018     my $dbh = C4::Context->dbh;
4019     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4020     $sth->execute(C4::Context->userenv->{'branch'});
4021     my $results = $sth->fetchall_arrayref({});
4022     return $results;
4023 }
4024
4025 sub GetOfflineOperation {
4026     my $operationid = shift;
4027     return unless $operationid;
4028     my $dbh = C4::Context->dbh;
4029     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4030     $sth->execute( $operationid );
4031     return $sth->fetchrow_hashref;
4032 }
4033
4034 sub AddOfflineOperation {
4035     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4036     my $dbh = C4::Context->dbh;
4037     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4038     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4039     return "Added.";
4040 }
4041
4042 sub DeleteOfflineOperation {
4043     my $dbh = C4::Context->dbh;
4044     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4045     $sth->execute( shift );
4046     return "Deleted.";
4047 }
4048
4049 sub ProcessOfflineOperation {
4050     my $operation = shift;
4051
4052     my $report;
4053     if ( $operation->{action} eq 'return' ) {
4054         $report = ProcessOfflineReturn( $operation );
4055     } elsif ( $operation->{action} eq 'issue' ) {
4056         $report = ProcessOfflineIssue( $operation );
4057     } elsif ( $operation->{action} eq 'payment' ) {
4058         $report = ProcessOfflinePayment( $operation );
4059     }
4060
4061     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4062
4063     return $report;
4064 }
4065
4066 sub ProcessOfflineReturn {
4067     my $operation = shift;
4068
4069     my $item = Koha::Items->find({barcode => $operation->{barcode}});
4070
4071     if ( $item ) {
4072         my $itemnumber = $item->itemnumber;
4073         my $issue = $item->checkout;
4074         if ( $issue ) {
4075             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4076             ModDateLastSeen( $itemnumber, $leave_item_lost );
4077             MarkIssueReturned(
4078                 $issue->borrowernumber,
4079                 $itemnumber,
4080                 $operation->{timestamp},
4081             );
4082             $item->onloan(undef);
4083             $item->store({ log_action => 0 });
4084             return "Success.";
4085         } else {
4086             return "Item not issued.";
4087         }
4088     } else {
4089         return "Item not found.";
4090     }
4091 }
4092
4093 sub ProcessOfflineIssue {
4094     my $operation = shift;
4095
4096     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4097
4098     if ( $patron ) {
4099         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4100         unless ($item) {
4101             return "Barcode not found.";
4102         }
4103         my $itemnumber = $item->itemnumber;
4104         my $issue = $item->checkout;
4105
4106         if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4107             MarkIssueReturned(
4108                 $issue->borrowernumber,
4109                 $itemnumber,
4110                 $operation->{timestamp},
4111             );
4112         }
4113         AddIssue(
4114             $patron->unblessed,
4115             $operation->{'barcode'},
4116             undef,
4117             undef,
4118             $operation->{timestamp},
4119             undef,
4120         );
4121         return "Success.";
4122     } else {
4123         return "Borrower not found.";
4124     }
4125 }
4126
4127 sub ProcessOfflinePayment {
4128     my $operation = shift;
4129
4130     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4131
4132     $patron->account->pay(
4133         {
4134             amount     => $operation->{amount},
4135             library_id => $operation->{branchcode},
4136             interface  => 'koc'
4137         }
4138     );
4139
4140     return "Success.";
4141 }
4142
4143 =head2 TransferSlip
4144
4145   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4146
4147   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4148
4149 =cut
4150
4151 sub TransferSlip {
4152     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4153
4154     my $item =
4155       $itemnumber
4156       ? Koha::Items->find($itemnumber)
4157       : Koha::Items->find( { barcode => $barcode } );
4158
4159     $item or return;
4160
4161     return C4::Letters::GetPreparedLetter (
4162         module => 'circulation',
4163         letter_code => 'TRANSFERSLIP',
4164         branchcode => $branch,
4165         tables => {
4166             'branches'    => $to_branch,
4167             'biblio'      => $item->biblionumber,
4168             'items'       => $item->unblessed,
4169         },
4170     );
4171 }
4172
4173 =head2 CheckIfIssuedToPatron
4174
4175   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4176
4177   Return 1 if any record item is issued to patron, otherwise return 0
4178
4179 =cut
4180
4181 sub CheckIfIssuedToPatron {
4182     my ($borrowernumber, $biblionumber) = @_;
4183
4184     my $dbh = C4::Context->dbh;
4185     my $query = q|
4186         SELECT COUNT(*) FROM issues
4187         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4188         WHERE items.biblionumber = ?
4189         AND issues.borrowernumber = ?
4190     |;
4191     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4192     return 1 if $is_issued;
4193     return;
4194 }
4195
4196 =head2 IsItemIssued
4197
4198   IsItemIssued( $itemnumber )
4199
4200   Return 1 if the item is on loan, otherwise return 0
4201
4202 =cut
4203
4204 sub IsItemIssued {
4205     my $itemnumber = shift;
4206     my $dbh = C4::Context->dbh;
4207     my $sth = $dbh->prepare(q{
4208         SELECT COUNT(*)
4209         FROM issues
4210         WHERE itemnumber = ?
4211     });
4212     $sth->execute($itemnumber);
4213     return $sth->fetchrow;
4214 }
4215
4216 =head2 GetAgeRestriction
4217
4218   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4219   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4220
4221   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4222   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4223
4224 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4225 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4226 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4227          Negative days mean the borrower has gone past the age restriction age.
4228
4229 =cut
4230
4231 sub GetAgeRestriction {
4232     my ($record_restrictions, $borrower) = @_;
4233     my $markers = C4::Context->preference('AgeRestrictionMarker');
4234
4235     return unless $record_restrictions;
4236     # Split $record_restrictions to something like FSK 16 or PEGI 6
4237     my @values = split ' ', uc($record_restrictions);
4238     return unless @values;
4239
4240     # Search first occurrence of one of the markers
4241     my @markers = split /\|/, uc($markers);
4242     return unless @markers;
4243
4244     my $index            = 0;
4245     my $restriction_year = 0;
4246     for my $value (@values) {
4247         $index++;
4248         for my $marker (@markers) {
4249             $marker =~ s/^\s+//;    #remove leading spaces
4250             $marker =~ s/\s+$//;    #remove trailing spaces
4251             if ( $marker eq $value ) {
4252                 if ( $index <= $#values ) {
4253                     $restriction_year += $values[$index];
4254                 }
4255                 last;
4256             }
4257             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4258
4259                 # Perhaps it is something like "K16" (as in Finland)
4260                 $restriction_year += $1;
4261                 last;
4262             }
4263         }
4264         last if ( $restriction_year > 0 );
4265     }
4266
4267     #Check if the borrower is age restricted for this material and for how long.
4268     if ($restriction_year && $borrower) {
4269         if ( $borrower->{'dateofbirth'} ) {
4270             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4271             $alloweddate[0] += $restriction_year;
4272
4273             #Prevent runime eror on leap year (invalid date)
4274             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4275                 $alloweddate[2] = 28;
4276             }
4277
4278             #Get how many days the borrower has to reach the age restriction
4279             my @Today = split /-/, dt_from_string()->ymd();
4280             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4281             #Negative days means the borrower went past the age restriction age
4282             return ($restriction_year, $daysToAgeRestriction);
4283         }
4284     }
4285
4286     return ($restriction_year);
4287 }
4288
4289
4290 =head2 GetPendingOnSiteCheckouts
4291
4292 =cut
4293
4294 sub GetPendingOnSiteCheckouts {
4295     my $dbh = C4::Context->dbh;
4296     return $dbh->selectall_arrayref(q|
4297         SELECT
4298           items.barcode,
4299           items.biblionumber,
4300           items.itemnumber,
4301           items.itemnotes,
4302           items.itemcallnumber,
4303           items.location,
4304           issues.date_due,
4305           issues.branchcode,
4306           issues.date_due < NOW() AS is_overdue,
4307           biblio.author,
4308           biblio.title,
4309           borrowers.firstname,
4310           borrowers.surname,
4311           borrowers.cardnumber,
4312           borrowers.borrowernumber
4313         FROM items
4314         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4315         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4316         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4317         WHERE issues.onsite_checkout = 1
4318     |, { Slice => {} } );
4319 }
4320
4321 sub GetTopIssues {
4322     my ($params) = @_;
4323
4324     my ($count, $branch, $itemtype, $ccode, $newness)
4325         = @$params{qw(count branch itemtype ccode newness)};
4326
4327     my $dbh = C4::Context->dbh;
4328     my $query = q{
4329         SELECT * FROM (
4330         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4331           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4332           i.ccode, SUM(i.issues) AS count
4333         FROM biblio b
4334         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4335         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4336     };
4337
4338     my (@where_strs, @where_args);
4339
4340     if ($branch) {
4341         push @where_strs, 'i.homebranch = ?';
4342         push @where_args, $branch;
4343     }
4344     if ($itemtype) {
4345         if (C4::Context->preference('item-level_itypes')){
4346             push @where_strs, 'i.itype = ?';
4347             push @where_args, $itemtype;
4348         } else {
4349             push @where_strs, 'bi.itemtype = ?';
4350             push @where_args, $itemtype;
4351         }
4352     }
4353     if ($ccode) {
4354         push @where_strs, 'i.ccode = ?';
4355         push @where_args, $ccode;
4356     }
4357     if ($newness) {
4358         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4359         push @where_args, $newness;
4360     }
4361
4362     if (@where_strs) {
4363         $query .= 'WHERE ' . join(' AND ', @where_strs);
4364     }
4365
4366     $query .= q{
4367         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4368           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4369           i.ccode
4370         ORDER BY count DESC
4371     };
4372
4373     $query .= q{ ) xxx WHERE count > 0 };
4374     $count = int($count);
4375     if ($count > 0) {
4376         $query .= "LIMIT $count";
4377     }
4378
4379     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4380
4381     return @$rows;
4382 }
4383
4384 =head2 Internal methods
4385
4386 =cut
4387
4388 sub _CalculateAndUpdateFine {
4389     my ($params) = @_;
4390
4391     my $borrower    = $params->{borrower};
4392     my $item        = $params->{item};
4393     my $issue       = $params->{issue};
4394     my $return_date = $params->{return_date};
4395
4396     unless ($borrower) { carp "No borrower passed in!" && return; }
4397     unless ($item)     { carp "No item passed in!"     && return; }
4398     unless ($issue)    { carp "No issue passed in!"    && return; }
4399
4400     my $datedue = dt_from_string( $issue->date_due );
4401
4402     # we only need to calculate and change the fines if we want to do that on return
4403     # Should be on for hourly loans
4404     my $control = C4::Context->preference('CircControl');
4405     my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4406     my $control_branchcode =
4407         ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4408       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4409       :                                     $issue->branchcode;
4410
4411     my $date_returned = $return_date ? $return_date : dt_from_string();
4412
4413     my ( $amount, $unitcounttotal, $unitcount  ) =
4414       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4415
4416     if ( C4::Context->preference('finesMode') eq 'production' ) {
4417         if ( $amount > 0 ) {
4418             C4::Overdues::UpdateFine({
4419                 issue_id       => $issue->issue_id,
4420                 itemnumber     => $issue->itemnumber,
4421                 borrowernumber => $issue->borrowernumber,
4422                 amount         => $amount,
4423                 due            => $datedue,
4424             });
4425         }
4426         elsif ($return_date) {
4427
4428             # Backdated returns may have fines that shouldn't exist,
4429             # so in this case, we need to drop those fines to 0
4430
4431             C4::Overdues::UpdateFine({
4432                 issue_id       => $issue->issue_id,
4433                 itemnumber     => $issue->itemnumber,
4434                 borrowernumber => $issue->borrowernumber,
4435                 amount         => 0,
4436                 due            => $datedue,
4437             });
4438         }
4439     }
4440 }
4441
4442 sub _CanBookBeAutoRenewed {
4443     my ( $params ) = @_;
4444     my $patron = $params->{patron};
4445     my $item = $params->{item};
4446     my $branchcode = $params->{branchcode};
4447     my $issue = $params->{issue};
4448
4449     return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4450
4451     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4452         {
4453             categorycode => $patron->categorycode,
4454             itemtype     => $item->effective_itemtype,
4455             branchcode   => $branchcode,
4456             rules => [
4457                 'no_auto_renewal_after',
4458                 'no_auto_renewal_after_hard_limit',
4459                 'lengthunit',
4460                 'norenewalbefore',
4461             ]
4462         }
4463     );
4464
4465     if ( $patron->is_expired && $patron->category->effective_BlockExpiredPatronOpacActions ) {
4466         return 'auto_account_expired';
4467     }
4468
4469     if ( defined $issuing_rule->{no_auto_renewal_after}
4470             and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4471         # Get issue_date and add no_auto_renewal_after
4472         # If this is greater than today, it's too late for renewal.
4473         my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4474         $maximum_renewal_date->add(
4475             $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4476         );
4477         my $now = dt_from_string;
4478         if ( $now >= $maximum_renewal_date ) {
4479             return "auto_too_late";
4480         }
4481     }
4482     if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4483                   and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4484         # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4485         if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4486             return "auto_too_late";
4487         }
4488     }
4489
4490     if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4491         my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4492         my $amountoutstanding =
4493           C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4494           ? $patron->account->balance
4495           : $patron->account->outstanding_debits->total_outstanding;
4496         if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4497             return "auto_too_much_oweing";
4498         }
4499     }
4500
4501     my $soonest = GetSoonestRenewDate($patron, $issue);
4502     if ( $soonest > dt_from_string() )
4503     {
4504         return ( "auto_too_soon", $soonest );
4505     }
4506
4507     return "ok";
4508 }
4509
4510
4511 1;
4512
4513 __END__
4514
4515 =head1 AUTHOR
4516
4517 Koha Development Team <http://koha-community.org/>
4518
4519 =cut