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, $dropboxdate ) = @_;
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'}, $dropboxdate ) == -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             $today = $dropboxdate if $dropbox;
1954             my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1955             if ($reminder){
1956                 $messages->{'PrevDebarred'} = $debardate;
1957             } else {
1958                 $messages->{'Debarred'} = $debardate if $debardate;
1959             }
1960         # there's no overdue on the item but borrower had been previously debarred
1961         } elsif ( $issue->{date_due} and $borrower->{'debarred'} ) {
1962              if ( $borrower->{debarred} eq "9999-12-31") {
1963                 $messages->{'ForeverDebarred'} = $borrower->{'debarred'};
1964              } else {
1965                   my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
1966                   $borrower_debar_dt->truncate(to => 'day');
1967                   my $today_dt = $today->clone()->truncate(to => 'day');
1968                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
1969                       $messages->{'PrevDebarred'} = $borrower->{'debarred'};
1970                   }
1971              }
1972         }
1973     }
1974
1975     # find reserves.....
1976     # if we don't have a reserve with the status W, we launch the Checkreserves routine
1977     my ($resfound, $resrec);
1978     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1979     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
1980     if ($resfound) {
1981           $resrec->{'ResFound'} = $resfound;
1982         $messages->{'ResFound'} = $resrec;
1983     }
1984
1985     # Record the fact that this book was returned.
1986     # FIXME itemtype should record item level type, not bibliolevel type
1987     UpdateStats({
1988                 branch => $branch,
1989                 type => $stat_type,
1990                 itemnumber => $item->{'itemnumber'},
1991                 itemtype => $biblio->{'itemtype'},
1992                 borrowernumber => $borrowernumber,
1993                 ccode => $item->{'ccode'}}
1994     );
1995
1996     # Send a check-in slip. # NOTE: borrower may be undef.  probably shouldn't try to send messages then.
1997     my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1998     my %conditions = (
1999         branchcode   => $branch,
2000         categorycode => $borrower->{categorycode},
2001         item_type    => $item->{itype},
2002         notification => 'CHECKIN',
2003     );
2004     if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2005         SendCirculationAlert({
2006             type     => 'CHECKIN',
2007             item     => $item,
2008             borrower => $borrower,
2009             branch   => $branch,
2010         });
2011     }
2012
2013     logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2014         if C4::Context->preference("ReturnLog");
2015
2016     # Remove any OVERDUES related debarment if the borrower has no overdues
2017     if ( $borrowernumber
2018       && $borrower->{'debarred'}
2019       && C4::Context->preference('AutoRemoveOverduesRestrictions')
2020       && !HasOverdues( $borrowernumber )
2021       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2022     ) {
2023         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2024     }
2025
2026     # FIXME: make this comment intelligible.
2027     #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
2028     #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
2029
2030     if ( !$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
2031         if ( C4::Context->preference("AutomaticItemReturn"    ) or
2032             (C4::Context->preference("UseBranchTransferLimits") and
2033              ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2034            )) {
2035             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
2036             $debug and warn "item: " . Dumper($item);
2037             ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
2038             $messages->{'WasTransfered'} = 1;
2039         } else {
2040             $messages->{'NeedsTransfer'} = 1;   # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
2041         }
2042     }
2043
2044     return ( $doreturn, $messages, $issue, $borrower );
2045 }
2046
2047 =head2 MarkIssueReturned
2048
2049   MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2050
2051 Unconditionally marks an issue as being returned by
2052 moving the C<issues> row to C<old_issues> and
2053 setting C<returndate> to the current date, or
2054 the last non-holiday date of the branccode specified in
2055 C<dropbox_branch> .  Assumes you've already checked that
2056 it's safe to do this, i.e. last non-holiday > issuedate.
2057
2058 if C<$returndate> is specified (in iso format), it is used as the date
2059 of the return. It is ignored when a dropbox_branch is passed in.
2060
2061 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2062 the old_issue is immediately anonymised
2063
2064 Ideally, this function would be internal to C<C4::Circulation>,
2065 not exported, but it is currently needed by one
2066 routine in C<C4::Accounts>.
2067
2068 =cut
2069
2070 sub MarkIssueReturned {
2071     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2072
2073     my $dbh   = C4::Context->dbh;
2074     my $query = 'UPDATE issues SET returndate=';
2075     my @bind;
2076     if ($dropbox_branch) {
2077         my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2078         my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2079         $query .= ' ? ';
2080         push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2081     } elsif ($returndate) {
2082         $query .= ' ? ';
2083         push @bind, $returndate;
2084     } else {
2085         $query .= ' now() ';
2086     }
2087     $query .= ' WHERE  borrowernumber = ?  AND itemnumber = ?';
2088     push @bind, $borrowernumber, $itemnumber;
2089     # FIXME transaction
2090     my $sth_upd  = $dbh->prepare($query);
2091     $sth_upd->execute(@bind);
2092     my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
2093                                   WHERE borrowernumber = ?
2094                                   AND itemnumber = ?');
2095     $sth_copy->execute($borrowernumber, $itemnumber);
2096     # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2097     if ( $privacy == 2) {
2098         # The default of 0 does not work due to foreign key constraints
2099         # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2100         # FIXME the above is unacceptable - bug 9942 relates
2101         my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2102         my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
2103                                   WHERE borrowernumber = ?
2104                                   AND itemnumber = ?");
2105        $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2106     }
2107     my $sth_del  = $dbh->prepare("DELETE FROM issues
2108                                   WHERE borrowernumber = ?
2109                                   AND itemnumber = ?");
2110     $sth_del->execute($borrowernumber, $itemnumber);
2111
2112     ModItem( { 'onloan' => undef }, undef, $itemnumber );
2113 }
2114
2115 =head2 _debar_user_on_return
2116
2117     _debar_user_on_return($borrower, $item, $datedue, today);
2118
2119 C<$borrower> borrower hashref
2120
2121 C<$item> item hashref
2122
2123 C<$datedue> date due DateTime object
2124
2125 C<$today> DateTime object representing the return time
2126
2127 Internal function, called only by AddReturn that calculates and updates
2128  the user fine days, and debars him if necessary.
2129
2130 Should only be called for overdue returns
2131
2132 =cut
2133
2134 sub _debar_user_on_return {
2135     my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2136
2137     my $branchcode = _GetCircControlBranch( $item, $borrower );
2138     my $calendar = Koha::Calendar->new( branchcode => $branchcode );
2139
2140     # $deltadays is a DateTime::Duration object
2141     my $deltadays = $calendar->days_between( $dt_due, $dt_today );
2142
2143     my $circcontrol = C4::Context->preference('CircControl');
2144     my $issuingrule =
2145       GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2146     my $finedays = $issuingrule->{finedays};
2147     my $unit     = $issuingrule->{lengthunit};
2148
2149     if ($finedays) {
2150
2151         # finedays is in days, so hourly loans must multiply by 24
2152         # thus 1 hour late equals 1 day suspension * finedays rate
2153         $finedays = $finedays * 24 if ( $unit eq 'hours' );
2154
2155         # grace period is measured in the same units as the loan
2156         my $grace =
2157           DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2158
2159         if ( $deltadays->subtract($grace)->is_positive() ) {
2160             my $suspension_days = $deltadays * $finedays;
2161
2162             # If the max suspension days is < than the suspension days
2163             # the suspension days is limited to this maximum period.
2164             my $max_sd = $issuingrule->{maxsuspensiondays};
2165             if ( defined $max_sd ) {
2166                 $max_sd = DateTime::Duration->new( days => $max_sd );
2167                 $suspension_days = $max_sd
2168                   if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2169             }
2170
2171             my $new_debar_dt =
2172               $dt_today->clone()->add_duration( $suspension_days );
2173
2174             Koha::Borrower::Debarments::AddUniqueDebarment({
2175                 borrowernumber => $borrower->{borrowernumber},
2176                 expiration     => $new_debar_dt->ymd(),
2177                 type           => 'SUSPENSION',
2178             });
2179             # if borrower was already debarred but does not get an extra debarment
2180             if ( $borrower->{debarred} eq Koha::Borrower::Debarments::IsDebarred($borrower->{borrowernumber}) ) {
2181                     return ($borrower->{debarred},1);
2182             }
2183             return $new_debar_dt->ymd();
2184         }
2185     }
2186     return;
2187 }
2188
2189 =head2 _FixOverduesOnReturn
2190
2191    &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2192
2193 C<$brn> borrowernumber
2194
2195 C<$itm> itemnumber
2196
2197 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2198 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2199
2200 Internal function, called only by AddReturn
2201
2202 =cut
2203
2204 sub _FixOverduesOnReturn {
2205     my ($borrowernumber, $item);
2206     unless ($borrowernumber = shift) {
2207         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2208         return;
2209     }
2210     unless ($item = shift) {
2211         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2212         return;
2213     }
2214     my ($exemptfine, $dropbox) = @_;
2215     my $dbh = C4::Context->dbh;
2216
2217     # check for overdue fine
2218     my $sth = $dbh->prepare(
2219 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2220     );
2221     $sth->execute( $borrowernumber, $item );
2222
2223     # alter fine to show that the book has been returned
2224     my $data = $sth->fetchrow_hashref;
2225     return 0 unless $data;    # no warning, there's just nothing to fix
2226
2227     my $uquery;
2228     my @bind = ($data->{'accountlines_id'});
2229     if ($exemptfine) {
2230         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2231         if (C4::Context->preference("FinesLog")) {
2232             &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2233         }
2234     } elsif ($dropbox && $data->{lastincrement}) {
2235         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2236         my $amt = $data->{amount} - $data->{lastincrement} ;
2237         if (C4::Context->preference("FinesLog")) {
2238             &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2239         }
2240          $uquery = "update accountlines set accounttype='F' ";
2241          if($outstanding  >= 0 && $amt >=0) {
2242             $uquery .= ", amount = ? , amountoutstanding=? ";
2243             unshift @bind, ($amt, $outstanding) ;
2244         }
2245     } else {
2246         $uquery = "update accountlines set accounttype='F' ";
2247     }
2248     $uquery .= " where (accountlines_id = ?)";
2249     my $usth = $dbh->prepare($uquery);
2250     return $usth->execute(@bind);
2251 }
2252
2253 =head2 _FixAccountForLostAndReturned
2254
2255   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2256
2257 Calculates the charge for a book lost and returned.
2258
2259 Internal function, not exported, called only by AddReturn.
2260
2261 FIXME: This function reflects how inscrutable fines logic is.  Fix both.
2262 FIXME: Give a positive return value on success.  It might be the $borrowernumber who received credit, or the amount forgiven.
2263
2264 =cut
2265
2266 sub _FixAccountForLostAndReturned {
2267     my $itemnumber     = shift or return;
2268     my $borrowernumber = @_ ? shift : undef;
2269     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2270     my $dbh = C4::Context->dbh;
2271     # check for charge made for lost book
2272     my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2273     $sth->execute($itemnumber);
2274     my $data = $sth->fetchrow_hashref;
2275     $data or return;    # bail if there is nothing to do
2276     $data->{accounttype} eq 'W' and return;    # Written off
2277
2278     # writeoff this amount
2279     my $offset;
2280     my $amount = $data->{'amount'};
2281     my $acctno = $data->{'accountno'};
2282     my $amountleft;                                             # Starts off undef/zero.
2283     if ($data->{'amountoutstanding'} == $amount) {
2284         $offset     = $data->{'amount'};
2285         $amountleft = 0;                                        # Hey, it's zero here, too.
2286     } else {
2287         $offset     = $amount - $data->{'amountoutstanding'};   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2288         $amountleft = $data->{'amountoutstanding'} - $amount;   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2289     }
2290     my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2291         WHERE (accountlines_id = ?)");
2292     $usth->execute($data->{'accountlines_id'});      # We might be adjusting an account for some OTHER borrowernumber now.  Not the one we passed in.
2293     #check if any credit is left if so writeoff other accounts
2294     my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2295     $amountleft *= -1 if ($amountleft < 0);
2296     if ($amountleft > 0) {
2297         my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2298                             AND (amountoutstanding >0) ORDER BY date");     # might want to order by amountoustanding ASC (pay smallest first)
2299         $msth->execute($data->{'borrowernumber'});
2300         # offset transactions
2301         my $newamtos;
2302         my $accdata;
2303         while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2304             if ($accdata->{'amountoutstanding'} < $amountleft) {
2305                 $newamtos = 0;
2306                 $amountleft -= $accdata->{'amountoutstanding'};
2307             }  else {
2308                 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2309                 $amountleft = 0;
2310             }
2311             my $thisacct = $accdata->{'accountlines_id'};
2312             # FIXME: move prepares outside while loop!
2313             my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2314                     WHERE (accountlines_id = ?)");
2315             $usth->execute($newamtos,$thisacct);
2316             $usth = $dbh->prepare("INSERT INTO accountoffsets
2317                 (borrowernumber, accountno, offsetaccount,  offsetamount)
2318                 VALUES
2319                 (?,?,?,?)");
2320             $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2321         }
2322     }
2323     $amountleft *= -1 if ($amountleft > 0);
2324     my $desc = "Item Returned " . $item_id;
2325     $usth = $dbh->prepare("INSERT INTO accountlines
2326         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2327         VALUES (?,?,now(),?,?,'CR',?)");
2328     $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2329     if ($borrowernumber) {
2330         # FIXME: same as query above.  use 1 sth for both
2331         $usth = $dbh->prepare("INSERT INTO accountoffsets
2332             (borrowernumber, accountno, offsetaccount,  offsetamount)
2333             VALUES (?,?,?,?)");
2334         $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2335     }
2336     ModItem({ paidfor => '' }, undef, $itemnumber);
2337     return;
2338 }
2339
2340 =head2 _GetCircControlBranch
2341
2342    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2343
2344 Internal function :
2345
2346 Return the library code to be used to determine which circulation
2347 policy applies to a transaction.  Looks up the CircControl and
2348 HomeOrHoldingBranch system preferences.
2349
2350 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2351
2352 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2353
2354 =cut
2355
2356 sub _GetCircControlBranch {
2357     my ($item, $borrower) = @_;
2358     my $circcontrol = C4::Context->preference('CircControl');
2359     my $branch;
2360
2361     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2362         $branch= C4::Context->userenv->{'branch'};
2363     } elsif ($circcontrol eq 'PatronLibrary') {
2364         $branch=$borrower->{branchcode};
2365     } else {
2366         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2367         $branch = $item->{$branchfield};
2368         # default to item home branch if holdingbranch is used
2369         # and is not defined
2370         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2371             $branch = $item->{homebranch};
2372         }
2373     }
2374     return $branch;
2375 }
2376
2377
2378
2379
2380
2381
2382 =head2 GetItemIssue
2383
2384   $issue = &GetItemIssue($itemnumber);
2385
2386 Returns patron currently having a book, or undef if not checked out.
2387
2388 C<$itemnumber> is the itemnumber.
2389
2390 C<$issue> is a hashref of the row from the issues table.
2391
2392 =cut
2393
2394 sub GetItemIssue {
2395     my ($itemnumber) = @_;
2396     return unless $itemnumber;
2397     my $sth = C4::Context->dbh->prepare(
2398         "SELECT items.*, issues.*
2399         FROM issues
2400         LEFT JOIN items ON issues.itemnumber=items.itemnumber
2401         WHERE issues.itemnumber=?");
2402     $sth->execute($itemnumber);
2403     my $data = $sth->fetchrow_hashref;
2404     return unless $data;
2405     $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2406     $data->{issuedate}->truncate(to => 'minute');
2407     $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2408     $data->{date_due}->truncate(to => 'minute');
2409     my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2410     $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2411     return $data;
2412 }
2413
2414 =head2 GetOpenIssue
2415
2416   $issue = GetOpenIssue( $itemnumber );
2417
2418 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2419
2420 C<$itemnumber> is the item's itemnumber
2421
2422 Returns a hashref
2423
2424 =cut
2425
2426 sub GetOpenIssue {
2427   my ( $itemnumber ) = @_;
2428   return unless $itemnumber;
2429   my $dbh = C4::Context->dbh;
2430   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2431   $sth->execute( $itemnumber );
2432   return $sth->fetchrow_hashref();
2433
2434 }
2435
2436 =head2 GetIssues
2437
2438     $issues = GetIssues({});    # return all issues!
2439     $issues = GetIssues({ borrowernumber => $borrowernumber, biblionumber => $biblionumber });
2440
2441 Returns all pending issues that match given criteria.
2442 Returns a arrayref or undef if an error occurs.
2443
2444 Allowed criteria are:
2445
2446 =over 2
2447
2448 =item * borrowernumber
2449
2450 =item * biblionumber
2451
2452 =item * itemnumber
2453
2454 =back
2455
2456 =cut
2457
2458 sub GetIssues {
2459     my ($criteria) = @_;
2460
2461     # Build filters
2462     my @filters;
2463     my @allowed = qw(borrowernumber biblionumber itemnumber);
2464     foreach (@allowed) {
2465         if (defined $criteria->{$_}) {
2466             push @filters, {
2467                 field => $_,
2468                 value => $criteria->{$_},
2469             };
2470         }
2471     }
2472
2473     # Do we need to join other tables ?
2474     my %join;
2475     if (defined $criteria->{biblionumber}) {
2476         $join{items} = 1;
2477     }
2478
2479     # Build SQL query
2480     my $where = '';
2481     if (@filters) {
2482         $where = "WHERE " . join(' AND ', map { "$_->{field} = ?" } @filters);
2483     }
2484     my $query = q{
2485         SELECT issues.*
2486         FROM issues
2487     };
2488     if (defined $join{items}) {
2489         $query .= q{
2490             LEFT JOIN items ON (issues.itemnumber = items.itemnumber)
2491         };
2492     }
2493     $query .= $where;
2494
2495     # Execute SQL query
2496     my $dbh = C4::Context->dbh;
2497     my $sth = $dbh->prepare($query);
2498     my $rv = $sth->execute(map { $_->{value} } @filters);
2499
2500     return $rv ? $sth->fetchall_arrayref({}) : undef;
2501 }
2502
2503 =head2 GetItemIssues
2504
2505   $issues = &GetItemIssues($itemnumber, $history);
2506
2507 Returns patrons that have issued a book
2508
2509 C<$itemnumber> is the itemnumber
2510 C<$history> is false if you just want the current "issuer" (if any)
2511 and true if you want issues history from old_issues also.
2512
2513 Returns reference to an array of hashes
2514
2515 =cut
2516
2517 sub GetItemIssues {
2518     my ( $itemnumber, $history ) = @_;
2519
2520     my $today = DateTime->now( time_zome => C4::Context->tz);  # get today date
2521     $today->truncate( to => 'minute' );
2522     my $sql = "SELECT * FROM issues
2523               JOIN borrowers USING (borrowernumber)
2524               JOIN items     USING (itemnumber)
2525               WHERE issues.itemnumber = ? ";
2526     if ($history) {
2527         $sql .= "UNION ALL
2528                  SELECT * FROM old_issues
2529                  LEFT JOIN borrowers USING (borrowernumber)
2530                  JOIN items USING (itemnumber)
2531                  WHERE old_issues.itemnumber = ? ";
2532     }
2533     $sql .= "ORDER BY date_due DESC";
2534     my $sth = C4::Context->dbh->prepare($sql);
2535     if ($history) {
2536         $sth->execute($itemnumber, $itemnumber);
2537     } else {
2538         $sth->execute($itemnumber);
2539     }
2540     my $results = $sth->fetchall_arrayref({});
2541     foreach (@$results) {
2542         my $date_due = dt_from_string($_->{date_due},'sql');
2543         $date_due->truncate( to => 'minute' );
2544
2545         $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2546     }
2547     return $results;
2548 }
2549
2550 =head2 GetBiblioIssues
2551
2552   $issues = GetBiblioIssues($biblionumber);
2553
2554 this function get all issues from a biblionumber.
2555
2556 Return:
2557 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2558 tables issues and the firstname,surname & cardnumber from borrowers.
2559
2560 =cut
2561
2562 sub GetBiblioIssues {
2563     my $biblionumber = shift;
2564     return unless $biblionumber;
2565     my $dbh   = C4::Context->dbh;
2566     my $query = "
2567         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2568         FROM issues
2569             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2570             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2571             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2572             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2573         WHERE biblio.biblionumber = ?
2574         UNION ALL
2575         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2576         FROM old_issues
2577             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2578             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2579             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2580             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2581         WHERE biblio.biblionumber = ?
2582         ORDER BY timestamp
2583     ";
2584     my $sth = $dbh->prepare($query);
2585     $sth->execute($biblionumber, $biblionumber);
2586
2587     my @issues;
2588     while ( my $data = $sth->fetchrow_hashref ) {
2589         push @issues, $data;
2590     }
2591     return \@issues;
2592 }
2593
2594 =head2 GetUpcomingDueIssues
2595
2596   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2597
2598 =cut
2599
2600 sub GetUpcomingDueIssues {
2601     my $params = shift;
2602
2603     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2604     my $dbh = C4::Context->dbh;
2605
2606     my $statement = <<END_SQL;
2607 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2608 FROM issues
2609 LEFT JOIN items USING (itemnumber)
2610 LEFT OUTER JOIN branches USING (branchcode)
2611 WHERE returndate is NULL
2612 HAVING days_until_due >= 0 AND days_until_due <= ?
2613 END_SQL
2614
2615     my @bind_parameters = ( $params->{'days_in_advance'} );
2616
2617     my $sth = $dbh->prepare( $statement );
2618     $sth->execute( @bind_parameters );
2619     my $upcoming_dues = $sth->fetchall_arrayref({});
2620
2621     return $upcoming_dues;
2622 }
2623
2624 =head2 CanBookBeRenewed
2625
2626   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2627
2628 Find out whether a borrowed item may be renewed.
2629
2630 C<$borrowernumber> is the borrower number of the patron who currently
2631 has the item on loan.
2632
2633 C<$itemnumber> is the number of the item to renew.
2634
2635 C<$override_limit>, if supplied with a true value, causes
2636 the limit on the number of times that the loan can be renewed
2637 (as controlled by the item type) to be ignored. Overriding also allows
2638 to renew sooner than "No renewal before" and to manually renew loans
2639 that are automatically renewed.
2640
2641 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2642 item must currently be on loan to the specified borrower; renewals
2643 must be allowed for the item's type; and the borrower must not have
2644 already renewed the loan. $error will contain the reason the renewal can not proceed
2645
2646 =cut
2647
2648 sub CanBookBeRenewed {
2649     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2650
2651     my $dbh    = C4::Context->dbh;
2652     my $renews = 1;
2653
2654     my $item      = GetItem($itemnumber)      or return ( 0, 'no_item' );
2655     my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2656
2657     $borrowernumber ||= $itemissue->{borrowernumber};
2658     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2659       or return;
2660
2661     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2662
2663     # This item can fill one or more unfilled reserve, can those unfilled reserves
2664     # all be filled by other available items?
2665     if ( $resfound
2666         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2667     {
2668         my $schema = Koha::Database->new()->schema();
2669
2670         # Get all other items that could possibly fill reserves
2671         my @itemnumbers = $schema->resultset('Item')->search(
2672             {
2673                 biblionumber => $resrec->{biblionumber},
2674                 onloan       => undef,
2675                 -not         => { itemnumber => $itemnumber }
2676             },
2677             { columns => 'itemnumber' }
2678         )->get_column('itemnumber')->all();
2679
2680         # Get all other reserves that could have been filled by this item
2681         my @borrowernumbers;
2682         while (1) {
2683             my ( $reserve_found, $reserve, undef ) =
2684               C4::Reserves::CheckReserves( $itemnumber, undef, undef,
2685                 \@borrowernumbers );
2686
2687             if ($reserve_found) {
2688                 push( @borrowernumbers, $reserve->{borrowernumber} );
2689             }
2690             else {
2691                 last;
2692             }
2693         }
2694
2695         # If the count of the union of the lists of reservable items for each borrower
2696         # is equal or greater than the number of borrowers, we know that all reserves
2697         # can be filled with available items. We can get the union of the sets simply
2698         # by pushing all the elements onto an array and removing the duplicates.
2699         my @reservable;
2700         foreach my $b (@borrowernumbers) {
2701             foreach my $i (@itemnumbers) {
2702                 if (   IsAvailableForItemLevelRequest($i)
2703                     && CanItemBeReserved( $b, $i )
2704                     && !IsItemOnHoldAndFound($i) )
2705                 {
2706                     push( @reservable, $i );
2707                 }
2708             }
2709         }
2710
2711         @reservable = uniq(@reservable);
2712
2713         if ( @reservable >= @borrowernumbers ) {
2714             $resfound = 0;
2715         }
2716     }
2717
2718     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2719
2720     return ( 1, undef ) if $override_limit;
2721
2722     my $branchcode = _GetCircControlBranch( $item, $borrower );
2723     my $issuingrule =
2724       GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2725
2726     return ( 0, "too_many" )
2727       if $issuingrule->{renewalsallowed} <= $itemissue->{renewals};
2728
2729     if ( $issuingrule->{norenewalbefore} ) {
2730
2731         # Get current time and add norenewalbefore.
2732         # If this is smaller than date_due, it's too soon for renewal.
2733         if (
2734             DateTime->now( time_zone => C4::Context->tz() )->add(
2735                 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore}
2736             ) < $itemissue->{date_due}
2737           )
2738         {
2739             return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2740             return ( 0, "too_soon" );
2741         }
2742     }
2743
2744     return ( 0, "auto_renew" ) if $itemissue->{auto_renew};
2745     return ( 1, undef );
2746 }
2747
2748 =head2 AddRenewal
2749
2750   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2751
2752 Renews a loan.
2753
2754 C<$borrowernumber> is the borrower number of the patron who currently
2755 has the item.
2756
2757 C<$itemnumber> is the number of the item to renew.
2758
2759 C<$branch> is the library where the renewal took place (if any).
2760            The library that controls the circ policies for the renewal is retrieved from the issues record.
2761
2762 C<$datedue> can be a C4::Dates object used to set the due date.
2763
2764 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2765 this parameter is not supplied, lastreneweddate is set to the current date.
2766
2767 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2768 from the book's item type.
2769
2770 =cut
2771
2772 sub AddRenewal {
2773     my $borrowernumber  = shift;
2774     my $itemnumber      = shift or return;
2775     my $branch          = shift;
2776     my $datedue         = shift;
2777     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2778
2779     my $item   = GetItem($itemnumber) or return;
2780     my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2781
2782     my $dbh = C4::Context->dbh;
2783
2784     # Find the issues record for this book
2785     my $sth =
2786       $dbh->prepare("SELECT * FROM issues WHERE itemnumber = ?");
2787     $sth->execute( $itemnumber );
2788     my $issuedata = $sth->fetchrow_hashref;
2789
2790     return unless ( $issuedata );
2791
2792     $borrowernumber ||= $issuedata->{borrowernumber};
2793
2794     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2795         carp 'Invalid date passed to AddRenewal.';
2796         return;
2797     }
2798
2799     # If the due date wasn't specified, calculate it by adding the
2800     # book's loan length to today's date or the current due date
2801     # based on the value of the RenewalPeriodBase syspref.
2802     unless ($datedue) {
2803
2804         my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2805         my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2806
2807         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2808                                         dt_from_string( $issuedata->{date_due} ) :
2809                                         DateTime->now( time_zone => C4::Context->tz());
2810         $datedue =  CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2811     }
2812
2813     # Update the issues record to have the new due date, and a new count
2814     # of how many times it has been renewed.
2815     my $renews = $issuedata->{'renewals'} + 1;
2816     $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2817                             WHERE borrowernumber=?
2818                             AND itemnumber=?"
2819     );
2820
2821     $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2822
2823     # Update the renewal count on the item, and tell zebra to reindex
2824     $renews = $biblio->{'renewals'} + 1;
2825     ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2826
2827     # Charge a new rental fee, if applicable?
2828     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2829     if ( $charge > 0 ) {
2830         my $accountno = getnextacctno( $borrowernumber );
2831         my $item = GetBiblioFromItemNumber($itemnumber);
2832         my $manager_id = 0;
2833         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2834         $sth = $dbh->prepare(
2835                 "INSERT INTO accountlines
2836                     (date, borrowernumber, accountno, amount, manager_id,
2837                     description,accounttype, amountoutstanding, itemnumber)
2838                     VALUES (now(),?,?,?,?,?,?,?,?)"
2839         );
2840         $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2841             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2842             'Rent', $charge, $itemnumber );
2843     }
2844
2845     # Send a renewal slip according to checkout alert preferencei
2846     if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2847         my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2848         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2849         my %conditions = (
2850                 branchcode   => $branch,
2851                 categorycode => $borrower->{categorycode},
2852                 item_type    => $item->{itype},
2853                 notification => 'CHECKOUT',
2854         );
2855         if ($circulation_alert->is_enabled_for(\%conditions)) {
2856                 SendCirculationAlert({
2857                         type     => 'RENEWAL',
2858                         item     => $item,
2859                 borrower => $borrower,
2860                 branch   => $branch,
2861                 });
2862         }
2863     }
2864
2865     # Remove any OVERDUES related debarment if the borrower has no overdues
2866     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2867     if ( $borrowernumber
2868       && $borrower->{'debarred'}
2869       && !HasOverdues( $borrowernumber )
2870       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2871     ) {
2872         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2873     }
2874
2875     # Log the renewal
2876     UpdateStats({branch => $branch,
2877                 type => 'renew',
2878                 amount => $charge,
2879                 itemnumber => $itemnumber,
2880                 itemtype => $item->{itype},
2881                 borrowernumber => $borrowernumber,
2882                 ccode => $item->{'ccode'}}
2883                 );
2884         return $datedue;
2885 }
2886
2887 sub GetRenewCount {
2888     # check renewal status
2889     my ( $bornum, $itemno ) = @_;
2890     my $dbh           = C4::Context->dbh;
2891     my $renewcount    = 0;
2892     my $renewsallowed = 0;
2893     my $renewsleft    = 0;
2894
2895     my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2896     my $item     = GetItem($itemno);
2897
2898     # Look in the issues table for this item, lent to this borrower,
2899     # and not yet returned.
2900
2901     # FIXME - I think this function could be redone to use only one SQL call.
2902     my $sth = $dbh->prepare(
2903         "select * from issues
2904                                 where (borrowernumber = ?)
2905                                 and (itemnumber = ?)"
2906     );
2907     $sth->execute( $bornum, $itemno );
2908     my $data = $sth->fetchrow_hashref;
2909     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2910     # $item and $borrower should be calculated
2911     my $branchcode = _GetCircControlBranch($item, $borrower);
2912
2913     my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2914
2915     $renewsallowed = $issuingrule->{'renewalsallowed'};
2916     $renewsleft    = $renewsallowed - $renewcount;
2917     if($renewsleft < 0){ $renewsleft = 0; }
2918     return ( $renewcount, $renewsallowed, $renewsleft );
2919 }
2920
2921 =head2 GetSoonestRenewDate
2922
2923   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2924
2925 Find out the soonest possible renew date of a borrowed item.
2926
2927 C<$borrowernumber> is the borrower number of the patron who currently
2928 has the item on loan.
2929
2930 C<$itemnumber> is the number of the item to renew.
2931
2932 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2933 renew date, based on the value "No renewal before" of the applicable
2934 issuing rule. Returns the current date if the item can already be
2935 renewed, and returns undefined if the borrower, loan, or item
2936 cannot be found.
2937
2938 =cut
2939
2940 sub GetSoonestRenewDate {
2941     my ( $borrowernumber, $itemnumber ) = @_;
2942
2943     my $dbh = C4::Context->dbh;
2944
2945     my $item      = GetItem($itemnumber)      or return;
2946     my $itemissue = GetItemIssue($itemnumber) or return;
2947
2948     $borrowernumber ||= $itemissue->{borrowernumber};
2949     my $borrower = C4::Members::GetMemberDetails($borrowernumber)
2950       or return;
2951
2952     my $branchcode = _GetCircControlBranch( $item, $borrower );
2953     my $issuingrule =
2954       GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2955
2956     my $now = DateTime->now( time_zone => C4::Context->tz() );
2957
2958     if ( $issuingrule->{norenewalbefore} ) {
2959         my $soonestrenewal =
2960           $itemissue->{date_due}->subtract(
2961             $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore} );
2962
2963         $soonestrenewal = $now > $soonestrenewal ? $now : $soonestrenewal;
2964         return $soonestrenewal;
2965     }
2966     return $now;
2967 }
2968
2969 =head2 GetIssuingCharges
2970
2971   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2972
2973 Calculate how much it would cost for a given patron to borrow a given
2974 item, including any applicable discounts.
2975
2976 C<$itemnumber> is the item number of item the patron wishes to borrow.
2977
2978 C<$borrowernumber> is the patron's borrower number.
2979
2980 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2981 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2982 if it's a video).
2983
2984 =cut
2985
2986 sub GetIssuingCharges {
2987
2988     # calculate charges due
2989     my ( $itemnumber, $borrowernumber ) = @_;
2990     my $charge = 0;
2991     my $dbh    = C4::Context->dbh;
2992     my $item_type;
2993
2994     # Get the book's item type and rental charge (via its biblioitem).
2995     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2996         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2997     $charge_query .= (C4::Context->preference('item-level_itypes'))
2998         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2999         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3000
3001     $charge_query .= ' WHERE items.itemnumber =?';
3002
3003     my $sth = $dbh->prepare($charge_query);
3004     $sth->execute($itemnumber);
3005     if ( my $item_data = $sth->fetchrow_hashref ) {
3006         $item_type = $item_data->{itemtype};
3007         $charge    = $item_data->{rentalcharge};
3008         my $branch = C4::Branch::mybranch();
3009         my $discount_query = q|SELECT rentaldiscount,
3010             issuingrules.itemtype, issuingrules.branchcode
3011             FROM borrowers
3012             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3013             WHERE borrowers.borrowernumber = ?
3014             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3015             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3016         my $discount_sth = $dbh->prepare($discount_query);
3017         $discount_sth->execute( $borrowernumber, $item_type, $branch );
3018         my $discount_rules = $discount_sth->fetchall_arrayref({});
3019         if (@{$discount_rules}) {
3020             # We may have multiple rules so get the most specific
3021             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3022             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3023         }
3024     }
3025
3026     return ( $charge, $item_type );
3027 }
3028
3029 # Select most appropriate discount rule from those returned
3030 sub _get_discount_from_rule {
3031     my ($rules_ref, $branch, $itemtype) = @_;
3032     my $discount;
3033
3034     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3035         $discount = $rules_ref->[0]->{rentaldiscount};
3036         return (defined $discount) ? $discount : 0;
3037     }
3038     # could have up to 4 does one match $branch and $itemtype
3039     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3040     if (@d) {
3041         $discount = $d[0]->{rentaldiscount};
3042         return (defined $discount) ? $discount : 0;
3043     }
3044     # do we have item type + all branches
3045     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3046     if (@d) {
3047         $discount = $d[0]->{rentaldiscount};
3048         return (defined $discount) ? $discount : 0;
3049     }
3050     # do we all item types + this branch
3051     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3052     if (@d) {
3053         $discount = $d[0]->{rentaldiscount};
3054         return (defined $discount) ? $discount : 0;
3055     }
3056     # so all and all (surely we wont get here)
3057     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3058     if (@d) {
3059         $discount = $d[0]->{rentaldiscount};
3060         return (defined $discount) ? $discount : 0;
3061     }
3062     # none of the above
3063     return 0;
3064 }
3065
3066 =head2 AddIssuingCharge
3067
3068   &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3069
3070 =cut
3071
3072 sub AddIssuingCharge {
3073     my ( $itemnumber, $borrowernumber, $charge ) = @_;
3074     my $dbh = C4::Context->dbh;
3075     my $nextaccntno = getnextacctno( $borrowernumber );
3076     my $manager_id = 0;
3077     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3078     my $query ="
3079         INSERT INTO accountlines
3080             (borrowernumber, itemnumber, accountno,
3081             date, amount, description, accounttype,
3082             amountoutstanding, manager_id)
3083         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3084     ";
3085     my $sth = $dbh->prepare($query);
3086     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3087 }
3088
3089 =head2 GetTransfers
3090
3091   GetTransfers($itemnumber);
3092
3093 =cut
3094
3095 sub GetTransfers {
3096     my ($itemnumber) = @_;
3097
3098     my $dbh = C4::Context->dbh;
3099
3100     my $query = '
3101         SELECT datesent,
3102                frombranch,
3103                tobranch
3104         FROM branchtransfers
3105         WHERE itemnumber = ?
3106           AND datearrived IS NULL
3107         ';
3108     my $sth = $dbh->prepare($query);
3109     $sth->execute($itemnumber);
3110     my @row = $sth->fetchrow_array();
3111     return @row;
3112 }
3113
3114 =head2 GetTransfersFromTo
3115
3116   @results = GetTransfersFromTo($frombranch,$tobranch);
3117
3118 Returns the list of pending transfers between $from and $to branch
3119
3120 =cut
3121
3122 sub GetTransfersFromTo {
3123     my ( $frombranch, $tobranch ) = @_;
3124     return unless ( $frombranch && $tobranch );
3125     my $dbh   = C4::Context->dbh;
3126     my $query = "
3127         SELECT itemnumber,datesent,frombranch
3128         FROM   branchtransfers
3129         WHERE  frombranch=?
3130           AND  tobranch=?
3131           AND datearrived IS NULL
3132     ";
3133     my $sth = $dbh->prepare($query);
3134     $sth->execute( $frombranch, $tobranch );
3135     my @gettransfers;
3136
3137     while ( my $data = $sth->fetchrow_hashref ) {
3138         push @gettransfers, $data;
3139     }
3140     return (@gettransfers);
3141 }
3142
3143 =head2 DeleteTransfer
3144
3145   &DeleteTransfer($itemnumber);
3146
3147 =cut
3148
3149 sub DeleteTransfer {
3150     my ($itemnumber) = @_;
3151     return unless $itemnumber;
3152     my $dbh          = C4::Context->dbh;
3153     my $sth          = $dbh->prepare(
3154         "DELETE FROM branchtransfers
3155          WHERE itemnumber=?
3156          AND datearrived IS NULL "
3157     );
3158     return $sth->execute($itemnumber);
3159 }
3160
3161 =head2 AnonymiseIssueHistory
3162
3163   ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
3164
3165 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
3166 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
3167
3168 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
3169 setting (force delete).
3170
3171 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
3172
3173 =cut
3174
3175 sub AnonymiseIssueHistory {
3176     my $date           = shift;
3177     my $borrowernumber = shift;
3178     my $dbh            = C4::Context->dbh;
3179     my $query          = "
3180         UPDATE old_issues
3181         SET    borrowernumber = ?
3182         WHERE  returndate < ?
3183           AND borrowernumber IS NOT NULL
3184     ";
3185
3186     # The default of 0 does not work due to foreign key constraints
3187     # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
3188     my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
3189     my @bind_params = ($anonymouspatron, $date);
3190     if (defined $borrowernumber) {
3191        $query .= " AND borrowernumber = ?";
3192        push @bind_params, $borrowernumber;
3193     } else {
3194        $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
3195     }
3196     my $sth = $dbh->prepare($query);
3197     $sth->execute(@bind_params);
3198     my $anonymisation_err = $dbh->err;
3199     my $rows_affected = $sth->rows;  ### doublecheck row count return function
3200     return ($rows_affected, $anonymisation_err);
3201 }
3202
3203 =head2 SendCirculationAlert
3204
3205 Send out a C<check-in> or C<checkout> alert using the messaging system.
3206
3207 B<Parameters>:
3208
3209 =over 4
3210
3211 =item type
3212
3213 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3214
3215 =item item
3216
3217 Hashref of information about the item being checked in or out.
3218
3219 =item borrower
3220
3221 Hashref of information about the borrower of the item.
3222
3223 =item branch
3224
3225 The branchcode from where the checkout or check-in took place.
3226
3227 =back
3228
3229 B<Example>:
3230
3231     SendCirculationAlert({
3232         type     => 'CHECKOUT',
3233         item     => $item,
3234         borrower => $borrower,
3235         branch   => $branch,
3236     });
3237
3238 =cut
3239
3240 sub SendCirculationAlert {
3241     my ($opts) = @_;
3242     my ($type, $item, $borrower, $branch) =
3243         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3244     my %message_name = (
3245         CHECKIN  => 'Item_Check_in',
3246         CHECKOUT => 'Item_Checkout',
3247         RENEWAL  => 'Item_Checkout',
3248     );
3249     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3250         borrowernumber => $borrower->{borrowernumber},
3251         message_name   => $message_name{$type},
3252     });
3253     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3254     my $letter =  C4::Letters::GetPreparedLetter (
3255         module => 'circulation',
3256         letter_code => $type,
3257         branchcode => $branch,
3258         tables => {
3259             $issues_table => $item->{itemnumber},
3260             'items'       => $item->{itemnumber},
3261             'biblio'      => $item->{biblionumber},
3262             'biblioitems' => $item->{biblionumber},
3263             'borrowers'   => $borrower,
3264             'branches'    => $branch,
3265         }
3266     ) or return;
3267
3268     my @transports = keys %{ $borrower_preferences->{transports} };
3269     # warn "no transports" unless @transports;
3270     for (@transports) {
3271         # warn "transport: $_";
3272         my $message = C4::Message->find_last_message($borrower, $type, $_);
3273         if (!$message) {
3274             #warn "create new message";
3275             C4::Message->enqueue($letter, $borrower, $_);
3276         } else {
3277             #warn "append to old message";
3278             $message->append($letter);
3279             $message->update;
3280         }
3281     }
3282
3283     return $letter;
3284 }
3285
3286 =head2 updateWrongTransfer
3287
3288   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3289
3290 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
3291
3292 =cut
3293
3294 sub updateWrongTransfer {
3295         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3296         my $dbh = C4::Context->dbh;
3297 # first step validate the actual line of transfert .
3298         my $sth =
3299                 $dbh->prepare(
3300                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3301                 );
3302                 $sth->execute($FromLibrary,$itemNumber);
3303
3304 # second step create a new line of branchtransfer to the right location .
3305         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3306
3307 #third step changing holdingbranch of item
3308         UpdateHoldingbranch($FromLibrary,$itemNumber);
3309 }
3310
3311 =head2 UpdateHoldingbranch
3312
3313   $items = UpdateHoldingbranch($branch,$itmenumber);
3314
3315 Simple methode for updating hodlingbranch in items BDD line
3316
3317 =cut
3318
3319 sub UpdateHoldingbranch {
3320         my ( $branch,$itemnumber ) = @_;
3321     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3322 }
3323
3324 =head2 CalcDateDue
3325
3326 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3327
3328 this function calculates the due date given the start date and configured circulation rules,
3329 checking against the holidays calendar as per the 'useDaysMode' syspref.
3330 C<$startdate>   = C4::Dates object representing start date of loan period (assumed to be today)
3331 C<$itemtype>  = itemtype code of item in question
3332 C<$branch>  = location whose calendar to use
3333 C<$borrower> = Borrower object
3334 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3335
3336 =cut
3337
3338 sub CalcDateDue {
3339     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3340
3341     $isrenewal ||= 0;
3342
3343     # loanlength now a href
3344     my $loanlength =
3345             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3346
3347     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3348             ? qq{renewalperiod}
3349             : qq{issuelength};
3350
3351     my $datedue;
3352     if ( $startdate ) {
3353         if (ref $startdate ne 'DateTime' ) {
3354             $datedue = dt_from_string($datedue);
3355         } else {
3356             $datedue = $startdate->clone;
3357         }
3358     } else {
3359         $datedue =
3360           DateTime->now( time_zone => C4::Context->tz() )
3361           ->truncate( to => 'minute' );
3362     }
3363
3364
3365     # calculate the datedue as normal
3366     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3367     {    # ignoring calendar
3368         if ( $loanlength->{lengthunit} eq 'hours' ) {
3369             $datedue->add( hours => $loanlength->{$length_key} );
3370         } else {    # days
3371             $datedue->add( days => $loanlength->{$length_key} );
3372             $datedue->set_hour(23);
3373             $datedue->set_minute(59);
3374         }
3375     } else {
3376         my $dur;
3377         if ($loanlength->{lengthunit} eq 'hours') {
3378             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3379         }
3380         else { # days
3381             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3382         }
3383         my $calendar = Koha::Calendar->new( branchcode => $branch );
3384         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3385         if ($loanlength->{lengthunit} eq 'days') {
3386             $datedue->set_hour(23);
3387             $datedue->set_minute(59);
3388         }
3389     }
3390
3391     # if Hard Due Dates are used, retreive them and apply as necessary
3392     my ( $hardduedate, $hardduedatecompare ) =
3393       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3394     if ($hardduedate) {    # hardduedates are currently dates
3395         $hardduedate->truncate( to => 'minute' );
3396         $hardduedate->set_hour(23);
3397         $hardduedate->set_minute(59);
3398         my $cmp = DateTime->compare( $hardduedate, $datedue );
3399
3400 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3401 # if the calculated date is before the 'after' Hard Due Date (floor), override
3402 # if the hard due date is set to 'exactly', overrride
3403         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3404             $datedue = $hardduedate->clone;
3405         }
3406
3407         # in all other cases, keep the date due as it is
3408
3409     }
3410
3411     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3412     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3413         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
3414         $expiry_dt->set( hour => 23, minute => 59);
3415         if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
3416             $datedue = $expiry_dt->clone;
3417         }
3418     }
3419
3420     return $datedue;
3421 }
3422
3423
3424 =head2 CheckRepeatableHolidays
3425
3426   $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3427
3428 This function checks if the date due is a repeatable holiday
3429
3430 C<$date_due>   = returndate calculate with no day check
3431 C<$itemnumber>  = itemnumber
3432 C<$branchcode>  = localisation of issue
3433
3434 =cut
3435
3436 sub CheckRepeatableHolidays{
3437 my($itemnumber,$week_day,$branchcode)=@_;
3438 my $dbh = C4::Context->dbh;
3439 my $query = qq|SELECT count(*)
3440         FROM repeatable_holidays
3441         WHERE branchcode=?
3442         AND weekday=?|;
3443 my $sth = $dbh->prepare($query);
3444 $sth->execute($branchcode,$week_day);
3445 my $result=$sth->fetchrow;
3446 return $result;
3447 }
3448
3449
3450 =head2 CheckSpecialHolidays
3451
3452   $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3453
3454 This function check if the date is a special holiday
3455
3456 C<$years>   = the years of datedue
3457 C<$month>   = the month of datedue
3458 C<$day>     = the day of datedue
3459 C<$itemnumber>  = itemnumber
3460 C<$branchcode>  = localisation of issue
3461
3462 =cut
3463
3464 sub CheckSpecialHolidays{
3465 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3466 my $dbh = C4::Context->dbh;
3467 my $query=qq|SELECT count(*)
3468              FROM `special_holidays`
3469              WHERE year=?
3470              AND month=?
3471              AND day=?
3472              AND branchcode=?
3473             |;
3474 my $sth = $dbh->prepare($query);
3475 $sth->execute($years,$month,$day,$branchcode);
3476 my $countspecial=$sth->fetchrow ;
3477 return $countspecial;
3478 }
3479
3480 =head2 CheckRepeatableSpecialHolidays
3481
3482   $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3483
3484 This function check if the date is a repeatble special holidays
3485
3486 C<$month>   = the month of datedue
3487 C<$day>     = the day of datedue
3488 C<$itemnumber>  = itemnumber
3489 C<$branchcode>  = localisation of issue
3490
3491 =cut
3492
3493 sub CheckRepeatableSpecialHolidays{
3494 my ($month,$day,$itemnumber,$branchcode) = @_;
3495 my $dbh = C4::Context->dbh;
3496 my $query=qq|SELECT count(*)
3497              FROM `repeatable_holidays`
3498              WHERE month=?
3499              AND day=?
3500              AND branchcode=?
3501             |;
3502 my $sth = $dbh->prepare($query);
3503 $sth->execute($month,$day,$branchcode);
3504 my $countspecial=$sth->fetchrow ;
3505 return $countspecial;
3506 }
3507
3508
3509
3510 sub CheckValidBarcode{
3511 my ($barcode) = @_;
3512 my $dbh = C4::Context->dbh;
3513 my $query=qq|SELECT count(*)
3514              FROM items
3515              WHERE barcode=?
3516             |;
3517 my $sth = $dbh->prepare($query);
3518 $sth->execute($barcode);
3519 my $exist=$sth->fetchrow ;
3520 return $exist;
3521 }
3522
3523 =head2 IsBranchTransferAllowed
3524
3525   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3526
3527 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3528
3529 =cut
3530
3531 sub IsBranchTransferAllowed {
3532         my ( $toBranch, $fromBranch, $code ) = @_;
3533
3534         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3535
3536         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3537         my $dbh = C4::Context->dbh;
3538
3539         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3540         $sth->execute( $toBranch, $fromBranch, $code );
3541         my $limit = $sth->fetchrow_hashref();
3542
3543         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3544         if ( $limit->{'limitId'} ) {
3545                 return 0;
3546         } else {
3547                 return 1;
3548         }
3549 }
3550
3551 =head2 CreateBranchTransferLimit
3552
3553   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3554
3555 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3556
3557 =cut
3558
3559 sub CreateBranchTransferLimit {
3560    my ( $toBranch, $fromBranch, $code ) = @_;
3561    return unless defined($toBranch) && defined($fromBranch);
3562    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3563
3564    my $dbh = C4::Context->dbh;
3565
3566    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3567    return $sth->execute( $code, $toBranch, $fromBranch );
3568 }
3569
3570 =head2 DeleteBranchTransferLimits
3571
3572     my $result = DeleteBranchTransferLimits($frombranch);
3573
3574 Deletes all the library transfer limits for one library.  Returns the
3575 number of limits deleted, 0e0 if no limits were deleted, or undef if
3576 no arguments are supplied.
3577
3578 =cut
3579
3580 sub DeleteBranchTransferLimits {
3581     my $branch = shift;
3582     return unless defined $branch;
3583     my $dbh    = C4::Context->dbh;
3584     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3585     return $sth->execute($branch);
3586 }
3587
3588 sub ReturnLostItem{
3589     my ( $borrowernumber, $itemnum ) = @_;
3590
3591     MarkIssueReturned( $borrowernumber, $itemnum );
3592     my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3593     my $item = C4::Items::GetItem( $itemnum );
3594     my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3595     my @datearr = localtime(time);
3596     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3597     my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3598     ModItem({ paidfor =>  $old_note."Paid for by $bor $date" }, undef, $itemnum);
3599 }
3600
3601
3602 sub LostItem{
3603     my ($itemnumber, $mark_returned) = @_;
3604
3605     my $dbh = C4::Context->dbh();
3606     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3607                            FROM issues
3608                            JOIN items USING (itemnumber)
3609                            JOIN biblio USING (biblionumber)
3610                            WHERE issues.itemnumber=?");
3611     $sth->execute($itemnumber);
3612     my $issues=$sth->fetchrow_hashref();
3613
3614     # If a borrower lost the item, add a replacement cost to the their record
3615     if ( my $borrowernumber = $issues->{borrowernumber} ){
3616         my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3617
3618         if (C4::Context->preference('WhenLostForgiveFine')){
3619             my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3620             defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3621         }
3622         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3623             C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3624             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3625             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3626         }
3627
3628         MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3629     }
3630 }
3631
3632 sub GetOfflineOperations {
3633     my $dbh = C4::Context->dbh;
3634     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3635     $sth->execute(C4::Context->userenv->{'branch'});
3636     my $results = $sth->fetchall_arrayref({});
3637     return $results;
3638 }
3639
3640 sub GetOfflineOperation {
3641     my $operationid = shift;
3642     return unless $operationid;
3643     my $dbh = C4::Context->dbh;
3644     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3645     $sth->execute( $operationid );
3646     return $sth->fetchrow_hashref;
3647 }
3648
3649 sub AddOfflineOperation {
3650     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3651     my $dbh = C4::Context->dbh;
3652     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3653     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3654     return "Added.";
3655 }
3656
3657 sub DeleteOfflineOperation {
3658     my $dbh = C4::Context->dbh;
3659     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3660     $sth->execute( shift );
3661     return "Deleted.";
3662 }
3663
3664 sub ProcessOfflineOperation {
3665     my $operation = shift;
3666
3667     my $report;
3668     if ( $operation->{action} eq 'return' ) {
3669         $report = ProcessOfflineReturn( $operation );
3670     } elsif ( $operation->{action} eq 'issue' ) {
3671         $report = ProcessOfflineIssue( $operation );
3672     } elsif ( $operation->{action} eq 'payment' ) {
3673         $report = ProcessOfflinePayment( $operation );
3674     }
3675
3676     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3677
3678     return $report;
3679 }
3680
3681 sub ProcessOfflineReturn {
3682     my $operation = shift;
3683
3684     my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3685
3686     if ( $itemnumber ) {
3687         my $issue = GetOpenIssue( $itemnumber );
3688         if ( $issue ) {
3689             MarkIssueReturned(
3690                 $issue->{borrowernumber},
3691                 $itemnumber,
3692                 undef,
3693                 $operation->{timestamp},
3694             );
3695             ModItem(
3696                 { renewals => 0, onloan => undef },
3697                 $issue->{'biblionumber'},
3698                 $itemnumber
3699             );
3700             return "Success.";
3701         } else {
3702             return "Item not issued.";
3703         }
3704     } else {
3705         return "Item not found.";
3706     }
3707 }
3708
3709 sub ProcessOfflineIssue {
3710     my $operation = shift;
3711
3712     my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3713
3714     if ( $borrower->{borrowernumber} ) {
3715         my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3716         unless ($itemnumber) {
3717             return "Barcode not found.";
3718         }
3719         my $issue = GetOpenIssue( $itemnumber );
3720
3721         if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3722             MarkIssueReturned(
3723                 $issue->{borrowernumber},
3724                 $itemnumber,
3725                 undef,
3726                 $operation->{timestamp},
3727             );
3728         }
3729         AddIssue(
3730             $borrower,
3731             $operation->{'barcode'},
3732             undef,
3733             1,
3734             $operation->{timestamp},
3735             undef,
3736         );
3737         return "Success.";
3738     } else {
3739         return "Borrower not found.";
3740     }
3741 }
3742
3743 sub ProcessOfflinePayment {
3744     my $operation = shift;
3745
3746     my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3747     my $amount = $operation->{amount};
3748
3749     recordpayment( $borrower->{borrowernumber}, $amount );
3750
3751     return "Success."
3752 }
3753
3754
3755 =head2 TransferSlip
3756
3757   TransferSlip($user_branch, $itemnumber, $to_branch)
3758
3759   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3760
3761 =cut
3762
3763 sub TransferSlip {
3764     my ($branch, $itemnumber, $to_branch) = @_;
3765
3766     my $item =  GetItem( $itemnumber )
3767       or return;
3768
3769     my $pulldate = C4::Dates->new();
3770
3771     return C4::Letters::GetPreparedLetter (
3772         module => 'circulation',
3773         letter_code => 'TRANSFERSLIP',
3774         branchcode => $branch,
3775         tables => {
3776             'branches'    => $to_branch,
3777             'biblio'      => $item->{biblionumber},
3778             'items'       => $item,
3779         },
3780     );
3781 }
3782
3783 =head2 CheckIfIssuedToPatron
3784
3785   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3786
3787   Return 1 if any record item is issued to patron, otherwise return 0
3788
3789 =cut
3790
3791 sub CheckIfIssuedToPatron {
3792     my ($borrowernumber, $biblionumber) = @_;
3793
3794     my $items = GetItemsByBiblioitemnumber($biblionumber);
3795
3796     foreach my $item (@{$items}) {
3797         return 1 if ($item->{borrowernumber} && $item->{borrowernumber} eq $borrowernumber);
3798     }
3799
3800     return;
3801 }
3802
3803 =head2 IsItemIssued
3804
3805   IsItemIssued( $itemnumber )
3806
3807   Return 1 if the item is on loan, otherwise return 0
3808
3809 =cut
3810
3811 sub IsItemIssued {
3812     my $itemnumber = shift;
3813     my $dbh = C4::Context->dbh;
3814     my $sth = $dbh->prepare(q{
3815         SELECT COUNT(*)
3816         FROM issues
3817         WHERE itemnumber = ?
3818     });
3819     $sth->execute($itemnumber);
3820     return $sth->fetchrow;
3821 }
3822
3823 =head2 GetAgeRestriction
3824
3825   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3826   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3827
3828   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as he is older or as old as the agerestriction }
3829   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3830
3831 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3832 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3833 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3834          Negative days mean the borrower has gone past the age restriction age.
3835
3836 =cut
3837
3838 sub GetAgeRestriction {
3839     my ($record_restrictions, $borrower) = @_;
3840     my $markers = C4::Context->preference('AgeRestrictionMarker');
3841
3842     # Split $record_restrictions to something like FSK 16 or PEGI 6
3843     my @values = split ' ', uc($record_restrictions);
3844     return unless @values;
3845
3846     # Search first occurence of one of the markers
3847     my @markers = split /\|/, uc($markers);
3848     return unless @markers;
3849
3850     my $index            = 0;
3851     my $restriction_year = 0;
3852     for my $value (@values) {
3853         $index++;
3854         for my $marker (@markers) {
3855             $marker =~ s/^\s+//;    #remove leading spaces
3856             $marker =~ s/\s+$//;    #remove trailing spaces
3857             if ( $marker eq $value ) {
3858                 if ( $index <= $#values ) {
3859                     $restriction_year += $values[$index];
3860                 }
3861                 last;
3862             }
3863             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3864
3865                 # Perhaps it is something like "K16" (as in Finland)
3866                 $restriction_year += $1;
3867                 last;
3868             }
3869         }
3870         last if ( $restriction_year > 0 );
3871     }
3872
3873     #Check if the borrower is age restricted for this material and for how long.
3874     if ($restriction_year && $borrower) {
3875         if ( $borrower->{'dateofbirth'} ) {
3876             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3877             $alloweddate[0] += $restriction_year;
3878
3879             #Prevent runime eror on leap year (invalid date)
3880             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3881                 $alloweddate[2] = 28;
3882             }
3883
3884             #Get how many days the borrower has to reach the age restriction
3885             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(Today);
3886             #Negative days means the borrower went past the age restriction age
3887             return ($restriction_year, $daysToAgeRestriction);
3888         }
3889     }
3890
3891     return ($restriction_year);
3892 }
3893
3894 1;
3895
3896 __END__
3897
3898 =head1 AUTHOR
3899
3900 Koha Development Team <http://koha-community.org/>
3901
3902 =cut
3903