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