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