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