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