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