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