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