C4/Circulation.pm

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