C4/Circulation.pm

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