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