C4/Circulation.pm

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