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