C4/Circulation.pm

   1 package C4::Circulation;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 # copyright 2010 BibLibre
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21
  22 use strict;
  23 #use warnings; FIXME - Bug 2505
  24 use DateTime;
  25 use POSIX qw( floor );
  26 use Koha::DateUtils;
  27 use C4::Context;
  28 use C4::Stats;
  29 use C4::Reserves;
  30 use C4::Biblio;
  31 use C4::Items;
  32 use C4::Members;
  33 use C4::Accounts;
  34 use C4::ItemCirculationAlertPreference;
  35 use C4::Message;
  36 use C4::Debug;
  37 use C4::Log; # logaction
  38 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
  39 use C4::RotatingCollections qw(GetCollectionItemBranches);
  40 use Algorithm::CheckDigits;
  41
  42 use Data::Dumper;
  43 use Koha::Account;
  44 use Koha::AuthorisedValues;
  45 use Koha::Biblioitems;
  46 use Koha::DateUtils;
  47 use Koha::Calendar;
  48 use Koha::Checkouts;
  49 use Koha::IssuingRules;
  50 use Koha::Items;
  51 use Koha::Patrons;
  52 use Koha::Patron::Debarments;
  53 use Koha::Database;
  54 use Koha::Libraries;
  55 use Koha::Account::Lines;
  56 use Koha::Holds;
  57 use Koha::RefundLostItemFeeRule;
  58 use Koha::RefundLostItemFeeRules;
  59 use Koha::Account::Lines;
  60 use Koha::Account::Offsets;
  61 use Koha::Config::SysPrefs;
  62 use Koha::Charges::Fees;
  63 use Koha::Util::SystemPreferences;
  64 use Carp;
  65 use List::MoreUtils qw( uniq any );
  66 use Scalar::Util qw( looks_like_number );
  67 use Date::Calc qw(
  68   Today
  69   Today_and_Now
  70   Add_Delta_YM
  71   Add_Delta_DHMS
  72   Date_to_Days
  73   Day_of_Week
  74   Add_Delta_Days
  75 );
  76 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  77
  78 BEGIN {
  79         require Exporter;
  80         @ISA    = qw(Exporter);
  81
  82         # FIXME subs that should probably be elsewhere
  83         push @EXPORT, qw(
  84                 &barcodedecode
  85         &LostItem
  86         &ReturnLostItem
  87         &GetPendingOnSiteCheckouts
  88         );
  89
  90         # subs to deal with issuing a book
  91         push @EXPORT, qw(
  92                 &CanBookBeIssued
  93                 &CanBookBeRenewed
  94                 &AddIssue
  95                 &AddRenewal
  96                 &GetRenewCount
  97         &GetSoonestRenewDate
  98         &GetLatestAutoRenewDate
  99                 &GetIssuingCharges
 100         &GetBranchBorrowerCircRule
 101         &GetBranchItemRule
 102                 &GetBiblioIssues
 103                 &GetOpenIssue
 104         &CheckIfIssuedToPatron
 105         &IsItemIssued
 106         GetTopIssues
 107         );
 108
 109         # subs to deal with returns
 110         push @EXPORT, qw(
 111                 &AddReturn
 112         &MarkIssueReturned
 113         );
 114
 115         # subs to deal with transfers
 116         push @EXPORT, qw(
 117                 &transferbook
 118                 &GetTransfers
 119                 &GetTransfersFromTo
 120                 &updateWrongTransfer
 121                 &DeleteTransfer
 122                 &IsBranchTransferAllowed
 123                 &CreateBranchTransferLimit
 124                 &DeleteBranchTransferLimits
 125         &TransferSlip
 126         );
 127
 128     # subs to deal with offline circulation
 129     push @EXPORT, qw(
 130       &GetOfflineOperations
 131       &GetOfflineOperation
 132       &AddOfflineOperation
 133       &DeleteOfflineOperation
 134       &ProcessOfflineOperation
 135     );
 136 }
 137
 138 =head1 NAME
 139
 140 C4::Circulation - Koha circulation module
 141
 142 =head1 SYNOPSIS
 143
 144 use C4::Circulation;
 145
 146 =head1 DESCRIPTION
 147
 148 The functions in this module deal with circulation, issues, and
 149 returns, as well as general information about the library.
 150 Also deals with inventory.
 151
 152 =head1 FUNCTIONS
 153
 154 =head2 barcodedecode
 155
 156   $str = &barcodedecode($barcode, [$filter]);
 157
 158 Generic filter function for barcode string.
 159 Called on every circ if the System Pref itemBarcodeInputFilter is set.
 160 Will do some manipulation of the barcode for systems that deliver a barcode
 161 to circulation.pl that differs from the barcode stored for the item.
 162 For proper functioning of this filter, calling the function on the
 163 correct barcode string (items.barcode) should return an unaltered barcode.
 164
 165 The optional $filter argument is to allow for testing or explicit
 166 behavior that ignores the System Pref.  Valid values are the same as the
 167 System Pref options.
 168
 169 =cut
 170
 171 # FIXME -- the &decode fcn below should be wrapped into this one.
 172 # FIXME -- these plugins should be moved out of Circulation.pm
 173 #
 174 sub barcodedecode {
 175     my ($barcode, $filter) = @_;
 176     my $branch = C4::Context::mybranch();
 177     $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
 178     $filter or return $barcode;     # ensure filter is defined, else return untouched barcode
 179         if ($filter eq 'whitespace') {
 180                 $barcode =~ s/\s//g;
 181         } elsif ($filter eq 'cuecat') {
 182                 chomp($barcode);
 183             my @fields = split( /\./, $barcode );
 184             my @results = map( decode($_), @fields[ 1 .. $#fields ] );
 185             ($#results == 2) and return $results[2];
 186         } elsif ($filter eq 'T-prefix') {
 187                 if ($barcode =~ /^[Tt](\d)/) {
 188                         (defined($1) and $1 eq '0') and return $barcode;
 189             $barcode = substr($barcode, 2) + 0;     # FIXME: probably should be substr($barcode, 1)
 190                 }
 191         return sprintf("T%07d", $barcode);
 192         # FIXME: $barcode could be "T1", causing warning: substr outside of string
 193         # Why drop the nonzero digit after the T?
 194         # Why pass non-digits (or empty string) to "T%07d"?
 195         } elsif ($filter eq 'libsuite8') {
 196                 unless($barcode =~ m/^($branch)-/i){    #if barcode starts with branch code its in Koha style. Skip it.
 197                         if($barcode =~ m/^(\d)/i){      #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
 198                                 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
 199                         }else{
 200                                 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
 201                         }
 202                 }
 203     } elsif ($filter eq 'EAN13') {
 204         my $ean = CheckDigits('ean');
 205         if ( $ean->is_valid($barcode) ) {
 206             #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
 207             $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
 208         } else {
 209             warn "# [$barcode] not valid EAN-13/UPC-A\n";
 210         }
 211         }
 212     return $barcode;    # return barcode, modified or not
 213 }
 214
 215 =head2 decode
 216
 217   $str = &decode($chunk);
 218
 219 Decodes a segment of a string emitted by a CueCat barcode scanner and
 220 returns it.
 221
 222 FIXME: Should be replaced with Barcode::Cuecat from CPAN
 223 or Javascript based decoding on the client side.
 224
 225 =cut
 226
 227 sub decode {
 228     my ($encoded) = @_;
 229     my $seq =
 230       'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
 231     my @s = map { index( $seq, $_ ); } split( //, $encoded );
 232     my $l = ( $#s + 1 ) % 4;
 233     if ($l) {
 234         if ( $l == 1 ) {
 235             # warn "Error: Cuecat decode parsing failed!";
 236             return;
 237         }
 238         $l = 4 - $l;
 239         $#s += $l;
 240     }
 241     my $r = '';
 242     while ( $#s >= 0 ) {
 243         my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
 244         $r .=
 245             chr( ( $n >> 16 ) ^ 67 )
 246          .chr( ( $n >> 8 & 255 ) ^ 67 )
 247          .chr( ( $n & 255 ) ^ 67 );
 248         @s = @s[ 4 .. $#s ];
 249     }
 250     $r = substr( $r, 0, length($r) - $l );
 251     return $r;
 252 }
 253
 254 =head2 transferbook
 255
 256   ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
 257                                             $barcode, $ignore_reserves);
 258
 259 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
 260
 261 C<$newbranch> is the code for the branch to which the item should be transferred.
 262
 263 C<$barcode> is the barcode of the item to be transferred.
 264
 265 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
 266 Otherwise, if an item is reserved, the transfer fails.
 267
 268 Returns three values:
 269
 270 =over
 271
 272 =item $dotransfer
 273
 274 is true if the transfer was successful.
 275
 276 =item $messages
 277
 278 is a reference-to-hash which may have any of the following keys:
 279
 280 =over
 281
 282 =item C<BadBarcode>
 283
 284 There is no item in the catalog with the given barcode. The value is C<$barcode>.
 285
 286 =item C<DestinationEqualsHolding>
 287
 288 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
 289
 290 =item C<WasReturned>
 291
 292 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
 293
 294 =item C<ResFound>
 295
 296 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
 297
 298 =item C<WasTransferred>
 299
 300 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
 301
 302 =back
 303
 304 =back
 305
 306 =cut
 307
 308 sub transferbook {
 309     my ( $tbr, $barcode, $ignoreRs ) = @_;
 310     my $messages;
 311     my $dotransfer      = 1;
 312     my $item = Koha::Items->find( { barcode => $barcode } );
 313
 314     # bad barcode..
 315     unless ( $item ) {
 316         $messages->{'BadBarcode'} = $barcode;
 317         $dotransfer = 0;
 318         return ( $dotransfer, $messages );
 319     }
 320
 321     my $itemnumber = $item->itemnumber;
 322     my $issue = GetOpenIssue($itemnumber);
 323     # get branches of book...
 324     my $hbr = $item->homebranch;
 325     my $fbr = $item->holdingbranch;
 326
 327     # if using Branch Transfer Limits
 328     if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
 329         my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
 330         if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
 331             if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
 332                 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
 333                 $dotransfer = 0;
 334             }
 335         } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
 336             $messages->{'NotAllowed'} = $tbr . "::" . $code;
 337             $dotransfer = 0;
 338         }
 339     }
 340
 341     # can't transfer book if is already there....
 342     if ( $fbr eq $tbr ) {
 343         $messages->{'DestinationEqualsHolding'} = 1;
 344         $dotransfer = 0;
 345     }
 346
 347     # check if it is still issued to someone, return it...
 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 = $patron->guarantees();
 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                 my $description = "Rental";
1479                 AddIssuingCharge( $issue, $charge, $description );
1480             }
1481
1482             my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1483             if ( $itemtype_object ) {
1484                 my $accumulate_charge = $fees->accumulate_rentalcharge();
1485                 if ( $accumulate_charge > 0 ) {
1486                     AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1487                     $charge += $accumulate_charge;
1488                     $item_unblessed->{charge} = $charge;
1489                 }
1490             }
1491
1492             # Record the fact that this book was issued.
1493             &UpdateStats(
1494                 {
1495                     branch => C4::Context->userenv->{'branch'},
1496                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1497                     amount         => $charge,
1498                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1499                     itemnumber     => $item_object->itemnumber,
1500                     itemtype       => $item_object->effective_itemtype,
1501                     location       => $item_object->location,
1502                     borrowernumber => $borrower->{'borrowernumber'},
1503                     ccode          => $item_object->ccode,
1504                 }
1505             );
1506
1507             # Send a checkout slip.
1508             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1509             my %conditions        = (
1510                 branchcode   => $branchcode,
1511                 categorycode => $borrower->{categorycode},
1512                 item_type    => $item_object->effective_itemtype,
1513                 notification => 'CHECKOUT',
1514             );
1515             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1516                 SendCirculationAlert(
1517                     {
1518                         type     => 'CHECKOUT',
1519                         item     => $item_object->unblessed,
1520                         borrower => $borrower,
1521                         branch   => $branchcode,
1522                     }
1523                 );
1524             }
1525             logaction(
1526                 "CIRCULATION", "ISSUE",
1527                 $borrower->{'borrowernumber'},
1528                 $item_object->itemnumber,
1529             ) if C4::Context->preference("IssueLog");
1530         }
1531     }
1532     return $issue;
1533 }
1534
1535 =head2 GetLoanLength
1536
1537   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1538
1539 Get loan length for an itemtype, a borrower type and a branch
1540
1541 =cut
1542
1543 sub GetLoanLength {
1544     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1545     my $dbh = C4::Context->dbh;
1546     my $sth = $dbh->prepare(qq{
1547         SELECT issuelength, lengthunit, renewalperiod
1548         FROM issuingrules
1549         WHERE   categorycode=?
1550             AND itemtype=?
1551             AND branchcode=?
1552             AND issuelength IS NOT NULL
1553     });
1554
1555     # try to find issuelength & return the 1st available.
1556     # check with borrowertype, itemtype and branchcode, then without one of those parameters
1557     $sth->execute( $borrowertype, $itemtype, $branchcode );
1558     my $loanlength = $sth->fetchrow_hashref;
1559
1560     return $loanlength
1561       if defined($loanlength) && defined $loanlength->{issuelength};
1562
1563     $sth->execute( $borrowertype, '*', $branchcode );
1564     $loanlength = $sth->fetchrow_hashref;
1565     return $loanlength
1566       if defined($loanlength) && defined $loanlength->{issuelength};
1567
1568     $sth->execute( '*', $itemtype, $branchcode );
1569     $loanlength = $sth->fetchrow_hashref;
1570     return $loanlength
1571       if defined($loanlength) && defined $loanlength->{issuelength};
1572
1573     $sth->execute( '*', '*', $branchcode );
1574     $loanlength = $sth->fetchrow_hashref;
1575     return $loanlength
1576       if defined($loanlength) && defined $loanlength->{issuelength};
1577
1578     $sth->execute( $borrowertype, $itemtype, '*' );
1579     $loanlength = $sth->fetchrow_hashref;
1580     return $loanlength
1581       if defined($loanlength) && defined $loanlength->{issuelength};
1582
1583     $sth->execute( $borrowertype, '*', '*' );
1584     $loanlength = $sth->fetchrow_hashref;
1585     return $loanlength
1586       if defined($loanlength) && defined $loanlength->{issuelength};
1587
1588     $sth->execute( '*', $itemtype, '*' );
1589     $loanlength = $sth->fetchrow_hashref;
1590     return $loanlength
1591       if defined($loanlength) && defined $loanlength->{issuelength};
1592
1593     $sth->execute( '*', '*', '*' );
1594     $loanlength = $sth->fetchrow_hashref;
1595     return $loanlength
1596       if defined($loanlength) && defined $loanlength->{issuelength};
1597
1598     # if no rule is set => 0 day (hardcoded)
1599     return {
1600         issuelength => 0,
1601         renewalperiod => 0,
1602         lengthunit => 'days',
1603     };
1604
1605 }
1606
1607
1608 =head2 GetHardDueDate
1609
1610   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1611
1612 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1613
1614 =cut
1615
1616 sub GetHardDueDate {
1617     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1618
1619     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
1620         {   categorycode => $borrowertype,
1621             itemtype     => $itemtype,
1622             branchcode   => $branchcode
1623         }
1624     );
1625
1626
1627     if ( defined( $issuing_rule ) ) {
1628         if ( $issuing_rule->hardduedate ) {
1629             return (dt_from_string($issuing_rule->hardduedate, 'iso'),$issuing_rule->hardduedatecompare);
1630         } else {
1631             return (undef, undef);
1632         }
1633     }
1634 }
1635
1636 =head2 GetBranchBorrowerCircRule
1637
1638   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1639
1640 Retrieves circulation rule attributes that apply to the given
1641 branch and patron category, regardless of item type.
1642 The return value is a hashref containing the following key:
1643
1644 patron_maxissueqty - maximum number of loans that a
1645 patron of the given category can have at the given
1646 branch.  If the value is undef, no limit.
1647
1648 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1649 patron of the given category can have at the given
1650 branch.  If the value is undef, no limit.
1651
1652 This will check for different branch/category combinations in the following order:
1653 branch and category
1654 branch only
1655 category only
1656 default branch and category
1657
1658 If no rule has been found in the database, it will default to
1659 the buillt in rule:
1660
1661 patron_maxissueqty - undef
1662 patron_maxonsiteissueqty - undef
1663
1664 C<$branchcode> and C<$categorycode> should contain the
1665 literal branch code and patron category code, respectively - no
1666 wildcards.
1667
1668 =cut
1669
1670 sub GetBranchBorrowerCircRule {
1671     my ( $branchcode, $categorycode ) = @_;
1672
1673     # Initialize default values
1674     my $rules = {
1675         patron_maxissueqty       => undef,
1676         patron_maxonsiteissueqty => undef,
1677     };
1678
1679     # Search for rules!
1680     foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1681         my $rule = Koha::CirculationRules->get_effective_rule(
1682             {
1683                 categorycode => $categorycode,
1684                 itemtype     => undef,
1685                 branchcode   => $branchcode,
1686                 rule_name    => $rule_name,
1687             }
1688         );
1689
1690         $rules->{$rule_name} = $rule->rule_value if defined $rule;
1691     }
1692
1693     return $rules;
1694 }
1695
1696 =head2 GetBranchItemRule
1697
1698   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1699
1700 Retrieves circulation rule attributes that apply to the given
1701 branch and item type, regardless of patron category.
1702
1703 The return value is a hashref containing the following keys:
1704
1705 holdallowed => Hold policy for this branch and itemtype. Possible values:
1706   0: No holds allowed.
1707   1: Holds allowed only by patrons that have the same homebranch as the item.
1708   2: Holds allowed from any patron.
1709
1710 returnbranch => branch to which to return item.  Possible values:
1711   noreturn: do not return, let item remain where checked in (floating collections)
1712   homebranch: return to item's home branch
1713   holdingbranch: return to issuer branch
1714
1715 This searches branchitemrules in the following order:
1716
1717   * Same branchcode and itemtype
1718   * Same branchcode, itemtype '*'
1719   * branchcode '*', same itemtype
1720   * branchcode and itemtype '*'
1721
1722 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1723
1724 =cut
1725
1726 sub GetBranchItemRule {
1727     my ( $branchcode, $itemtype ) = @_;
1728     my $dbh = C4::Context->dbh();
1729     my $result = {};
1730
1731     my @attempts = (
1732         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1733             FROM branch_item_rules
1734             WHERE branchcode = ?
1735               AND itemtype = ?', $branchcode, $itemtype],
1736         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1737             FROM default_branch_circ_rules
1738             WHERE branchcode = ?', $branchcode],
1739         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1740             FROM default_branch_item_rules
1741             WHERE itemtype = ?', $itemtype],
1742         ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1743             FROM default_circ_rules'],
1744     );
1745
1746     foreach my $attempt (@attempts) {
1747         my ($query, @bind_params) = @{$attempt};
1748         my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1749           or next;
1750
1751         # Since branch/category and branch/itemtype use the same per-branch
1752         # defaults tables, we have to check that the key we want is set, not
1753         # just that a row was returned
1754         $result->{'holdallowed'}  = $search_result->{'holdallowed'}  unless ( defined $result->{'holdallowed'} );
1755         $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1756         $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1757     }
1758
1759     # built-in default circulation rule
1760     $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1761     $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1762     $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1763
1764     return $result;
1765 }
1766
1767 =head2 AddReturn
1768
1769   ($doreturn, $messages, $iteminformation, $borrower) =
1770       &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1771
1772 Returns a book.
1773
1774 =over 4
1775
1776 =item C<$barcode> is the bar code of the book being returned.
1777
1778 =item C<$branch> is the code of the branch where the book is being returned.
1779
1780 =item C<$exemptfine> indicates that overdue charges for the item will be
1781 removed. Optional.
1782
1783 =item C<$return_date> allows the default return date to be overridden
1784 by the given return date. Optional.
1785
1786 =back
1787
1788 C<&AddReturn> returns a list of four items:
1789
1790 C<$doreturn> is true iff the return succeeded.
1791
1792 C<$messages> is a reference-to-hash giving feedback on the operation.
1793 The keys of the hash are:
1794
1795 =over 4
1796
1797 =item C<BadBarcode>
1798
1799 No item with this barcode exists. The value is C<$barcode>.
1800
1801 =item C<NotIssued>
1802
1803 The book is not currently on loan. The value is C<$barcode>.
1804
1805 =item C<withdrawn>
1806
1807 This book has been withdrawn/cancelled. The value should be ignored.
1808
1809 =item C<Wrongbranch>
1810
1811 This book has was returned to the wrong branch.  The value is a hashref
1812 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1813 contain the branchcode of the incorrect and correct return library, respectively.
1814
1815 =item C<ResFound>
1816
1817 The item was reserved. The value is a reference-to-hash whose keys are
1818 fields from the reserves table of the Koha database, and
1819 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1820 either C<Waiting>, C<Reserved>, or 0.
1821
1822 =item C<WasReturned>
1823
1824 Value 1 if return is successful.
1825
1826 =item C<NeedsTransfer>
1827
1828 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1829
1830 =back
1831
1832 C<$iteminformation> is a reference-to-hash, giving information about the
1833 returned item from the issues table.
1834
1835 C<$borrower> is a reference-to-hash, giving information about the
1836 patron who last borrowed the book.
1837
1838 =cut
1839
1840 sub AddReturn {
1841     my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1842
1843     if ($branch and not Koha::Libraries->find($branch)) {
1844         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1845         undef $branch;
1846     }
1847     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1848     $return_date //= dt_from_string();
1849     my $messages;
1850     my $patron;
1851     my $doreturn       = 1;
1852     my $validTransfert = 0;
1853     my $stat_type = 'return';
1854
1855     # get information on item
1856     my $item = Koha::Items->find({ barcode => $barcode });
1857     unless ($item) {
1858         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1859     }
1860
1861     my $itemnumber = $item->itemnumber;
1862     my $itemtype = $item->effective_itemtype;
1863
1864     my $issue  = $item->checkout;
1865     if ( $issue ) {
1866         $patron = $issue->patron
1867             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1868                 . Dumper($issue->unblessed) . "\n";
1869     } else {
1870         $messages->{'NotIssued'} = $barcode;
1871         ModItem({ onloan => undef }, $item->biblionumber, $item->itemnumber) if defined $item->onloan;
1872         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1873         $doreturn = 0;
1874         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1875         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1876         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1877            $messages->{'LocalUse'} = 1;
1878            $stat_type = 'localuse';
1879         }
1880     }
1881
1882     my $item_unblessed = $item->unblessed;
1883         # full item data, but no borrowernumber or checkout info (no issue)
1884     my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1885         # get the proper branch to which to return the item
1886     my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1887         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1888
1889     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
1890     my $patron_unblessed = $patron ? $patron->unblessed : {};
1891
1892     my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1893     map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1894     if ($update_loc_rules) {
1895         if (defined $update_loc_rules->{_ALL_}) {
1896             if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1897             if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1898             if ( $item->location ne $update_loc_rules->{_ALL_}) {
1899                 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1900                 ModItem( { location => $update_loc_rules->{_ALL_} }, undef, $itemnumber );
1901             }
1902         }
1903         else {
1904             foreach my $key ( keys %$update_loc_rules ) {
1905                 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1906                 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1907                 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
1908                     $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
1909                     ModItem( { location => $update_loc_rules->{$key} }, undef, $itemnumber );
1910                     last;
1911                 }
1912             }
1913         }
1914     }
1915
1916     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1917     if ($yaml) {
1918         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
1919         my $rules;
1920         eval { $rules = YAML::Load($yaml); };
1921         if ($@) {
1922             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1923         }
1924         else {
1925             foreach my $key ( keys %$rules ) {
1926                 if ( $item->notforloan eq $key ) {
1927                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
1928                     ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber, { log_action => 0 } );
1929                     last;
1930                 }
1931             }
1932         }
1933     }
1934
1935     # check if the return is allowed at this branch
1936     my ($returnallowed, $message) = CanBookBeReturned($item_unblessed, $branch);
1937     unless ($returnallowed){
1938         $messages->{'Wrongbranch'} = {
1939             Wrongbranch => $branch,
1940             Rightbranch => $message
1941         };
1942         $doreturn = 0;
1943         return ( $doreturn, $messages, $issue, $patron_unblessed);
1944     }
1945
1946     if ( $item->withdrawn ) { # book has been cancelled
1947         $messages->{'withdrawn'} = 1;
1948         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1949     }
1950
1951     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
1952         $doreturn = 0;
1953     }
1954
1955     # case of a return of document (deal with issues and holdingbranch)
1956     if ($doreturn) {
1957         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
1958         $patron or warn "AddReturn without current borrower";
1959
1960         if ($patron) {
1961             eval {
1962                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy );
1963             };
1964             unless ( $@ ) {
1965                 if ( C4::Context->preference('CalculateFinesOnReturn') && !$item->itemlost ) {
1966                     _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed, return_date => $return_date } );
1967                 }
1968             } else {
1969                 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 );
1970
1971                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
1972             }
1973
1974             # FIXME is the "= 1" right?  This could be the borrower hash.
1975             $messages->{'WasReturned'} = 1;
1976
1977         }
1978
1979         ModItem( { onloan => undef }, $item->biblionumber, $item->itemnumber, { log_action => 0 } );
1980     }
1981
1982     # the holdingbranch is updated if the document is returned to another location.
1983     # this is always done regardless of whether the item was on loan or not
1984     my $item_holding_branch = $item->holdingbranch;
1985     if ($item->holdingbranch ne $branch) {
1986         UpdateHoldingbranch($branch, $item->itemnumber);
1987         $item_unblessed->{'holdingbranch'} = $branch; # update item data holdingbranch too # FIXME I guess this is for the _debar_user_on_return call later
1988     }
1989
1990     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
1991     ModDateLastSeen( $item->itemnumber, $leave_item_lost );
1992
1993     # check if we have a transfer for this document
1994     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
1995
1996     # if we have a transfer to do, we update the line of transfers with the datearrived
1997     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
1998     if ($datesent) {
1999         if ( $tobranch eq $branch ) {
2000             my $sth = C4::Context->dbh->prepare(
2001                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2002             );
2003             $sth->execute( $item->itemnumber );
2004             # if we have a reservation with valid transfer, we can set it's status to 'W'
2005             C4::Reserves::ModReserveStatus($item->itemnumber, 'W');
2006         } else {
2007             $messages->{'WrongTransfer'}     = $tobranch;
2008             $messages->{'WrongTransferItem'} = $item->itemnumber;
2009         }
2010         $validTransfert = 1;
2011     }
2012
2013     # fix up the accounts.....
2014     if ( $item->itemlost ) {
2015         $messages->{'WasLost'} = 1;
2016         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2017             if (
2018                 Koha::RefundLostItemFeeRules->should_refund(
2019                     {
2020                         current_branch      => C4::Context->userenv->{branch},
2021                         item_home_branch    => $item->homebranch,
2022                         item_holding_branch => $item_holding_branch
2023                     }
2024                 )
2025               )
2026             {
2027                 _FixAccountForLostAndReturned( $item->itemnumber,
2028                     $borrowernumber, $barcode );
2029                 $messages->{'LostItemFeeRefunded'} = 1;
2030             }
2031         }
2032     }
2033
2034     # fix up the overdues in accounts...
2035     if ($borrowernumber) {
2036         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine );
2037         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->itemnumber...) failed!";  # zero is OK, check defined
2038
2039         if ( $issue and $issue->is_overdue ) {
2040         # fix fine days
2041             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item_unblessed, dt_from_string($issue->date_due), $return_date );
2042             if ($reminder){
2043                 $messages->{'PrevDebarred'} = $debardate;
2044             } else {
2045                 $messages->{'Debarred'} = $debardate if $debardate;
2046             }
2047         # there's no overdue on the item but borrower had been previously debarred
2048         } elsif ( $issue->date_due and $patron->debarred ) {
2049              if ( $patron->debarred eq "9999-12-31") {
2050                 $messages->{'ForeverDebarred'} = $patron->debarred;
2051              } else {
2052                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2053                   $borrower_debar_dt->truncate(to => 'day');
2054                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2055                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2056                       $messages->{'PrevDebarred'} = $patron->debarred;
2057                   }
2058              }
2059         }
2060     }
2061
2062     # find reserves.....
2063     # if we don't have a reserve with the status W, we launch the Checkreserves routine
2064     my ($resfound, $resrec);
2065     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2066     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2067     if ($resfound) {
2068           $resrec->{'ResFound'} = $resfound;
2069         $messages->{'ResFound'} = $resrec;
2070     }
2071
2072     # Record the fact that this book was returned.
2073     UpdateStats({
2074         branch         => $branch,
2075         type           => $stat_type,
2076         itemnumber     => $itemnumber,
2077         itemtype       => $itemtype,
2078         borrowernumber => $borrowernumber,
2079         ccode          => $item->ccode,
2080     });
2081
2082     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2083     if ( $patron ) {
2084         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2085         my %conditions = (
2086             branchcode   => $branch,
2087             categorycode => $patron->categorycode,
2088             item_type    => $itemtype,
2089             notification => 'CHECKIN',
2090         );
2091         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2092             SendCirculationAlert({
2093                 type     => 'CHECKIN',
2094                 item     => $item_unblessed,
2095                 borrower => $patron->unblessed,
2096                 branch   => $branch,
2097             });
2098         }
2099
2100         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2101             if C4::Context->preference("ReturnLog");
2102         }
2103
2104     # Remove any OVERDUES related debarment if the borrower has no overdues
2105     if ( $borrowernumber
2106       && $patron->debarred
2107       && C4::Context->preference('AutoRemoveOverduesRestrictions')
2108       && !Koha::Patrons->find( $borrowernumber )->has_overdues
2109       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2110     ) {
2111         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2112     }
2113
2114     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2115     if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2116         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType");
2117         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2118             (C4::Context->preference("UseBranchTransferLimits") and
2119              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2120            )) {
2121             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->itemnumber,$branch, $returnbranch;
2122             $debug and warn "item: " . Dumper($item_unblessed);
2123             ModItemTransfer($item->itemnumber, $branch, $returnbranch);
2124             $messages->{'WasTransfered'} = 1;
2125         } else {
2126             $messages->{'NeedsTransfer'} = $returnbranch;
2127         }
2128     }
2129
2130     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2131 }
2132
2133 =head2 MarkIssueReturned
2134
2135   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy);
2136
2137 Unconditionally marks an issue as being returned by
2138 moving the C<issues> row to C<old_issues> and
2139 setting C<returndate> to the current date.
2140
2141 if C<$returndate> is specified (in iso format), it is used as the date
2142 of the return.
2143
2144 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2145 the old_issue is immediately anonymised
2146
2147 Ideally, this function would be internal to C<C4::Circulation>,
2148 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2149 and offline_circ/process_koc.pl.
2150
2151 =cut
2152
2153 sub MarkIssueReturned {
2154     my ( $borrowernumber, $itemnumber, $returndate, $privacy ) = @_;
2155
2156     # Retrieve the issue
2157     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2158     my $issue_id = $issue->issue_id;
2159
2160     my $anonymouspatron;
2161     if ( $privacy == 2 ) {
2162         # The default of 0 will not work due to foreign key constraints
2163         # The anonymisation will fail if AnonymousPatron is not a valid entry
2164         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2165         # Note that a warning should appear on the about page (System information tab).
2166         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2167         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."
2168             unless Koha::Patrons->find( $anonymouspatron );
2169     }
2170
2171     my $schema = Koha::Database->schema;
2172
2173     # FIXME Improve the return value and handle it from callers
2174     $schema->txn_do(sub {
2175
2176         # Update the returndate value
2177         if ( $returndate ) {
2178             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2179         }
2180         else {
2181             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2182         }
2183
2184         # Create the old_issues entry
2185         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2186
2187         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2188         if ( $privacy == 2) {
2189             $old_checkout->borrowernumber($anonymouspatron)->store;
2190         }
2191
2192         # And finally delete the issue
2193         $issue->delete;
2194
2195         ModItem( { 'onloan' => undef }, undef, $itemnumber, { log_action => 0 } );
2196
2197         if ( C4::Context->preference('StoreLastBorrower') ) {
2198             my $item = Koha::Items->find( $itemnumber );
2199             my $patron = Koha::Patrons->find( $borrowernumber );
2200             $item->last_returned_by( $patron );
2201         }
2202     });
2203
2204     return $issue_id;
2205 }
2206
2207 =head2 _debar_user_on_return
2208
2209     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2210
2211 C<$borrower> borrower hashref
2212
2213 C<$item> item hashref
2214
2215 C<$datedue> date due DateTime object
2216
2217 C<$returndate> DateTime object representing the return time
2218
2219 Internal function, called only by AddReturn that calculates and updates
2220  the user fine days, and debars them if necessary.
2221
2222 Should only be called for overdue returns
2223
2224 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2225 to ease testing.
2226
2227 =cut
2228
2229 sub _calculate_new_debar_dt {
2230     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2231
2232     my $branchcode = _GetCircControlBranch( $item, $borrower );
2233     my $circcontrol = C4::Context->preference('CircControl');
2234     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2235         {   categorycode => $borrower->{categorycode},
2236             itemtype     => $item->{itype},
2237             branchcode   => $branchcode
2238         }
2239     );
2240     my $finedays = $issuing_rule ? $issuing_rule->finedays : undef;
2241     my $unit     = $issuing_rule ? $issuing_rule->lengthunit : undef;
2242     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2243
2244     return unless $finedays;
2245
2246     # finedays is in days, so hourly loans must multiply by 24
2247     # thus 1 hour late equals 1 day suspension * finedays rate
2248     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2249
2250     # grace period is measured in the same units as the loan
2251     my $grace =
2252       DateTime::Duration->new( $unit => $issuing_rule->firstremind );
2253
2254     my $deltadays = DateTime::Duration->new(
2255         days => $chargeable_units
2256     );
2257
2258     if ( $deltadays->subtract($grace)->is_positive() ) {
2259         my $suspension_days = $deltadays * $finedays;
2260
2261         if ( $issuing_rule->suspension_chargeperiod > 1 ) {
2262             # No need to / 1 and do not consider / 0
2263             $suspension_days = DateTime::Duration->new(
2264                 days => floor( $suspension_days->in_units('days') / $issuing_rule->suspension_chargeperiod )
2265             );
2266         }
2267
2268         # If the max suspension days is < than the suspension days
2269         # the suspension days is limited to this maximum period.
2270         my $max_sd = $issuing_rule->maxsuspensiondays;
2271         if ( defined $max_sd ) {
2272             $max_sd = DateTime::Duration->new( days => $max_sd );
2273             $suspension_days = $max_sd
2274               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2275         }
2276
2277         my ( $has_been_extended );
2278         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2279             my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2280             if ( $debarment ) {
2281                 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2282                 $has_been_extended = 1;
2283             }
2284         }
2285
2286         my $new_debar_dt;
2287         # Use the calendar or not to calculate the debarment date
2288         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2289             my $calendar = Koha::Calendar->new(
2290                 branchcode => $branchcode,
2291                 days_mode  => 'Calendar'
2292             );
2293             $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2294         }
2295         else {
2296             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2297         }
2298         return $new_debar_dt;
2299     }
2300     return;
2301 }
2302
2303 sub _debar_user_on_return {
2304     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2305
2306     $return_date //= dt_from_string();
2307
2308     my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2309
2310     return unless $new_debar_dt;
2311
2312     Koha::Patron::Debarments::AddUniqueDebarment({
2313         borrowernumber => $borrower->{borrowernumber},
2314         expiration     => $new_debar_dt->ymd(),
2315         type           => 'SUSPENSION',
2316     });
2317     # if borrower was already debarred but does not get an extra debarment
2318     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2319     my ($new_debarment_str, $is_a_reminder);
2320     if ( $borrower->{debarred} eq $patron->is_debarred ) {
2321         $is_a_reminder = 1;
2322         $new_debarment_str = $borrower->{debarred};
2323     } else {
2324         $new_debarment_str = $new_debar_dt->ymd();
2325     }
2326     # FIXME Should return a DateTime object
2327     return $new_debarment_str, $is_a_reminder;
2328 }
2329
2330 =head2 _FixOverduesOnReturn
2331
2332    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine);
2333
2334 C<$borrowernumber> borrowernumber
2335
2336 C<$itemnumber> itemnumber
2337
2338 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2339
2340 Internal function
2341
2342 =cut
2343
2344 sub _FixOverduesOnReturn {
2345     my ( $borrowernumber, $item, $exemptfine ) = @_;
2346     unless( $borrowernumber ) {
2347         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2348         return;
2349     }
2350     unless( $item ) {
2351         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2352         return;
2353     }
2354
2355     my $schema = Koha::Database->schema;
2356
2357     my $result = $schema->txn_do(
2358         sub {
2359             # check for overdue fine
2360             my $accountlines = Koha::Account::Lines->search(
2361                 {
2362                     borrowernumber => $borrowernumber,
2363                     itemnumber     => $item,
2364                     accounttype    => 'OVERDUE',
2365                     status         => 'UNRETURNED'
2366                 }
2367             );
2368             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2369
2370             my $accountline = $accountlines->next;
2371             if ($exemptfine) {
2372                 my $amountoutstanding = $accountline->amountoutstanding;
2373
2374                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2375                 my $credit = $account->add_credit(
2376                     {
2377                         amount     => $amountoutstanding,
2378                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2379                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2380                         interface  => C4::Context->interface,
2381                         type       => 'forgiven',
2382                         item_id    => $item
2383                     }
2384                 );
2385
2386                 $credit->apply({ debits => $accountlines->reset, offset_type => 'Forgiven' });
2387
2388                 $accountline->status('FORGIVEN');
2389
2390                 if (C4::Context->preference("FinesLog")) {
2391                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2392                 }
2393             } else {
2394                 $accountline->status('RETURNED');
2395             }
2396
2397             return $accountline->store();
2398         }
2399     );
2400
2401     return $result;
2402 }
2403
2404 =head2 _FixAccountForLostAndReturned
2405
2406   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2407
2408 Calculates the charge for a book lost and returned.
2409
2410 Internal function, not exported, called only by AddReturn.
2411
2412 =cut
2413
2414 sub _FixAccountForLostAndReturned {
2415     my $itemnumber     = shift or return;
2416     my $borrowernumber = @_ ? shift : undef;
2417     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2418
2419     my $credit;
2420
2421     # check for charge made for lost book
2422     my $accountlines = Koha::Account::Lines->search(
2423         {
2424             itemnumber  => $itemnumber,
2425             accounttype => 'L',
2426         },
2427         {
2428             order_by => { -desc => [ 'date', 'accountlines_id' ] }
2429         }
2430     );
2431
2432     return unless $accountlines->count > 0;
2433     my $accountline     = $accountlines->next;
2434     my $total_to_refund = 0;
2435
2436     return unless $accountline->borrowernumber;
2437     my $patron = Koha::Patrons->find( $accountline->borrowernumber );
2438     return unless $patron; # Patron has been deleted, nobody to credit the return to
2439
2440     my $account = $patron->account;
2441
2442     # Use cases
2443     if ( $accountline->amount > $accountline->amountoutstanding ) {
2444         # some amount has been cancelled. collect the offsets that are not writeoffs
2445         # this works because the only way to subtract from this kind of a debt is
2446         # using the UI buttons 'Pay' and 'Write off'
2447         my $credits_offsets = Koha::Account::Offsets->search({
2448             debit_id  => $accountline->id,
2449             credit_id => { '!=' => undef }, # it is not the debit itself
2450             type      => { '!=' => 'Writeoff' },
2451             amount    => { '<'  => 0 } # credits are negative on the DB
2452         });
2453
2454         $total_to_refund = ( $credits_offsets->count > 0 )
2455                             ? $credits_offsets->total * -1 # credits are negative on the DB
2456                             : 0;
2457     }
2458
2459     my $credit_total = $accountline->amountoutstanding + $total_to_refund;
2460
2461     if ( $credit_total > 0 ) {
2462         my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
2463         $credit = $account->add_credit(
2464             {   amount      => $credit_total,
2465                 description => 'Item Returned ' . $item_id,
2466                 type        => 'lost_item_return',
2467                 interface   => C4::Context->interface,
2468                 library_id  => $branchcode
2469             }
2470         );
2471
2472         # TODO: ->apply should just accept the accountline
2473         $credit->apply( { debits => $accountlines->reset } );
2474     }
2475
2476     # Manually set the accounttype
2477     $accountline->discard_changes->accounttype('LR');
2478     $accountline->store;
2479
2480     ModItem( { paidfor => '' }, undef, $itemnumber, { log_action => 0 } );
2481
2482     if ( defined $account and C4::Context->preference('AccountAutoReconcile') ) {
2483         $account->reconcile_balance;
2484     }
2485
2486     return ($credit) ? $credit->id : undef;
2487 }
2488
2489 =head2 _GetCircControlBranch
2490
2491    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2492
2493 Internal function :
2494
2495 Return the library code to be used to determine which circulation
2496 policy applies to a transaction.  Looks up the CircControl and
2497 HomeOrHoldingBranch system preferences.
2498
2499 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2500
2501 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2502
2503 =cut
2504
2505 sub _GetCircControlBranch {
2506     my ($item, $borrower) = @_;
2507     my $circcontrol = C4::Context->preference('CircControl');
2508     my $branch;
2509
2510     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2511         $branch= C4::Context->userenv->{'branch'};
2512     } elsif ($circcontrol eq 'PatronLibrary') {
2513         $branch=$borrower->{branchcode};
2514     } else {
2515         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2516         $branch = $item->{$branchfield};
2517         # default to item home branch if holdingbranch is used
2518         # and is not defined
2519         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2520             $branch = $item->{homebranch};
2521         }
2522     }
2523     return $branch;
2524 }
2525
2526 =head2 GetOpenIssue
2527
2528   $issue = GetOpenIssue( $itemnumber );
2529
2530 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2531
2532 C<$itemnumber> is the item's itemnumber
2533
2534 Returns a hashref
2535
2536 =cut
2537
2538 sub GetOpenIssue {
2539   my ( $itemnumber ) = @_;
2540   return unless $itemnumber;
2541   my $dbh = C4::Context->dbh;
2542   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2543   $sth->execute( $itemnumber );
2544   return $sth->fetchrow_hashref();
2545
2546 }
2547
2548 =head2 GetBiblioIssues
2549
2550   $issues = GetBiblioIssues($biblionumber);
2551
2552 this function get all issues from a biblionumber.
2553
2554 Return:
2555 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2556 tables issues and the firstname,surname & cardnumber from borrowers.
2557
2558 =cut
2559
2560 sub GetBiblioIssues {
2561     my $biblionumber = shift;
2562     return unless $biblionumber;
2563     my $dbh   = C4::Context->dbh;
2564     my $query = "
2565         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2566         FROM issues
2567             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2568             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2569             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2570             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2571         WHERE biblio.biblionumber = ?
2572         UNION ALL
2573         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2574         FROM old_issues
2575             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2576             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2577             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2578             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2579         WHERE biblio.biblionumber = ?
2580         ORDER BY timestamp
2581     ";
2582     my $sth = $dbh->prepare($query);
2583     $sth->execute($biblionumber, $biblionumber);
2584
2585     my @issues;
2586     while ( my $data = $sth->fetchrow_hashref ) {
2587         push @issues, $data;
2588     }
2589     return \@issues;
2590 }
2591
2592 =head2 GetUpcomingDueIssues
2593
2594   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2595
2596 =cut
2597
2598 sub GetUpcomingDueIssues {
2599     my $params = shift;
2600
2601     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2602     my $dbh = C4::Context->dbh;
2603
2604     my $statement = <<END_SQL;
2605 SELECT *
2606 FROM (
2607     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2608     FROM issues
2609     LEFT JOIN items USING (itemnumber)
2610     LEFT OUTER JOIN branches USING (branchcode)
2611     WHERE returndate is NULL
2612 ) tmp
2613 WHERE days_until_due >= 0 AND days_until_due <= ?
2614 END_SQL
2615
2616     my @bind_parameters = ( $params->{'days_in_advance'} );
2617
2618     my $sth = $dbh->prepare( $statement );
2619     $sth->execute( @bind_parameters );
2620     my $upcoming_dues = $sth->fetchall_arrayref({});
2621
2622     return $upcoming_dues;
2623 }
2624
2625 =head2 CanBookBeRenewed
2626
2627   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2628
2629 Find out whether a borrowed item may be renewed.
2630
2631 C<$borrowernumber> is the borrower number of the patron who currently
2632 has the item on loan.
2633
2634 C<$itemnumber> is the number of the item to renew.
2635
2636 C<$override_limit>, if supplied with a true value, causes
2637 the limit on the number of times that the loan can be renewed
2638 (as controlled by the item type) to be ignored. Overriding also allows
2639 to renew sooner than "No renewal before" and to manually renew loans
2640 that are automatically renewed.
2641
2642 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2643 item must currently be on loan to the specified borrower; renewals
2644 must be allowed for the item's type; and the borrower must not have
2645 already renewed the loan. $error will contain the reason the renewal can not proceed
2646
2647 =cut
2648
2649 sub CanBookBeRenewed {
2650     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2651
2652     my $dbh    = C4::Context->dbh;
2653     my $renews = 1;
2654
2655     my $item      = Koha::Items->find($itemnumber)      or return ( 0, 'no_item' );
2656     my $issue = $item->checkout or return ( 0, 'no_checkout' );
2657     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2658     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2659
2660     my $patron = $issue->patron or return;
2661
2662     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2663
2664     # This item can fill one or more unfilled reserve, can those unfilled reserves
2665     # all be filled by other available items?
2666     if ( $resfound
2667         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2668     {
2669         my $schema = Koha::Database->new()->schema();
2670
2671         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2672         if ($item_holds) {
2673             # There is an item level hold on this item, no other item can fill the hold
2674             $resfound = 1;
2675         }
2676         else {
2677
2678             # Get all other items that could possibly fill reserves
2679             my @itemnumbers = $schema->resultset('Item')->search(
2680                 {
2681                     biblionumber => $resrec->{biblionumber},
2682                     onloan       => undef,
2683                     notforloan   => 0,
2684                     -not         => { itemnumber => $itemnumber }
2685                 },
2686                 { columns => 'itemnumber' }
2687             )->get_column('itemnumber')->all();
2688
2689             # Get all other reserves that could have been filled by this item
2690             my @borrowernumbers;
2691             while (1) {
2692                 my ( $reserve_found, $reserve, undef ) =
2693                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2694
2695                 if ($reserve_found) {
2696                     push( @borrowernumbers, $reserve->{borrowernumber} );
2697                 }
2698                 else {
2699                     last;
2700                 }
2701             }
2702
2703             # If the count of the union of the lists of reservable items for each borrower
2704             # is equal or greater than the number of borrowers, we know that all reserves
2705             # can be filled with available items. We can get the union of the sets simply
2706             # by pushing all the elements onto an array and removing the duplicates.
2707             my @reservable;
2708             my %patrons;
2709             ITEM: foreach my $itemnumber (@itemnumbers) {
2710                 my $item = Koha::Items->find( $itemnumber );
2711                 next if IsItemOnHoldAndFound( $itemnumber );
2712                 for my $borrowernumber (@borrowernumbers) {
2713                     my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2714                     next unless IsAvailableForItemLevelRequest($item, $patron);
2715                     next unless CanItemBeReserved($borrowernumber,$itemnumber);
2716
2717                     push @reservable, $itemnumber;
2718                     if (@reservable >= @borrowernumbers) {
2719                         $resfound = 0;
2720                         last ITEM;
2721                     }
2722                     last;
2723                 }
2724             }
2725         }
2726     }
2727     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2728
2729     return ( 1, undef ) if $override_limit;
2730
2731     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2732     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
2733         {   categorycode => $patron->categorycode,
2734             itemtype     => $item->effective_itemtype,
2735             branchcode   => $branchcode
2736         }
2737     );
2738
2739     return ( 0, "too_many" )
2740       if not $issuing_rule or $issuing_rule->renewalsallowed <= $issue->renewals;
2741
2742     my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2743     my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2744     $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2745     my $restricted  = $patron->is_debarred;
2746     my $hasoverdues = $patron->has_overdues;
2747
2748     if ( $restricted and $restrictionblockrenewing ) {
2749         return ( 0, 'restriction');
2750     } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2751         return ( 0, 'overdue');
2752     }
2753
2754     if ( $issue->auto_renew ) {
2755
2756         if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2757             return ( 0, 'auto_account_expired' );
2758         }
2759
2760         if ( defined $issuing_rule->no_auto_renewal_after
2761                 and $issuing_rule->no_auto_renewal_after ne "" ) {
2762             # Get issue_date and add no_auto_renewal_after
2763             # If this is greater than today, it's too late for renewal.
2764             my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2765             $maximum_renewal_date->add(
2766                 $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
2767             );
2768             my $now = dt_from_string;
2769             if ( $now >= $maximum_renewal_date ) {
2770                 return ( 0, "auto_too_late" );
2771             }
2772         }
2773         if ( defined $issuing_rule->no_auto_renewal_after_hard_limit
2774                       and $issuing_rule->no_auto_renewal_after_hard_limit ne "" ) {
2775             # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2776             if ( dt_from_string >= dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit ) ) {
2777                 return ( 0, "auto_too_late" );
2778             }
2779         }
2780
2781         if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2782             my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2783             my $amountoutstanding = $patron->account->balance;
2784             if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2785                 return ( 0, "auto_too_much_oweing" );
2786             }
2787         }
2788     }
2789
2790     if ( defined $issuing_rule->norenewalbefore
2791         and $issuing_rule->norenewalbefore ne "" )
2792     {
2793
2794         # Calculate soonest renewal by subtracting 'No renewal before' from due date
2795         my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2796             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
2797
2798         # Depending on syspref reset the exact time, only check the date
2799         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2800             and $issuing_rule->lengthunit eq 'days' )
2801         {
2802             $soonestrenewal->truncate( to => 'day' );
2803         }
2804
2805         if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2806         {
2807             return ( 0, "auto_too_soon" ) if $issue->auto_renew;
2808             return ( 0, "too_soon" );
2809         }
2810         elsif ( $issue->auto_renew ) {
2811             return ( 0, "auto_renew" );
2812         }
2813     }
2814
2815     # Fallback for automatic renewals:
2816     # If norenewalbefore is undef, don't renew before due date.
2817     if ( $issue->auto_renew ) {
2818         my $now = dt_from_string;
2819         return ( 0, "auto_renew" )
2820           if $now >= dt_from_string( $issue->date_due, 'sql' );
2821         return ( 0, "auto_too_soon" );
2822     }
2823
2824     return ( 1, undef );
2825 }
2826
2827 =head2 AddRenewal
2828
2829   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2830
2831 Renews a loan.
2832
2833 C<$borrowernumber> is the borrower number of the patron who currently
2834 has the item.
2835
2836 C<$itemnumber> is the number of the item to renew.
2837
2838 C<$branch> is the library where the renewal took place (if any).
2839            The library that controls the circ policies for the renewal is retrieved from the issues record.
2840
2841 C<$datedue> can be a DateTime object used to set the due date.
2842
2843 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2844 this parameter is not supplied, lastreneweddate is set to the current date.
2845
2846 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2847 from the book's item type.
2848
2849 =cut
2850
2851 sub AddRenewal {
2852     my $borrowernumber  = shift;
2853     my $itemnumber      = shift or return;
2854     my $branch          = shift;
2855     my $datedue         = shift;
2856     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz);
2857
2858     my $item_object   = Koha::Items->find($itemnumber) or return;
2859     my $biblio = $item_object->biblio;
2860     my $issue  = $item_object->checkout;
2861     my $item_unblessed = $item_object->unblessed;
2862
2863     my $dbh = C4::Context->dbh;
2864
2865     return unless $issue;
2866
2867     $borrowernumber ||= $issue->borrowernumber;
2868
2869     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2870         carp 'Invalid date passed to AddRenewal.';
2871         return;
2872     }
2873
2874     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
2875     my $patron_unblessed = $patron->unblessed;
2876
2877     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
2878
2879     if ( C4::Context->preference('CalculateFinesOnReturn') ) {
2880         _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
2881     }
2882     _FixOverduesOnReturn( $borrowernumber, $itemnumber );
2883
2884     # If the due date wasn't specified, calculate it by adding the
2885     # book's loan length to today's date or the current due date
2886     # based on the value of the RenewalPeriodBase syspref.
2887     my $itemtype = $item_object->effective_itemtype;
2888     unless ($datedue) {
2889
2890         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2891                                         dt_from_string( $issue->date_due, 'sql' ) :
2892                                         DateTime->now( time_zone => C4::Context->tz());
2893         $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
2894     }
2895
2896     my $fees = Koha::Charges::Fees->new(
2897         {
2898             patron    => $patron,
2899             library   => $circ_library,
2900             item      => $item_object,
2901             from_date => dt_from_string( $issue->date_due, 'sql' ),
2902             to_date   => dt_from_string($datedue),
2903         }
2904     );
2905
2906     # Update the issues record to have the new due date, and a new count
2907     # of how many times it has been renewed.
2908     my $renews = $issue->renewals + 1;
2909     my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2910                             WHERE borrowernumber=?
2911                             AND itemnumber=?"
2912     );
2913
2914     $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2915
2916     # Update the renewal count on the item, and tell zebra to reindex
2917     $renews = $item_object->renewals + 1;
2918     ModItem( { renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $item_object->biblionumber, $itemnumber, { log_action => 0 } );
2919
2920     # Charge a new rental fee, if applicable
2921     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2922     if ( $charge > 0 ) {
2923         my $description = "Renewal of Rental Item " . $biblio->title . " " .$item_object->barcode;
2924         AddIssuingCharge($issue, $charge, $description);
2925     }
2926
2927     # Charge a new accumulate rental fee, if applicable
2928     my $itemtype_object = Koha::ItemTypes->find( $itemtype );
2929     if ( $itemtype_object ) {
2930         my $accumulate_charge = $fees->accumulate_rentalcharge();
2931         if ( $accumulate_charge > 0 ) {
2932             my $type_desc = "Renewal of Daily Rental Item " . $biblio->title . " $item_unblessed->{'barcode'}";
2933             AddIssuingCharge( $issue, $accumulate_charge, $type_desc )
2934         }
2935         $charge += $accumulate_charge;
2936     }
2937
2938     # Send a renewal slip according to checkout alert preferencei
2939     if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
2940         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2941         my %conditions        = (
2942             branchcode   => $branch,
2943             categorycode => $patron->categorycode,
2944             item_type    => $itemtype,
2945             notification => 'CHECKOUT',
2946         );
2947         if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
2948             SendCirculationAlert(
2949                 {
2950                     type     => 'RENEWAL',
2951                     item     => $item_unblessed,
2952                     borrower => $patron->unblessed,
2953                     branch   => $branch,
2954                 }
2955             );
2956         }
2957     }
2958
2959     # Remove any OVERDUES related debarment if the borrower has no overdues
2960     if ( $patron
2961       && $patron->is_debarred
2962       && ! $patron->has_overdues
2963       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2964     ) {
2965         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2966     }
2967         unless ( C4::Context->interface eq 'opac' ) { #if from opac we are obeying OpacRenewalBranch as calculated in opac-renew.pl
2968             $branch = ( C4::Context->userenv && defined C4::Context->userenv->{branch} ) ? C4::Context->userenv->{branch} : $branch;
2969         }
2970
2971     # Add the renewal to stats
2972     UpdateStats(
2973         {
2974             branch         => $branch,
2975             type           => 'renew',
2976             amount         => $charge,
2977             itemnumber     => $itemnumber,
2978             itemtype       => $itemtype,
2979             location       => $item_object->location,
2980             borrowernumber => $borrowernumber,
2981             ccode          => $item_object->ccode,
2982         }
2983     );
2984
2985     #Log the renewal
2986     logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
2987     return $datedue;
2988 }
2989
2990 sub GetRenewCount {
2991     # check renewal status
2992     my ( $bornum, $itemno ) = @_;
2993     my $dbh           = C4::Context->dbh;
2994     my $renewcount    = 0;
2995     my $renewsallowed = 0;
2996     my $renewsleft    = 0;
2997
2998     my $patron = Koha::Patrons->find( $bornum );
2999     my $item   = Koha::Items->find($itemno);
3000
3001     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3002
3003     # Look in the issues table for this item, lent to this borrower,
3004     # and not yet returned.
3005
3006     # FIXME - I think this function could be redone to use only one SQL call.
3007     my $sth = $dbh->prepare(
3008         "select * from issues
3009                                 where (borrowernumber = ?)
3010                                 and (itemnumber = ?)"
3011     );
3012     $sth->execute( $bornum, $itemno );
3013     my $data = $sth->fetchrow_hashref;
3014     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3015     # $item and $borrower should be calculated
3016     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3017
3018     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3019         {   categorycode => $patron->categorycode,
3020             itemtype     => $item->effective_itemtype,
3021             branchcode   => $branchcode
3022         }
3023     );
3024
3025     $renewsallowed = $issuing_rule ? $issuing_rule->renewalsallowed : 0;
3026     $renewsleft    = $renewsallowed - $renewcount;
3027     if($renewsleft < 0){ $renewsleft = 0; }
3028     return ( $renewcount, $renewsallowed, $renewsleft );
3029 }
3030
3031 =head2 GetSoonestRenewDate
3032
3033   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3034
3035 Find out the soonest possible renew date of a borrowed item.
3036
3037 C<$borrowernumber> is the borrower number of the patron who currently
3038 has the item on loan.
3039
3040 C<$itemnumber> is the number of the item to renew.
3041
3042 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3043 renew date, based on the value "No renewal before" of the applicable
3044 issuing rule. Returns the current date if the item can already be
3045 renewed, and returns undefined if the borrower, loan, or item
3046 cannot be found.
3047
3048 =cut
3049
3050 sub GetSoonestRenewDate {
3051     my ( $borrowernumber, $itemnumber ) = @_;
3052
3053     my $dbh = C4::Context->dbh;
3054
3055     my $item      = Koha::Items->find($itemnumber)      or return;
3056     my $itemissue = $item->checkout or return;
3057
3058     $borrowernumber ||= $itemissue->borrowernumber;
3059     my $patron = Koha::Patrons->find( $borrowernumber )
3060       or return;
3061
3062     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3063     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3064         {   categorycode => $patron->categorycode,
3065             itemtype     => $item->effective_itemtype,
3066             branchcode   => $branchcode
3067         }
3068     );
3069
3070     my $now = dt_from_string;
3071     return $now unless $issuing_rule;
3072
3073     if ( defined $issuing_rule->norenewalbefore
3074         and $issuing_rule->norenewalbefore ne "" )
3075     {
3076         my $soonestrenewal =
3077           dt_from_string( $itemissue->date_due )->subtract(
3078             $issuing_rule->lengthunit => $issuing_rule->norenewalbefore );
3079
3080         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3081             and $issuing_rule->lengthunit eq 'days' )
3082         {
3083             $soonestrenewal->truncate( to => 'day' );
3084         }
3085         return $soonestrenewal if $now < $soonestrenewal;
3086     }
3087     return $now;
3088 }
3089
3090 =head2 GetLatestAutoRenewDate
3091
3092   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3093
3094 Find out the latest possible auto renew date of a borrowed item.
3095
3096 C<$borrowernumber> is the borrower number of the patron who currently
3097 has the item on loan.
3098
3099 C<$itemnumber> is the number of the item to renew.
3100
3101 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3102 auto renew date, based on the value "No auto renewal after" and the "No auto
3103 renewal after (hard limit) of the applicable issuing rule.
3104 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3105 or item cannot be found.
3106
3107 =cut
3108
3109 sub GetLatestAutoRenewDate {
3110     my ( $borrowernumber, $itemnumber ) = @_;
3111
3112     my $dbh = C4::Context->dbh;
3113
3114     my $item      = Koha::Items->find($itemnumber)  or return;
3115     my $itemissue = $item->checkout                 or return;
3116
3117     $borrowernumber ||= $itemissue->borrowernumber;
3118     my $patron = Koha::Patrons->find( $borrowernumber )
3119       or return;
3120
3121     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3122     my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule(
3123         {   categorycode => $patron->categorycode,
3124             itemtype     => $item->effective_itemtype,
3125             branchcode   => $branchcode
3126         }
3127     );
3128
3129     return unless $issuing_rule;
3130     return
3131       if ( not $issuing_rule->no_auto_renewal_after
3132             or $issuing_rule->no_auto_renewal_after eq '' )
3133       and ( not $issuing_rule->no_auto_renewal_after_hard_limit
3134              or $issuing_rule->no_auto_renewal_after_hard_limit eq '' );
3135
3136     my $maximum_renewal_date;
3137     if ( $issuing_rule->no_auto_renewal_after ) {
3138         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3139         $maximum_renewal_date->add(
3140             $issuing_rule->lengthunit => $issuing_rule->no_auto_renewal_after
3141         );
3142     }
3143
3144     if ( $issuing_rule->no_auto_renewal_after_hard_limit ) {
3145         my $dt = dt_from_string( $issuing_rule->no_auto_renewal_after_hard_limit );
3146         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3147     }
3148     return $maximum_renewal_date;
3149 }
3150
3151
3152 =head2 GetIssuingCharges
3153
3154   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3155
3156 Calculate how much it would cost for a given patron to borrow a given
3157 item, including any applicable discounts.
3158
3159 C<$itemnumber> is the item number of item the patron wishes to borrow.
3160
3161 C<$borrowernumber> is the patron's borrower number.
3162
3163 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3164 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3165 if it's a video).
3166
3167 =cut
3168
3169 sub GetIssuingCharges {
3170
3171     # calculate charges due
3172     my ( $itemnumber, $borrowernumber ) = @_;
3173     my $charge = 0;
3174     my $dbh    = C4::Context->dbh;
3175     my $item_type;
3176
3177     # Get the book's item type and rental charge (via its biblioitem).
3178     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3179         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3180     $charge_query .= (C4::Context->preference('item-level_itypes'))
3181         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3182         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3183
3184     $charge_query .= ' WHERE items.itemnumber =?';
3185
3186     my $sth = $dbh->prepare($charge_query);
3187     $sth->execute($itemnumber);
3188     if ( my $item_data = $sth->fetchrow_hashref ) {
3189         $item_type = $item_data->{itemtype};
3190         $charge    = $item_data->{rentalcharge};
3191         my $branch = C4::Context::mybranch();
3192         my $discount_query = q|SELECT rentaldiscount,
3193             issuingrules.itemtype, issuingrules.branchcode
3194             FROM borrowers
3195             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3196             WHERE borrowers.borrowernumber = ?
3197             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3198             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3199         my $discount_sth = $dbh->prepare($discount_query);
3200         $discount_sth->execute( $borrowernumber, $item_type, $branch );
3201         my $discount_rules = $discount_sth->fetchall_arrayref({});
3202         if (@{$discount_rules}) {
3203             # We may have multiple rules so get the most specific
3204             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3205             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3206         }
3207         if ($charge) {
3208             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3209         }
3210     }
3211
3212     return ( $charge, $item_type );
3213 }
3214
3215 # Select most appropriate discount rule from those returned
3216 sub _get_discount_from_rule {
3217     my ($rules_ref, $branch, $itemtype) = @_;
3218     my $discount;
3219
3220     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3221         $discount = $rules_ref->[0]->{rentaldiscount};
3222         return (defined $discount) ? $discount : 0;
3223     }
3224     # could have up to 4 does one match $branch and $itemtype
3225     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3226     if (@d) {
3227         $discount = $d[0]->{rentaldiscount};
3228         return (defined $discount) ? $discount : 0;
3229     }
3230     # do we have item type + all branches
3231     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3232     if (@d) {
3233         $discount = $d[0]->{rentaldiscount};
3234         return (defined $discount) ? $discount : 0;
3235     }
3236     # do we all item types + this branch
3237     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3238     if (@d) {
3239         $discount = $d[0]->{rentaldiscount};
3240         return (defined $discount) ? $discount : 0;
3241     }
3242     # so all and all (surely we wont get here)
3243     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3244     if (@d) {
3245         $discount = $d[0]->{rentaldiscount};
3246         return (defined $discount) ? $discount : 0;
3247     }
3248     # none of the above
3249     return 0;
3250 }
3251
3252 =head2 AddIssuingCharge
3253
3254   &AddIssuingCharge( $checkout, $charge, [$description] )
3255
3256 =cut
3257
3258 sub AddIssuingCharge {
3259     my ( $checkout, $charge, $description ) = @_;
3260
3261     # FIXME What if checkout does not exist?
3262
3263     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3264     my $accountline = $account->add_debit(
3265         {
3266             amount      => $charge,
3267             description => $description,
3268             note        => undef,
3269             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3270             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3271             interface   => C4::Context->interface,
3272             type        => 'rent',
3273             item_id     => $checkout->itemnumber,
3274             issue_id    => $checkout->issue_id,
3275         }
3276     );
3277 }
3278
3279 =head2 GetTransfers
3280
3281   GetTransfers($itemnumber);
3282
3283 =cut
3284
3285 sub GetTransfers {
3286     my ($itemnumber) = @_;
3287
3288     my $dbh = C4::Context->dbh;
3289
3290     my $query = '
3291         SELECT datesent,
3292                frombranch,
3293                tobranch,
3294                branchtransfer_id
3295         FROM branchtransfers
3296         WHERE itemnumber = ?
3297           AND datearrived IS NULL
3298         ';
3299     my $sth = $dbh->prepare($query);
3300     $sth->execute($itemnumber);
3301     my @row = $sth->fetchrow_array();
3302     return @row;
3303 }
3304
3305 =head2 GetTransfersFromTo
3306
3307   @results = GetTransfersFromTo($frombranch,$tobranch);
3308
3309 Returns the list of pending transfers between $from and $to branch
3310
3311 =cut
3312
3313 sub GetTransfersFromTo {
3314     my ( $frombranch, $tobranch ) = @_;
3315     return unless ( $frombranch && $tobranch );
3316     my $dbh   = C4::Context->dbh;
3317     my $query = "
3318         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3319         FROM   branchtransfers
3320         WHERE  frombranch=?
3321           AND  tobranch=?
3322           AND datearrived IS NULL
3323     ";
3324     my $sth = $dbh->prepare($query);
3325     $sth->execute( $frombranch, $tobranch );
3326     my @gettransfers;
3327
3328     while ( my $data = $sth->fetchrow_hashref ) {
3329         push @gettransfers, $data;
3330     }
3331     return (@gettransfers);
3332 }
3333
3334 =head2 DeleteTransfer
3335
3336   &DeleteTransfer($itemnumber);
3337
3338 =cut
3339
3340 sub DeleteTransfer {
3341     my ($itemnumber) = @_;
3342     return unless $itemnumber;
3343     my $dbh          = C4::Context->dbh;
3344     my $sth          = $dbh->prepare(
3345         "DELETE FROM branchtransfers
3346          WHERE itemnumber=?
3347          AND datearrived IS NULL "
3348     );
3349     return $sth->execute($itemnumber);
3350 }
3351
3352 =head2 SendCirculationAlert
3353
3354 Send out a C<check-in> or C<checkout> alert using the messaging system.
3355
3356 B<Parameters>:
3357
3358 =over 4
3359
3360 =item type
3361
3362 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3363
3364 =item item
3365
3366 Hashref of information about the item being checked in or out.
3367
3368 =item borrower
3369
3370 Hashref of information about the borrower of the item.
3371
3372 =item branch
3373
3374 The branchcode from where the checkout or check-in took place.
3375
3376 =back
3377
3378 B<Example>:
3379
3380     SendCirculationAlert({
3381         type     => 'CHECKOUT',
3382         item     => $item,
3383         borrower => $borrower,
3384         branch   => $branch,
3385     });
3386
3387 =cut
3388
3389 sub SendCirculationAlert {
3390     my ($opts) = @_;
3391     my ($type, $item, $borrower, $branch) =
3392         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3393     my %message_name = (
3394         CHECKIN  => 'Item_Check_in',
3395         CHECKOUT => 'Item_Checkout',
3396         RENEWAL  => 'Item_Checkout',
3397     );
3398     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3399         borrowernumber => $borrower->{borrowernumber},
3400         message_name   => $message_name{$type},
3401     });
3402     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3403
3404     my $schema = Koha::Database->new->schema;
3405     my @transports = keys %{ $borrower_preferences->{transports} };
3406
3407     # From the MySQL doc:
3408     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3409     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3410     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3411     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_NO_TABLE_LOCKS};
3412
3413     for my $mtt (@transports) {
3414         my $letter =  C4::Letters::GetPreparedLetter (
3415             module => 'circulation',
3416             letter_code => $type,
3417             branchcode => $branch,
3418             message_transport_type => $mtt,
3419             lang => $borrower->{lang},
3420             tables => {
3421                 $issues_table => $item->{itemnumber},
3422                 'items'       => $item->{itemnumber},
3423                 'biblio'      => $item->{biblionumber},
3424                 'biblioitems' => $item->{biblionumber},
3425                 'borrowers'   => $borrower,
3426                 'branches'    => $branch,
3427             }
3428         ) or next;
3429
3430         $schema->storage->txn_begin;
3431         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3432         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3433         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3434         unless ( $message ) {
3435             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3436             C4::Message->enqueue($letter, $borrower, $mtt);
3437         } else {
3438             $message->append($letter);
3439             $message->update;
3440         }
3441         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3442         $schema->storage->txn_commit;
3443     }
3444
3445     return;
3446 }
3447
3448 =head2 updateWrongTransfer
3449
3450   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3451
3452 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
3453
3454 =cut
3455
3456 sub updateWrongTransfer {
3457         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3458         my $dbh = C4::Context->dbh;
3459 # first step validate the actual line of transfert .
3460         my $sth =
3461                 $dbh->prepare(
3462                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3463                 );
3464                 $sth->execute($FromLibrary,$itemNumber);
3465
3466 # second step create a new line of branchtransfer to the right location .
3467         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3468
3469 #third step changing holdingbranch of item
3470         UpdateHoldingbranch($FromLibrary,$itemNumber);
3471 }
3472
3473 =head2 UpdateHoldingbranch
3474
3475   $items = UpdateHoldingbranch($branch,$itmenumber);
3476
3477 Simple methode for updating hodlingbranch in items BDD line
3478
3479 =cut
3480
3481 sub UpdateHoldingbranch {
3482         my ( $branch,$itemnumber ) = @_;
3483     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3484 }
3485
3486 =head2 CalcDateDue
3487
3488 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3489
3490 this function calculates the due date given the start date and configured circulation rules,
3491 checking against the holidays calendar as per the 'useDaysMode' syspref.
3492 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3493 C<$itemtype>  = itemtype code of item in question
3494 C<$branch>  = location whose calendar to use
3495 C<$borrower> = Borrower object
3496 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3497
3498 =cut
3499
3500 sub CalcDateDue {
3501     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3502
3503     $isrenewal ||= 0;
3504
3505     # loanlength now a href
3506     my $loanlength =
3507             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3508
3509     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3510             ? qq{renewalperiod}
3511             : qq{issuelength};
3512
3513     my $datedue;
3514     if ( $startdate ) {
3515         if (ref $startdate ne 'DateTime' ) {
3516             $datedue = dt_from_string($datedue);
3517         } else {
3518             $datedue = $startdate->clone;
3519         }
3520     } else {
3521         $datedue =
3522           DateTime->now( time_zone => C4::Context->tz() )
3523           ->truncate( to => 'minute' );
3524     }
3525
3526
3527     # calculate the datedue as normal
3528     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3529     {    # ignoring calendar
3530         if ( $loanlength->{lengthunit} eq 'hours' ) {
3531             $datedue->add( hours => $loanlength->{$length_key} );
3532         } else {    # days
3533             $datedue->add( days => $loanlength->{$length_key} );
3534             $datedue->set_hour(23);
3535             $datedue->set_minute(59);
3536         }
3537     } else {
3538         my $dur;
3539         if ($loanlength->{lengthunit} eq 'hours') {
3540             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3541         }
3542         else { # days
3543             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3544         }
3545         my $calendar = Koha::Calendar->new( branchcode => $branch );
3546         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3547         if ($loanlength->{lengthunit} eq 'days') {
3548             $datedue->set_hour(23);
3549             $datedue->set_minute(59);
3550         }
3551     }
3552
3553     # if Hard Due Dates are used, retrieve them and apply as necessary
3554     my ( $hardduedate, $hardduedatecompare ) =
3555       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3556     if ($hardduedate) {    # hardduedates are currently dates
3557         $hardduedate->truncate( to => 'minute' );
3558         $hardduedate->set_hour(23);
3559         $hardduedate->set_minute(59);
3560         my $cmp = DateTime->compare( $hardduedate, $datedue );
3561
3562 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3563 # if the calculated date is before the 'after' Hard Due Date (floor), override
3564 # if the hard due date is set to 'exactly', overrride
3565         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3566             $datedue = $hardduedate->clone;
3567         }
3568
3569         # in all other cases, keep the date due as it is
3570
3571     }
3572
3573     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3574     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3575         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3576         if( $expiry_dt ) { #skip empty expiry date..
3577             $expiry_dt->set( hour => 23, minute => 59);
3578             my $d1= $datedue->clone->set_time_zone('floating');
3579             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3580                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3581             }
3582         }
3583         if ( C4::Context->preference('useDaysMode') ne 'Days' ) {
3584           my $calendar = Koha::Calendar->new( branchcode => $branch );
3585           if ( $calendar->is_holiday($datedue) ) {
3586               # Don't return on a closed day
3587               $datedue = $calendar->prev_open_day( $datedue );
3588           }
3589         }
3590     }
3591
3592     return $datedue;
3593 }
3594
3595
3596 sub CheckValidBarcode{
3597 my ($barcode) = @_;
3598 my $dbh = C4::Context->dbh;
3599 my $query=qq|SELECT count(*)
3600              FROM items
3601              WHERE barcode=?
3602             |;
3603 my $sth = $dbh->prepare($query);
3604 $sth->execute($barcode);
3605 my $exist=$sth->fetchrow ;
3606 return $exist;
3607 }
3608
3609 =head2 IsBranchTransferAllowed
3610
3611   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3612
3613 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3614
3615 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3616 Koha::Item->can_be_transferred.
3617
3618 =cut
3619
3620 sub IsBranchTransferAllowed {
3621         my ( $toBranch, $fromBranch, $code ) = @_;
3622
3623         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3624
3625         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3626         my $dbh = C4::Context->dbh;
3627
3628         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3629         $sth->execute( $toBranch, $fromBranch, $code );
3630         my $limit = $sth->fetchrow_hashref();
3631
3632         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3633         if ( $limit->{'limitId'} ) {
3634                 return 0;
3635         } else {
3636                 return 1;
3637         }
3638 }
3639
3640 =head2 CreateBranchTransferLimit
3641
3642   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3643
3644 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3645
3646 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3647
3648 =cut
3649
3650 sub CreateBranchTransferLimit {
3651    my ( $toBranch, $fromBranch, $code ) = @_;
3652    return unless defined($toBranch) && defined($fromBranch);
3653    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3654
3655    my $dbh = C4::Context->dbh;
3656
3657    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3658    return $sth->execute( $code, $toBranch, $fromBranch );
3659 }
3660
3661 =head2 DeleteBranchTransferLimits
3662
3663     my $result = DeleteBranchTransferLimits($frombranch);
3664
3665 Deletes all the library transfer limits for one library.  Returns the
3666 number of limits deleted, 0e0 if no limits were deleted, or undef if
3667 no arguments are supplied.
3668
3669 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3670     fromBranch => $fromBranch
3671     })->delete.
3672
3673 =cut
3674
3675 sub DeleteBranchTransferLimits {
3676     my $branch = shift;
3677     return unless defined $branch;
3678     my $dbh    = C4::Context->dbh;
3679     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3680     return $sth->execute($branch);
3681 }
3682
3683 sub ReturnLostItem{
3684     my ( $borrowernumber, $itemnum ) = @_;
3685
3686     MarkIssueReturned( $borrowernumber, $itemnum );
3687     my $patron = Koha::Patrons->find( $borrowernumber );
3688     my $item = Koha::Items->find($itemnum);
3689     my $old_note = ($item->paidfor && ($item->paidfor ne q{})) ? $item->paidfor.' / ' : q{};
3690     my @datearr = localtime(time);
3691     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3692     my $bor = $patron->firstname . ' ' . $patron->surname . ' ' . $patron->cardnumber;
3693     ModItem({ paidfor =>  $old_note."Paid for by $bor $date" }, undef, $itemnum);
3694 }
3695
3696
3697 sub LostItem{
3698     my ($itemnumber, $mark_lost_from, $force_mark_returned) = @_;
3699
3700     unless ( $mark_lost_from ) {
3701         # Temporary check to avoid regressions
3702         die q|LostItem called without $mark_lost_from, check the API.|;
3703     }
3704
3705     my $mark_returned;
3706     if ( $force_mark_returned ) {
3707         $mark_returned = 1;
3708     } else {
3709         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3710         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3711     }
3712
3713     my $dbh = C4::Context->dbh();
3714     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3715                            FROM issues
3716                            JOIN items USING (itemnumber)
3717                            JOIN biblio USING (biblionumber)
3718                            WHERE issues.itemnumber=?");
3719     $sth->execute($itemnumber);
3720     my $issues=$sth->fetchrow_hashref();
3721
3722     # If a borrower lost the item, add a replacement cost to the their record
3723     if ( my $borrowernumber = $issues->{borrowernumber} ){
3724         my $patron = Koha::Patrons->find( $borrowernumber );
3725
3726         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 0); # 1, 0 = exemptfine, no-dropbox
3727         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3728
3729         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3730             C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "$issues->{'title'} $issues->{'barcode'} $issues->{'itemcallnumber'}");
3731             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3732             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3733         }
3734
3735         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3736     }
3737
3738     #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3739     if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3740         ModItem({holdingbranch => $frombranch}, undef, $itemnumber);
3741     }
3742     my $transferdeleted = DeleteTransfer($itemnumber);
3743 }
3744
3745 sub GetOfflineOperations {
3746     my $dbh = C4::Context->dbh;
3747     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3748     $sth->execute(C4::Context->userenv->{'branch'});
3749     my $results = $sth->fetchall_arrayref({});
3750     return $results;
3751 }
3752
3753 sub GetOfflineOperation {
3754     my $operationid = shift;
3755     return unless $operationid;
3756     my $dbh = C4::Context->dbh;
3757     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3758     $sth->execute( $operationid );
3759     return $sth->fetchrow_hashref;
3760 }
3761
3762 sub AddOfflineOperation {
3763     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3764     my $dbh = C4::Context->dbh;
3765     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3766     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3767     return "Added.";
3768 }
3769
3770 sub DeleteOfflineOperation {
3771     my $dbh = C4::Context->dbh;
3772     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3773     $sth->execute( shift );
3774     return "Deleted.";
3775 }
3776
3777 sub ProcessOfflineOperation {
3778     my $operation = shift;
3779
3780     my $report;
3781     if ( $operation->{action} eq 'return' ) {
3782         $report = ProcessOfflineReturn( $operation );
3783     } elsif ( $operation->{action} eq 'issue' ) {
3784         $report = ProcessOfflineIssue( $operation );
3785     } elsif ( $operation->{action} eq 'payment' ) {
3786         $report = ProcessOfflinePayment( $operation );
3787     }
3788
3789     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3790
3791     return $report;
3792 }
3793
3794 sub ProcessOfflineReturn {
3795     my $operation = shift;
3796
3797     my $item = Koha::Items->find({barcode => $operation->{barcode}});
3798
3799     if ( $item ) {
3800         my $itemnumber = $item->itemnumber;
3801         my $issue = GetOpenIssue( $itemnumber );
3802         if ( $issue ) {
3803             MarkIssueReturned(
3804                 $issue->{borrowernumber},
3805                 $itemnumber,
3806                 $operation->{timestamp},
3807             );
3808             ModItem(
3809                 { renewals => 0, onloan => undef },
3810                 $issue->{'biblionumber'},
3811                 $itemnumber,
3812                 { log_action => 0 }
3813             );
3814             return "Success.";
3815         } else {
3816             return "Item not issued.";
3817         }
3818     } else {
3819         return "Item not found.";
3820     }
3821 }
3822
3823 sub ProcessOfflineIssue {
3824     my $operation = shift;
3825
3826     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
3827
3828     if ( $patron ) {
3829         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
3830         unless ($item) {
3831             return "Barcode not found.";
3832         }
3833         my $itemnumber = $item->itemnumber;
3834         my $issue = GetOpenIssue( $itemnumber );
3835
3836         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
3837             MarkIssueReturned(
3838                 $issue->{borrowernumber},
3839                 $itemnumber,
3840                 $operation->{timestamp},
3841             );
3842         }
3843         AddIssue(
3844             $patron->unblessed,
3845             $operation->{'barcode'},
3846             undef,
3847             1,
3848             $operation->{timestamp},
3849             undef,
3850         );
3851         return "Success.";
3852     } else {
3853         return "Borrower not found.";
3854     }
3855 }
3856
3857 sub ProcessOfflinePayment {
3858     my $operation = shift;
3859
3860     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
3861
3862     $patron->account->pay(
3863         {
3864             amount     => $operation->{amount},
3865             library_id => $operation->{branchcode},
3866             interface  => 'koc'
3867         }
3868     );
3869
3870     return "Success.";
3871 }
3872
3873 =head2 TransferSlip
3874
3875   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3876
3877   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3878
3879 =cut
3880
3881 sub TransferSlip {
3882     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3883
3884     my $item =
3885       $itemnumber
3886       ? Koha::Items->find($itemnumber)
3887       : Koha::Items->find( { barcode => $barcode } );
3888
3889     $item or return;
3890
3891     return C4::Letters::GetPreparedLetter (
3892         module => 'circulation',
3893         letter_code => 'TRANSFERSLIP',
3894         branchcode => $branch,
3895         tables => {
3896             'branches'    => $to_branch,
3897             'biblio'      => $item->biblionumber,
3898             'items'       => $item->unblessed,
3899         },
3900     );
3901 }
3902
3903 =head2 CheckIfIssuedToPatron
3904
3905   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3906
3907   Return 1 if any record item is issued to patron, otherwise return 0
3908
3909 =cut
3910
3911 sub CheckIfIssuedToPatron {
3912     my ($borrowernumber, $biblionumber) = @_;
3913
3914     my $dbh = C4::Context->dbh;
3915     my $query = q|
3916         SELECT COUNT(*) FROM issues
3917         LEFT JOIN items ON items.itemnumber = issues.itemnumber
3918         WHERE items.biblionumber = ?
3919         AND issues.borrowernumber = ?
3920     |;
3921     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3922     return 1 if $is_issued;
3923     return;
3924 }
3925
3926 =head2 IsItemIssued
3927
3928   IsItemIssued( $itemnumber )
3929
3930   Return 1 if the item is on loan, otherwise return 0
3931
3932 =cut
3933
3934 sub IsItemIssued {
3935     my $itemnumber = shift;
3936     my $dbh = C4::Context->dbh;
3937     my $sth = $dbh->prepare(q{
3938         SELECT COUNT(*)
3939         FROM issues
3940         WHERE itemnumber = ?
3941     });
3942     $sth->execute($itemnumber);
3943     return $sth->fetchrow;
3944 }
3945
3946 =head2 GetAgeRestriction
3947
3948   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3949   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3950
3951   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
3952   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3953
3954 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3955 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3956 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3957          Negative days mean the borrower has gone past the age restriction age.
3958
3959 =cut
3960
3961 sub GetAgeRestriction {
3962     my ($record_restrictions, $borrower) = @_;
3963     my $markers = C4::Context->preference('AgeRestrictionMarker');
3964
3965     # Split $record_restrictions to something like FSK 16 or PEGI 6
3966     my @values = split ' ', uc($record_restrictions);
3967     return unless @values;
3968
3969     # Search first occurrence of one of the markers
3970     my @markers = split /\|/, uc($markers);
3971     return unless @markers;
3972
3973     my $index            = 0;
3974     my $restriction_year = 0;
3975     for my $value (@values) {
3976         $index++;
3977         for my $marker (@markers) {
3978             $marker =~ s/^\s+//;    #remove leading spaces
3979             $marker =~ s/\s+$//;    #remove trailing spaces
3980             if ( $marker eq $value ) {
3981                 if ( $index <= $#values ) {
3982                     $restriction_year += $values[$index];
3983                 }
3984                 last;
3985             }
3986             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3987
3988                 # Perhaps it is something like "K16" (as in Finland)
3989                 $restriction_year += $1;
3990                 last;
3991             }
3992         }
3993         last if ( $restriction_year > 0 );
3994     }
3995
3996     #Check if the borrower is age restricted for this material and for how long.
3997     if ($restriction_year && $borrower) {
3998         if ( $borrower->{'dateofbirth'} ) {
3999             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4000             $alloweddate[0] += $restriction_year;
4001
4002             #Prevent runime eror on leap year (invalid date)
4003             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4004                 $alloweddate[2] = 28;
4005             }
4006
4007             #Get how many days the borrower has to reach the age restriction
4008             my @Today = split /-/, DateTime->today->ymd();
4009             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4010             #Negative days means the borrower went past the age restriction age
4011             return ($restriction_year, $daysToAgeRestriction);
4012         }
4013     }
4014
4015     return ($restriction_year);
4016 }
4017
4018
4019 =head2 GetPendingOnSiteCheckouts
4020
4021 =cut
4022
4023 sub GetPendingOnSiteCheckouts {
4024     my $dbh = C4::Context->dbh;
4025     return $dbh->selectall_arrayref(q|
4026         SELECT
4027           items.barcode,
4028           items.biblionumber,
4029           items.itemnumber,
4030           items.itemnotes,
4031           items.itemcallnumber,
4032           items.location,
4033           issues.date_due,
4034           issues.branchcode,
4035           issues.date_due < NOW() AS is_overdue,
4036           biblio.author,
4037           biblio.title,
4038           borrowers.firstname,
4039           borrowers.surname,
4040           borrowers.cardnumber,
4041           borrowers.borrowernumber
4042         FROM items
4043         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4044         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4045         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4046         WHERE issues.onsite_checkout = 1
4047     |, { Slice => {} } );
4048 }
4049
4050 sub GetTopIssues {
4051     my ($params) = @_;
4052
4053     my ($count, $branch, $itemtype, $ccode, $newness)
4054         = @$params{qw(count branch itemtype ccode newness)};
4055
4056     my $dbh = C4::Context->dbh;
4057     my $query = q{
4058         SELECT * FROM (
4059         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4060           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4061           i.ccode, SUM(i.issues) AS count
4062         FROM biblio b
4063         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4064         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4065     };
4066
4067     my (@where_strs, @where_args);
4068
4069     if ($branch) {
4070         push @where_strs, 'i.homebranch = ?';
4071         push @where_args, $branch;
4072     }
4073     if ($itemtype) {
4074         if (C4::Context->preference('item-level_itypes')){
4075             push @where_strs, 'i.itype = ?';
4076             push @where_args, $itemtype;
4077         } else {
4078             push @where_strs, 'bi.itemtype = ?';
4079             push @where_args, $itemtype;
4080         }
4081     }
4082     if ($ccode) {
4083         push @where_strs, 'i.ccode = ?';
4084         push @where_args, $ccode;
4085     }
4086     if ($newness) {
4087         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4088         push @where_args, $newness;
4089     }
4090
4091     if (@where_strs) {
4092         $query .= 'WHERE ' . join(' AND ', @where_strs);
4093     }
4094
4095     $query .= q{
4096         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4097           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4098           i.ccode
4099         ORDER BY count DESC
4100     };
4101
4102     $query .= q{ ) xxx WHERE count > 0 };
4103     $count = int($count);
4104     if ($count > 0) {
4105         $query .= "LIMIT $count";
4106     }
4107
4108     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4109
4110     return @$rows;
4111 }
4112
4113 sub _CalculateAndUpdateFine {
4114     my ($params) = @_;
4115
4116     my $borrower    = $params->{borrower};
4117     my $item        = $params->{item};
4118     my $issue       = $params->{issue};
4119     my $return_date = $params->{return_date};
4120
4121     unless ($borrower) { carp "No borrower passed in!" && return; }
4122     unless ($item)     { carp "No item passed in!"     && return; }
4123     unless ($issue)    { carp "No issue passed in!"    && return; }
4124
4125     my $datedue = dt_from_string( $issue->date_due );
4126
4127     # we only need to calculate and change the fines if we want to do that on return
4128     # Should be on for hourly loans
4129     my $control = C4::Context->preference('CircControl');
4130     my $control_branchcode =
4131         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4132       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4133       :                                     $issue->branchcode;
4134
4135     my $date_returned = $return_date ? $return_date : dt_from_string();
4136
4137     my ( $amount, $unitcounttotal, $unitcount  ) =
4138       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4139
4140     if ( C4::Context->preference('finesMode') eq 'production' ) {
4141         if ( $amount > 0 ) {
4142             C4::Overdues::UpdateFine({
4143                 issue_id       => $issue->issue_id,
4144                 itemnumber     => $issue->itemnumber,
4145                 borrowernumber => $issue->borrowernumber,
4146                 amount         => $amount,
4147                 due            => output_pref($datedue),
4148             });
4149         }
4150         elsif ($return_date) {
4151
4152             # Backdated returns may have fines that shouldn't exist,
4153             # so in this case, we need to drop those fines to 0
4154
4155             C4::Overdues::UpdateFine({
4156                 issue_id       => $issue->issue_id,
4157                 itemnumber     => $issue->itemnumber,
4158                 borrowernumber => $issue->borrowernumber,
4159                 amount         => 0,
4160                 due            => output_pref($datedue),
4161             });
4162         }
4163     }
4164 }
4165
4166 sub _item_denied_renewal {
4167     my ($params) = @_;
4168
4169     my $item = $params->{item};
4170     return unless $item;
4171
4172     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4173     return unless $denyingrules;
4174     foreach my $field (keys %$denyingrules) {
4175         my $val = $item->$field;
4176         if( !defined $val) {
4177             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4178                 return 1;
4179             }
4180         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4181            # If the results matches the values in the syspref
4182            # We return true if match found
4183             return 1;
4184         }
4185     }
4186     return 0;
4187 }
4188
4189
4190 1;
4191
4192 __END__
4193
4194 =head1 AUTHOR
4195
4196 Koha Development Team <http://koha-community.org/>
4197
4198 =cut