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