C4/Circulation.pm

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