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