C4/Circulation.pm

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