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