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