C4/Circulation.pm

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