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