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