C4/Circulation.pm

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