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