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->as_list;
 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_object, $patron );
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, $patron ) = @_;
1282     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
1283
1284     my $return_data = {
1285         exceeded    => 0,
1286         outstanding => 0,
1287         duration    => 0,
1288         due_date    => undef,
1289     };
1290
1291     my $holds = Koha::Holds->search( { biblionumber => $item->biblionumber } );
1292
1293     if ( $holds->count() ) {
1294         $return_data->{outstanding} = $holds->count();
1295
1296         my $decreaseLoanHighHoldsControl        = C4::Context->preference('decreaseLoanHighHoldsControl');
1297         my $decreaseLoanHighHoldsValue          = C4::Context->preference('decreaseLoanHighHoldsValue');
1298         my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1299
1300         my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1301
1302         if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1303
1304             # static means just more than a given number of holds on the record
1305
1306             # If the number of holds is less than the threshold, we can stop here
1307             if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1308                 return $return_data;
1309             }
1310         }
1311         elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1312
1313             # dynamic means X more than the number of holdable items on the record
1314
1315             # let's get the items
1316             my @items = $holds->next()->biblio()->items()->as_list;
1317
1318             # Remove any items with status defined to be ignored even if the would not make item unholdable
1319             foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1320                 @items = grep { !$_->$status } @items;
1321             }
1322
1323             # Remove any items that are not holdable for this patron
1324             @items = grep { CanItemBeReserved( $patron , $_, undef, { ignore_found_holds => 1 } )->{status} eq 'OK' } @items;
1325
1326             my $items_count = scalar @items;
1327
1328             my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1329
1330             # If the number of holds is less than the count of items we have
1331             # plus the number of holds allowed above that count, we can stop here
1332             if ( $holds->count() <= $threshold ) {
1333                 return $return_data;
1334             }
1335         }
1336
1337         my $issuedate = dt_from_string();
1338
1339         my $itype = $item->effective_itemtype;
1340         my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1341             {
1342                 categorycode => $patron->categorycode,
1343                 itemtype     => $itype,
1344                 branchcode   => $branchcode,
1345             }
1346         );
1347         my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1348
1349         my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron->unblessed );
1350
1351         my $rule = Koha::CirculationRules->get_effective_rule(
1352             {
1353                 categorycode => $patron->categorycode,
1354                 itemtype     => $item->effective_itemtype,
1355                 branchcode   => $branchcode,
1356                 rule_name    => 'decreaseloanholds',
1357             }
1358         );
1359
1360         my $duration;
1361         if ( defined($rule) && $rule->rule_value ne '' ){
1362             # overrides decreaseLoanHighHoldsDuration syspref
1363             $duration = $rule->rule_value;
1364         } else {
1365             $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1366         }
1367         my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1368         $reduced_datedue->set_hour($orig_due->hour);
1369         $reduced_datedue->set_minute($orig_due->minute);
1370         $reduced_datedue->truncate( to => 'minute' );
1371
1372         if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1373             $return_data->{exceeded} = 1;
1374             $return_data->{duration} = $duration;
1375             $return_data->{due_date} = $reduced_datedue;
1376         }
1377     }
1378
1379     return $return_data;
1380 }
1381
1382 =head2 AddIssue
1383
1384   &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1385
1386 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1387
1388 =over 4
1389
1390 =item C<$borrower> is a hash with borrower informations (from Koha::Patron->unblessed).
1391
1392 =item C<$barcode> is the barcode of the item being issued.
1393
1394 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1395 Calculated if empty.
1396
1397 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1398
1399 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1400 Defaults to today.  Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1401
1402 AddIssue does the following things :
1403
1404   - step 01: check that there is a borrowernumber & a barcode provided
1405   - check for RENEWAL (book issued & being issued to the same patron)
1406       - renewal YES = Calculate Charge & renew
1407       - renewal NO  =
1408           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1409           * RESERVE PLACED ?
1410               - fill reserve if reserve to this patron
1411               - cancel reserve or not, otherwise
1412           * TRANSFERT PENDING ?
1413               - complete the transfert
1414           * ISSUE THE BOOK
1415
1416 =back
1417
1418 =cut
1419
1420 sub AddIssue {
1421     my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1422
1423     my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1424     my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1425     my $auto_renew = $params && $params->{auto_renew};
1426     my $dbh          = C4::Context->dbh;
1427     my $barcodecheck = CheckValidBarcode($barcode);
1428
1429     my $issue;
1430
1431     if ( $datedue && ref $datedue ne 'DateTime' ) {
1432         $datedue = dt_from_string($datedue);
1433     }
1434
1435     # $issuedate defaults to today.
1436     if ( !defined $issuedate ) {
1437         $issuedate = dt_from_string();
1438     }
1439     else {
1440         if ( ref $issuedate ne 'DateTime' ) {
1441             $issuedate = dt_from_string($issuedate);
1442
1443         }
1444     }
1445
1446     # Stop here if the patron or barcode doesn't exist
1447     if ( $borrower && $barcode && $barcodecheck ) {
1448         # find which item we issue
1449         my $item_object = Koha::Items->find({ barcode => $barcode })
1450           or return;    # if we don't get an Item, abort.
1451         my $item_unblessed = $item_object->unblessed;
1452
1453         my $branchcode = _GetCircControlBranch( $item_unblessed, $borrower );
1454
1455         # get actual issuing if there is one
1456         my $actualissue = $item_object->checkout;
1457
1458         # check if we just renew the issue.
1459         if ( $actualissue and $actualissue->borrowernumber eq $borrower->{'borrowernumber'}
1460                 and not $switch_onsite_checkout ) {
1461             $datedue = AddRenewal(
1462                 $borrower->{'borrowernumber'},
1463                 $item_object->itemnumber,
1464                 $branchcode,
1465                 $datedue,
1466                 $issuedate,    # here interpreted as the renewal date
1467             );
1468         }
1469         else {
1470             unless ($datedue) {
1471                 my $itype = $item_object->effective_itemtype;
1472                 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $borrower );
1473
1474             }
1475             $datedue->truncate( to => 'minute' );
1476
1477             my $patron = Koha::Patrons->find( $borrower );
1478             my $library = Koha::Libraries->find( $branchcode );
1479             my $fees = Koha::Charges::Fees->new(
1480                 {
1481                     patron    => $patron,
1482                     library   => $library,
1483                     item      => $item_object,
1484                     to_date   => $datedue,
1485                 }
1486             );
1487
1488             # it's NOT a renewal
1489             if ( $actualissue and not $switch_onsite_checkout ) {
1490                 # This book is currently on loan, but not to the person
1491                 # who wants to borrow it now. mark it returned before issuing to the new borrower
1492                 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1493                 return unless $allowed;
1494                 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1495                 # AddReturn certainly has side-effects, like onloan => undef
1496                 $item_object->discard_changes;
1497             }
1498
1499             C4::Reserves::MoveReserve( $item_object->itemnumber, $borrower->{'borrowernumber'}, $cancelreserve );
1500
1501             # Starting process for transfer job (checking transfert and validate it if we have one)
1502             if ( my $transfer = $item_object->get_transfer ) {
1503                 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1504                 $transfer->set(
1505                     {
1506                         datearrived => dt_from_string,
1507                         tobranch    => C4::Context->userenv->{branch},
1508                         comments    => 'Forced branchtransfer'
1509                     }
1510                 )->store;
1511                 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1512                     my $hold = $item_object->holds->search( { found => 'T' } )->next;
1513                     if ( $hold ) { # Is this really needed?
1514                         $hold->set( { found => undef } )->store;
1515                         C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1516                     }
1517                 }
1518             }
1519
1520             # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1521             unless ($auto_renew) {
1522                 my $rule = Koha::CirculationRules->get_effective_rule(
1523                     {
1524                         categorycode => $borrower->{categorycode},
1525                         itemtype     => $item_object->effective_itemtype,
1526                         branchcode   => $branchcode,
1527                         rule_name    => 'auto_renew'
1528                     }
1529                 );
1530
1531                 $auto_renew = $rule->rule_value if $rule;
1532             }
1533
1534             my $issue_attributes = {
1535                 borrowernumber  => $borrower->{'borrowernumber'},
1536                 issuedate       => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1537                 date_due        => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1538                 branchcode      => C4::Context->userenv->{'branch'},
1539                 onsite_checkout => $onsite_checkout,
1540                 auto_renew      => $auto_renew ? 1 : 0,
1541             };
1542
1543             # Get ID of logged in user.  if called from a batch job,
1544             # no user session exists and C4::Context->userenv() returns
1545             # the scalar '0'. Only do this if the syspref says so
1546             if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1547                 my $userenv = C4::Context->userenv();
1548                 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1549                 if ($usernumber) {
1550                     $issue_attributes->{issuer_id} = $usernumber;
1551                 }
1552             }
1553
1554             # In the case that the borrower has an on-site checkout
1555             # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1556             $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1557             if ($issue) {
1558                 $issue->set($issue_attributes)->store;
1559             }
1560             else {
1561                 $issue = Koha::Checkout->new(
1562                     {
1563                         itemnumber => $item_object->itemnumber,
1564                         %$issue_attributes,
1565                     }
1566                 )->store;
1567             }
1568             $issue->discard_changes;
1569             C4::Auth::track_login_daily( $borrower->{userid} );
1570             if ( $item_object->location && $item_object->location eq 'CART'
1571                 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1572             ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1573                 CartToShelf( $item_object->itemnumber );
1574             }
1575
1576             if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1577                 UpdateTotalIssues( $item_object->biblionumber, 1 );
1578             }
1579
1580             # Record if item was lost
1581             my $was_lost = $item_object->itemlost;
1582
1583             $item_object->issues( ( $item_object->issues || 0 ) + 1);
1584             $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1585             $item_object->itemlost(0);
1586             $item_object->onloan($datedue->ymd());
1587             $item_object->datelastborrowed( dt_from_string()->ymd() );
1588             $item_object->datelastseen( dt_from_string()->ymd() );
1589             $item_object->store({log_action => 0});
1590
1591             # If the item was lost, it has now been found, charge the overdue if necessary
1592             if ($was_lost) {
1593                 if ( $item_object->{_charge} ) {
1594                     $actualissue //= Koha::Old::Checkouts->search(
1595                         { itemnumber => $item_unblessed->{itemnumber} },
1596                         {
1597                             order_by => { '-desc' => 'returndate' },
1598                             rows     => 1
1599                         }
1600                     )->single;
1601                     unless ( exists( $borrower->{branchcode} ) ) {
1602                         my $patron = $actualissue->patron;
1603                         $borrower = $patron->unblessed;
1604                     }
1605                     _CalculateAndUpdateFine(
1606                         {
1607                             issue       => $actualissue,
1608                             item        => $item_unblessed,
1609                             borrower    => $borrower,
1610                             return_date => $issuedate
1611                         }
1612                     );
1613                     _FixOverduesOnReturn( $borrower->{borrowernumber},
1614                         $item_object->itemnumber, undef, 'RENEWED' );
1615                 }
1616             }
1617
1618             # If it costs to borrow this book, charge it to the patron's account.
1619             my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1620             if ( $charge && $charge > 0 ) {
1621                 AddIssuingCharge( $issue, $charge, 'RENT' );
1622             }
1623
1624             my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1625             if ( $itemtype_object ) {
1626                 my $accumulate_charge = $fees->accumulate_rentalcharge();
1627                 if ( $accumulate_charge > 0 ) {
1628                     AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1629                     $charge += $accumulate_charge;
1630                     $item_unblessed->{charge} = $charge;
1631                 }
1632             }
1633
1634             # Record the fact that this book was issued.
1635             C4::Stats::UpdateStats(
1636                 {
1637                     branch => C4::Context->userenv->{'branch'},
1638                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1639                     amount         => $charge,
1640                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1641                     itemnumber     => $item_object->itemnumber,
1642                     itemtype       => $item_object->effective_itemtype,
1643                     location       => $item_object->location,
1644                     borrowernumber => $borrower->{'borrowernumber'},
1645                     ccode          => $item_object->ccode,
1646                 }
1647             );
1648
1649             # Send a checkout slip.
1650             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1651             my %conditions        = (
1652                 branchcode   => $branchcode,
1653                 categorycode => $borrower->{categorycode},
1654                 item_type    => $item_object->effective_itemtype,
1655                 notification => 'CHECKOUT',
1656             );
1657             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1658                 SendCirculationAlert(
1659                     {
1660                         type     => 'CHECKOUT',
1661                         item     => $item_object->unblessed,
1662                         borrower => $borrower,
1663                         branch   => $branchcode,
1664                     }
1665                 );
1666             }
1667             logaction(
1668                 "CIRCULATION", "ISSUE",
1669                 $borrower->{'borrowernumber'},
1670                 $item_object->itemnumber,
1671             ) if C4::Context->preference("IssueLog");
1672
1673             Koha::Plugins->call('after_circ_action', {
1674                 action  => 'checkout',
1675                 payload => {
1676                     type     => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1677                     checkout => $issue->get_from_storage
1678                 }
1679             });
1680         }
1681     }
1682     return $issue;
1683 }
1684
1685 =head2 GetLoanLength
1686
1687   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1688
1689 Get loan length for an itemtype, a borrower type and a branch
1690
1691 =cut
1692
1693 sub GetLoanLength {
1694     my ( $categorycode, $itemtype, $branchcode ) = @_;
1695
1696     # Initialize default values
1697     my $rules = {
1698         issuelength   => 0,
1699         renewalperiod => 0,
1700         lengthunit    => 'days',
1701     };
1702
1703     my $found = Koha::CirculationRules->get_effective_rules( {
1704         branchcode => $branchcode,
1705         categorycode => $categorycode,
1706         itemtype => $itemtype,
1707         rules => [
1708             'issuelength',
1709             'renewalperiod',
1710             'lengthunit'
1711         ],
1712     } );
1713
1714     # Search for rules!
1715     foreach my $rule_name (keys %$found) {
1716         $rules->{$rule_name} = $found->{$rule_name};
1717     }
1718
1719     return $rules;
1720 }
1721
1722
1723 =head2 GetHardDueDate
1724
1725   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1726
1727 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1728
1729 =cut
1730
1731 sub GetHardDueDate {
1732     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1733
1734     my $rules = Koha::CirculationRules->get_effective_rules(
1735         {
1736             categorycode => $borrowertype,
1737             itemtype     => $itemtype,
1738             branchcode   => $branchcode,
1739             rules        => [ 'hardduedate', 'hardduedatecompare' ],
1740         }
1741     );
1742
1743     if ( defined( $rules->{hardduedate} ) ) {
1744         if ( $rules->{hardduedate} ) {
1745             return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1746         }
1747         else {
1748             return ( undef, undef );
1749         }
1750     }
1751 }
1752
1753 =head2 GetBranchBorrowerCircRule
1754
1755   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1756
1757 Retrieves circulation rule attributes that apply to the given
1758 branch and patron category, regardless of item type.
1759 The return value is a hashref containing the following key:
1760
1761 patron_maxissueqty - maximum number of loans that a
1762 patron of the given category can have at the given
1763 branch.  If the value is undef, no limit.
1764
1765 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1766 patron of the given category can have at the given
1767 branch.  If the value is undef, no limit.
1768
1769 This will check for different branch/category combinations in the following order:
1770 branch and category
1771 branch only
1772 category only
1773 default branch and category
1774
1775 If no rule has been found in the database, it will default to
1776 the buillt in rule:
1777
1778 patron_maxissueqty - undef
1779 patron_maxonsiteissueqty - undef
1780
1781 C<$branchcode> and C<$categorycode> should contain the
1782 literal branch code and patron category code, respectively - no
1783 wildcards.
1784
1785 =cut
1786
1787 sub GetBranchBorrowerCircRule {
1788     my ( $branchcode, $categorycode ) = @_;
1789
1790     # Initialize default values
1791     my $rules = {
1792         patron_maxissueqty       => undef,
1793         patron_maxonsiteissueqty => undef,
1794     };
1795
1796     # Search for rules!
1797     foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1798         my $rule = Koha::CirculationRules->get_effective_rule(
1799             {
1800                 categorycode => $categorycode,
1801                 itemtype     => undef,
1802                 branchcode   => $branchcode,
1803                 rule_name    => $rule_name,
1804             }
1805         );
1806
1807         $rules->{$rule_name} = $rule->rule_value if defined $rule;
1808     }
1809
1810     return $rules;
1811 }
1812
1813 =head2 GetBranchItemRule
1814
1815   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1816
1817 Retrieves circulation rule attributes that apply to the given
1818 branch and item type, regardless of patron category.
1819
1820 The return value is a hashref containing the following keys:
1821
1822 holdallowed => Hold policy for this branch and itemtype. Possible values:
1823   not_allowed:           No holds allowed.
1824   from_home_library:     Holds allowed only by patrons that have the same homebranch as the item.
1825   from_any_library:      Holds allowed from any patron.
1826   from_local_hold_group: Holds allowed from libraries in hold group
1827
1828 returnbranch => branch to which to return item.  Possible values:
1829   noreturn: do not return, let item remain where checked in (floating collections)
1830   homebranch: return to item's home branch
1831   holdingbranch: return to issuer branch
1832
1833 This searches branchitemrules in the following order:
1834
1835   * Same branchcode and itemtype
1836   * Same branchcode, itemtype '*'
1837   * branchcode '*', same itemtype
1838   * branchcode and itemtype '*'
1839
1840 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1841
1842 =cut
1843
1844 sub GetBranchItemRule {
1845     my ( $branchcode, $itemtype ) = @_;
1846
1847     # Search for rules!
1848     my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1849         {
1850             branchcode => $branchcode,
1851             itemtype   => $itemtype,
1852             rule_name  => 'holdallowed',
1853         }
1854     );
1855     my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1856         {
1857             branchcode => $branchcode,
1858             itemtype   => $itemtype,
1859             rule_name  => 'hold_fulfillment_policy',
1860         }
1861     );
1862     my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1863         {
1864             branchcode => $branchcode,
1865             itemtype   => $itemtype,
1866             rule_name  => 'returnbranch',
1867         }
1868     );
1869
1870     # built-in default circulation rule
1871     my $rules;
1872     $rules->{holdallowed} = defined $holdallowed_rule
1873         ? $holdallowed_rule->rule_value
1874         : 'from_any_library';
1875     $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1876         ? $hold_fulfillment_policy_rule->rule_value
1877         : 'any';
1878     $rules->{returnbranch} = defined $returnbranch_rule
1879         ? $returnbranch_rule->rule_value
1880         : 'homebranch';
1881
1882     return $rules;
1883 }
1884
1885 =head2 AddReturn
1886
1887   ($doreturn, $messages, $iteminformation, $borrower) =
1888       &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1889
1890 Returns a book.
1891
1892 =over 4
1893
1894 =item C<$barcode> is the bar code of the book being returned.
1895
1896 =item C<$branch> is the code of the branch where the book is being returned.
1897
1898 =item C<$exemptfine> indicates that overdue charges for the item will be
1899 removed. Optional.
1900
1901 =item C<$return_date> allows the default return date to be overridden
1902 by the given return date. Optional.
1903
1904 =back
1905
1906 C<&AddReturn> returns a list of four items:
1907
1908 C<$doreturn> is true iff the return succeeded.
1909
1910 C<$messages> is a reference-to-hash giving feedback on the operation.
1911 The keys of the hash are:
1912
1913 =over 4
1914
1915 =item C<BadBarcode>
1916
1917 No item with this barcode exists. The value is C<$barcode>.
1918
1919 =item C<NotIssued>
1920
1921 The book is not currently on loan. The value is C<$barcode>.
1922
1923 =item C<withdrawn>
1924
1925 This book has been withdrawn/cancelled. The value should be ignored.
1926
1927 =item C<Wrongbranch>
1928
1929 This book has was returned to the wrong branch.  The value is a hashref
1930 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1931 contain the branchcode of the incorrect and correct return library, respectively.
1932
1933 =item C<ResFound>
1934
1935 The item was reserved. The value is a reference-to-hash whose keys are
1936 fields from the reserves table of the Koha database, and
1937 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1938 either C<Waiting>, C<Reserved>, or 0.
1939
1940 =item C<WasReturned>
1941
1942 Value 1 if return is successful.
1943
1944 =item C<NeedsTransfer>
1945
1946 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1947
1948 =back
1949
1950 C<$iteminformation> is a reference-to-hash, giving information about the
1951 returned item from the issues table.
1952
1953 C<$borrower> is a reference-to-hash, giving information about the
1954 patron who last borrowed the book.
1955
1956 =cut
1957
1958 sub AddReturn {
1959     my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1960
1961     if ($branch and not Koha::Libraries->find($branch)) {
1962         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1963         undef $branch;
1964     }
1965     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1966     my $return_date_specified = !!$return_date;
1967     $return_date //= dt_from_string();
1968     my $messages;
1969     my $patron;
1970     my $doreturn       = 1;
1971     my $validTransfer = 1;
1972     my $stat_type = 'return';
1973
1974     # get information on item
1975     my $item = Koha::Items->find({ barcode => $barcode });
1976     unless ($item) {
1977         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1978     }
1979
1980     my $itemnumber = $item->itemnumber;
1981     my $itemtype = $item->effective_itemtype;
1982
1983     my $issue  = $item->checkout;
1984     if ( $issue ) {
1985         $patron = $issue->patron
1986             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1987                 . Dumper($issue->unblessed) . "\n";
1988     } else {
1989         $messages->{'NotIssued'} = $barcode;
1990         $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
1991
1992         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1993         $doreturn = 0;
1994         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1995         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1996         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1997            $messages->{'LocalUse'} = 1;
1998            $stat_type = 'localuse';
1999         }
2000     }
2001
2002         # full item data, but no borrowernumber or checkout info (no issue)
2003     my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
2004         # get the proper branch to which to return the item
2005     my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
2006         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2007     my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2008
2009     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
2010     my $patron_unblessed = $patron ? $patron->unblessed : {};
2011
2012     my $update_loc_rules = Koha::Config::SysPrefs->find('UpdateItemLocationOnCheckin')->get_yaml_pref_hash();
2013     map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
2014     if ($update_loc_rules) {
2015         if (defined $update_loc_rules->{_ALL_}) {
2016             if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
2017             if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
2018             if (
2019                 ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) ||
2020                 (!defined $item->location && $update_loc_rules->{_ALL_} ne "")
2021                ) {
2022                 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
2023                 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
2024             }
2025         }
2026         else {
2027             foreach my $key ( keys %$update_loc_rules ) {
2028                 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
2029                 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
2030                 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2031                     $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2032                     $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2033                     last;
2034                 }
2035             }
2036         }
2037     }
2038
2039     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2040     if ($yaml) {
2041         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
2042         my $rules;
2043         eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2044         if ($@) {
2045             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2046         }
2047         else {
2048             foreach my $key ( keys %$rules ) {
2049                 if ( $item->notforloan eq $key ) {
2050                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2051                     $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2052                     last;
2053                 }
2054             }
2055         }
2056     }
2057
2058     # check if the return is allowed at this branch
2059     my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2060     unless ($returnallowed){
2061         $messages->{'Wrongbranch'} = {
2062             Wrongbranch => $branch,
2063             Rightbranch => $message
2064         };
2065         $doreturn = 0;
2066         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2067         $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2068         return ( $doreturn, $messages, $issue, $patron_unblessed);
2069     }
2070
2071     if ( $item->withdrawn ) { # book has been cancelled
2072         $messages->{'withdrawn'} = 1;
2073         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2074     }
2075
2076     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2077         $doreturn = 0;
2078     }
2079
2080     # case of a return of document (deal with issues and holdingbranch)
2081     if ($doreturn) {
2082         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2083         $patron or warn "AddReturn without current borrower";
2084
2085         if ($patron) {
2086             eval {
2087                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2088             };
2089             unless ( $@ ) {
2090                 if (
2091                     (
2092                         C4::Context->preference('CalculateFinesOnReturn')
2093                         || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2094                     )
2095                     && !$item->itemlost
2096                   )
2097                 {
2098                     _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2099                 }
2100             } else {
2101                 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 );
2102
2103                 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2104                 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2105
2106                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2107             }
2108
2109             # FIXME is the "= 1" right?  This could be the borrower hash.
2110             $messages->{'WasReturned'} = 1;
2111
2112         } else {
2113             $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2114         }
2115     }
2116
2117     # the holdingbranch is updated if the document is returned to another location.
2118     # this is always done regardless of whether the item was on loan or not
2119     if ($item->holdingbranch ne $branch) {
2120         $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2121     }
2122
2123     my $item_was_lost = $item->itemlost;
2124     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2125     my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2126
2127     # fix up the accounts.....
2128     if ($item_was_lost) {
2129         $messages->{'WasLost'} = 1;
2130         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2131             my @object_messages = @{ $updated_item->messages };
2132             for my $message (@object_messages) {
2133                 $messages->{'LostItemFeeRefunded'} = 1
2134                   if $message->message eq 'lost_refunded';
2135                 $messages->{'LostItemFeeRestored'} = 1
2136                   if $message->message eq 'lost_restored';
2137
2138                 if ( $message->message eq 'lost_charge' ) {
2139                     $issue //= Koha::Old::Checkouts->search(
2140                         { itemnumber => $item->itemnumber },
2141                         { order_by   => { '-desc' => 'returndate' }, rows => 1 }
2142                     )->single;
2143                     unless ( exists( $patron_unblessed->{branchcode} ) ) {
2144                         my $patron = $issue->patron;
2145                         $patron_unblessed = $patron->unblessed;
2146                     }
2147                     _CalculateAndUpdateFine(
2148                         {
2149                             issue       => $issue,
2150                             item        => $item->unblessed,
2151                             borrower    => $patron_unblessed,
2152                             return_date => $return_date
2153                         }
2154                     );
2155                     _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2156                         $item->itemnumber, undef, 'RETURNED' );
2157                     $messages->{'LostItemFeeCharged'} = 1;
2158                 }
2159             }
2160         }
2161     }
2162
2163     # check if we have a transfer for this document
2164     my $transfer = $item->get_transfer;
2165
2166     # if we have a transfer to complete, we update the line of transfers with the datearrived
2167     if ($transfer) {
2168         $validTransfer = 0;
2169         if ( $transfer->in_transit ) {
2170             if ( $transfer->tobranch eq $branch ) {
2171                 $transfer->receive;
2172                 $messages->{'TransferArrived'} = $transfer->frombranch;
2173                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2174                 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2175             }
2176             else {
2177                 $messages->{'WrongTransfer'}     = $transfer->tobranch;
2178                 $messages->{'WrongTransferItem'} = $item->itemnumber;
2179                 $messages->{'TransferTrigger'}   = $transfer->reason;
2180             }
2181         }
2182         else {
2183             if ( $transfer->tobranch eq $branch ) {
2184                 $transfer->receive;
2185                 $messages->{'TransferArrived'} = $transfer->frombranch;
2186                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2187                 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2188             }
2189             else {
2190                 $messages->{'WasTransfered'}   = $transfer->tobranch;
2191                 $messages->{'TransferTrigger'} = $transfer->reason;
2192             }
2193         }
2194     }
2195
2196     # fix up the overdues in accounts...
2197     if ($borrowernumber) {
2198         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2199         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!";  # zero is OK, check defined
2200
2201         if ( $issue and $issue->is_overdue($return_date) ) {
2202         # fix fine days
2203             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2204             if ($reminder){
2205                 $messages->{'PrevDebarred'} = $debardate;
2206             } else {
2207                 $messages->{'Debarred'} = $debardate if $debardate;
2208             }
2209         # there's no overdue on the item but borrower had been previously debarred
2210         } elsif ( $issue->date_due and $patron->debarred ) {
2211              if ( $patron->debarred eq "9999-12-31") {
2212                 $messages->{'ForeverDebarred'} = $patron->debarred;
2213              } else {
2214                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2215                   $borrower_debar_dt->truncate(to => 'day');
2216                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2217                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2218                       $messages->{'PrevDebarred'} = $patron->debarred;
2219                   }
2220              }
2221         }
2222     }
2223
2224     # find reserves.....
2225     # launch the Checkreserves routine to find any holds
2226     my ($resfound, $resrec);
2227     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2228     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2229     # 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)
2230     if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2231         my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2232         $resfound = 'Reserved';
2233         $resrec = $hold->unblessed;
2234     }
2235     if ($resfound) {
2236           $resrec->{'ResFound'} = $resfound;
2237         $messages->{'ResFound'} = $resrec;
2238     }
2239
2240     # Record the fact that this book was returned.
2241     C4::Stats::UpdateStats({
2242         branch         => $branch,
2243         type           => $stat_type,
2244         itemnumber     => $itemnumber,
2245         itemtype       => $itemtype,
2246         location       => $item->location,
2247         borrowernumber => $borrowernumber,
2248         ccode          => $item->ccode,
2249     });
2250
2251     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2252     if ( $patron ) {
2253         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2254         my %conditions = (
2255             branchcode   => $branch,
2256             categorycode => $patron->categorycode,
2257             item_type    => $itemtype,
2258             notification => 'CHECKIN',
2259         );
2260         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2261             SendCirculationAlert({
2262                 type     => 'CHECKIN',
2263                 item     => $item->unblessed,
2264                 borrower => $patron->unblessed,
2265                 branch   => $branch,
2266                 issue    => $issue
2267             });
2268         }
2269
2270         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2271             if C4::Context->preference("ReturnLog");
2272         }
2273
2274     # Check if this item belongs to a biblio record that is attached to an
2275     # ILL request, if it is we need to update the ILL request's status
2276     if ( $doreturn and C4::Context->preference('CirculateILL')) {
2277         my $request = Koha::Illrequests->find(
2278             { biblio_id => $item->biblio->biblionumber }
2279         );
2280         $request->status('RET') if $request;
2281     }
2282
2283     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2284     if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2285         && ( $doreturn or $messages->{'NotIssued'} )
2286         and !$resfound
2287         and ( $branch ne $returnbranch )
2288         and not $messages->{'WrongTransfer'}
2289         and not $messages->{'WasTransfered'} )
2290     {
2291         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2292         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2293             (C4::Context->preference("UseBranchTransferLimits") and
2294              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2295            )) {
2296             ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2297             $messages->{'WasTransfered'} = $returnbranch;
2298             $messages->{'TransferTrigger'} = $transfer_trigger;
2299         } else {
2300             $messages->{'NeedsTransfer'} = $returnbranch;
2301             $messages->{'TransferTrigger'} = $transfer_trigger;
2302         }
2303     }
2304
2305     if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2306         my $claims = Koha::Checkouts::ReturnClaims->search(
2307            {
2308                itemnumber => $item->id,
2309                resolution => undef,
2310            }
2311         );
2312
2313         if ( $claims->count ) {
2314             $messages->{ReturnClaims} = $claims;
2315         }
2316     }
2317
2318     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2319     $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2320
2321     if ( $doreturn and $issue ) {
2322         my $checkin = Koha::Old::Checkouts->find($issue->id);
2323
2324         Koha::Plugins->call('after_circ_action', {
2325             action  => 'checkin',
2326             payload => {
2327                 checkout=> $checkin
2328             }
2329         });
2330     }
2331
2332     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2333 }
2334
2335 =head2 MarkIssueReturned
2336
2337   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2338
2339 Unconditionally marks an issue as being returned by
2340 moving the C<issues> row to C<old_issues> and
2341 setting C<returndate> to the current date.
2342
2343 if C<$returndate> is specified (in iso format), it is used as the date
2344 of the return.
2345
2346 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2347 the old_issue is immediately anonymised
2348
2349 Ideally, this function would be internal to C<C4::Circulation>,
2350 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2351 and offline_circ/process_koc.pl.
2352
2353 The last optional parameter allos passing skip_record_index to the item store call.
2354
2355 =cut
2356
2357 sub MarkIssueReturned {
2358     my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2359
2360     # Retrieve the issue
2361     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2362
2363     return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2364
2365     my $issue_id = $issue->issue_id;
2366
2367     my $anonymouspatron;
2368     if ( $privacy && $privacy == 2 ) {
2369         # The default of 0 will not work due to foreign key constraints
2370         # The anonymisation will fail if AnonymousPatron is not a valid entry
2371         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2372         # Note that a warning should appear on the about page (System information tab).
2373         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2374         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."
2375             unless Koha::Patrons->find( $anonymouspatron );
2376     }
2377
2378     my $schema = Koha::Database->schema;
2379
2380     # FIXME Improve the return value and handle it from callers
2381     $schema->txn_do(sub {
2382
2383         my $patron = Koha::Patrons->find( $borrowernumber );
2384
2385         # Update the returndate value
2386         if ( $returndate ) {
2387             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2388         }
2389         else {
2390             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2391         }
2392
2393         # Create the old_issues entry
2394         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2395
2396         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2397         if ( $privacy && $privacy == 2) {
2398             $old_checkout->borrowernumber($anonymouspatron)->store;
2399         }
2400
2401         # And finally delete the issue
2402         $issue->delete;
2403
2404         $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2405
2406         if ( C4::Context->preference('StoreLastBorrower') ) {
2407             my $item = Koha::Items->find( $itemnumber );
2408             $item->last_returned_by( $patron );
2409         }
2410
2411         # Remove any OVERDUES related debarment if the borrower has no overdues
2412         if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2413           && $patron->debarred
2414           && !$patron->has_overdues
2415           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2416         ) {
2417             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2418         }
2419
2420     });
2421
2422     return $issue_id;
2423 }
2424
2425 =head2 _debar_user_on_return
2426
2427     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2428
2429 C<$borrower> borrower hashref
2430
2431 C<$item> item hashref
2432
2433 C<$datedue> date due DateTime object
2434
2435 C<$returndate> DateTime object representing the return time
2436
2437 Internal function, called only by AddReturn that calculates and updates
2438  the user fine days, and debars them if necessary.
2439
2440 Should only be called for overdue returns
2441
2442 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2443 to ease testing.
2444
2445 =cut
2446
2447 sub _calculate_new_debar_dt {
2448     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2449
2450     my $branchcode = _GetCircControlBranch( $item, $borrower );
2451     my $circcontrol = C4::Context->preference('CircControl');
2452     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2453         {   categorycode => $borrower->{categorycode},
2454             itemtype     => $item->{itype},
2455             branchcode   => $branchcode,
2456             rules => [
2457                 'finedays',
2458                 'lengthunit',
2459                 'firstremind',
2460                 'maxsuspensiondays',
2461                 'suspension_chargeperiod',
2462             ]
2463         }
2464     );
2465     my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2466     my $unit     = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2467     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2468
2469     return unless $finedays;
2470
2471     # finedays is in days, so hourly loans must multiply by 24
2472     # thus 1 hour late equals 1 day suspension * finedays rate
2473     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2474
2475     # grace period is measured in the same units as the loan
2476     my $grace =
2477       DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2478
2479     my $deltadays = DateTime::Duration->new(
2480         days => $chargeable_units
2481     );
2482
2483     if ( $deltadays->subtract($grace)->is_positive() ) {
2484         my $suspension_days = $deltadays * $finedays;
2485
2486         if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2487             # No need to / 1 and do not consider / 0
2488             $suspension_days = DateTime::Duration->new(
2489                 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2490             );
2491         }
2492
2493         # If the max suspension days is < than the suspension days
2494         # the suspension days is limited to this maximum period.
2495         my $max_sd = $issuing_rule->{maxsuspensiondays};
2496         if ( defined $max_sd && $max_sd ne '' ) {
2497             $max_sd = DateTime::Duration->new( days => $max_sd );
2498             $suspension_days = $max_sd
2499               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2500         }
2501
2502         my ( $has_been_extended );
2503         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2504             my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2505             if ( $debarment ) {
2506                 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2507                 $has_been_extended = 1;
2508             }
2509         }
2510
2511         my $new_debar_dt;
2512         # Use the calendar or not to calculate the debarment date
2513         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2514             my $calendar = Koha::Calendar->new(
2515                 branchcode => $branchcode,
2516                 days_mode  => 'Calendar'
2517             );
2518             $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2519         }
2520         else {
2521             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2522         }
2523         return $new_debar_dt;
2524     }
2525     return;
2526 }
2527
2528 sub _debar_user_on_return {
2529     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2530
2531     $return_date //= dt_from_string();
2532
2533     my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2534
2535     return unless $new_debar_dt;
2536
2537     Koha::Patron::Debarments::AddUniqueDebarment({
2538         borrowernumber => $borrower->{borrowernumber},
2539         expiration     => $new_debar_dt->ymd(),
2540         type           => 'SUSPENSION',
2541     });
2542     # if borrower was already debarred but does not get an extra debarment
2543     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2544     my ($new_debarment_str, $is_a_reminder);
2545     if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2546         $is_a_reminder = 1;
2547         $new_debarment_str = $borrower->{debarred};
2548     } else {
2549         $new_debarment_str = $new_debar_dt->ymd();
2550     }
2551     # FIXME Should return a DateTime object
2552     return $new_debarment_str, $is_a_reminder;
2553 }
2554
2555 =head2 _FixOverduesOnReturn
2556
2557    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2558
2559 C<$borrowernumber> borrowernumber
2560
2561 C<$itemnumber> itemnumber
2562
2563 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2564
2565 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2566
2567 Internal function
2568
2569 =cut
2570
2571 sub _FixOverduesOnReturn {
2572     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2573     unless( $borrowernumber ) {
2574         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2575         return;
2576     }
2577     unless( $item ) {
2578         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2579         return;
2580     }
2581     unless( $status ) {
2582         warn "_FixOverduesOnReturn() not supplied valid status";
2583         return;
2584     }
2585
2586     my $schema = Koha::Database->schema;
2587
2588     my $result = $schema->txn_do(
2589         sub {
2590             # check for overdue fine
2591             my $accountlines = Koha::Account::Lines->search(
2592                 {
2593                     borrowernumber  => $borrowernumber,
2594                     itemnumber      => $item,
2595                     debit_type_code => 'OVERDUE',
2596                     status          => 'UNRETURNED'
2597                 }
2598             );
2599             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2600
2601             my $accountline = $accountlines->next;
2602             my $payments = $accountline->credits;
2603
2604             my $amountoutstanding = $accountline->amountoutstanding;
2605             if ( $accountline->amount == 0 && $payments->count == 0 ) {
2606                 $accountline->delete;
2607                 return 0; # no warning, we've just removed a zero value fine (backdated return)
2608             } elsif ($exemptfine && ($amountoutstanding != 0)) {
2609                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2610                 my $credit = $account->add_credit(
2611                     {
2612                         amount     => $amountoutstanding,
2613                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2614                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2615                         interface  => C4::Context->interface,
2616                         type       => 'FORGIVEN',
2617                         item_id    => $item
2618                     }
2619                 );
2620
2621                 $credit->apply({ debits => [ $accountline ] });
2622
2623                 if (C4::Context->preference("FinesLog")) {
2624                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2625                 }
2626             }
2627
2628             $accountline->status($status);
2629             return $accountline->store();
2630         }
2631     );
2632
2633     return $result;
2634 }
2635
2636 =head2 _GetCircControlBranch
2637
2638    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2639
2640 Internal function :
2641
2642 Return the library code to be used to determine which circulation
2643 policy applies to a transaction.  Looks up the CircControl and
2644 HomeOrHoldingBranch system preferences.
2645
2646 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2647
2648 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2649
2650 =cut
2651
2652 sub _GetCircControlBranch {
2653     my ($item, $borrower) = @_;
2654     my $circcontrol = C4::Context->preference('CircControl');
2655     my $branch;
2656
2657     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2658         $branch= C4::Context->userenv->{'branch'};
2659     } elsif ($circcontrol eq 'PatronLibrary') {
2660         $branch=$borrower->{branchcode};
2661     } else {
2662         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2663         $branch = $item->{$branchfield};
2664         # default to item home branch if holdingbranch is used
2665         # and is not defined
2666         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2667             $branch = $item->{homebranch};
2668         }
2669     }
2670     return $branch;
2671 }
2672
2673 =head2 GetOpenIssue
2674
2675   $issue = GetOpenIssue( $itemnumber );
2676
2677 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2678
2679 C<$itemnumber> is the item's itemnumber
2680
2681 Returns a hashref
2682
2683 =cut
2684
2685 sub GetOpenIssue {
2686   my ( $itemnumber ) = @_;
2687   return unless $itemnumber;
2688   my $dbh = C4::Context->dbh;
2689   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2690   $sth->execute( $itemnumber );
2691   return $sth->fetchrow_hashref();
2692
2693 }
2694
2695 =head2 GetUpcomingDueIssues
2696
2697   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2698
2699 =cut
2700
2701 sub GetUpcomingDueIssues {
2702     my $params = shift;
2703
2704     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2705     my $dbh = C4::Context->dbh;
2706     my $statement;
2707     $statement = q{
2708         SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2709         FROM issues
2710         LEFT JOIN items USING (itemnumber)
2711         LEFT JOIN branches ON branches.branchcode =
2712     };
2713     $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2714     $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2715     my @bind_parameters = ( $params->{'days_in_advance'} );
2716
2717     my $sth = $dbh->prepare( $statement );
2718     $sth->execute( @bind_parameters );
2719     my $upcoming_dues = $sth->fetchall_arrayref({});
2720
2721     return $upcoming_dues;
2722 }
2723
2724 =head2 CanBookBeRenewed
2725
2726   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2727
2728 Find out whether a borrowed item may be renewed.
2729
2730 C<$borrowernumber> is the borrower number of the patron who currently
2731 has the item on loan.
2732
2733 C<$itemnumber> is the number of the item to renew.
2734
2735 C<$override_limit>, if supplied with a true value, causes
2736 the limit on the number of times that the loan can be renewed
2737 (as controlled by the item type) to be ignored. Overriding also allows
2738 to renew sooner than "No renewal before" and to manually renew loans
2739 that are automatically renewed.
2740
2741 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2742 item must currently be on loan to the specified borrower; renewals
2743 must be allowed for the item's type; and the borrower must not have
2744 already renewed the loan. $error will contain the reason the renewal can not proceed
2745
2746 =cut
2747
2748 sub CanBookBeRenewed {
2749     my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2750
2751     my $auto_renew = "no";
2752
2753     my $item      = Koha::Items->find($itemnumber)      or return ( 0, 'no_item' );
2754     my $issue = $item->checkout or return ( 0, 'no_checkout' );
2755     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2756     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2757
2758     my $patron = $issue->patron or return;
2759
2760     # override_limit will override anything else except on_reserve
2761     unless ( $override_limit ){
2762         my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2763         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2764             {
2765                 categorycode => $patron->categorycode,
2766                 itemtype     => $item->effective_itemtype,
2767                 branchcode   => $branchcode,
2768                 rules => [
2769                     'renewalsallowed',
2770                     'lengthunit',
2771                     'unseen_renewals_allowed'
2772                 ]
2773             }
2774         );
2775
2776         return ( 0, "too_many" )
2777           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2778
2779         return ( 0, "too_unseen" )
2780           if C4::Context->preference('UnseenRenewals') &&
2781             $issuing_rule->{unseen_renewals_allowed} &&
2782             $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
2783
2784         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2785         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2786         $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2787         my $restricted  = $patron->is_debarred;
2788         my $hasoverdues = $patron->has_overdues;
2789
2790         if ( $restricted and $restrictionblockrenewing ) {
2791             return ( 0, 'restriction');
2792         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2793             return ( 0, 'overdue');
2794         }
2795
2796         $auto_renew = _CanBookBeAutoRenewed({
2797             patron     => $patron,
2798             item       => $item,
2799             branchcode => $branchcode,
2800             issue      => $issue
2801         });
2802         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_soon' && $cron;
2803         # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
2804         # extra notices being sent. Cron also implies no override
2805         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_account_expired';
2806         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_late';
2807         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_much_oweing';
2808     }
2809
2810     my ( $resfound, $resrec, $possible_reserves ) = C4::Reserves::CheckReserves($itemnumber);
2811
2812     # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2813     if ( $resfound && $resrec->{non_priority} ) {
2814         $resfound = Koha::Holds->search(
2815             { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2816           ->count > 0;
2817     }
2818
2819
2820
2821     # This item can fill one or more unfilled reserve, can those unfilled reserves
2822     # all be filled by other available items?
2823     if ( $resfound
2824         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2825     {
2826         my $item_holds = Koha::Holds->search( { itemnumber => $itemnumber, found => undef } )->count();
2827         if ($item_holds) {
2828             # There is an item level hold on this item, no other item can fill the hold
2829             $resfound = 1;
2830         }
2831         else {
2832
2833             # Get all other items that could possibly fill reserves
2834             my $items = Koha::Items->search({
2835                 biblionumber => $resrec->{biblionumber},
2836                 onloan       => undef,
2837                 notforloan   => 0,
2838                 -not         => { itemnumber => $itemnumber }
2839             });
2840
2841             # Get all other reserves that could have been filled by this item
2842             my @borrowernumbers = map { $_->{borrowernumber} } @$possible_reserves;
2843             my $patrons = Koha::Patrons->search({
2844                 borrowernumber => { -in => \@borrowernumbers }
2845             });
2846
2847             # If the count of the union of the lists of reservable items for each borrower
2848             # is equal or greater than the number of borrowers, we know that all reserves
2849             # can be filled with available items. We can get the union of the sets simply
2850             # by pushing all the elements onto an array and removing the duplicates.
2851             my @reservable;
2852             ITEM: while ( my $item = $items->next ) {
2853                 next if IsItemOnHoldAndFound( $item->itemnumber );
2854                 while ( my $patron = $patrons->next ) {
2855                     next unless IsAvailableForItemLevelRequest($item, $patron);
2856                     next unless CanItemBeReserved($patron,$item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
2857                     push @reservable, $item->itemnumber;
2858                     if (@reservable >= @borrowernumbers) {
2859                         $resfound = 0;
2860                         last ITEM;
2861                     }
2862                     last;
2863                 }
2864                 $patrons->reset;
2865             }
2866         }
2867     }
2868
2869     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2870     return ( 0, $auto_renew  ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
2871     if ( GetSoonestRenewDate($borrowernumber, $itemnumber) > dt_from_string() ){
2872         return (0, "too_soon") unless $override_limit;
2873     }
2874
2875     return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
2876
2877     return ( 1, undef );
2878 }
2879
2880 =head2 AddRenewal
2881
2882   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate], [$seen]);
2883
2884 Renews a loan.
2885
2886 C<$borrowernumber> is the borrower number of the patron who currently
2887 has the item.
2888
2889 C<$itemnumber> is the number of the item to renew.
2890
2891 C<$branch> is the library where the renewal took place (if any).
2892            The library that controls the circ policies for the renewal is retrieved from the issues record.
2893
2894 C<$datedue> can be a DateTime object used to set the due date.
2895
2896 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2897 this parameter is not supplied, lastreneweddate is set to the current date.
2898
2899 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
2900 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
2901 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
2902 syspref)
2903
2904 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2905 from the book's item type.
2906
2907 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
2908 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
2909 fallback to a true value
2910
2911 =cut
2912
2913 sub AddRenewal {
2914     my $borrowernumber  = shift;
2915     my $itemnumber      = shift or return;
2916     my $branch          = shift;
2917     my $datedue         = shift;
2918     my $lastreneweddate = shift || dt_from_string();
2919     my $skipfinecalc    = shift;
2920     my $seen            = shift;
2921
2922     # Fallback on a 'seen' renewal
2923     $seen = defined $seen && $seen == 0 ? 0 : 1;
2924
2925     my $item_object   = Koha::Items->find($itemnumber) or return;
2926     my $biblio = $item_object->biblio;
2927     my $issue  = $item_object->checkout;
2928     my $item_unblessed = $item_object->unblessed;
2929
2930     my $dbh = C4::Context->dbh;
2931
2932     return unless $issue;
2933
2934     $borrowernumber ||= $issue->borrowernumber;
2935
2936     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2937         carp 'Invalid date passed to AddRenewal.';
2938         return;
2939     }
2940
2941     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2942     my $patron_unblessed = $patron->unblessed;
2943
2944     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2945
2946     my $schema = Koha::Database->schema;
2947     $schema->txn_do(sub{
2948
2949         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
2950             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2951         }
2952         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2953
2954         # If the due date wasn't specified, calculate it by adding the
2955         # book's loan length to today's date or the current due date
2956         # based on the value of the RenewalPeriodBase syspref.
2957         my $itemtype = $item_object->effective_itemtype;
2958         unless ($datedue) {
2959
2960             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2961                                             dt_from_string( $issue->date_due, 'sql' ) :
2962                                             dt_from_string();
2963             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2964         }
2965
2966         my $fees = Koha::Charges::Fees->new(
2967             {
2968                 patron    => $patron,
2969                 library   => $circ_library,
2970                 item      => $item_object,
2971                 from_date => dt_from_string( $issue->date_due, 'sql' ),
2972                 to_date   => dt_from_string($datedue),
2973             }
2974         );
2975
2976         # Increment the unseen renewals, if appropriate
2977         # We only do so if the syspref is enabled and
2978         # a maximum value has been set in the circ rules
2979         my $unseen_renewals = $issue->unseen_renewals;
2980         if (C4::Context->preference('UnseenRenewals')) {
2981             my $rule = Koha::CirculationRules->get_effective_rule(
2982                 {   categorycode => $patron->categorycode,
2983                     itemtype     => $item_object->effective_itemtype,
2984                     branchcode   => $circ_library->branchcode,
2985                     rule_name    => 'unseen_renewals_allowed'
2986                 }
2987             );
2988             if (!$seen && $rule && $rule->rule_value) {
2989                 $unseen_renewals++;
2990             } else {
2991                 # If the renewal is seen, unseen should revert to 0
2992                 $unseen_renewals = 0;
2993             }
2994         }
2995
2996         # Update the issues record to have the new due date, and a new count
2997         # of how many times it has been renewed.
2998         my $renews = ( $issue->renewals || 0 ) + 1;
2999         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3000
3001         eval{
3002             $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3003         };
3004         if( $sth->err ){
3005             Koha::Exceptions::Checkout::FailedRenewal->throw(
3006                 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3007             );
3008         }
3009
3010         # Update the renewal count on the item, and tell zebra to reindex
3011         $renews = ( $item_object->renewals || 0 ) + 1;
3012         $item_object->renewals($renews);
3013         $item_object->onloan($datedue);
3014         $item_object->store({ log_action => 0 });
3015
3016         # Charge a new rental fee, if applicable
3017         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3018         if ( $charge > 0 ) {
3019             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3020         }
3021
3022         # Charge a new accumulate rental fee, if applicable
3023         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3024         if ( $itemtype_object ) {
3025             my $accumulate_charge = $fees->accumulate_rentalcharge();
3026             if ( $accumulate_charge > 0 ) {
3027                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3028             }
3029             $charge += $accumulate_charge;
3030         }
3031
3032         # Send a renewal slip according to checkout alert preferencei
3033         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3034             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3035             my %conditions        = (
3036                 branchcode   => $branch,
3037                 categorycode => $patron->categorycode,
3038                 item_type    => $itemtype,
3039                 notification => 'CHECKOUT',
3040             );
3041             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3042                 SendCirculationAlert(
3043                     {
3044                         type     => 'RENEWAL',
3045                         item     => $item_unblessed,
3046                         borrower => $patron->unblessed,
3047                         branch   => $branch,
3048                     }
3049                 );
3050             }
3051         }
3052
3053         # Remove any OVERDUES related debarment if the borrower has no overdues
3054         if ( $patron
3055           && $patron->is_debarred
3056           && ! $patron->has_overdues
3057           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3058         ) {
3059             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3060         }
3061
3062         # Add the renewal to stats
3063         C4::Stats::UpdateStats(
3064             {
3065                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3066                 type           => 'renew',
3067                 amount         => $charge,
3068                 itemnumber     => $itemnumber,
3069                 itemtype       => $itemtype,
3070                 location       => $item_object->location,
3071                 borrowernumber => $borrowernumber,
3072                 ccode          => $item_object->ccode,
3073             }
3074         );
3075
3076         #Log the renewal
3077         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3078
3079         Koha::Plugins->call('after_circ_action', {
3080             action  => 'renewal',
3081             payload => {
3082                 checkout  => $issue->get_from_storage
3083             }
3084         });
3085     });
3086
3087     return $datedue;
3088 }
3089
3090 sub GetRenewCount {
3091     # check renewal status
3092     my ( $bornum, $itemno ) = @_;
3093     my $dbh           = C4::Context->dbh;
3094     my $renewcount    = 0;
3095     my $unseencount    = 0;
3096     my $renewsallowed = 0;
3097     my $unseenallowed = 0;
3098     my $renewsleft    = 0;
3099     my $unseenleft    = 0;
3100
3101     my $patron = Koha::Patrons->find( $bornum );
3102     my $item   = Koha::Items->find($itemno);
3103
3104     return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3105
3106     # Look in the issues table for this item, lent to this borrower,
3107     # and not yet returned.
3108
3109     # FIXME - I think this function could be redone to use only one SQL call.
3110     my $sth = $dbh->prepare(
3111         "select * from issues
3112                                 where (borrowernumber = ?)
3113                                 and (itemnumber = ?)"
3114     );
3115     $sth->execute( $bornum, $itemno );
3116     my $data = $sth->fetchrow_hashref;
3117     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3118     $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3119     # $item and $borrower should be calculated
3120     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3121
3122     my $rules = Koha::CirculationRules->get_effective_rules(
3123         {
3124             categorycode => $patron->categorycode,
3125             itemtype     => $item->effective_itemtype,
3126             branchcode   => $branchcode,
3127             rules        => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3128         }
3129     );
3130     $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3131     $unseenallowed = $rules->{unseen_renewals_allowed} ?
3132         $rules->{unseen_renewals_allowed} :
3133         0;
3134     $renewsleft    = $renewsallowed - $renewcount;
3135     $unseenleft    = $unseenallowed - $unseencount;
3136     if($renewsleft < 0){ $renewsleft = 0; }
3137     if($unseenleft < 0){ $unseenleft = 0; }
3138     return (
3139         $renewcount,
3140         $renewsallowed,
3141         $renewsleft,
3142         $unseencount,
3143         $unseenallowed,
3144         $unseenleft
3145     );
3146 }
3147
3148 =head2 GetSoonestRenewDate
3149
3150   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3151
3152 Find out the soonest possible renew date of a borrowed item.
3153
3154 C<$borrowernumber> is the borrower number of the patron who currently
3155 has the item on loan.
3156
3157 C<$itemnumber> is the number of the item to renew.
3158
3159 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3160 renew date, based on the value "No renewal before" of the applicable
3161 issuing rule. Returns the current date if the item can already be
3162 renewed, and returns undefined if the borrower, loan, or item
3163 cannot be found.
3164
3165 =cut
3166
3167 sub GetSoonestRenewDate {
3168     my ( $borrowernumber, $itemnumber ) = @_;
3169
3170     my $dbh = C4::Context->dbh;
3171
3172     my $item      = Koha::Items->find($itemnumber)      or return;
3173     my $itemissue = $item->checkout or return;
3174
3175     $borrowernumber ||= $itemissue->borrowernumber;
3176     my $patron = Koha::Patrons->find( $borrowernumber )
3177       or return;
3178
3179     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3180     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3181         {   categorycode => $patron->categorycode,
3182             itemtype     => $item->effective_itemtype,
3183             branchcode   => $branchcode,
3184             rules => [
3185                 'norenewalbefore',
3186                 'lengthunit',
3187             ]
3188         }
3189     );
3190
3191     my $now = dt_from_string;
3192
3193     if ( defined $issuing_rule->{norenewalbefore}
3194         and $issuing_rule->{norenewalbefore} ne "" )
3195     {
3196         my $soonestrenewal =
3197           dt_from_string( $itemissue->date_due )->subtract(
3198             $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3199
3200         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3201             and $issuing_rule->{lengthunit} eq 'days' )
3202         {
3203             $soonestrenewal->truncate( to => 'day' );
3204         }
3205         return $soonestrenewal if $now < $soonestrenewal;
3206     } elsif ( $itemissue->auto_renew && $patron->autorenew_checkouts ) {
3207         # Checkouts with auto-renewing fall back to due date
3208         my $soonestrenewal = dt_from_string( $itemissue->date_due );
3209         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3210             and $issuing_rule->{lengthunit} eq 'days' )
3211         {
3212             $soonestrenewal->truncate( to => 'day' );
3213         }
3214         return $soonestrenewal;
3215     }
3216     return $now;
3217 }
3218
3219 =head2 GetLatestAutoRenewDate
3220
3221   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3222
3223 Find out the latest possible auto renew date of a borrowed item.
3224
3225 C<$borrowernumber> is the borrower number of the patron who currently
3226 has the item on loan.
3227
3228 C<$itemnumber> is the number of the item to renew.
3229
3230 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3231 auto renew date, based on the value "No auto renewal after" and the "No auto
3232 renewal after (hard limit) of the applicable issuing rule.
3233 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3234 or item cannot be found.
3235
3236 =cut
3237
3238 sub GetLatestAutoRenewDate {
3239     my ( $borrowernumber, $itemnumber ) = @_;
3240
3241     my $dbh = C4::Context->dbh;
3242
3243     my $item      = Koha::Items->find($itemnumber)  or return;
3244     my $itemissue = $item->checkout                 or return;
3245
3246     $borrowernumber ||= $itemissue->borrowernumber;
3247     my $patron = Koha::Patrons->find( $borrowernumber )
3248       or return;
3249
3250     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3251     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3252         {
3253             categorycode => $patron->categorycode,
3254             itemtype     => $item->effective_itemtype,
3255             branchcode   => $branchcode,
3256             rules => [
3257                 'no_auto_renewal_after',
3258                 'no_auto_renewal_after_hard_limit',
3259                 'lengthunit',
3260             ]
3261         }
3262     );
3263
3264     return unless $circulation_rules;
3265     return
3266       if ( not $circulation_rules->{no_auto_renewal_after}
3267             or $circulation_rules->{no_auto_renewal_after} eq '' )
3268       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3269              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3270
3271     my $maximum_renewal_date;
3272     if ( $circulation_rules->{no_auto_renewal_after} ) {
3273         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3274         $maximum_renewal_date->add(
3275             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3276         );
3277     }
3278
3279     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3280         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3281         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3282     }
3283     return $maximum_renewal_date;
3284 }
3285
3286
3287 =head2 GetIssuingCharges
3288
3289   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3290
3291 Calculate how much it would cost for a given patron to borrow a given
3292 item, including any applicable discounts.
3293
3294 C<$itemnumber> is the item number of item the patron wishes to borrow.
3295
3296 C<$borrowernumber> is the patron's borrower number.
3297
3298 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3299 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3300 if it's a video).
3301
3302 =cut
3303
3304 sub GetIssuingCharges {
3305
3306     # calculate charges due
3307     my ( $itemnumber, $borrowernumber ) = @_;
3308     my $charge = 0;
3309     my $dbh    = C4::Context->dbh;
3310     my $item_type;
3311
3312     # Get the book's item type and rental charge (via its biblioitem).
3313     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3314         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3315     $charge_query .= (C4::Context->preference('item-level_itypes'))
3316         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3317         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3318
3319     $charge_query .= ' WHERE items.itemnumber =?';
3320
3321     my $sth = $dbh->prepare($charge_query);
3322     $sth->execute($itemnumber);
3323     if ( my $item_data = $sth->fetchrow_hashref ) {
3324         $item_type = $item_data->{itemtype};
3325         $charge    = $item_data->{rentalcharge};
3326         if ($charge) {
3327             # FIXME This should follow CircControl
3328             my $branch = C4::Context::mybranch();
3329             my $patron = Koha::Patrons->find( $borrowernumber );
3330             my $discount = Koha::CirculationRules->get_effective_rule({
3331                 categorycode => $patron->categorycode,
3332                 branchcode   => $branch,
3333                 itemtype     => $item_type,
3334                 rule_name    => 'rentaldiscount'
3335             });
3336             if ($discount) {
3337                 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3338             }
3339             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3340         }
3341     }
3342
3343     return ( $charge, $item_type );
3344 }
3345
3346 =head2 AddIssuingCharge
3347
3348   &AddIssuingCharge( $checkout, $charge, $type )
3349
3350 =cut
3351
3352 sub AddIssuingCharge {
3353     my ( $checkout, $charge, $type ) = @_;
3354
3355     # FIXME What if checkout does not exist?
3356
3357     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3358     my $accountline = $account->add_debit(
3359         {
3360             amount      => $charge,
3361             note        => undef,
3362             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3363             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3364             interface   => C4::Context->interface,
3365             type        => $type,
3366             item_id     => $checkout->itemnumber,
3367             issue_id    => $checkout->issue_id,
3368         }
3369     );
3370 }
3371
3372 =head2 GetTransfers
3373
3374   GetTransfers($itemnumber);
3375
3376 =cut
3377
3378 sub GetTransfers {
3379     my ($itemnumber) = @_;
3380
3381     my $dbh = C4::Context->dbh;
3382
3383     my $query = '
3384         SELECT datesent,
3385                frombranch,
3386                tobranch,
3387                branchtransfer_id,
3388                daterequested,
3389                reason
3390         FROM branchtransfers
3391         WHERE itemnumber = ?
3392           AND datearrived IS NULL
3393           AND datecancelled IS NULL
3394         ';
3395     my $sth = $dbh->prepare($query);
3396     $sth->execute($itemnumber);
3397     my @row = $sth->fetchrow_array();
3398     return @row;
3399 }
3400
3401 =head2 GetTransfersFromTo
3402
3403   @results = GetTransfersFromTo($frombranch,$tobranch);
3404
3405 Returns the list of pending transfers between $from and $to branch
3406
3407 =cut
3408
3409 sub GetTransfersFromTo {
3410     my ( $frombranch, $tobranch ) = @_;
3411     return unless ( $frombranch && $tobranch );
3412     my $dbh   = C4::Context->dbh;
3413     my $query = "
3414         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3415         FROM   branchtransfers
3416         WHERE  frombranch=?
3417           AND  tobranch=?
3418           AND datecancelled IS NULL
3419           AND datesent IS NOT NULL
3420           AND datearrived IS NULL
3421     ";
3422     my $sth = $dbh->prepare($query);
3423     $sth->execute( $frombranch, $tobranch );
3424     my @gettransfers;
3425
3426     while ( my $data = $sth->fetchrow_hashref ) {
3427         push @gettransfers, $data;
3428     }
3429     return (@gettransfers);
3430 }
3431
3432 =head2 SendCirculationAlert
3433
3434 Send out a C<check-in> or C<checkout> alert using the messaging system.
3435
3436 B<Parameters>:
3437
3438 =over 4
3439
3440 =item type
3441
3442 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3443
3444 =item item
3445
3446 Hashref of information about the item being checked in or out.
3447
3448 =item borrower
3449
3450 Hashref of information about the borrower of the item.
3451
3452 =item branch
3453
3454 The branchcode from where the checkout or check-in took place.
3455
3456 =back
3457
3458 B<Example>:
3459
3460     SendCirculationAlert({
3461         type     => 'CHECKOUT',
3462         item     => $item,
3463         borrower => $borrower,
3464         branch   => $branch,
3465     });
3466
3467 =cut
3468
3469 sub SendCirculationAlert {
3470     my ($opts) = @_;
3471     my ($type, $item, $borrower, $branch, $issue) =
3472         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3473     my %message_name = (
3474         CHECKIN  => 'Item_Check_in',
3475         CHECKOUT => 'Item_Checkout',
3476         RENEWAL  => 'Item_Checkout',
3477     );
3478     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3479         borrowernumber => $borrower->{borrowernumber},
3480         message_name   => $message_name{$type},
3481     });
3482
3483
3484     my $tables = {
3485         items => $item->{itemnumber},
3486         biblio      => $item->{biblionumber},
3487         biblioitems => $item->{biblionumber},
3488         borrowers   => $borrower,
3489         branches    => $branch,
3490     };
3491
3492     # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3493     # See C4::Letters:: _parseletter_sth
3494     if( $type eq 'CHECKIN' ){
3495         $tables->{old_issues} = $issue->issue_id;
3496     } else {
3497         $tables->{issues} = $item->{itemnumber};
3498     }
3499
3500     my $schema = Koha::Database->new->schema;
3501     my @transports = keys %{ $borrower_preferences->{transports} };
3502
3503     # From the MySQL doc:
3504     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3505     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3506     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3507     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3508
3509     for my $mtt (@transports) {
3510         my $letter =  C4::Letters::GetPreparedLetter (
3511             module => 'circulation',
3512             letter_code => $type,
3513             branchcode => $branch,
3514             message_transport_type => $mtt,
3515             lang => $borrower->{lang},
3516             tables => $tables,
3517         ) or next;
3518
3519         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3520         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3521         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3522         unless ( $message ) {
3523             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3524             C4::Message->enqueue($letter, $borrower, $mtt);
3525         } else {
3526             $message->append($letter);
3527             $message->update;
3528         }
3529         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3530     }
3531
3532     return;
3533 }
3534
3535 =head2 updateWrongTransfer
3536
3537   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3538
3539 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
3540
3541 =cut
3542
3543 sub updateWrongTransfer {
3544         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3545
3546     # first step: cancel the original transfer
3547     my $item = Koha::Items->find($itemNumber);
3548     my $transfer = $item->get_transfer;
3549     $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3550
3551     # second step: create a new transfer to the right location
3552     my $new_transfer = $item->request_transfer(
3553         {
3554             to            => $transfer->to_library,
3555             reason        => $transfer->reason,
3556             comment       => $transfer->comments,
3557             ignore_limits => 1,
3558             enqueue       => 1
3559         }
3560     );
3561
3562     return $new_transfer;
3563 }
3564
3565 =head2 CalcDateDue
3566
3567 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3568
3569 this function calculates the due date given the start date and configured circulation rules,
3570 checking against the holidays calendar as per the daysmode circulation rule.
3571 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3572 C<$itemtype>  = itemtype code of item in question
3573 C<$branch>  = location whose calendar to use
3574 C<$borrower> = Borrower object
3575 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3576
3577 =cut
3578
3579 sub CalcDateDue {
3580     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3581
3582     $isrenewal ||= 0;
3583
3584     # loanlength now a href
3585     my $loanlength =
3586             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3587
3588     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3589             ? qq{renewalperiod}
3590             : qq{issuelength};
3591
3592     my $datedue;
3593     if ( $startdate ) {
3594         if (ref $startdate ne 'DateTime' ) {
3595             $datedue = dt_from_string($datedue);
3596         } else {
3597             $datedue = $startdate->clone;
3598         }
3599     } else {
3600         $datedue = dt_from_string()->truncate( to => 'minute' );
3601     }
3602
3603
3604     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3605         {
3606             categorycode => $borrower->{categorycode},
3607             itemtype     => $itemtype,
3608             branchcode   => $branch,
3609         }
3610     );
3611
3612     # calculate the datedue as normal
3613     if ( $daysmode eq 'Days' )
3614     {    # ignoring calendar
3615         if ( $loanlength->{lengthunit} eq 'hours' ) {
3616             $datedue->add( hours => $loanlength->{$length_key} );
3617         } else {    # days
3618             $datedue->add( days => $loanlength->{$length_key} );
3619             $datedue->set_hour(23);
3620             $datedue->set_minute(59);
3621         }
3622     } else {
3623         my $dur;
3624         if ($loanlength->{lengthunit} eq 'hours') {
3625             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3626         }
3627         else { # days
3628             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3629         }
3630         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3631         $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3632         if ($loanlength->{lengthunit} eq 'days') {
3633             $datedue->set_hour(23);
3634             $datedue->set_minute(59);
3635         }
3636     }
3637
3638     # if Hard Due Dates are used, retrieve them and apply as necessary
3639     my ( $hardduedate, $hardduedatecompare ) =
3640       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3641     if ($hardduedate) {    # hardduedates are currently dates
3642         $hardduedate->truncate( to => 'minute' );
3643         $hardduedate->set_hour(23);
3644         $hardduedate->set_minute(59);
3645         my $cmp = DateTime->compare( $hardduedate, $datedue );
3646
3647 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3648 # if the calculated date is before the 'after' Hard Due Date (floor), override
3649 # if the hard due date is set to 'exactly', overrride
3650         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3651             $datedue = $hardduedate->clone;
3652         }
3653
3654         # in all other cases, keep the date due as it is
3655
3656     }
3657
3658     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3659     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3660         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3661         if( $expiry_dt ) { #skip empty expiry date..
3662             $expiry_dt->set( hour => 23, minute => 59);
3663             my $d1= $datedue->clone->set_time_zone('floating');
3664             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3665                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3666             }
3667         }
3668         if ( $daysmode ne 'Days' ) {
3669           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3670           if ( $calendar->is_holiday($datedue) ) {
3671               # Don't return on a closed day
3672               $datedue = $calendar->prev_open_days( $datedue, 1 );
3673           }
3674         }
3675     }
3676
3677     return $datedue;
3678 }
3679
3680
3681 sub CheckValidBarcode{
3682 my ($barcode) = @_;
3683 my $dbh = C4::Context->dbh;
3684 my $query=qq|SELECT count(*)
3685              FROM items
3686              WHERE barcode=?
3687             |;
3688 my $sth = $dbh->prepare($query);
3689 $sth->execute($barcode);
3690 my $exist=$sth->fetchrow ;
3691 return $exist;
3692 }
3693
3694 =head2 IsBranchTransferAllowed
3695
3696   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3697
3698 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3699
3700 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3701 Koha::Item->can_be_transferred.
3702
3703 =cut
3704
3705 sub IsBranchTransferAllowed {
3706         my ( $toBranch, $fromBranch, $code ) = @_;
3707
3708         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3709
3710         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3711         my $dbh = C4::Context->dbh;
3712
3713         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3714         $sth->execute( $toBranch, $fromBranch, $code );
3715         my $limit = $sth->fetchrow_hashref();
3716
3717         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3718         if ( $limit->{'limitId'} ) {
3719                 return 0;
3720         } else {
3721                 return 1;
3722         }
3723 }
3724
3725 =head2 CreateBranchTransferLimit
3726
3727   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3728
3729 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3730
3731 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3732
3733 =cut
3734
3735 sub CreateBranchTransferLimit {
3736    my ( $toBranch, $fromBranch, $code ) = @_;
3737    return unless defined($toBranch) && defined($fromBranch);
3738    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3739
3740    my $dbh = C4::Context->dbh;
3741
3742    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3743    return $sth->execute( $code, $toBranch, $fromBranch );
3744 }
3745
3746 =head2 DeleteBranchTransferLimits
3747
3748     my $result = DeleteBranchTransferLimits($frombranch);
3749
3750 Deletes all the library transfer limits for one library.  Returns the
3751 number of limits deleted, 0e0 if no limits were deleted, or undef if
3752 no arguments are supplied.
3753
3754 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3755     fromBranch => $fromBranch
3756     })->delete.
3757
3758 =cut
3759
3760 sub DeleteBranchTransferLimits {
3761     my $branch = shift;
3762     return unless defined $branch;
3763     my $dbh    = C4::Context->dbh;
3764     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3765     return $sth->execute($branch);
3766 }
3767
3768 sub ReturnLostItem{
3769     my ( $borrowernumber, $itemnum ) = @_;
3770     MarkIssueReturned( $borrowernumber, $itemnum );
3771 }
3772
3773 =head2 LostItem
3774
3775   LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3776
3777 The final optional parameter, C<$params>, expected to contain
3778 'skip_record_index' key, which relayed down to Koha::Item/store,
3779 there it prevents calling of ModZebra index_records,
3780 which takes most of the time in batch adds/deletes: index_records better
3781 to be called later in C<additem.pl> after the whole loop.
3782
3783 $params:
3784     skip_record_index => 1|0
3785
3786 =cut
3787
3788 sub LostItem{
3789     my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3790
3791     unless ( $mark_lost_from ) {
3792         # Temporary check to avoid regressions
3793         die q|LostItem called without $mark_lost_from, check the API.|;
3794     }
3795
3796     my $mark_returned;
3797     if ( $force_mark_returned ) {
3798         $mark_returned = 1;
3799     } else {
3800         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3801         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3802     }
3803
3804     my $dbh = C4::Context->dbh();
3805     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3806                            FROM issues
3807                            JOIN items USING (itemnumber)
3808                            JOIN biblio USING (biblionumber)
3809                            WHERE issues.itemnumber=?");
3810     $sth->execute($itemnumber);
3811     my $issues=$sth->fetchrow_hashref();
3812
3813     # If a borrower lost the item, add a replacement cost to the their record
3814     if ( my $borrowernumber = $issues->{borrowernumber} ){
3815         my $patron = Koha::Patrons->find( $borrowernumber );
3816
3817         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3818         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3819
3820         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3821             C4::Accounts::chargelostitem(
3822                 $borrowernumber,
3823                 $itemnumber,
3824                 $issues->{'replacementprice'},
3825                 sprintf( "%s %s %s",
3826                     $issues->{'title'}          || q{},
3827                     $issues->{'barcode'}        || q{},
3828                     $issues->{'itemcallnumber'} || q{},
3829                 ),
3830             );
3831             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3832             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3833         }
3834
3835         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
3836     }
3837
3838     # When an item is marked as lost, we should automatically cancel its outstanding transfers.
3839     my $item = Koha::Items->find($itemnumber);
3840     my $transfers = $item->get_transfers;
3841     while (my $transfer = $transfers->next) {
3842         $transfer->cancel({ reason => 'ItemLost', force => 1 });
3843     }
3844 }
3845
3846 sub GetOfflineOperations {
3847     my $dbh = C4::Context->dbh;
3848     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3849     $sth->execute(C4::Context->userenv->{'branch'});
3850     my $results = $sth->fetchall_arrayref({});
3851     return $results;
3852 }
3853
3854 sub GetOfflineOperation {
3855     my $operationid = shift;
3856     return unless $operationid;
3857     my $dbh = C4::Context->dbh;
3858     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3859     $sth->execute( $operationid );
3860     return $sth->fetchrow_hashref;
3861 }
3862
3863 sub AddOfflineOperation {
3864     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3865     my $dbh = C4::Context->dbh;
3866     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3867     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3868     return "Added.";
3869 }
3870
3871 sub DeleteOfflineOperation {
3872     my $dbh = C4::Context->dbh;
3873     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3874     $sth->execute( shift );
3875     return "Deleted.";
3876 }
3877
3878 sub ProcessOfflineOperation {
3879     my $operation = shift;
3880
3881     my $report;
3882     if ( $operation->{action} eq 'return' ) {
3883         $report = ProcessOfflineReturn( $operation );
3884     } elsif ( $operation->{action} eq 'issue' ) {
3885         $report = ProcessOfflineIssue( $operation );
3886     } elsif ( $operation->{action} eq 'payment' ) {
3887         $report = ProcessOfflinePayment( $operation );
3888     }
3889
3890     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3891
3892     return $report;
3893 }
3894
3895 sub ProcessOfflineReturn {
3896     my $operation = shift;
3897
3898     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3899
3900     if ( $item ) {
3901         my $itemnumber = $item->itemnumber;
3902         my $issue = GetOpenIssue( $itemnumber );
3903         if ( $issue ) {
3904             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
3905             ModDateLastSeen( $itemnumber, $leave_item_lost );
3906             MarkIssueReturned(
3907                 $issue->{borrowernumber},
3908                 $itemnumber,
3909                 $operation->{timestamp},
3910             );
3911             $item->renewals(0);
3912             $item->onloan(undef);
3913             $item->store({ log_action => 0 });
3914             return "Success.";
3915         } else {
3916             return "Item not issued.";
3917         }
3918     } else {
3919         return "Item not found.";
3920     }
3921 }
3922
3923 sub ProcessOfflineIssue {
3924     my $operation = shift;
3925
3926     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3927
3928     if ( $patron ) {
3929         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3930         unless ($item) {
3931             return "Barcode not found.";
3932         }
3933         my $itemnumber = $item->itemnumber;
3934         my $issue = GetOpenIssue( $itemnumber );
3935
3936         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3937             MarkIssueReturned(
3938                 $issue->{borrowernumber},
3939                 $itemnumber,
3940                 $operation->{timestamp},
3941             );
3942         }
3943         AddIssue(
3944             $patron->unblessed,
3945             $operation->{'barcode'},
3946             undef,
3947             1,
3948             $operation->{timestamp},
3949             undef,
3950         );
3951         return "Success.";
3952     } else {
3953         return "Borrower not found.";
3954     }
3955 }
3956
3957 sub ProcessOfflinePayment {
3958     my $operation = shift;
3959
3960     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3961
3962     $patron->account->pay(
3963         {
3964             amount     => $operation->{amount},
3965             library_id => $operation->{branchcode},
3966             interface  => 'koc'
3967         }
3968     );
3969
3970     return "Success.";
3971 }
3972
3973 =head2 TransferSlip
3974
3975   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3976
3977   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3978
3979 =cut
3980
3981 sub TransferSlip {
3982     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3983
3984     my $item =
3985       $itemnumber
3986       ? Koha::Items->find($itemnumber)
3987       : Koha::Items->find( { barcode => $barcode } );
3988
3989     $item or return;
3990
3991     return C4::Letters::GetPreparedLetter (
3992         module => 'circulation',
3993         letter_code => 'TRANSFERSLIP',
3994         branchcode => $branch,
3995         tables => {
3996             'branches'    => $to_branch,
3997             'biblio'      => $item->biblionumber,
3998             'items'       => $item->unblessed,
3999         },
4000     );
4001 }
4002
4003 =head2 CheckIfIssuedToPatron
4004
4005   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4006
4007   Return 1 if any record item is issued to patron, otherwise return 0
4008
4009 =cut
4010
4011 sub CheckIfIssuedToPatron {
4012     my ($borrowernumber, $biblionumber) = @_;
4013
4014     my $dbh = C4::Context->dbh;
4015     my $query = q|
4016         SELECT COUNT(*) FROM issues
4017         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4018         WHERE items.biblionumber = ?
4019         AND issues.borrowernumber = ?
4020     |;
4021     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4022     return 1 if $is_issued;
4023     return;
4024 }
4025
4026 =head2 IsItemIssued
4027
4028   IsItemIssued( $itemnumber )
4029
4030   Return 1 if the item is on loan, otherwise return 0
4031
4032 =cut
4033
4034 sub IsItemIssued {
4035     my $itemnumber = shift;
4036     my $dbh = C4::Context->dbh;
4037     my $sth = $dbh->prepare(q{
4038         SELECT COUNT(*)
4039         FROM issues
4040         WHERE itemnumber = ?
4041     });
4042     $sth->execute($itemnumber);
4043     return $sth->fetchrow;
4044 }
4045
4046 =head2 GetAgeRestriction
4047
4048   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4049   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4050
4051   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4052   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4053
4054 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4055 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4056 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4057          Negative days mean the borrower has gone past the age restriction age.
4058
4059 =cut
4060
4061 sub GetAgeRestriction {
4062     my ($record_restrictions, $borrower) = @_;
4063     my $markers = C4::Context->preference('AgeRestrictionMarker');
4064
4065     return unless $record_restrictions;
4066     # Split $record_restrictions to something like FSK 16 or PEGI 6
4067     my @values = split ' ', uc($record_restrictions);
4068     return unless @values;
4069
4070     # Search first occurrence of one of the markers
4071     my @markers = split /\|/, uc($markers);
4072     return unless @markers;
4073
4074     my $index            = 0;
4075     my $restriction_year = 0;
4076     for my $value (@values) {
4077         $index++;
4078         for my $marker (@markers) {
4079             $marker =~ s/^\s+//;    #remove leading spaces
4080             $marker =~ s/\s+$//;    #remove trailing spaces
4081             if ( $marker eq $value ) {
4082                 if ( $index <= $#values ) {
4083                     $restriction_year += $values[$index];
4084                 }
4085                 last;
4086             }
4087             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4088
4089                 # Perhaps it is something like "K16" (as in Finland)
4090                 $restriction_year += $1;
4091                 last;
4092             }
4093         }
4094         last if ( $restriction_year > 0 );
4095     }
4096
4097     #Check if the borrower is age restricted for this material and for how long.
4098     if ($restriction_year && $borrower) {
4099         if ( $borrower->{'dateofbirth'} ) {
4100             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4101             $alloweddate[0] += $restriction_year;
4102
4103             #Prevent runime eror on leap year (invalid date)
4104             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4105                 $alloweddate[2] = 28;
4106             }
4107
4108             #Get how many days the borrower has to reach the age restriction
4109             my @Today = split /-/, dt_from_string()->ymd();
4110             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4111             #Negative days means the borrower went past the age restriction age
4112             return ($restriction_year, $daysToAgeRestriction);
4113         }
4114     }
4115
4116     return ($restriction_year);
4117 }
4118
4119
4120 =head2 GetPendingOnSiteCheckouts
4121
4122 =cut
4123
4124 sub GetPendingOnSiteCheckouts {
4125     my $dbh = C4::Context->dbh;
4126     return $dbh->selectall_arrayref(q|
4127         SELECT
4128           items.barcode,
4129           items.biblionumber,
4130           items.itemnumber,
4131           items.itemnotes,
4132           items.itemcallnumber,
4133           items.location,
4134           issues.date_due,
4135           issues.branchcode,
4136           issues.date_due < NOW() AS is_overdue,
4137           biblio.author,
4138           biblio.title,
4139           borrowers.firstname,
4140           borrowers.surname,
4141           borrowers.cardnumber,
4142           borrowers.borrowernumber
4143         FROM items
4144         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4145         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4146         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4147         WHERE issues.onsite_checkout = 1
4148     |, { Slice => {} } );
4149 }
4150
4151 sub GetTopIssues {
4152     my ($params) = @_;
4153
4154     my ($count, $branch, $itemtype, $ccode, $newness)
4155         = @$params{qw(count branch itemtype ccode newness)};
4156
4157     my $dbh = C4::Context->dbh;
4158     my $query = q{
4159         SELECT * FROM (
4160         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4161           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4162           i.ccode, SUM(i.issues) AS count
4163         FROM biblio b
4164         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4165         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4166     };
4167
4168     my (@where_strs, @where_args);
4169
4170     if ($branch) {
4171         push @where_strs, 'i.homebranch = ?';
4172         push @where_args, $branch;
4173     }
4174     if ($itemtype) {
4175         if (C4::Context->preference('item-level_itypes')){
4176             push @where_strs, 'i.itype = ?';
4177             push @where_args, $itemtype;
4178         } else {
4179             push @where_strs, 'bi.itemtype = ?';
4180             push @where_args, $itemtype;
4181         }
4182     }
4183     if ($ccode) {
4184         push @where_strs, 'i.ccode = ?';
4185         push @where_args, $ccode;
4186     }
4187     if ($newness) {
4188         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4189         push @where_args, $newness;
4190     }
4191
4192     if (@where_strs) {
4193         $query .= 'WHERE ' . join(' AND ', @where_strs);
4194     }
4195
4196     $query .= q{
4197         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4198           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4199           i.ccode
4200         ORDER BY count DESC
4201     };
4202
4203     $query .= q{ ) xxx WHERE count > 0 };
4204     $count = int($count);
4205     if ($count > 0) {
4206         $query .= "LIMIT $count";
4207     }
4208
4209     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4210
4211     return @$rows;
4212 }
4213
4214 =head2 Internal methods
4215
4216 =cut
4217
4218 sub _CalculateAndUpdateFine {
4219     my ($params) = @_;
4220
4221     my $borrower    = $params->{borrower};
4222     my $item        = $params->{item};
4223     my $issue       = $params->{issue};
4224     my $return_date = $params->{return_date};
4225
4226     unless ($borrower) { carp "No borrower passed in!" && return; }
4227     unless ($item)     { carp "No item passed in!"     && return; }
4228     unless ($issue)    { carp "No issue passed in!"    && return; }
4229
4230     my $datedue = dt_from_string( $issue->date_due );
4231
4232     # we only need to calculate and change the fines if we want to do that on return
4233     # Should be on for hourly loans
4234     my $control = C4::Context->preference('CircControl');
4235     my $control_branchcode =
4236         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4237       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4238       :                                     $issue->branchcode;
4239
4240     my $date_returned = $return_date ? $return_date : dt_from_string();
4241
4242     my ( $amount, $unitcounttotal, $unitcount  ) =
4243       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4244
4245     if ( C4::Context->preference('finesMode') eq 'production' ) {
4246         if ( $amount > 0 ) {
4247             C4::Overdues::UpdateFine({
4248                 issue_id       => $issue->issue_id,
4249                 itemnumber     => $issue->itemnumber,
4250                 borrowernumber => $issue->borrowernumber,
4251                 amount         => $amount,
4252                 due            => output_pref($datedue),
4253             });
4254         }
4255         elsif ($return_date) {
4256
4257             # Backdated returns may have fines that shouldn't exist,
4258             # so in this case, we need to drop those fines to 0
4259
4260             C4::Overdues::UpdateFine({
4261                 issue_id       => $issue->issue_id,
4262                 itemnumber     => $issue->itemnumber,
4263                 borrowernumber => $issue->borrowernumber,
4264                 amount         => 0,
4265                 due            => output_pref($datedue),
4266             });
4267         }
4268     }
4269 }
4270
4271 sub _CanBookBeAutoRenewed {
4272     my ( $params ) = @_;
4273     my $patron = $params->{patron};
4274     my $item = $params->{item};
4275     my $branchcode = $params->{branchcode};
4276     my $issue = $params->{issue};
4277
4278     return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4279
4280     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4281         {
4282             categorycode => $patron->categorycode,
4283             itemtype     => $item->effective_itemtype,
4284             branchcode   => $branchcode,
4285             rules => [
4286                 'no_auto_renewal_after',
4287                 'no_auto_renewal_after_hard_limit',
4288                 'lengthunit',
4289                 'norenewalbefore',
4290             ]
4291         }
4292     );
4293
4294     if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
4295         return 'auto_account_expired';
4296     }
4297
4298     if ( defined $issuing_rule->{no_auto_renewal_after}
4299             and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4300         # Get issue_date and add no_auto_renewal_after
4301         # If this is greater than today, it's too late for renewal.
4302         my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4303         $maximum_renewal_date->add(
4304             $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4305         );
4306         my $now = dt_from_string;
4307         if ( $now >= $maximum_renewal_date ) {
4308             return "auto_too_late";
4309         }
4310     }
4311     if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4312                   and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4313         # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4314         if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4315             return "auto_too_late";
4316         }
4317     }
4318
4319     if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4320         my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4321         my $amountoutstanding =
4322           C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4323           ? $patron->account->balance
4324           : $patron->account->outstanding_debits->total_outstanding;
4325         if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4326             return "auto_too_much_oweing";
4327         }
4328     }
4329
4330     if ( defined $issuing_rule->{norenewalbefore}
4331         and $issuing_rule->{norenewalbefore} ne "" ) {
4332         if ( GetSoonestRenewDate($patron->id, $item->id) > dt_from_string()) {
4333             return "auto_too_soon";
4334         } else {
4335             return "ok";
4336         }
4337     }
4338
4339     # Fallback for automatic renewals:
4340     # If norenewalbefore is undef, don't renew before due date.
4341     my $now = dt_from_string;
4342     if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
4343         return "ok";
4344     } else {
4345         return "auto_too_soon";
4346     }
4347 }
4348
4349 sub _item_denied_renewal {
4350     my ($params) = @_;
4351
4352     my $item = $params->{item};
4353     return unless $item;
4354
4355     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4356     return unless $denyingrules;
4357     foreach my $field (keys %$denyingrules) {
4358         my $val = $item->$field;
4359         if( !defined $val) {
4360             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4361                 return 1;
4362             }
4363         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4364            # If the results matches the values in the syspref
4365            # We return true if match found
4366             return 1;
4367         }
4368     }
4369     return 0;
4370 }
4371
4372 1;
4373
4374 __END__
4375
4376 =head1 AUTHOR
4377
4378 Koha Development Team <http://koha-community.org/>
4379
4380 =cut