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