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