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