C4/Circulation.pm

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