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     my $issue_id = $issue->issue_id;
2171
2172     my $anonymouspatron;
2173     if ( $privacy == 2 ) {
2174         # The default of 0 will not work due to foreign key constraints
2175         # The anonymisation will fail if AnonymousPatron is not a valid entry
2176         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2177         # Note that a warning should appear on the about page (System information tab).
2178         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2179         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."
2180             unless Koha::Patrons->find( $anonymouspatron );
2181     }
2182
2183     my $schema = Koha::Database->schema;
2184
2185     # FIXME Improve the return value and handle it from callers
2186     $schema->txn_do(sub {
2187
2188         # Update the returndate value
2189         if ( $returndate ) {
2190             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2191         }
2192         else {
2193             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2194         }
2195
2196         # Create the old_issues entry
2197         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2198
2199         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2200         if ( $privacy == 2) {
2201             $old_checkout->borrowernumber($anonymouspatron)->store;
2202         }
2203
2204         # And finally delete the issue
2205         $issue->delete;
2206
2207         ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2208
2209         if ( C4::Context->preference('StoreLastBorrower') ) {
2210             my $item = Koha::Items->find( $itemnumber );
2211             my $patron = Koha::Patrons->find( $borrowernumber );
2212             $item->last_returned_by( $patron );
2213         }
2214     });
2215
2216     return $issue_id;
2217 }
2218
2219 =head2 _debar_user_on_return
2220
2221     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2222
2223 C<$borrower> borrower hashref
2224
2225 C<$item> item hashref
2226
2227 C<$datedue> date due DateTime object
2228
2229 C<$returndate> DateTime object representing the return time
2230
2231 Internal function, called only by AddReturn that calculates and updates
2232  the user fine days, and debars them if necessary.
2233
2234 Should only be called for overdue returns
2235
2236 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2237 to ease testing.
2238
2239 =cut
2240
2241 sub _calculate_new_debar_dt {
2242     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2243
2244     my $branchcode = _GetCircControlBranch( $item, $borrower );
2245     my $circcontrol = C4::Context->preference('CircControl');
2246     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2247         {   categorycode => $borrower->{categorycode},
2248             itemtype     => $item->{itype},
2249             branchcode   => $branchcode
2250         }
2251     );
2252     my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2253     my $unit     = $issuing_rule ? $issuing_rule->lengthunit : undef;
2254     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2255
2256     return unless $finedays;
2257
2258     # finedays is in days, so hourly loans must multiply by 24
2259     # thus 1 hour late equals 1 day suspension * finedays rate
2260     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2261
2262     # grace period is measured in the same units as the loan
2263     my $grace =
2264       DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2265
2266     my $deltadays = DateTime::Duration->new(
2267         days => $chargeable_units
2268     );
2269
2270     if ( $deltadays->subtract($grace)->is_positive() ) {
2271         my $suspension_days = $deltadays * $finedays;
2272
2273         if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2274             # No need to / 1 and do not consider / 0
2275             $suspension_days = DateTime::Duration->new(
2276                 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2277             );
2278         }
2279
2280         # If the max suspension days is < than the suspension days
2281         # the suspension days is limited to this maximum period.
2282         my $max_sd = $issuing_rule->maxsuspensiondays;
2283         if ( defined $max_sd ) {
2284             $max_sd = DateTime::Duration->new( days => $max_sd );
2285             $suspension_days = $max_sd
2286               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2287         }
2288
2289         my ( $has_been_extended );
2290         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2291             my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2292             if ( $debarment ) {
2293                 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2294                 $has_been_extended = 1;
2295             }
2296         }
2297
2298         my $new_debar_dt;
2299         # Use the calendar or not to calculate the debarment date
2300         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2301             my $calendar = Koha::Calendar->new(
2302                 branchcode => $branchcode,
2303                 days_mode  => 'Calendar'
2304             );
2305             $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2306         }
2307         else {
2308             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2309         }
2310         return $new_debar_dt;
2311     }
2312     return;
2313 }
2314
2315 sub _debar_user_on_return {
2316     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2317
2318     $return_date //= dt_from_string();
2319
2320     my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2321
2322     return unless $new_debar_dt;
2323
2324     Koha::Patron::Debarments::AddUniqueDebarment({
2325         borrowernumber => $borrower->{borrowernumber},
2326         expiration     => $new_debar_dt->ymd(),
2327         type           => 'SUSPENSION',
2328     });
2329     # if borrower was already debarred but does not get an extra debarment
2330     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2331     my ($new_debarment_str, $is_a_reminder);
2332     if ( $borrower->{debarred} eq $patron->is_debarred ) {
2333         $is_a_reminder = 1;
2334         $new_debarment_str = $borrower->{debarred};
2335     } else {
2336         $new_debarment_str = $new_debar_dt->ymd();
2337     }
2338     # FIXME Should return a DateTime object
2339     return $new_debarment_str, $is_a_reminder;
2340 }
2341
2342 =head2 _FixOverduesOnReturn
2343
2344    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2345
2346 C<$borrowernumber> borrowernumber
2347
2348 C<$itemnumber> itemnumber
2349
2350 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2351
2352 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2353
2354 Internal function
2355
2356 =cut
2357
2358 sub _FixOverduesOnReturn {
2359     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2360     unless( $borrowernumber ) {
2361         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2362         return;
2363     }
2364     unless( $item ) {
2365         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2366         return;
2367     }
2368     unless( $status ) {
2369         warn "_FixOverduesOnReturn() not supplied valid status";
2370         return;
2371     }
2372
2373     my $schema = Koha::Database->schema;
2374
2375     my $result = $schema->txn_do(
2376         sub {
2377             # check for overdue fine
2378             my $accountlines = Koha::Account::Lines->search(
2379                 {
2380                     borrowernumber  => $borrowernumber,
2381                     itemnumber      => $item,
2382                     debit_type_code => 'OVERDUE',
2383                     status          => 'UNRETURNED'
2384                 }
2385             );
2386             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2387
2388             my $accountline = $accountlines->next;
2389             if ($exemptfine) {
2390                 my $amountoutstanding = $accountline->amountoutstanding;
2391
2392                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2393                 my $credit = $account->add_credit(
2394                     {
2395                         amount     => $amountoutstanding,
2396                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2397                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2398                         interface  => C4::Context->interface,
2399                         type       => 'FORGIVEN',
2400                         item_id    => $item
2401                     }
2402                 );
2403
2404                 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2405
2406                 $accountline->status('FORGIVEN');
2407
2408                 if (C4::Context->preference("FinesLog")) {
2409                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2410                 }
2411             } else {
2412                 $accountline->status($status);
2413             }
2414
2415             return $accountline->store();
2416         }
2417     );
2418
2419     return $result;
2420 }
2421
2422 =head2 _FixAccountForLostAndReturned
2423
2424   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2425
2426 Finds the most recent lost item charge for this item and refunds the borrower
2427 appropriatly, taking into account any payments or writeoffs already applied
2428 against the charge.
2429
2430 Internal function, not exported, called only by AddReturn.
2431
2432 =cut
2433
2434 sub _FixAccountForLostAndReturned {
2435     my $itemnumber     = shift or return;
2436     my $borrowernumber = @_ ? shift : undef;
2437     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2438
2439     my $credit;
2440
2441     # check for charge made for lost book
2442     my $accountlines = Koha::Account::Lines->search(
2443         {
2444             itemnumber      => $itemnumber,
2445             debit_type_code => 'LOST',
2446             status          => [ undef, { '<>' => 'RETURNED' } ]
2447         },
2448         {
2449             order_by => { -desc => [ 'date', 'accountlines_id' ] }
2450         }
2451     );
2452
2453     return unless $accountlines->count > 0;
2454     my $accountline     = $accountlines->next;
2455     my $total_to_refund = 0;
2456
2457     return unless $accountline->borrowernumber;
2458     my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2459     return unless $patron; # Patron has been deleted, nobody to credit the return to
2460
2461     my $account = $patron->account;
2462
2463     # Use cases
2464     if ( $accountline->amount > $accountline->amountoutstanding ) {
2465         # some amount has been cancelled. collect the offsets that are not writeoffs
2466         # this works because the only way to subtract from this kind of a debt is
2467         # using the UI buttons 'Pay' and 'Write off'
2468         my $credits_offsets = Koha::Account::Offsets->search({
2469             debit_id  => $accountline->id,
2470             credit_id => { '!=' => undef }, # it is not the debit itself
2471             type      => { '!=' => 'Writeoff' },
2472             amount    => { '<'  => 0 } # credits are negative on the DB
2473         });
2474
2475         $total_to_refund = ( $credits_offsets->count > 0 )
2476                             ? $credits_offsets->total * -1 # credits are negative on the DB
2477                             : 0;
2478     }
2479
2480     my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2481
2482     if ( $credit_total > 0 ) {
2483         my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2484         $credit = $account->add_credit(
2485             {   amount      => $credit_total,
2486                 description => 'Item Returned ' . $item_id,
2487                 type        => 'LOST_RETURN',
2488                 interface   => C4::Context->interface,
2489                 library_id  => $branchcode
2490             }
2491         );
2492
2493         $credit->apply( { debits => [ $accountline ] } );
2494     }
2495
2496     # Update the account status
2497     $accountline->discard_changes->status('RETURNED');
2498     $accountline->store;
2499
2500     if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2501         $account->reconcile_balance;
2502     }
2503
2504     return ($credit) ? $credit->id : undef;
2505 }
2506
2507 =head2 _GetCircControlBranch
2508
2509    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2510
2511 Internal function :
2512
2513 Return the library code to be used to determine which circulation
2514 policy applies to a transaction.  Looks up the CircControl and
2515 HomeOrHoldingBranch system preferences.
2516
2517 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2518
2519 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2520
2521 =cut
2522
2523 sub _GetCircControlBranch {
2524     my ($item, $borrower) = @_;
2525     my $circcontrol = C4::Context->preference('CircControl');
2526     my $branch;
2527
2528     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2529         $branch= C4::Context->userenv->{'branch'};
2530     } elsif ($circcontrol eq 'PatronLibrary') {
2531         $branch=$borrower->{branchcode};
2532     } else {
2533         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2534         $branch = $item->{$branchfield};
2535         # default to item home branch if holdingbranch is used
2536         # and is not defined
2537         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2538             $branch = $item->{homebranch};
2539         }
2540     }
2541     return $branch;
2542 }
2543
2544 =head2 GetOpenIssue
2545
2546   $issue = GetOpenIssue( $itemnumber );
2547
2548 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2549
2550 C<$itemnumber> is the item's itemnumber
2551
2552 Returns a hashref
2553
2554 =cut
2555
2556 sub GetOpenIssue {
2557   my ( $itemnumber ) = @_;
2558   return unless $itemnumber;
2559   my $dbh = C4::Context->dbh;
2560   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2561   $sth->execute( $itemnumber );
2562   return $sth->fetchrow_hashref();
2563
2564 }
2565
2566 =head2 GetBiblioIssues
2567
2568   $issues = GetBiblioIssues($biblionumber);
2569
2570 this function get all issues from a biblionumber.
2571
2572 Return:
2573 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2574 tables issues and the firstname,surname & cardnumber from borrowers.
2575
2576 =cut
2577
2578 sub GetBiblioIssues {
2579     my $biblionumber = shift;
2580     return unless $biblionumber;
2581     my $dbh   = C4::Context->dbh;
2582     my $query = "
2583         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2584         FROM issues
2585             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2586             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2587             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2588             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2589         WHERE biblio.biblionumber = ?
2590         UNION ALL
2591         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2592         FROM old_issues
2593             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2594             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2595             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2596             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2597         WHERE biblio.biblionumber = ?
2598         ORDER BY timestamp
2599     ";
2600     my $sth = $dbh->prepare($query);
2601     $sth->execute($biblionumber, $biblionumber);
2602
2603     my @issues;
2604     while ( my $data = $sth->fetchrow_hashref ) {
2605         push @issues, $data;
2606     }
2607     return \@issues;
2608 }
2609
2610 =head2 GetUpcomingDueIssues
2611
2612   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2613
2614 =cut
2615
2616 sub GetUpcomingDueIssues {
2617     my $params = shift;
2618
2619     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2620     my $dbh = C4::Context->dbh;
2621
2622     my $statement = <<END_SQL;
2623 SELECT *
2624 FROM (
2625     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2626     FROM issues
2627     LEFT JOIN items USING (itemnumber)
2628     LEFT OUTER JOIN branches USING (branchcode)
2629     WHERE returndate is NULL
2630 ) tmp
2631 WHERE days_until_due >= 0 AND days_until_due <= ?
2632 END_SQL
2633
2634     my @bind_parameters = ( $params->{'days_in_advance'} );
2635
2636     my $sth = $dbh->prepare( $statement );
2637     $sth->execute( @bind_parameters );
2638     my $upcoming_dues = $sth->fetchall_arrayref({});
2639
2640     return $upcoming_dues;
2641 }
2642
2643 =head2 CanBookBeRenewed
2644
2645   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2646
2647 Find out whether a borrowed item may be renewed.
2648
2649 C<$borrowernumber> is the borrower number of the patron who currently
2650 has the item on loan.
2651
2652 C<$itemnumber> is the number of the item to renew.
2653
2654 C<$override_limit>, if supplied with a true value, causes
2655 the limit on the number of times that the loan can be renewed
2656 (as controlled by the item type) to be ignored. Overriding also allows
2657 to renew sooner than "No renewal before" and to manually renew loans
2658 that are automatically renewed.
2659
2660 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2661 item must currently be on loan to the specified borrower; renewals
2662 must be allowed for the item's type; and the borrower must not have
2663 already renewed the loan. $error will contain the reason the renewal can not proceed
2664
2665 =cut
2666
2667 sub CanBookBeRenewed {
2668     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2669
2670     my $dbh    = C4::Context->dbh;
2671     my $renews = 1;
2672
2673     my $item      = Koha::Items->find($itemnumber)      or return ( 0, 'no_item' );
2674     my $issue = $item->checkout or return ( 0, 'no_checkout' );
2675     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2676     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2677
2678     my $patron = $issue->patron or return;
2679
2680     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2681
2682     # This item can fill one or more unfilled reserve, can those unfilled reserves
2683     # all be filled by other available items?
2684     if ( $resfound
2685         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2686     {
2687         my $schema = Koha::Database->new()->schema();
2688
2689         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2690         if ($item_holds) {
2691             # There is an item level hold on this item, no other item can fill the hold
2692             $resfound = 1;
2693         }
2694         else {
2695
2696             # Get all other items that could possibly fill reserves
2697             my @itemnumbers = $schema->resultset('Item')->search(
2698                 {
2699                     biblionumber => $resrec->{biblionumber},
2700                     onloan       => undef,
2701                     notforloan   => 0,
2702                     -not         => { itemnumber => $itemnumber }
2703                 },
2704                 { columns => 'itemnumber' }
2705             )->get_column('itemnumber')->all();
2706
2707             # Get all other reserves that could have been filled by this item
2708             my @borrowernumbers;
2709             while (1) {
2710                 my ( $reserve_found, $reserve, undef ) =
2711                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2712
2713                 if ($reserve_found) {
2714                     push( @borrowernumbers, $reserve->{borrowernumber} );
2715                 }
2716                 else {
2717                     last;
2718                 }
2719             }
2720
2721             # If the count of the union of the lists of reservable items for each borrower
2722             # is equal or greater than the number of borrowers, we know that all reserves
2723             # can be filled with available items. We can get the union of the sets simply
2724             # by pushing all the elements onto an array and removing the duplicates.
2725             my @reservable;
2726             my %patrons;
2727             ITEM: foreach my $itemnumber (@itemnumbers) {
2728                 my $item = Koha::Items->find( $itemnumber );
2729                 next if IsItemOnHoldAndFound( $itemnumber );
2730                 for my $borrowernumber (@borrowernumbers) {
2731                     my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2732                     next unless IsAvailableForItemLevelRequest($item, $patron);
2733                     next unless CanItemBeReserved($borrowernumber,$itemnumber);
2734
2735                     push @reservable, $itemnumber;
2736                     if (@reservable >= @borrowernumbers) {
2737                         $resfound = 0;
2738                         last ITEM;
2739                     }
2740                     last;
2741                 }
2742             }
2743         }
2744     }
2745     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2746
2747     return ( 1, undef ) if $override_limit;
2748
2749     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2750     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2751         {   categorycode => $patron->categorycode,
2752             itemtype     => $item->effective_itemtype,
2753             branchcode   => $branchcode
2754         }
2755     );
2756
2757     return ( 0, "too_many" )
2758       if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2759
2760     my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2761     my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2762     $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2763     my $restricted  = $patron->is_debarred;
2764     my $hasoverdues = $patron->has_overdues;
2765
2766     if ( $restricted and $restrictionblockrenewing ) {
2767         return ( 0, 'restriction');
2768     } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2769         return ( 0, 'overdue');
2770     }
2771
2772     if ( $issue->auto_renew ) {
2773
2774         if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2775             return ( 0, 'auto_account_expired' );
2776         }
2777
2778         if ( defined $issuing_rule->no_auto_renewal_after
2779                 and $issuing_rule->no_auto_renewal_after ne "" ) {
2780             # Get issue_date and add no_auto_renewal_after
2781             # If this is greater than today, it's too late for renewal.
2782             my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2783             $maximum_renewal_date->add(
2784                 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2785             );
2786             my $now = dt_from_string;
2787             if ( $now >= $maximum_renewal_date ) {
2788                 return ( 0, "auto_too_late" );
2789             }
2790         }
2791         if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2792                       and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2793             # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2794             if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2795                 return ( 0, "auto_too_late" );
2796             }
2797         }
2798
2799         if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2800             my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2801             my $amountoutstanding =
2802               C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2803               ? $patron->account->balance
2804               : $patron->account->outstanding_debits->total_outstanding;
2805             if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2806                 return ( 0, "auto_too_much_oweing" );
2807             }
2808         }
2809     }
2810
2811     if ( defined $issuing_rule->norenewalbefore
2812         and $issuing_rule->norenewalbefore ne "" )
2813     {
2814
2815         # Calculate soonest renewal by subtracting 'No renewal before' from due date
2816         my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2817             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2818
2819         # Depending on syspref reset the exact time, only check the date
2820         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2821             and $issuing_rule->lengthunit eq 'days' )
2822         {
2823             $soonestrenewal->truncate( to => 'day' );
2824         }
2825
2826         if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2827         {
2828             return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2829             return ( 0, "too_soon" );
2830         }
2831         elsif ( $issue->auto_renew ) {
2832             return ( 0, "auto_renew" );
2833         }
2834     }
2835
2836     # Fallback for automatic renewals:
2837     # If norenewalbefore is undef, don't renew before due date.
2838     if ( $issue->auto_renew ) {
2839         my $now = dt_from_string;
2840         return ( 0, "auto_renew" )
2841           if $now >= dt_from_string( $issue->date_due, 'sql' );
2842         return ( 0, "auto_too_soon" );
2843     }
2844
2845     return ( 1, undef );
2846 }
2847
2848 =head2 AddRenewal
2849
2850   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2851
2852 Renews a loan.
2853
2854 C<$borrowernumber> is the borrower number of the patron who currently
2855 has the item.
2856
2857 C<$itemnumber> is the number of the item to renew.
2858
2859 C<$branch> is the library where the renewal took place (if any).
2860            The library that controls the circ policies for the renewal is retrieved from the issues record.
2861
2862 C<$datedue> can be a DateTime object used to set the due date.
2863
2864 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2865 this parameter is not supplied, lastreneweddate is set to the current date.
2866
2867 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2868 from the book's item type.
2869
2870 =cut
2871
2872 sub AddRenewal {
2873     my $borrowernumber  = shift;
2874     my $itemnumber      = shift or return;
2875     my $branch          = shift;
2876     my $datedue         = shift;
2877     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2878
2879     my $item_object   = Koha::Items->find($itemnumber) or return;
2880     my $biblio = $item_object->biblio;
2881     my $issue  = $item_object->checkout;
2882     my $item_unblessed = $item_object->unblessed;
2883
2884     my $dbh = C4::Context->dbh;
2885
2886     return unless $issue;
2887
2888     $borrowernumber ||= $issue->borrowernumber;
2889
2890     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2891         carp 'Invalid date passed to AddRenewal.';
2892         return;
2893     }
2894
2895     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2896     my $patron_unblessed = $patron->unblessed;
2897
2898     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2899
2900     my $schema = Koha::Database->schema;
2901     $schema->txn_do(sub{
2902
2903         if ( C4::Context->preference('CalculateFinesOnReturn') ) {
2904             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2905         }
2906         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
2907
2908         # If the due date wasn't specified, calculate it by adding the
2909         # book's loan length to today's date or the current due date
2910         # based on the value of the RenewalPeriodBase syspref.
2911         my $itemtype = $item_object->effective_itemtype;
2912         unless ($datedue) {
2913
2914             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2915                                             dt_from_string( $issue->date_due, 'sql' ) :
2916                                             DateTime->now( time_zone => C4::Context->tz());
2917             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2918         }
2919
2920         my $fees = Koha::Charges::Fees->new(
2921             {
2922                 patron    => $patron,
2923                 library   => $circ_library,
2924                 item      => $item_object,
2925                 from_date => dt_from_string( $issue->date_due, 'sql' ),
2926                 to_date   => dt_from_string($datedue),
2927             }
2928         );
2929
2930         # Update the issues record to have the new due date, and a new count
2931         # of how many times it has been renewed.
2932         my $renews = $issue->renewals + 1;
2933         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2934                                 WHERE borrowernumber=?
2935                                 AND itemnumber=?"
2936         );
2937
2938         $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2939
2940         # Update the renewal count on the item, and tell zebra to reindex
2941         $renews = $item_object->renewals + 1;
2942         ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2943
2944         # Charge a new rental fee, if applicable
2945         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2946         if ( $charge > 0 ) {
2947             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
2948         }
2949
2950         # Charge a new accumulate rental fee, if applicable
2951         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2952         if ( $itemtype_object ) {
2953             my $accumulate_charge = $fees->accumulate_rentalcharge();
2954             if ( $accumulate_charge > 0 ) {
2955                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
2956             }
2957             $charge += $accumulate_charge;
2958         }
2959
2960         # Send a renewal slip according to checkout alert preferencei
2961         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2962             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2963             my %conditions        = (
2964                 branchcode   => $branch,
2965                 categorycode => $patron->categorycode,
2966                 item_type    => $itemtype,
2967                 notification => 'CHECKOUT',
2968             );
2969             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2970                 SendCirculationAlert(
2971                     {
2972                         type     => 'RENEWAL',
2973                         item     => $item_unblessed,
2974                         borrower => $patron->unblessed,
2975                         branch   => $branch,
2976                     }
2977                 );
2978             }
2979         }
2980
2981         # Remove any OVERDUES related debarment if the borrower has no overdues
2982         if ( $patron
2983           && $patron->is_debarred
2984           && ! $patron->has_overdues
2985           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2986         ) {
2987             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2988         }
2989
2990         unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2991             $branch = C4::Context->userenv ? C4::Context->userenv->{branch} : $branch;
2992         }
2993
2994         # Add the renewal to stats
2995         UpdateStats(
2996             {
2997                 branch         => $branch,
2998                 type           => 'renew',
2999                 amount         => $charge,
3000                 itemnumber     => $itemnumber,
3001                 itemtype       => $itemtype,
3002                 location       => $item_object->location,
3003                 borrowernumber => $borrowernumber,
3004                 ccode          => $item_object->ccode,
3005             }
3006         );
3007
3008         #Log the renewal
3009         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3010     });
3011
3012     return $datedue;
3013 }
3014
3015 sub GetRenewCount {
3016     # check renewal status
3017     my ( $bornum, $itemno ) = @_;
3018     my $dbh           = C4::Context->dbh;
3019     my $renewcount    = 0;
3020     my $renewsallowed = 0;
3021     my $renewsleft    = 0;
3022
3023     my $patron = Koha::Patrons->find( $bornum );
3024     my $item   = Koha::Items->find($itemno);
3025
3026     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3027
3028     # Look in the issues table for this item, lent to this borrower,
3029     # and not yet returned.
3030
3031     # FIXME - I think this function could be redone to use only one SQL call.
3032     my $sth = $dbh->prepare(
3033         "select * from issues
3034                                 where (borrowernumber = ?)
3035                                 and (itemnumber = ?)"
3036     );
3037     $sth->execute( $bornum, $itemno );
3038     my $data = $sth->fetchrow_hashref;
3039     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3040     # $item and $borrower should be calculated
3041     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3042
3043     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3044         {   categorycode => $patron->categorycode,
3045             itemtype     => $item->effective_itemtype,
3046             branchcode   => $branchcode
3047         }
3048     );
3049
3050     $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3051     $renewsleft    = $renewsallowed - $renewcount;
3052     if($renewsleft < 0){ $renewsleft = 0; }
3053     return ( $renewcount, $renewsallowed, $renewsleft );
3054 }
3055
3056 =head2 GetSoonestRenewDate
3057
3058   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3059
3060 Find out the soonest possible renew date of a borrowed item.
3061
3062 C<$borrowernumber> is the borrower number of the patron who currently
3063 has the item on loan.
3064
3065 C<$itemnumber> is the number of the item to renew.
3066
3067 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3068 renew date, based on the value "No renewal before" of the applicable
3069 issuing rule. Returns the current date if the item can already be
3070 renewed, and returns undefined if the borrower, loan, or item
3071 cannot be found.
3072
3073 =cut
3074
3075 sub GetSoonestRenewDate {
3076     my ( $borrowernumber, $itemnumber ) = @_;
3077
3078     my $dbh = C4::Context->dbh;
3079
3080     my $item      = Koha::Items->find($itemnumber)      or return;
3081     my $itemissue = $item->checkout or return;
3082
3083     $borrowernumber ||= $itemissue->borrowernumber;
3084     my $patron = Koha::Patrons->find( $borrowernumber )
3085       or return;
3086
3087     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3088     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3089         {   categorycode => $patron->categorycode,
3090             itemtype     => $item->effective_itemtype,
3091             branchcode   => $branchcode
3092         }
3093     );
3094
3095     my $now = dt_from_string;
3096     return $now unless $issuing_rule;
3097
3098     if ( defined $issuing_rule->norenewalbefore
3099         and $issuing_rule->norenewalbefore ne "" )
3100     {
3101         my $soonestrenewal =
3102           dt_from_string( $itemissue->date_due )->subtract(
3103             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3104
3105         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3106             and $issuing_rule->lengthunit eq 'days' )
3107         {
3108             $soonestrenewal->truncate( to => 'day' );
3109         }
3110         return $soonestrenewal if $now < $soonestrenewal;
3111     }
3112     return $now;
3113 }
3114
3115 =head2 GetLatestAutoRenewDate
3116
3117   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3118
3119 Find out the latest possible auto renew date of a borrowed item.
3120
3121 C<$borrowernumber> is the borrower number of the patron who currently
3122 has the item on loan.
3123
3124 C<$itemnumber> is the number of the item to renew.
3125
3126 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3127 auto renew date, based on the value "No auto renewal after" and the "No auto
3128 renewal after (hard limit) of the applicable issuing rule.
3129 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3130 or item cannot be found.
3131
3132 =cut
3133
3134 sub GetLatestAutoRenewDate {
3135     my ( $borrowernumber, $itemnumber ) = @_;
3136
3137     my $dbh = C4::Context->dbh;
3138
3139     my $item      = Koha::Items->find($itemnumber)  or return;
3140     my $itemissue = $item->checkout                 or return;
3141
3142     $borrowernumber ||= $itemissue->borrowernumber;
3143     my $patron = Koha::Patrons->find( $borrowernumber )
3144       or return;
3145
3146     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3147     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3148         {   categorycode => $patron->categorycode,
3149             itemtype     => $item->effective_itemtype,
3150             branchcode   => $branchcode
3151         }
3152     );
3153
3154     return unless $issuing_rule;
3155     return
3156       if ( not $issuing_rule->no_auto_renewal_after
3157             or $issuing_rule->no_auto_renewal_after eq '' )
3158       and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3159              or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3160
3161     my $maximum_renewal_date;
3162     if ( $issuing_rule->no_auto_renewal_after ) {
3163         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3164         $maximum_renewal_date->add(
3165             $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3166         );
3167     }
3168
3169     if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3170         my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3171         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3172     }
3173     return $maximum_renewal_date;
3174 }
3175
3176
3177 =head2 GetIssuingCharges
3178
3179   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3180
3181 Calculate how much it would cost for a given patron to borrow a given
3182 item, including any applicable discounts.
3183
3184 C<$itemnumber> is the item number of item the patron wishes to borrow.
3185
3186 C<$borrowernumber> is the patron's borrower number.
3187
3188 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3189 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3190 if it's a video).
3191
3192 =cut
3193
3194 sub GetIssuingCharges {
3195
3196     # calculate charges due
3197     my ( $itemnumber, $borrowernumber ) = @_;
3198     my $charge = 0;
3199     my $dbh    = C4::Context->dbh;
3200     my $item_type;
3201
3202     # Get the book's item type and rental charge (via its biblioitem).
3203     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3204         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3205     $charge_query .= (C4::Context->preference('item-level_itypes'))
3206         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3207         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3208
3209     $charge_query .= ' WHERE items.itemnumber =?';
3210
3211     my $sth = $dbh->prepare($charge_query);
3212     $sth->execute($itemnumber);
3213     if ( my $item_data = $sth->fetchrow_hashref ) {
3214         $item_type = $item_data->{itemtype};
3215         $charge    = $item_data->{rentalcharge};
3216         my $branch = C4::Context::mybranch();
3217         my $discount_query = q|SELECT rentaldiscount,
3218             issuingrules.itemtype, issuingrules.branchcode
3219             FROM borrowers
3220             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3221             WHERE borrowers.borrowernumber = ?
3222             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3223             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3224         my $discount_sth = $dbh->prepare($discount_query);
3225         $discount_sth->execute( $borrowernumber, $item_type, $branch );
3226         my $discount_rules = $discount_sth->fetchall_arrayref({});
3227         if (@{$discount_rules}) {
3228             # We may have multiple rules so get the most specific
3229             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3230             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3231         }
3232         if ($charge) {
3233             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3234         }
3235     }
3236
3237     return ( $charge, $item_type );
3238 }
3239
3240 # Select most appropriate discount rule from those returned
3241 sub _get_discount_from_rule {
3242     my ($rules_ref, $branch, $itemtype) = @_;
3243     my $discount;
3244
3245     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3246         $discount = $rules_ref->[0]->{rentaldiscount};
3247         return (defined $discount) ? $discount : 0;
3248     }
3249     # could have up to 4 does one match $branch and $itemtype
3250     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3251     if (@d) {
3252         $discount = $d[0]->{rentaldiscount};
3253         return (defined $discount) ? $discount : 0;
3254     }
3255     # do we have item type + all branches
3256     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3257     if (@d) {
3258         $discount = $d[0]->{rentaldiscount};
3259         return (defined $discount) ? $discount : 0;
3260     }
3261     # do we all item types + this branch
3262     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3263     if (@d) {
3264         $discount = $d[0]->{rentaldiscount};
3265         return (defined $discount) ? $discount : 0;
3266     }
3267     # so all and all (surely we wont get here)
3268     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3269     if (@d) {
3270         $discount = $d[0]->{rentaldiscount};
3271         return (defined $discount) ? $discount : 0;
3272     }
3273     # none of the above
3274     return 0;
3275 }
3276
3277 =head2 AddIssuingCharge
3278
3279   &AddIssuingCharge( $checkout, $charge, $type )
3280
3281 =cut
3282
3283 sub AddIssuingCharge {
3284     my ( $checkout, $charge, $type ) = @_;
3285
3286     # FIXME What if checkout does not exist?
3287
3288     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3289     my $accountline = $account->add_debit(
3290         {
3291             amount      => $charge,
3292             note        => undef,
3293             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3294             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3295             interface   => C4::Context->interface,
3296             type        => $type,
3297             item_id     => $checkout->itemnumber,
3298             issue_id    => $checkout->issue_id,
3299         }
3300     );
3301 }
3302
3303 =head2 GetTransfers
3304
3305   GetTransfers($itemnumber);
3306
3307 =cut
3308
3309 sub GetTransfers {
3310     my ($itemnumber) = @_;
3311
3312     my $dbh = C4::Context->dbh;
3313
3314     my $query = '
3315         SELECT datesent,
3316                frombranch,
3317                tobranch,
3318                branchtransfer_id
3319         FROM branchtransfers
3320         WHERE itemnumber = ?
3321           AND datearrived IS NULL
3322         ';
3323     my $sth = $dbh->prepare($query);
3324     $sth->execute($itemnumber);
3325     my @row = $sth->fetchrow_array();
3326     return @row;
3327 }
3328
3329 =head2 GetTransfersFromTo
3330
3331   @results = GetTransfersFromTo($frombranch,$tobranch);
3332
3333 Returns the list of pending transfers between $from and $to branch
3334
3335 =cut
3336
3337 sub GetTransfersFromTo {
3338     my ( $frombranch, $tobranch ) = @_;
3339     return unless ( $frombranch && $tobranch );
3340     my $dbh   = C4::Context->dbh;
3341     my $query = "
3342         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3343         FROM   branchtransfers
3344         WHERE  frombranch=?
3345           AND  tobranch=?
3346           AND datearrived IS NULL
3347     ";
3348     my $sth = $dbh->prepare($query);
3349     $sth->execute( $frombranch, $tobranch );
3350     my @gettransfers;
3351
3352     while ( my $data = $sth->fetchrow_hashref ) {
3353         push @gettransfers, $data;
3354     }
3355     return (@gettransfers);
3356 }
3357
3358 =head2 DeleteTransfer
3359
3360   &DeleteTransfer($itemnumber);
3361
3362 =cut
3363
3364 sub DeleteTransfer {
3365     my ($itemnumber) = @_;
3366     return unless $itemnumber;
3367     my $dbh          = C4::Context->dbh;
3368     my $sth          = $dbh->prepare(
3369         "DELETE FROM branchtransfers
3370          WHERE itemnumber=?
3371          AND datearrived IS NULL "
3372     );
3373     return $sth->execute($itemnumber);
3374 }
3375
3376 =head2 SendCirculationAlert
3377
3378 Send out a C<check-in> or C<checkout> alert using the messaging system.
3379
3380 B<Parameters>:
3381
3382 =over 4
3383
3384 =item type
3385
3386 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3387
3388 =item item
3389
3390 Hashref of information about the item being checked in or out.
3391
3392 =item borrower
3393
3394 Hashref of information about the borrower of the item.
3395
3396 =item branch
3397
3398 The branchcode from where the checkout or check-in took place.
3399
3400 =back
3401
3402 B<Example>:
3403
3404     SendCirculationAlert({
3405         type     => 'CHECKOUT',
3406         item     => $item,
3407         borrower => $borrower,
3408         branch   => $branch,
3409     });
3410
3411 =cut
3412
3413 sub SendCirculationAlert {
3414     my ($opts) = @_;
3415     my ($type, $item, $borrower, $branch) =
3416         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3417     my %message_name = (
3418         CHECKIN  => 'Item_Check_in',
3419         CHECKOUT => 'Item_Checkout',
3420         RENEWAL  => 'Item_Checkout',
3421     );
3422     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3423         borrowernumber => $borrower->{borrowernumber},
3424         message_name   => $message_name{$type},
3425     });
3426     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3427
3428     my $schema = Koha::Database->new->schema;
3429     my @transports = keys %{ $borrower_preferences->{transports} };
3430
3431     # From the MySQL doc:
3432     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3433     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3434     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3435     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3436
3437     for my $mtt (@transports) {
3438         my $letter =  C4::Letters::GetPreparedLetter (
3439             module => 'circulation',
3440             letter_code => $type,
3441             branchcode => $branch,
3442             message_transport_type => $mtt,
3443             lang => $borrower->{lang},
3444             tables => {
3445                 $issues_table => $item->{itemnumber},
3446                 'items'       => $item->{itemnumber},
3447                 'biblio'      => $item->{biblionumber},
3448                 'biblioitems' => $item->{biblionumber},
3449                 'borrowers'   => $borrower,
3450                 'branches'    => $branch,
3451             }
3452         ) or next;
3453
3454         $schema->storage->txn_begin;
3455         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3456         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3457         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3458         unless ( $message ) {
3459             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3460             C4::Message->enqueue($letter, $borrower, $mtt);
3461         } else {
3462             $message->append($letter);
3463             $message->update;
3464         }
3465         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3466         $schema->storage->txn_commit;
3467     }
3468
3469     return;
3470 }
3471
3472 =head2 updateWrongTransfer
3473
3474   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3475
3476 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
3477
3478 =cut
3479
3480 sub updateWrongTransfer {
3481         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3482         my $dbh = C4::Context->dbh;
3483 # first step validate the actual line of transfert .
3484         my $sth =
3485                 $dbh->prepare(
3486                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3487                 );
3488                 $sth->execute($FromLibrary,$itemNumber);
3489
3490 # second step create a new line of branchtransfer to the right location .
3491         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3492
3493 #third step changing holdingbranch of item
3494         UpdateHoldingbranch($FromLibrary,$itemNumber);
3495 }
3496
3497 =head2 UpdateHoldingbranch
3498
3499   $items = UpdateHoldingbranch($branch,$itmenumber);
3500
3501 Simple methode for updating hodlingbranch in items BDD line
3502
3503 =cut
3504
3505 sub UpdateHoldingbranch {
3506         my ( $branch,$itemnumber ) = @_;
3507     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3508 }
3509
3510 =head2 CalcDateDue
3511
3512 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3513
3514 this function calculates the due date given the start date and configured circulation rules,
3515 checking against the holidays calendar as per the 'useDaysMode' syspref.
3516 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3517 C<$itemtype>  = itemtype code of item in question
3518 C<$branch>  = location whose calendar to use
3519 C<$borrower> = Borrower object
3520 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3521
3522 =cut
3523
3524 sub CalcDateDue {
3525     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3526
3527     $isrenewal ||= 0;
3528
3529     # loanlength now a href
3530     my $loanlength =
3531             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3532
3533     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3534             ? qq{renewalperiod}
3535             : qq{issuelength};
3536
3537     my $datedue;
3538     if ( $startdate ) {
3539         if (ref $startdate ne 'DateTime' ) {
3540             $datedue = dt_from_string($datedue);
3541         } else {
3542             $datedue = $startdate->clone;
3543         }
3544     } else {
3545         $datedue =
3546           DateTime->now( time_zone => C4::Context->tz() )
3547           ->truncate( to => 'minute' );
3548     }
3549
3550
3551     # calculate the datedue as normal
3552     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3553     {    # ignoring calendar
3554         if ( $loanlength->{lengthunit} eq 'hours' ) {
3555             $datedue->add( hours => $loanlength->{$length_key} );
3556         } else {    # days
3557             $datedue->add( days => $loanlength->{$length_key} );
3558             $datedue->set_hour(23);
3559             $datedue->set_minute(59);
3560         }
3561     } else {
3562         my $dur;
3563         if ($loanlength->{lengthunit} eq 'hours') {
3564             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3565         }
3566         else { # days
3567             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3568         }
3569         my $calendar = Koha::Calendar->new( branchcode => $branch );
3570         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3571         if ($loanlength->{lengthunit} eq 'days') {
3572             $datedue->set_hour(23);
3573             $datedue->set_minute(59);
3574         }
3575     }
3576
3577     # if Hard Due Dates are used, retrieve them and apply as necessary
3578     my ( $hardduedate, $hardduedatecompare ) =
3579       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3580     if ($hardduedate) {    # hardduedates are currently dates
3581         $hardduedate->truncate( to => 'minute' );
3582         $hardduedate->set_hour(23);
3583         $hardduedate->set_minute(59);
3584         my $cmp = DateTime->compare( $hardduedate, $datedue );
3585
3586 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3587 # if the calculated date is before the 'after' Hard Due Date (floor), override
3588 # if the hard due date is set to 'exactly', overrride
3589         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3590             $datedue = $hardduedate->clone;
3591         }
3592
3593         # in all other cases, keep the date due as it is
3594
3595     }
3596
3597     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3598     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3599         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3600         if( $expiry_dt ) { #skip empty expiry date..
3601             $expiry_dt->set( hour => 23, minute => 59);
3602             my $d1= $datedue->clone->set_time_zone('floating');
3603             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3604                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3605             }
3606         }
3607         if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3608           my $calendar = Koha::Calendar->new( branchcode => $branch );
3609           if ( $calendar->is_holiday($datedue) ) {
3610               # Don't return on a closed day
3611               $datedue = $calendar->prev_open_days( $datedue, 1 );
3612           }
3613         }
3614     }
3615
3616     return $datedue;
3617 }
3618
3619
3620 sub CheckValidBarcode{
3621 my ($barcode) = @_;
3622 my $dbh = C4::Context->dbh;
3623 my $query=qq|SELECT count(*)
3624              FROM items
3625              WHERE barcode=?
3626             |;
3627 my $sth = $dbh->prepare($query);
3628 $sth->execute($barcode);
3629 my $exist=$sth->fetchrow ;
3630 return $exist;
3631 }
3632
3633 =head2 IsBranchTransferAllowed
3634
3635   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3636
3637 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3638
3639 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3640 Koha::Item->can_be_transferred.
3641
3642 =cut
3643
3644 sub IsBranchTransferAllowed {
3645         my ( $toBranch, $fromBranch, $code ) = @_;
3646
3647         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3648
3649         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3650         my $dbh = C4::Context->dbh;
3651
3652         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3653         $sth->execute( $toBranch, $fromBranch, $code );
3654         my $limit = $sth->fetchrow_hashref();
3655
3656         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3657         if ( $limit->{'limitId'} ) {
3658                 return 0;
3659         } else {
3660                 return 1;
3661         }
3662 }
3663
3664 =head2 CreateBranchTransferLimit
3665
3666   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3667
3668 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3669
3670 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3671
3672 =cut
3673
3674 sub CreateBranchTransferLimit {
3675    my ( $toBranch, $fromBranch, $code ) = @_;
3676    return unless defined($toBranch) && defined($fromBranch);
3677    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3678
3679    my $dbh = C4::Context->dbh;
3680
3681    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3682    return $sth->execute( $code, $toBranch, $fromBranch );
3683 }
3684
3685 =head2 DeleteBranchTransferLimits
3686
3687     my $result = DeleteBranchTransferLimits($frombranch);
3688
3689 Deletes all the library transfer limits for one library.  Returns the
3690 number of limits deleted, 0e0 if no limits were deleted, or undef if
3691 no arguments are supplied.
3692
3693 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3694     fromBranch => $fromBranch
3695     })->delete.
3696
3697 =cut
3698
3699 sub DeleteBranchTransferLimits {
3700     my $branch = shift;
3701     return unless defined $branch;
3702     my $dbh    = C4::Context->dbh;
3703     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3704     return $sth->execute($branch);
3705 }
3706
3707 sub ReturnLostItem{
3708     my ( $borrowernumber, $itemnum ) = @_;
3709     MarkIssueReturned( $borrowernumber, $itemnum );
3710 }
3711
3712
3713 sub LostItem{
3714     my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3715
3716     unless ( $mark_lost_from ) {
3717         # Temporary check to avoid regressions
3718         die q|LostItem called without $mark_lost_from, check the API.|;
3719     }
3720
3721     my $mark_returned;
3722     if ( $force_mark_returned ) {
3723         $mark_returned = 1;
3724     } else {
3725         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3726         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3727     }
3728
3729     my $dbh = C4::Context->dbh();
3730     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3731                            FROM issues
3732                            JOIN items USING (itemnumber)
3733                            JOIN biblio USING (biblionumber)
3734                            WHERE issues.itemnumber=?");
3735     $sth->execute($itemnumber);
3736     my $issues=$sth->fetchrow_hashref();
3737
3738     # If a borrower lost the item, add a replacement cost to the their record
3739     if ( my $borrowernumber = $issues->{borrowernumber} ){
3740         my $patron = Koha::Patrons->find( $borrowernumber );
3741
3742         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3743         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3744
3745         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3746             C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "$issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3747             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3748             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3749         }
3750
3751         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3752     }
3753
3754     #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3755     if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3756         ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3757     }
3758     my $transferdeleted = DeleteTransfer($itemnumber);
3759 }
3760
3761 sub GetOfflineOperations {
3762     my $dbh = C4::Context->dbh;
3763     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3764     $sth->execute(C4::Context->userenv->{'branch'});
3765     my $results = $sth->fetchall_arrayref({});
3766     return $results;
3767 }
3768
3769 sub GetOfflineOperation {
3770     my $operationid = shift;
3771     return unless $operationid;
3772     my $dbh = C4::Context->dbh;
3773     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3774     $sth->execute( $operationid );
3775     return $sth->fetchrow_hashref;
3776 }
3777
3778 sub AddOfflineOperation {
3779     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3780     my $dbh = C4::Context->dbh;
3781     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3782     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3783     return "Added.";
3784 }
3785
3786 sub DeleteOfflineOperation {
3787     my $dbh = C4::Context->dbh;
3788     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3789     $sth->execute( shift );
3790     return "Deleted.";
3791 }
3792
3793 sub ProcessOfflineOperation {
3794     my $operation = shift;
3795
3796     my $report;
3797     if ( $operation->{action} eq 'return' ) {
3798         $report = ProcessOfflineReturn( $operation );
3799     } elsif ( $operation->{action} eq 'issue' ) {
3800         $report = ProcessOfflineIssue( $operation );
3801     } elsif ( $operation->{action} eq 'payment' ) {
3802         $report = ProcessOfflinePayment( $operation );
3803     }
3804
3805     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3806
3807     return $report;
3808 }
3809
3810 sub ProcessOfflineReturn {
3811     my $operation = shift;
3812
3813     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3814
3815     if ( $item ) {
3816         my $itemnumber = $item->itemnumber;
3817         my $issue = GetOpenIssue( $itemnumber );
3818         if ( $issue ) {
3819             MarkIssueReturned(
3820                 $issue->{borrowernumber},
3821                 $itemnumber,
3822                 $operation->{timestamp},
3823             );
3824             ModItem(
3825                 { renewals => 0, onloan => undef },
3826                 $issue->{'biblionumber'},
3827                 $itemnumber,
3828                 { log_action => 0 }
3829             );
3830             return "Success.";
3831         } else {
3832             return "Item not issued.";
3833         }
3834     } else {
3835         return "Item not found.";
3836     }
3837 }
3838
3839 sub ProcessOfflineIssue {
3840     my $operation = shift;
3841
3842     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3843
3844     if ( $patron ) {
3845         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3846         unless ($item) {
3847             return "Barcode not found.";
3848         }
3849         my $itemnumber = $item->itemnumber;
3850         my $issue = GetOpenIssue( $itemnumber );
3851
3852         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3853             MarkIssueReturned(
3854                 $issue->{borrowernumber},
3855                 $itemnumber,
3856                 $operation->{timestamp},
3857             );
3858         }
3859         AddIssue(
3860             $patron->unblessed,
3861             $operation->{'barcode'},
3862             undef,
3863             1,
3864             $operation->{timestamp},
3865             undef,
3866         );
3867         return "Success.";
3868     } else {
3869         return "Borrower not found.";
3870     }
3871 }
3872
3873 sub ProcessOfflinePayment {
3874     my $operation = shift;
3875
3876     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3877
3878     $patron->account->pay(
3879         {
3880             amount     => $operation->{amount},
3881             library_id => $operation->{branchcode},
3882             interface  => 'koc'
3883         }
3884     );
3885
3886     return "Success.";
3887 }
3888
3889 =head2 TransferSlip
3890
3891   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3892
3893   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3894
3895 =cut
3896
3897 sub TransferSlip {
3898     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3899
3900     my $item =
3901       $itemnumber
3902       ? Koha::Items->find($itemnumber)
3903       : Koha::Items->find( { barcode => $barcode } );
3904
3905     $item or return;
3906
3907     return C4::Letters::GetPreparedLetter (
3908         module => 'circulation',
3909         letter_code => 'TRANSFERSLIP',
3910         branchcode => $branch,
3911         tables => {
3912             'branches'    => $to_branch,
3913             'biblio'      => $item->biblionumber,
3914             'items'       => $item->unblessed,
3915         },
3916     );
3917 }
3918
3919 =head2 CheckIfIssuedToPatron
3920
3921   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3922
3923   Return 1 if any record item is issued to patron, otherwise return 0
3924
3925 =cut
3926
3927 sub CheckIfIssuedToPatron {
3928     my ($borrowernumber, $biblionumber) = @_;
3929
3930     my $dbh = C4::Context->dbh;
3931     my $query = q|
3932         SELECT COUNT(*) FROM issues
3933         LEFT JOIN items ON items.itemnumber = issues.itemnumber
3934         WHERE items.biblionumber = ?
3935         AND issues.borrowernumber = ?
3936     |;
3937     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3938     return 1 if $is_issued;
3939     return;
3940 }
3941
3942 =head2 IsItemIssued
3943
3944   IsItemIssued( $itemnumber )
3945
3946   Return 1 if the item is on loan, otherwise return 0
3947
3948 =cut
3949
3950 sub IsItemIssued {
3951     my $itemnumber = shift;
3952     my $dbh = C4::Context->dbh;
3953     my $sth = $dbh->prepare(q{
3954         SELECT COUNT(*)
3955         FROM issues
3956         WHERE itemnumber = ?
3957     });
3958     $sth->execute($itemnumber);
3959     return $sth->fetchrow;
3960 }
3961
3962 =head2 GetAgeRestriction
3963
3964   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3965   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3966
3967   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3968   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3969
3970 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3971 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3972 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3973          Negative days mean the borrower has gone past the age restriction age.
3974
3975 =cut
3976
3977 sub GetAgeRestriction {
3978     my ($record_restrictions, $borrower) = @_;
3979     my $markers = C4::Context->preference('AgeRestrictionMarker');
3980
3981     # Split $record_restrictions to something like FSK 16 or PEGI 6
3982     my @values = split ' ', uc($record_restrictions);
3983     return unless @values;
3984
3985     # Search first occurrence of one of the markers
3986     my @markers = split /\|/, uc($markers);
3987     return unless @markers;
3988
3989     my $index            = 0;
3990     my $restriction_year = 0;
3991     for my $value (@values) {
3992         $index++;
3993         for my $marker (@markers) {
3994             $marker =~ s/^\s+//;    #remove leading spaces
3995             $marker =~ s/\s+$//;    #remove trailing spaces
3996             if ( $marker eq $value ) {
3997                 if ( $index <= $#values ) {
3998                     $restriction_year += $values[$index];
3999                 }
4000                 last;
4001             }
4002             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4003
4004                 # Perhaps it is something like "K16" (as in Finland)
4005                 $restriction_year += $1;
4006                 last;
4007             }
4008         }
4009         last if ( $restriction_year > 0 );
4010     }
4011
4012     #Check if the borrower is age restricted for this material and for how long.
4013     if ($restriction_year && $borrower) {
4014         if ( $borrower->{'dateofbirth'} ) {
4015             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4016             $alloweddate[0] += $restriction_year;
4017
4018             #Prevent runime eror on leap year (invalid date)
4019             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4020                 $alloweddate[2] = 28;
4021             }
4022
4023             #Get how many days the borrower has to reach the age restriction
4024             my @Today = split /-/, DateTime->today->ymd();
4025             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4026             #Negative days means the borrower went past the age restriction age
4027             return ($restriction_year, $daysToAgeRestriction);
4028         }
4029     }
4030
4031     return ($restriction_year);
4032 }
4033
4034
4035 =head2 GetPendingOnSiteCheckouts
4036
4037 =cut
4038
4039 sub GetPendingOnSiteCheckouts {
4040     my $dbh = C4::Context->dbh;
4041     return $dbh->selectall_arrayref(q|
4042         SELECT
4043           items.barcode,
4044           items.biblionumber,
4045           items.itemnumber,
4046           items.itemnotes,
4047           items.itemcallnumber,
4048           items.location,
4049           issues.date_due,
4050           issues.branchcode,
4051           issues.date_due < NOW() AS is_overdue,
4052           biblio.author,
4053           biblio.title,
4054           borrowers.firstname,
4055           borrowers.surname,
4056           borrowers.cardnumber,
4057           borrowers.borrowernumber
4058         FROM items
4059         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4060         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4061         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4062         WHERE issues.onsite_checkout = 1
4063     |, { Slice => {} } );
4064 }
4065
4066 sub GetTopIssues {
4067     my ($params) = @_;
4068
4069     my ($count, $branch, $itemtype, $ccode, $newness)
4070         = @$params{qw(count branch itemtype ccode newness)};
4071
4072     my $dbh = C4::Context->dbh;
4073     my $query = q{
4074         SELECT * FROM (
4075         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4076           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4077           i.ccode, SUM(i.issues) AS count
4078         FROM biblio b
4079         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4080         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4081     };
4082
4083     my (@where_strs, @where_args);
4084
4085     if ($branch) {
4086         push @where_strs, 'i.homebranch = ?';
4087         push @where_args, $branch;
4088     }
4089     if ($itemtype) {
4090         if (C4::Context->preference('item-level_itypes')){
4091             push @where_strs, 'i.itype = ?';
4092             push @where_args, $itemtype;
4093         } else {
4094             push @where_strs, 'bi.itemtype = ?';
4095             push @where_args, $itemtype;
4096         }
4097     }
4098     if ($ccode) {
4099         push @where_strs, 'i.ccode = ?';
4100         push @where_args, $ccode;
4101     }
4102     if ($newness) {
4103         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4104         push @where_args, $newness;
4105     }
4106
4107     if (@where_strs) {
4108         $query .= 'WHERE ' . join(' AND ', @where_strs);
4109     }
4110
4111     $query .= q{
4112         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4113           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4114           i.ccode
4115         ORDER BY count DESC
4116     };
4117
4118     $query .= q{ ) xxx WHERE count > 0 };
4119     $count = int($count);
4120     if ($count > 0) {
4121         $query .= "LIMIT $count";
4122     }
4123
4124     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4125
4126     return @$rows;
4127 }
4128
4129 sub _CalculateAndUpdateFine {
4130     my ($params) = @_;
4131
4132     my $borrower    = $params->{borrower};
4133     my $item        = $params->{item};
4134     my $issue       = $params->{issue};
4135     my $return_date = $params->{return_date};
4136
4137     unless ($borrower) { carp "No borrower passed in!" && return; }
4138     unless ($item)     { carp "No item passed in!"     && return; }
4139     unless ($issue)    { carp "No issue passed in!"    && return; }
4140
4141     my $datedue = dt_from_string( $issue->date_due );
4142
4143     # we only need to calculate and change the fines if we want to do that on return
4144     # Should be on for hourly loans
4145     my $control = C4::Context->preference('CircControl');
4146     my $control_branchcode =
4147         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4148       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4149       :                                     $issue->branchcode;
4150
4151     my $date_returned = $return_date ? $return_date : dt_from_string();
4152
4153     my ( $amount, $unitcounttotal, $unitcount  ) =
4154       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4155
4156     if ( C4::Context->preference('finesMode') eq 'production' ) {
4157         if ( $amount > 0 ) {
4158             C4::Overdues::UpdateFine({
4159                 issue_id       => $issue->issue_id,
4160                 itemnumber     => $issue->itemnumber,
4161                 borrowernumber => $issue->borrowernumber,
4162                 amount         => $amount,
4163                 due            => output_pref($datedue),
4164             });
4165         }
4166         elsif ($return_date) {
4167
4168             # Backdated returns may have fines that shouldn't exist,
4169             # so in this case, we need to drop those fines to 0
4170
4171             C4::Overdues::UpdateFine({
4172                 issue_id       => $issue->issue_id,
4173                 itemnumber     => $issue->itemnumber,
4174                 borrowernumber => $issue->borrowernumber,
4175                 amount         => 0,
4176                 due            => output_pref($datedue),
4177             });
4178         }
4179     }
4180 }
4181
4182 sub _item_denied_renewal {
4183     my ($params) = @_;
4184
4185     my $item = $params->{item};
4186     return unless $item;
4187
4188     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4189     return unless $denyingrules;
4190     foreach my $field (keys %$denyingrules) {
4191         my $val = $item->$field;
4192         if( !defined $val) {
4193             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4194                 return 1;
4195             }
4196         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4197            # If the results matches the values in the syspref
4198            # We return true if match found
4199             return 1;
4200         }
4201     }
4202     return 0;
4203 }
4204
4205
4206 1;
4207
4208 __END__
4209
4210 =head1 AUTHOR
4211
4212 Koha Development Team <http://koha-community.org/>
4213
4214 =cut