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