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