C4/Reserves.pm

   1 package C4::Reserves;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #           2006 SAN Ouest Provence
   5 #           2007-2010 BibLibre Paul POULAIN
   6 #           2011 Catalyst IT
   7 #
   8 # This file is part of Koha.
   9 #
  10 # Koha is free software; you can redistribute it and/or modify it under the
  11 # terms of the GNU General Public License as published by the Free Software
  12 # Foundation; either version 2 of the License, or (at your option) any later
  13 # version.
  14 #
  15 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  16 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  17 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License along
  20 # with Koha; if not, write to the Free Software Foundation, Inc.,
  21 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22
  23
  24 use strict;
  25 #use warnings; FIXME - Bug 2505
  26 use C4::Context;
  27 use C4::Biblio;
  28 use C4::Members;
  29 use C4::Items;
  30 use C4::Circulation;
  31 use C4::Accounts;
  32
  33 # for _koha_notify_reserve
  34 use C4::Members::Messaging;
  35 use C4::Members qw();
  36 use C4::Letters;
  37 use C4::Branch qw( GetBranchDetail );
  38 use C4::Dates qw( format_date_in_iso );
  39
  40 use Koha::DateUtils;
  41
  42 use List::MoreUtils qw( firstidx );
  43
  44 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  45
  46 =head1 NAME
  47
  48 C4::Reserves - Koha functions for dealing with reservation.
  49
  50 =head1 SYNOPSIS
  51
  52   use C4::Reserves;
  53
  54 =head1 DESCRIPTION
  55
  56 This modules provides somes functions to deal with reservations.
  57
  58   Reserves are stored in reserves table.
  59   The following columns contains important values :
  60   - priority >0      : then the reserve is at 1st stage, and not yet affected to any item.
  61              =0      : then the reserve is being dealed
  62   - found : NULL       : means the patron requested the 1st available, and we haven't choosen the item
  63             T(ransit)  : the reserve is linked to an item but is in transit to the pickup branch
  64             W(aiting)  : the reserve is linked to an item, is at the pickup branch, and is waiting on the hold shelf
  65             F(inished) : the reserve has been completed, and is done
  66   - itemnumber : empty : the reserve is still unaffected to an item
  67                  filled: the reserve is attached to an item
  68   The complete workflow is :
  69   ==== 1st use case ====
  70   patron request a document, 1st available :                      P >0, F=NULL, I=NULL
  71   a library having it run "transfertodo", and clic on the list
  72          if there is no transfer to do, the reserve waiting
  73          patron can pick it up                                    P =0, F=W,    I=filled
  74          if there is a transfer to do, write in branchtransfer    P =0, F=T,    I=filled
  75            The pickup library recieve the book, it check in       P =0, F=W,    I=filled
  76   The patron borrow the book                                      P =0, F=F,    I=filled
  77
  78   ==== 2nd use case ====
  79   patron requests a document, a given item,
  80     If pickup is holding branch                                   P =0, F=W,   I=filled
  81     If transfer needed, write in branchtransfer                   P =0, F=T,    I=filled
  82         The pickup library receive the book, it checks it in      P =0, F=W,    I=filled
  83   The patron borrow the book                                      P =0, F=F,    I=filled
  84
  85 =head1 FUNCTIONS
  86
  87 =cut
  88
  89 BEGIN {
  90     # set the version for version checking
  91     $VERSION = 3.07.00.049;
  92     require Exporter;
  93     @ISA = qw(Exporter);
  94     @EXPORT = qw(
  95         &AddReserve
  96
  97         &GetReserve
  98         &GetReservesFromItemnumber
  99         &GetReservesFromBiblionumber
 100         &GetReservesFromBorrowernumber
 101         &GetReservesForBranch
 102         &GetReservesToBranch
 103         &GetReserveCount
 104         &GetReserveFee
 105         &GetReserveInfo
 106         &GetReserveStatus
 107
 108         &GetOtherReserves
 109
 110         &ModReserveFill
 111         &ModReserveAffect
 112         &ModReserve
 113         &ModReserveStatus
 114         &ModReserveCancelAll
 115         &ModReserveMinusPriority
 116         &MoveReserve
 117
 118         &CheckReserves
 119         &CanBookBeReserved
 120         &CanItemBeReserved
 121         &CancelReserve
 122         &CancelExpiredReserves
 123
 124         &AutoUnsuspendReserves
 125
 126         &IsAvailableForItemLevelRequest
 127
 128         &AlterPriority
 129         &ToggleLowestPriority
 130
 131         &ReserveSlip
 132         &ToggleSuspend
 133         &SuspendAll
 134
 135         &GetReservesControlBranch
 136     );
 137     @EXPORT_OK = qw( MergeHolds );
 138 }
 139
 140 =head2 AddReserve
 141
 142     AddReserve($branch,$borrowernumber,$biblionumber,$constraint,$bibitems,$priority,$resdate,$expdate,$notes,$title,$checkitem,$found)
 143
 144 =cut
 145
 146 sub AddReserve {
 147     my (
 148         $branch,    $borrowernumber, $biblionumber,
 149         $constraint, $bibitems,  $priority, $resdate, $expdate, $notes,
 150         $title,      $checkitem, $found
 151     ) = @_;
 152     my $fee =
 153           GetReserveFee($borrowernumber, $biblionumber, $constraint,
 154             $bibitems );
 155     my $dbh     = C4::Context->dbh;
 156     my $const   = lc substr( $constraint, 0, 1 );
 157     $resdate = format_date_in_iso( $resdate ) if ( $resdate );
 158     $resdate = C4::Dates->today( 'iso' ) unless ( $resdate );
 159     if ($expdate) {
 160         $expdate = format_date_in_iso( $expdate );
 161     } else {
 162         undef $expdate; # make reserves.expirationdate default to null rather than '0000-00-00'
 163     }
 164     if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
 165         # Make room in reserves for this before those of a later reserve date
 166         $priority = _ShiftPriorityByDateAndPriority( $biblionumber, $resdate, $priority );
 167     }
 168     my $waitingdate;
 169
 170     # If the reserv had the waiting status, we had the value of the resdate
 171     if ( $found eq 'W' ) {
 172         $waitingdate = $resdate;
 173     }
 174
 175     #eval {
 176     # updates take place here
 177     if ( $fee > 0 ) {
 178         my $nextacctno = &getnextacctno( $borrowernumber );
 179         my $query      = qq/
 180         INSERT INTO accountlines
 181             (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
 182         VALUES
 183             (?,?,now(),?,?,'Res',?)
 184     /;
 185         my $usth = $dbh->prepare($query);
 186         $usth->execute( $borrowernumber, $nextacctno, $fee,
 187             "Reserve Charge - $title", $fee );
 188     }
 189
 190     #if ($const eq 'a'){
 191     my $query = qq/
 192         INSERT INTO reserves
 193             (borrowernumber,biblionumber,reservedate,branchcode,constrainttype,
 194             priority,reservenotes,itemnumber,found,waitingdate,expirationdate)
 195         VALUES
 196              (?,?,?,?,?,
 197              ?,?,?,?,?,?)
 198     /;
 199     my $sth = $dbh->prepare($query);
 200     $sth->execute(
 201         $borrowernumber, $biblionumber, $resdate, $branch,
 202         $const,          $priority,     $notes,   $checkitem,
 203         $found,          $waitingdate,  $expdate
 204     );
 205
 206     # Send e-mail to librarian if syspref is active
 207     if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
 208         my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
 209         my $branch_details = C4::Branch::GetBranchDetail($borrower->{branchcode});
 210         if ( my $letter =  C4::Letters::GetPreparedLetter (
 211             module => 'reserves',
 212             letter_code => 'HOLDPLACED',
 213             branchcode => $branch,
 214             tables => {
 215                 'branches'  => $branch_details,
 216                 'borrowers' => $borrower,
 217                 'biblio'    => $biblionumber,
 218                 'items'     => $checkitem,
 219             },
 220         ) ) {
 221
 222             my $admin_email_address =$branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
 223
 224             C4::Letters::EnqueueLetter(
 225                 {   letter                 => $letter,
 226                     borrowernumber         => $borrowernumber,
 227                     message_transport_type => 'email',
 228                     from_address           => $admin_email_address,
 229                     to_address           => $admin_email_address,
 230                 }
 231             );
 232         }
 233     }
 234
 235     #}
 236     ($const eq "o" || $const eq "e") or return;   # FIXME: why not have a useful return value?
 237     $query = qq/
 238         INSERT INTO reserveconstraints
 239             (borrowernumber,biblionumber,reservedate,biblioitemnumber)
 240         VALUES
 241             (?,?,?,?)
 242     /;
 243     $sth = $dbh->prepare($query);    # keep prepare outside the loop!
 244     foreach (@$bibitems) {
 245         $sth->execute($borrowernumber, $biblionumber, $resdate, $_);
 246     }
 247
 248     return;     # FIXME: why not have a useful return value?
 249 }
 250
 251 =head2 GetReserve
 252
 253     $res = GetReserve( $reserve_id );
 254
 255     Return the current reserve or the old reserve.
 256
 257 =cut
 258
 259 sub GetReserve {
 260     my ($reserve_id) = @_;
 261
 262     my $dbh = C4::Context->dbh;
 263     my $query = "SELECT * FROM reserves WHERE reserve_id = ?";
 264     my $sth = $dbh->prepare( $query );
 265     $sth->execute( $reserve_id );
 266     return $sth->fetchrow_hashref();
 267 }
 268
 269 =head2 GetReservesFromBiblionumber
 270
 271   ($count, $title_reserves) = GetReservesFromBiblionumber($biblionumber);
 272
 273 This function gets the list of reservations for one C<$biblionumber>, returning a count
 274 of the reserves and an arrayref pointing to the reserves for C<$biblionumber>.
 275
 276 =cut
 277
 278 sub GetReservesFromBiblionumber {
 279     my ($biblionumber) = shift or return (0, []);
 280     my ($all_dates) = shift;
 281     my ($itemnumber) = shift;
 282     my $dbh   = C4::Context->dbh;
 283
 284     # Find the desired items in the reserves
 285     my @params;
 286     my $query = "
 287         SELECT  reserve_id,
 288                 branchcode,
 289                 timestamp AS rtimestamp,
 290                 priority,
 291                 biblionumber,
 292                 borrowernumber,
 293                 reservedate,
 294                 constrainttype,
 295                 found,
 296                 itemnumber,
 297                 reservenotes,
 298                 expirationdate,
 299                 lowestPriority,
 300                 suspend,
 301                 suspend_until
 302         FROM     reserves
 303         WHERE biblionumber = ? ";
 304     push( @params, $biblionumber );
 305     unless ( $all_dates ) {
 306         $query .= " AND reservedate <= CAST(NOW() AS DATE) ";
 307     }
 308     if ( $itemnumber ) {
 309         $query .= " AND ( itemnumber IS NULL OR itemnumber = ? )";
 310         push( @params, $itemnumber );
 311     }
 312     $query .= "ORDER BY priority";
 313     my $sth = $dbh->prepare($query);
 314     $sth->execute( @params );
 315     my @results;
 316     my $i = 0;
 317     while ( my $data = $sth->fetchrow_hashref ) {
 318
 319         # FIXME - What is this doing? How do constraints work?
 320         if ($data->{constrainttype} eq 'o') {
 321             $query = '
 322                 SELECT biblioitemnumber
 323                 FROM  reserveconstraints
 324                 WHERE  biblionumber   = ?
 325                 AND   borrowernumber = ?
 326                 AND   reservedate    = ?
 327             ';
 328             my $csth = $dbh->prepare($query);
 329             $csth->execute($data->{biblionumber}, $data->{borrowernumber}, $data->{reservedate});
 330             my @bibitemno;
 331             while ( my $bibitemnos = $csth->fetchrow_array ) {
 332                 push( @bibitemno, $bibitemnos );    # FIXME: inefficient: use fetchall_arrayref
 333             }
 334             my $count = scalar @bibitemno;
 335
 336             # if we have two or more different specific itemtypes
 337             # reserved by same person on same day
 338             my $bdata;
 339             if ( $count > 1 ) {
 340                 $bdata = GetBiblioItemData( $bibitemno[$i] );   # FIXME: This doesn't make sense.
 341                 $i++; #  $i can increase each pass, but the next @bibitemno might be smaller?
 342             }
 343             else {
 344                 # Look up the book we just found.
 345                 $bdata = GetBiblioItemData( $bibitemno[0] );
 346             }
 347             # Add the results of this latest search to the current
 348             # results.
 349             # FIXME - An 'each' would probably be more efficient.
 350             foreach my $key ( keys %$bdata ) {
 351                 $data->{$key} = $bdata->{$key};
 352             }
 353         }
 354         push @results, $data;
 355     }
 356     return ( $#results + 1, \@results );
 357 }
 358
 359 =head2 GetReservesFromItemnumber
 360
 361  ( $reservedate, $borrowernumber, $branchcode, $reserve_id ) = GetReservesFromItemnumber($itemnumber);
 362
 363 TODO :: Description here
 364
 365 =cut
 366
 367 sub GetReservesFromItemnumber {
 368     my ( $itemnumber, $all_dates ) = @_;
 369     my $dbh   = C4::Context->dbh;
 370     my $query = "
 371     SELECT reservedate,borrowernumber,branchcode,reserve_id
 372     FROM   reserves
 373     WHERE  itemnumber=?
 374     ";
 375     unless ( $all_dates ) {
 376         $query .= " AND reservedate <= CURRENT_DATE()";
 377     }
 378     my $sth_res = $dbh->prepare($query);
 379     $sth_res->execute($itemnumber);
 380     my ( $reservedate, $borrowernumber, $branchcode, $reserve_id ) = $sth_res->fetchrow_array;
 381     return ( $reservedate, $borrowernumber, $branchcode, $reserve_id );
 382 }
 383
 384 =head2 GetReservesFromBorrowernumber
 385
 386     $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
 387
 388 TODO :: Descritpion
 389
 390 =cut
 391
 392 sub GetReservesFromBorrowernumber {
 393     my ( $borrowernumber, $status ) = @_;
 394     my $dbh   = C4::Context->dbh;
 395     my $sth;
 396     if ($status) {
 397         $sth = $dbh->prepare("
 398             SELECT *
 399             FROM   reserves
 400             WHERE  borrowernumber=?
 401                 AND found =?
 402             ORDER BY reservedate
 403         ");
 404         $sth->execute($borrowernumber,$status);
 405     } else {
 406         $sth = $dbh->prepare("
 407             SELECT *
 408             FROM   reserves
 409             WHERE  borrowernumber=?
 410             ORDER BY reservedate
 411         ");
 412         $sth->execute($borrowernumber);
 413     }
 414     my $data = $sth->fetchall_arrayref({});
 415     return @$data;
 416 }
 417 #-------------------------------------------------------------------------------------
 418 =head2 CanBookBeReserved
 419
 420   $error = &CanBookBeReserved($borrowernumber, $biblionumber)
 421
 422 =cut
 423
 424 sub CanBookBeReserved{
 425     my ($borrowernumber, $biblionumber) = @_;
 426
 427     my $items = GetItemnumbersForBiblio($biblionumber);
 428     #get items linked via host records
 429     my @hostitems = get_hostitemnumbers_of($biblionumber);
 430     if (@hostitems){
 431     push (@$items,@hostitems);
 432     }
 433
 434     foreach my $item (@$items){
 435         return 1 if CanItemBeReserved($borrowernumber, $item);
 436     }
 437     return 0;
 438 }
 439
 440 =head2 CanItemBeReserved
 441
 442   $error = &CanItemBeReserved($borrowernumber, $itemnumber)
 443
 444 This function return 1 if an item can be issued by this borrower.
 445
 446 =cut
 447
 448 sub CanItemBeReserved{
 449     my ($borrowernumber, $itemnumber) = @_;
 450
 451     my $dbh             = C4::Context->dbh;
 452     my $allowedreserves = 0;
 453
 454     my $controlbranch = C4::Context->preference('ReservesControlBranch');
 455     my $itype         = C4::Context->preference('item-level_itypes') ? "itype" : "itemtype";
 456
 457     # we retrieve borrowers and items informations #
 458     my $item     = GetItem($itemnumber);
 459     my $borrower = C4::Members::GetMember('borrowernumber'=>$borrowernumber);
 460
 461     # we retrieve user rights on this itemtype and branchcode
 462     my $sth = $dbh->prepare("SELECT categorycode, itemtype, branchcode, reservesallowed
 463                              FROM issuingrules
 464                              WHERE (categorycode in (?,'*') )
 465                              AND (itemtype IN (?,'*'))
 466                              AND (branchcode IN (?,'*'))
 467                              ORDER BY
 468                                categorycode DESC,
 469                                itemtype     DESC,
 470                                branchcode   DESC;"
 471                            );
 472
 473     my $querycount ="SELECT
 474                             count(*) as count
 475                             FROM reserves
 476                                 LEFT JOIN items USING (itemnumber)
 477                                 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
 478                                 LEFT JOIN borrowers USING (borrowernumber)
 479                             WHERE borrowernumber = ?
 480                                 ";
 481
 482
 483     my $itemtype     = $item->{$itype};
 484     my $categorycode = $borrower->{categorycode};
 485     my $branchcode   = "";
 486     my $branchfield  = "reserves.branchcode";
 487
 488     if( $controlbranch eq "ItemHomeLibrary" ){
 489         $branchfield = "items.homebranch";
 490         $branchcode = $item->{homebranch};
 491     }elsif( $controlbranch eq "PatronLibrary" ){
 492         $branchfield = "borrowers.branchcode";
 493         $branchcode = $borrower->{branchcode};
 494     }
 495
 496     # we retrieve rights
 497     $sth->execute($categorycode, $itemtype, $branchcode);
 498     if(my $rights = $sth->fetchrow_hashref()){
 499         $itemtype        = $rights->{itemtype};
 500         $allowedreserves = $rights->{reservesallowed};
 501     }else{
 502         $itemtype = '*';
 503     }
 504
 505     # we retrieve count
 506
 507     $querycount .= "AND $branchfield = ?";
 508
 509     $querycount .= " AND $itype = ?" if ($itemtype ne "*");
 510     my $sthcount = $dbh->prepare($querycount);
 511
 512     if($itemtype eq "*"){
 513         $sthcount->execute($borrowernumber, $branchcode);
 514     }else{
 515         $sthcount->execute($borrowernumber, $branchcode, $itemtype);
 516     }
 517
 518     my $reservecount = "0";
 519     if(my $rowcount = $sthcount->fetchrow_hashref()){
 520         $reservecount = $rowcount->{count};
 521     }
 522
 523     # we check if it's ok or not
 524     if( $reservecount >= $allowedreserves ){
 525         return 0;
 526     }
 527
 528     # If reservecount is ok, we check item branch if IndependentBranches is ON
 529     # and canreservefromotherbranches is OFF
 530     if ( C4::Context->preference('IndependentBranches')
 531         and !C4::Context->preference('canreservefromotherbranches') )
 532     {
 533         my $itembranch = $item->{homebranch};
 534         if ($itembranch ne $borrower->{branchcode}) {
 535             return 0;
 536         }
 537     }
 538
 539     return 1;
 540 }
 541 #--------------------------------------------------------------------------------
 542 =head2 GetReserveCount
 543
 544   $number = &GetReserveCount($borrowernumber);
 545
 546 this function returns the number of reservation for a borrower given on input arg.
 547
 548 =cut
 549
 550 sub GetReserveCount {
 551     my ($borrowernumber) = @_;
 552
 553     my $dbh = C4::Context->dbh;
 554
 555     my $query = "
 556         SELECT COUNT(*) AS counter
 557         FROM reserves
 558         WHERE borrowernumber = ?
 559     ";
 560     my $sth = $dbh->prepare($query);
 561     $sth->execute($borrowernumber);
 562     my $row = $sth->fetchrow_hashref;
 563     return $row->{counter};
 564 }
 565
 566 =head2 GetOtherReserves
 567
 568   ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
 569
 570 Check queued list of this document and check if this document must be  transfered
 571
 572 =cut
 573
 574 sub GetOtherReserves {
 575     my ($itemnumber) = @_;
 576     my $messages;
 577     my $nextreservinfo;
 578     my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
 579     if ($checkreserves) {
 580         my $iteminfo = GetItem($itemnumber);
 581         if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
 582             $messages->{'transfert'} = $checkreserves->{'branchcode'};
 583             #minus priorities of others reservs
 584             ModReserveMinusPriority(
 585                 $itemnumber,
 586                 $checkreserves->{'reserve_id'},
 587             );
 588
 589             #launch the subroutine dotransfer
 590             C4::Items::ModItemTransfer(
 591                 $itemnumber,
 592                 $iteminfo->{'holdingbranch'},
 593                 $checkreserves->{'branchcode'}
 594               ),
 595               ;
 596         }
 597
 598      #step 2b : case of a reservation on the same branch, set the waiting status
 599         else {
 600             $messages->{'waiting'} = 1;
 601             ModReserveMinusPriority(
 602                 $itemnumber,
 603                 $checkreserves->{'reserve_id'},
 604             );
 605             ModReserveStatus($itemnumber,'W');
 606         }
 607
 608         $nextreservinfo = $checkreserves->{'borrowernumber'};
 609     }
 610
 611     return ( $messages, $nextreservinfo );
 612 }
 613
 614 =head2 GetReserveFee
 615
 616   $fee = GetReserveFee($borrowernumber,$biblionumber,$constraint,$biblionumber);
 617
 618 Calculate the fee for a reserve
 619
 620 =cut
 621
 622 sub GetReserveFee {
 623     my ($borrowernumber, $biblionumber, $constraint, $bibitems ) = @_;
 624
 625     #check for issues;
 626     my $dbh   = C4::Context->dbh;
 627     my $const = lc substr( $constraint, 0, 1 );
 628     my $query = qq/
 629       SELECT * FROM borrowers
 630     LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
 631     WHERE borrowernumber = ?
 632     /;
 633     my $sth = $dbh->prepare($query);
 634     $sth->execute($borrowernumber);
 635     my $data = $sth->fetchrow_hashref;
 636     my $fee      = $data->{'reservefee'};
 637     my $cntitems = @- > $bibitems;
 638
 639     if ( $fee > 0 ) {
 640
 641         # check for items on issue
 642         # first find biblioitem records
 643         my @biblioitems;
 644         my $sth1 = $dbh->prepare(
 645             "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber
 646                    WHERE (biblio.biblionumber = ?)"
 647         );
 648         $sth1->execute($biblionumber);
 649         while ( my $data1 = $sth1->fetchrow_hashref ) {
 650             if ( $const eq "a" ) {
 651                 push @biblioitems, $data1;
 652             }
 653             else {
 654                 my $found = 0;
 655                 my $x     = 0;
 656                 while ( $x < $cntitems ) {
 657                     if ( @$bibitems->{'biblioitemnumber'} ==
 658                         $data->{'biblioitemnumber'} )
 659                     {
 660                         $found = 1;
 661                     }
 662                     $x++;
 663                 }
 664                 if ( $const eq 'o' ) {
 665                     if ( $found == 1 ) {
 666                         push @biblioitems, $data1;
 667                     }
 668                 }
 669                 else {
 670                     if ( $found == 0 ) {
 671                         push @biblioitems, $data1;
 672                     }
 673                 }
 674             }
 675         }
 676         my $cntitemsfound = @biblioitems;
 677         my $issues        = 0;
 678         my $x             = 0;
 679         my $allissued     = 1;
 680         while ( $x < $cntitemsfound ) {
 681             my $bitdata = $biblioitems[$x];
 682             my $sth2    = $dbh->prepare(
 683                 "SELECT * FROM items
 684                      WHERE biblioitemnumber = ?"
 685             );
 686             $sth2->execute( $bitdata->{'biblioitemnumber'} );
 687             while ( my $itdata = $sth2->fetchrow_hashref ) {
 688                 my $sth3 = $dbh->prepare(
 689                     "SELECT * FROM issues
 690                        WHERE itemnumber = ?"
 691                 );
 692                 $sth3->execute( $itdata->{'itemnumber'} );
 693                 if ( my $isdata = $sth3->fetchrow_hashref ) {
 694                 }
 695                 else {
 696                     $allissued = 0;
 697                 }
 698             }
 699             $x++;
 700         }
 701         if ( $allissued == 0 ) {
 702             my $rsth =
 703               $dbh->prepare("SELECT * FROM reserves WHERE biblionumber = ?");
 704             $rsth->execute($biblionumber);
 705             if ( my $rdata = $rsth->fetchrow_hashref ) {
 706             }
 707             else {
 708                 $fee = 0;
 709             }
 710         }
 711     }
 712     return $fee;
 713 }
 714
 715 =head2 GetReservesToBranch
 716
 717   @transreserv = GetReservesToBranch( $frombranch );
 718
 719 Get reserve list for a given branch
 720
 721 =cut
 722
 723 sub GetReservesToBranch {
 724     my ( $frombranch ) = @_;
 725     my $dbh = C4::Context->dbh;
 726     my $sth = $dbh->prepare(
 727         "SELECT reserve_id,borrowernumber,reservedate,itemnumber,timestamp
 728          FROM reserves
 729          WHERE priority='0'
 730            AND branchcode=?"
 731     );
 732     $sth->execute( $frombranch );
 733     my @transreserv;
 734     my $i = 0;
 735     while ( my $data = $sth->fetchrow_hashref ) {
 736         $transreserv[$i] = $data;
 737         $i++;
 738     }
 739     return (@transreserv);
 740 }
 741
 742 =head2 GetReservesForBranch
 743
 744   @transreserv = GetReservesForBranch($frombranch);
 745
 746 =cut
 747
 748 sub GetReservesForBranch {
 749     my ($frombranch) = @_;
 750     my $dbh = C4::Context->dbh;
 751
 752     my $query = "
 753         SELECT reserve_id,borrowernumber,reservedate,itemnumber,waitingdate
 754         FROM   reserves
 755         WHERE   priority='0'
 756         AND found='W'
 757     ";
 758     $query .= " AND branchcode=? " if ( $frombranch );
 759     $query .= "ORDER BY waitingdate" ;
 760
 761     my $sth = $dbh->prepare($query);
 762     if ($frombranch){
 763      $sth->execute($frombranch);
 764     } else {
 765         $sth->execute();
 766     }
 767
 768     my @transreserv;
 769     my $i = 0;
 770     while ( my $data = $sth->fetchrow_hashref ) {
 771         $transreserv[$i] = $data;
 772         $i++;
 773     }
 774     return (@transreserv);
 775 }
 776
 777 =head2 GetReserveStatus
 778
 779   $reservestatus = GetReserveStatus($itemnumber, $biblionumber);
 780
 781 Take an itemnumber or a biblionumber and return the status of the reserve places on it.
 782 If several reserves exist, the reserve with the lower priority is given.
 783
 784 =cut
 785
 786 ## FIXME: I don't think this does what it thinks it does.
 787 ## It only ever checks the first reserve result, even though
 788 ## multiple reserves for that bib can have the itemnumber set
 789 ## the sub is only used once in the codebase.
 790 sub GetReserveStatus {
 791     my ($itemnumber, $biblionumber) = @_;
 792
 793     my $dbh = C4::Context->dbh;
 794
 795     my ($sth, $found, $priority);
 796     if ( $itemnumber ) {
 797         $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
 798         $sth->execute($itemnumber);
 799         ($found, $priority) = $sth->fetchrow_array;
 800     }
 801
 802     if ( $biblionumber and not defined $found and not defined $priority ) {
 803         $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE biblionumber = ? order by priority LIMIT 1");
 804         $sth->execute($biblionumber);
 805         ($found, $priority) = $sth->fetchrow_array;
 806     }
 807
 808     if(defined $found) {
 809         return 'Waiting'  if $found eq 'W' and $priority == 0;
 810         return 'Finished' if $found eq 'F';
 811     }
 812
 813     return 'Reserved' if $priority > 0;
 814
 815     return ''; # empty string here will remove need for checking undef, or less log lines
 816 }
 817
 818 =head2 CheckReserves
 819
 820   ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber);
 821   ($status, $reserve, $all_reserves) = &CheckReserves(undef, $barcode);
 822   ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
 823
 824 Find a book in the reserves.
 825
 826 C<$itemnumber> is the book's item number.
 827 C<$lookahead> is the number of days to look in advance for future reserves.
 828
 829 As I understand it, C<&CheckReserves> looks for the given item in the
 830 reserves. If it is found, that's a match, and C<$status> is set to
 831 C<Waiting>.
 832
 833 Otherwise, it finds the most important item in the reserves with the
 834 same biblio number as this book (I'm not clear on this) and returns it
 835 with C<$status> set to C<Reserved>.
 836
 837 C<&CheckReserves> returns a two-element list:
 838
 839 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
 840
 841 C<$reserve> is the reserve item that matched. It is a
 842 reference-to-hash whose keys are mostly the fields of the reserves
 843 table in the Koha database.
 844
 845 =cut
 846
 847 sub CheckReserves {
 848     my ( $item, $barcode, $lookahead_days) = @_;
 849     my $dbh = C4::Context->dbh;
 850     my $sth;
 851     my $select;
 852     if (C4::Context->preference('item-level_itypes')){
 853         $select = "
 854            SELECT items.biblionumber,
 855            items.biblioitemnumber,
 856            itemtypes.notforloan,
 857            items.notforloan AS itemnotforloan,
 858            items.itemnumber
 859            FROM   items
 860            LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
 861            LEFT JOIN itemtypes   ON items.itype   = itemtypes.itemtype
 862         ";
 863     }
 864     else {
 865         $select = "
 866            SELECT items.biblionumber,
 867            items.biblioitemnumber,
 868            itemtypes.notforloan,
 869            items.notforloan AS itemnotforloan,
 870            items.itemnumber
 871            FROM   items
 872            LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
 873            LEFT JOIN itemtypes   ON biblioitems.itemtype   = itemtypes.itemtype
 874         ";
 875     }
 876
 877     if ($item) {
 878         $sth = $dbh->prepare("$select WHERE itemnumber = ?");
 879         $sth->execute($item);
 880     }
 881     else {
 882         $sth = $dbh->prepare("$select WHERE barcode = ?");
 883         $sth->execute($barcode);
 884     }
 885     # note: we get the itemnumber because we might have started w/ just the barcode.  Now we know for sure we have it.
 886     my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber ) = $sth->fetchrow_array;
 887
 888     return ( '' ) unless $itemnumber; # bail if we got nothing.
 889
 890     # if item is not for loan it cannot be reserved either.....
 891     #    execpt where items.notforloan < 0 :  This indicates the item is holdable.
 892     return ( '' ) if  ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
 893
 894     # Find this item in the reserves
 895     my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days);
 896
 897     # $priority and $highest are used to find the most important item
 898     # in the list returned by &_Findgroupreserve. (The lower $priority,
 899     # the more important the item.)
 900     # $highest is the most important item we've seen so far.
 901     my $highest;
 902     if (scalar @reserves) {
 903         my $priority = 10000000;
 904         foreach my $res (@reserves) {
 905             if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
 906                 return ( "Waiting", $res, \@reserves ); # Found it
 907             } else {
 908                 # See if this item is more important than what we've got so far
 909                 if ( $res->{'priority'} && $res->{'priority'} < $priority ) {
 910                     my $borrowerinfo=C4::Members::GetMember(borrowernumber => $res->{'borrowernumber'});
 911                     my $iteminfo=C4::Items::GetItem($itemnumber);
 912                     my $branch = GetReservesControlBranch( $iteminfo, $borrowerinfo );
 913                     my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$iteminfo->{'itype'});
 914                     next if ($branchitemrule->{'holdallowed'} == 0);
 915                     next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $borrowerinfo->{'branchcode'}));
 916                     $priority = $res->{'priority'};
 917                     $highest  = $res;
 918                 }
 919             }
 920         }
 921     }
 922
 923     # If we get this far, then no exact match was found.
 924     # We return the most important (i.e. next) reservation.
 925     if ($highest) {
 926         $highest->{'itemnumber'} = $item;
 927         return ( "Reserved", $highest, \@reserves );
 928     }
 929
 930     return ( '' );
 931 }
 932
 933 =head2 CancelExpiredReserves
 934
 935   CancelExpiredReserves();
 936
 937 Cancels all reserves with an expiration date from before today.
 938
 939 =cut
 940
 941 sub CancelExpiredReserves {
 942
 943     # Cancel reserves that have passed their expiration date.
 944     my $dbh = C4::Context->dbh;
 945     my $sth = $dbh->prepare( "
 946         SELECT * FROM reserves WHERE DATE(expirationdate) < DATE( CURDATE() )
 947         AND expirationdate IS NOT NULL
 948         AND found IS NULL
 949     " );
 950     $sth->execute();
 951
 952     while ( my $res = $sth->fetchrow_hashref() ) {
 953         CancelReserve({ reserve_id => $res->{'reserve_id'} });
 954     }
 955
 956     # Cancel reserves that have been waiting too long
 957     if ( C4::Context->preference("ExpireReservesMaxPickUpDelay") ) {
 958         my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
 959         my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
 960
 961         my $query = "SELECT * FROM reserves WHERE TO_DAYS( NOW() ) - TO_DAYS( waitingdate ) > ? AND found = 'W' AND priority = 0";
 962         $sth = $dbh->prepare( $query );
 963         $sth->execute( $max_pickup_delay );
 964
 965         while (my $res = $sth->fetchrow_hashref ) {
 966             if ( $charge ) {
 967                 manualinvoice($res->{'borrowernumber'}, $res->{'itemnumber'}, 'Hold waiting too long', 'F', $charge);
 968             }
 969
 970             CancelReserve({ reserve_id => $res->{'reserve_id'} });
 971         }
 972     }
 973
 974 }
 975
 976 =head2 AutoUnsuspendReserves
 977
 978   AutoUnsuspendReserves();
 979
 980 Unsuspends all suspended reserves with a suspend_until date from before today.
 981
 982 =cut
 983
 984 sub AutoUnsuspendReserves {
 985
 986     my $dbh = C4::Context->dbh;
 987
 988     my $query = "UPDATE reserves SET suspend = 0, suspend_until = NULL WHERE DATE( suspend_until ) < DATE( CURDATE() )";
 989     my $sth = $dbh->prepare( $query );
 990     $sth->execute();
 991
 992 }
 993
 994 =head2 CancelReserve
 995
 996   CancelReserve({ reserve_id => $reserve_id, [ biblionumber => $biblionumber, borrowernumber => $borrrowernumber, itemnumber => $itemnumber ] });
 997
 998 Cancels a reserve.
 999
1000 =cut
1001
1002 sub CancelReserve {
1003     my ( $params ) = @_;
1004
1005     my $reserve_id = $params->{'reserve_id'};
1006     $reserve_id = GetReserveId( $params ) unless ( $reserve_id );
1007
1008     return unless ( $reserve_id );
1009
1010     my $dbh = C4::Context->dbh;
1011
1012     my $reserve = GetReserve( $reserve_id );
1013
1014     my $query = "
1015         UPDATE reserves
1016         SET    cancellationdate = now(),
1017                found            = Null,
1018                priority         = 0
1019         WHERE  reserve_id = ?
1020     ";
1021     my $sth = $dbh->prepare($query);
1022     $sth->execute( $reserve_id );
1023
1024     $query = "
1025         INSERT INTO old_reserves
1026         SELECT * FROM reserves
1027         WHERE  reserve_id = ?
1028     ";
1029     $sth = $dbh->prepare($query);
1030     $sth->execute( $reserve_id );
1031
1032     $query = "
1033         DELETE FROM reserves
1034         WHERE  reserve_id = ?
1035     ";
1036     $sth = $dbh->prepare($query);
1037     $sth->execute( $reserve_id );
1038
1039     # now fix the priority on the others....
1040     _FixPriority({
1041         reserve_id   => $reserve_id,
1042         biblionumber => $reserve->{biblionumber},
1043     });
1044 }
1045
1046 =head2 ModReserve
1047
1048   ModReserve({ rank => $rank,
1049                reserve_id => $reserve_id,
1050                branchcode => $branchcode
1051                [, itemnumber => $itemnumber ]
1052                [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1053               });
1054
1055 Change a hold request's priority or cancel it.
1056
1057 C<$rank> specifies the effect of the change.  If C<$rank>
1058 is 'W' or 'n', nothing happens.  This corresponds to leaving a
1059 request alone when changing its priority in the holds queue
1060 for a bib.
1061
1062 If C<$rank> is 'del', the hold request is cancelled.
1063
1064 If C<$rank> is an integer greater than zero, the priority of
1065 the request is set to that value.  Since priority != 0 means
1066 that the item is not waiting on the hold shelf, setting the
1067 priority to a non-zero value also sets the request's found
1068 status and waiting date to NULL.
1069
1070 The optional C<$itemnumber> parameter is used only when
1071 C<$rank> is a non-zero integer; if supplied, the itemnumber
1072 of the hold request is set accordingly; if omitted, the itemnumber
1073 is cleared.
1074
1075 B<FIXME:> Note that the forgoing can have the effect of causing
1076 item-level hold requests to turn into title-level requests.  This
1077 will be fixed once reserves has separate columns for requested
1078 itemnumber and supplying itemnumber.
1079
1080 =cut
1081
1082 sub ModReserve {
1083     my ( $params ) = @_;
1084
1085     my $rank = $params->{'rank'};
1086     my $reserve_id = $params->{'reserve_id'};
1087     my $branchcode = $params->{'branchcode'};
1088     my $itemnumber = $params->{'itemnumber'};
1089     my $suspend_until = $params->{'suspend_until'};
1090     my $borrowernumber = $params->{'borrowernumber'};
1091     my $biblionumber = $params->{'biblionumber'};
1092
1093     return if $rank eq "W";
1094     return if $rank eq "n";
1095
1096     return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1097     $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber }) unless ( $reserve_id );
1098
1099     my $dbh = C4::Context->dbh;
1100     if ( $rank eq "del" ) {
1101         CancelReserve({ reserve_id => $reserve_id });
1102     }
1103     elsif ($rank =~ /^\d+/ and $rank > 0) {
1104         my $query = "
1105             UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL, waitingdate = NULL
1106             WHERE reserve_id = ?
1107         ";
1108         my $sth = $dbh->prepare($query);
1109         $sth->execute( $rank, $branchcode, $itemnumber, $reserve_id );
1110
1111         if ( defined( $suspend_until ) ) {
1112             if ( $suspend_until ) {
1113                 $suspend_until = C4::Dates->new( $suspend_until )->output("iso");
1114                 $dbh->do("UPDATE reserves SET suspend = 1, suspend_until = ? WHERE reserve_id = ?", undef, ( $suspend_until, $reserve_id ) );
1115             } else {
1116                 $dbh->do("UPDATE reserves SET suspend_until = NULL WHERE reserve_id = ?", undef, ( $reserve_id ) );
1117             }
1118         }
1119
1120         _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
1121     }
1122 }
1123
1124 =head2 ModReserveFill
1125
1126   &ModReserveFill($reserve);
1127
1128 Fill a reserve. If I understand this correctly, this means that the
1129 reserved book has been found and given to the patron who reserved it.
1130
1131 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
1132 whose keys are fields from the reserves table in the Koha database.
1133
1134 =cut
1135
1136 sub ModReserveFill {
1137     my ($res) = @_;
1138     my $dbh = C4::Context->dbh;
1139     # fill in a reserve record....
1140     my $reserve_id = $res->{'reserve_id'};
1141     my $biblionumber = $res->{'biblionumber'};
1142     my $borrowernumber    = $res->{'borrowernumber'};
1143     my $resdate = $res->{'reservedate'};
1144
1145     # get the priority on this record....
1146     my $priority;
1147     my $query = "SELECT priority
1148                  FROM   reserves
1149                  WHERE  biblionumber   = ?
1150                   AND   borrowernumber = ?
1151                   AND   reservedate    = ?";
1152     my $sth = $dbh->prepare($query);
1153     $sth->execute( $biblionumber, $borrowernumber, $resdate );
1154     ($priority) = $sth->fetchrow_array;
1155
1156     # update the database...
1157     $query = "UPDATE reserves
1158                   SET    found            = 'F',
1159                          priority         = 0
1160                  WHERE  biblionumber     = ?
1161                     AND reservedate      = ?
1162                     AND borrowernumber   = ?
1163                 ";
1164     $sth = $dbh->prepare($query);
1165     $sth->execute( $biblionumber, $resdate, $borrowernumber );
1166
1167     # move to old_reserves
1168     $query = "INSERT INTO old_reserves
1169                  SELECT * FROM reserves
1170                  WHERE  biblionumber     = ?
1171                     AND reservedate      = ?
1172                     AND borrowernumber   = ?
1173                 ";
1174     $sth = $dbh->prepare($query);
1175     $sth->execute( $biblionumber, $resdate, $borrowernumber );
1176     $query = "DELETE FROM reserves
1177                  WHERE  biblionumber     = ?
1178                     AND reservedate      = ?
1179                     AND borrowernumber   = ?
1180                 ";
1181     $sth = $dbh->prepare($query);
1182     $sth->execute( $biblionumber, $resdate, $borrowernumber );
1183
1184     # now fix the priority on the others (if the priority wasn't
1185     # already sorted!)....
1186     unless ( $priority == 0 ) {
1187         _FixPriority({ reserve_id => $reserve_id });
1188     }
1189 }
1190
1191 =head2 ModReserveStatus
1192
1193   &ModReserveStatus($itemnumber, $newstatus);
1194
1195 Update the reserve status for the active (priority=0) reserve.
1196
1197 $itemnumber is the itemnumber the reserve is on
1198
1199 $newstatus is the new status.
1200
1201 =cut
1202
1203 sub ModReserveStatus {
1204
1205     #first : check if we have a reservation for this item .
1206     my ($itemnumber, $newstatus) = @_;
1207     my $dbh = C4::Context->dbh;
1208
1209     my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1210     my $sth_set = $dbh->prepare($query);
1211     $sth_set->execute( $newstatus, $itemnumber );
1212
1213     if ( C4::Context->preference("ReturnToShelvingCart") && $newstatus ) {
1214       CartToShelf( $itemnumber );
1215     }
1216 }
1217
1218 =head2 ModReserveAffect
1219
1220   &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend);
1221
1222 This function affect an item and a status for a given reserve
1223 The itemnumber parameter is used to find the biblionumber.
1224 with the biblionumber & the borrowernumber, we can affect the itemnumber
1225 to the correct reserve.
1226
1227 if $transferToDo is not set, then the status is set to "Waiting" as well.
1228 otherwise, a transfer is on the way, and the end of the transfer will
1229 take care of the waiting status
1230
1231 =cut
1232
1233 sub ModReserveAffect {
1234     my ( $itemnumber, $borrowernumber,$transferToDo ) = @_;
1235     my $dbh = C4::Context->dbh;
1236
1237     # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1238     # attached to $itemnumber
1239     my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1240     $sth->execute($itemnumber);
1241     my ($biblionumber) = $sth->fetchrow;
1242
1243     # get request - need to find out if item is already
1244     # waiting in order to not send duplicate hold filled notifications
1245     my $reserve_id = GetReserveId({
1246         borrowernumber => $borrowernumber,
1247         biblionumber   => $biblionumber,
1248     });
1249     return unless defined $reserve_id;
1250     my $request = GetReserveInfo($reserve_id);
1251     my $already_on_shelf = ($request && $request->{found} eq 'W') ? 1 : 0;
1252
1253     # If we affect a reserve that has to be transfered, don't set to Waiting
1254     my $query;
1255     if ($transferToDo) {
1256     $query = "
1257         UPDATE reserves
1258         SET    priority = 0,
1259                itemnumber = ?,
1260                found = 'T'
1261         WHERE borrowernumber = ?
1262           AND biblionumber = ?
1263     ";
1264     }
1265     else {
1266     # affect the reserve to Waiting as well.
1267         $query = "
1268             UPDATE reserves
1269             SET     priority = 0,
1270                     found = 'W',
1271                     waitingdate = NOW(),
1272                     itemnumber = ?
1273             WHERE borrowernumber = ?
1274               AND biblionumber = ?
1275         ";
1276     }
1277     $sth = $dbh->prepare($query);
1278     $sth->execute( $itemnumber, $borrowernumber,$biblionumber);
1279     _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo && !$already_on_shelf );
1280
1281     if ( C4::Context->preference("ReturnToShelvingCart") ) {
1282       CartToShelf( $itemnumber );
1283     }
1284
1285     return;
1286 }
1287
1288 =head2 ModReserveCancelAll
1289
1290   ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1291
1292 function to cancel reserv,check other reserves, and transfer document if it's necessary
1293
1294 =cut
1295
1296 sub ModReserveCancelAll {
1297     my $messages;
1298     my $nextreservinfo;
1299     my ( $itemnumber, $borrowernumber ) = @_;
1300
1301     #step 1 : cancel the reservation
1302     my $CancelReserve = CancelReserve({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1303
1304     #step 2 launch the subroutine of the others reserves
1305     ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1306
1307     return ( $messages, $nextreservinfo );
1308 }
1309
1310 =head2 ModReserveMinusPriority
1311
1312   &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1313
1314 Reduce the values of queued list
1315
1316 =cut
1317
1318 sub ModReserveMinusPriority {
1319     my ( $itemnumber, $reserve_id ) = @_;
1320
1321     #first step update the value of the first person on reserv
1322     my $dbh   = C4::Context->dbh;
1323     my $query = "
1324         UPDATE reserves
1325         SET    priority = 0 , itemnumber = ?
1326         WHERE  reserve_id = ?
1327     ";
1328     my $sth_upd = $dbh->prepare($query);
1329     $sth_upd->execute( $itemnumber, $reserve_id );
1330     # second step update all others reservs
1331     _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1332 }
1333
1334 =head2 GetReserveInfo
1335
1336   &GetReserveInfo($reserve_id);
1337
1338 Get item and borrower details for a current hold.
1339 Current implementation this query should have a single result.
1340
1341 =cut
1342
1343 sub GetReserveInfo {
1344     my ( $reserve_id ) = @_;
1345     my $dbh = C4::Context->dbh;
1346     my $strsth="SELECT
1347                    reserve_id,
1348                    reservedate,
1349                    reservenotes,
1350                    reserves.borrowernumber,
1351                    reserves.biblionumber,
1352                    reserves.branchcode,
1353                    reserves.waitingdate,
1354                    notificationdate,
1355                    reminderdate,
1356                    priority,
1357                    found,
1358                    firstname,
1359                    surname,
1360                    phone,
1361                    email,
1362                    address,
1363                    address2,
1364                    cardnumber,
1365                    city,
1366                    zipcode,
1367                    biblio.title,
1368                    biblio.author,
1369                    items.holdingbranch,
1370                    items.itemcallnumber,
1371                    items.itemnumber,
1372                    items.location,
1373                    barcode,
1374                    notes
1375                 FROM reserves
1376                 LEFT JOIN items USING(itemnumber)
1377                 LEFT JOIN borrowers USING(borrowernumber)
1378                 LEFT JOIN biblio ON  (reserves.biblionumber=biblio.biblionumber)
1379                 WHERE reserves.reserve_id = ?";
1380     my $sth = $dbh->prepare($strsth);
1381     $sth->execute($reserve_id);
1382
1383     my $data = $sth->fetchrow_hashref;
1384     return $data;
1385 }
1386
1387 =head2 IsAvailableForItemLevelRequest
1388
1389   my $is_available = IsAvailableForItemLevelRequest($itemnumber);
1390
1391 Checks whether a given item record is available for an
1392 item-level hold request.  An item is available if
1393
1394 * it is not lost AND
1395 * it is not damaged AND
1396 * it is not withdrawn AND
1397 * does not have a not for loan value > 0
1398
1399 Whether or not the item is currently on loan is
1400 also checked - if the AllowOnShelfHolds system preference
1401 is ON, an item can be requested even if it is currently
1402 on loan to somebody else.  If the system preference
1403 is OFF, an item that is currently checked out cannot
1404 be the target of an item-level hold request.
1405
1406 Note that IsAvailableForItemLevelRequest() does not
1407 check if the staff operator is authorized to place
1408 a request on the item - in particular,
1409 this routine does not check IndependentBranches
1410 and canreservefromotherbranches.
1411
1412 =cut
1413
1414 sub IsAvailableForItemLevelRequest {
1415     my $itemnumber = shift;
1416
1417     my $item = GetItem($itemnumber);
1418
1419     # must check the notforloan setting of the itemtype
1420     # FIXME - a lot of places in the code do this
1421     #         or something similar - need to be
1422     #         consolidated
1423     my $dbh = C4::Context->dbh;
1424     my $notforloan_query;
1425     if (C4::Context->preference('item-level_itypes')) {
1426         $notforloan_query = "SELECT itemtypes.notforloan
1427                              FROM items
1428                              JOIN itemtypes ON (itemtypes.itemtype = items.itype)
1429                              WHERE itemnumber = ?";
1430     } else {
1431         $notforloan_query = "SELECT itemtypes.notforloan
1432                              FROM items
1433                              JOIN biblioitems USING (biblioitemnumber)
1434                              JOIN itemtypes USING (itemtype)
1435                              WHERE itemnumber = ?";
1436     }
1437     my $sth = $dbh->prepare($notforloan_query);
1438     $sth->execute($itemnumber);
1439     my $notforloan_per_itemtype = 0;
1440     if (my ($notforloan) = $sth->fetchrow_array) {
1441         $notforloan_per_itemtype = 1 if $notforloan;
1442     }
1443
1444     my $available_per_item = 1;
1445     $available_per_item = 0 if $item->{itemlost} or
1446                                ( $item->{notforloan} > 0 ) or
1447                                ($item->{damaged} and not C4::Context->preference('AllowHoldsOnDamagedItems')) or
1448                                $item->{withdrawn} or
1449                                $notforloan_per_itemtype;
1450
1451
1452     if (C4::Context->preference('AllowOnShelfHolds')) {
1453         return $available_per_item;
1454     } else {
1455         return ($available_per_item and ($item->{onloan} or GetReserveStatus($itemnumber) eq "Waiting"));
1456     }
1457 }
1458
1459 =head2 AlterPriority
1460
1461   AlterPriority( $where, $reserve_id );
1462
1463 This function changes a reserve's priority up, down, to the top, or to the bottom.
1464 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1465
1466 =cut
1467
1468 sub AlterPriority {
1469     my ( $where, $reserve_id ) = @_;
1470
1471     my $dbh = C4::Context->dbh;
1472
1473     my $reserve = GetReserve( $reserve_id );
1474
1475     if ( $reserve->{cancellationdate} ) {
1476         warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (".$reserve->{cancellationdate}.')';
1477         return;
1478     }
1479
1480     if ( $where eq 'up' || $where eq 'down' ) {
1481
1482       my $priority = $reserve->{'priority'};
1483       $priority = $where eq 'up' ? $priority - 1 : $priority + 1;
1484       _FixPriority({ reserve_id => $reserve_id, rank => $priority })
1485
1486     } elsif ( $where eq 'top' ) {
1487
1488       _FixPriority({ reserve_id => $reserve_id, rank => '1' })
1489
1490     } elsif ( $where eq 'bottom' ) {
1491
1492       _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1493
1494     }
1495 }
1496
1497 =head2 ToggleLowestPriority
1498
1499   ToggleLowestPriority( $borrowernumber, $biblionumber );
1500
1501 This function sets the lowestPriority field to true if is false, and false if it is true.
1502
1503 =cut
1504
1505 sub ToggleLowestPriority {
1506     my ( $reserve_id ) = @_;
1507
1508     my $dbh = C4::Context->dbh;
1509
1510     my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1511     $sth->execute( $reserve_id );
1512
1513     _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1514 }
1515
1516 =head2 ToggleSuspend
1517
1518   ToggleSuspend( $reserve_id );
1519
1520 This function sets the suspend field to true if is false, and false if it is true.
1521 If the reserve is currently suspended with a suspend_until date, that date will
1522 be cleared when it is unsuspended.
1523
1524 =cut
1525
1526 sub ToggleSuspend {
1527     my ( $reserve_id, $suspend_until ) = @_;
1528
1529     $suspend_until = output_pref({ dt => dt_from_string( $suspend_until ), dateformat => 'iso' }) if ( $suspend_until );
1530
1531     my $do_until = ( $suspend_until ) ? '?' : 'NULL';
1532
1533     my $dbh = C4::Context->dbh;
1534
1535     my $sth = $dbh->prepare(
1536         "UPDATE reserves SET suspend = NOT suspend,
1537         suspend_until = CASE WHEN suspend = 0 THEN NULL ELSE $do_until END
1538         WHERE reserve_id = ?
1539     ");
1540
1541     my @params;
1542     push( @params, $suspend_until ) if ( $suspend_until );
1543     push( @params, $reserve_id );
1544
1545     $sth->execute( @params );
1546 }
1547
1548 =head2 SuspendAll
1549
1550   SuspendAll(
1551       borrowernumber   => $borrowernumber,
1552       [ biblionumber   => $biblionumber, ]
1553       [ suspend_until  => $suspend_until, ]
1554       [ suspend        => $suspend ]
1555   );
1556
1557   This function accepts a set of hash keys as its parameters.
1558   It requires either borrowernumber or biblionumber, or both.
1559
1560   suspend_until is wholly optional.
1561
1562 =cut
1563
1564 sub SuspendAll {
1565     my %params = @_;
1566
1567     my $borrowernumber = $params{'borrowernumber'} || undef;
1568     my $biblionumber   = $params{'biblionumber'}   || undef;
1569     my $suspend_until  = $params{'suspend_until'}  || undef;
1570     my $suspend        = defined( $params{'suspend'} ) ? $params{'suspend'} :  1;
1571
1572     $suspend_until = C4::Dates->new( $suspend_until )->output("iso") if ( defined( $suspend_until ) );
1573
1574     return unless ( $borrowernumber || $biblionumber );
1575
1576     my ( $query, $sth, $dbh, @query_params );
1577
1578     $query = "UPDATE reserves SET suspend = ? ";
1579     push( @query_params, $suspend );
1580     if ( !$suspend ) {
1581         $query .= ", suspend_until = NULL ";
1582     } elsif ( $suspend_until ) {
1583         $query .= ", suspend_until = ? ";
1584         push( @query_params, $suspend_until );
1585     }
1586     $query .= " WHERE ";
1587     if ( $borrowernumber ) {
1588         $query .= " borrowernumber = ? ";
1589         push( @query_params, $borrowernumber );
1590     }
1591     $query .= " AND " if ( $borrowernumber && $biblionumber );
1592     if ( $biblionumber ) {
1593         $query .= " biblionumber = ? ";
1594         push( @query_params, $biblionumber );
1595     }
1596     $query .= " AND found IS NULL ";
1597
1598     $dbh = C4::Context->dbh;
1599     $sth = $dbh->prepare( $query );
1600     $sth->execute( @query_params );
1601 }
1602
1603
1604 =head2 _FixPriority
1605
1606   &_FixPriority({ reserve_id => $reserve_id, rank => $rank, ignoreSetLowestRank => $ignoreSetLowestRank });
1607
1608 Only used internally (so don't export it)
1609 Changed how this functions works #
1610 Now just gets an array of reserves in the rank order and updates them with
1611 the array index (+1 as array starts from 0)
1612 and if $rank is supplied will splice item from the array and splice it back in again
1613 in new priority rank
1614
1615 =cut
1616
1617 sub _FixPriority {
1618     my ( $params ) = @_;
1619     my $reserve_id = $params->{reserve_id};
1620     my $rank = $params->{rank};
1621     my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1622     my $biblionumber = $params->{biblionumber};
1623
1624     my $dbh = C4::Context->dbh;
1625
1626     unless ( $biblionumber ) {
1627         my $res = GetReserve( $reserve_id );
1628         $biblionumber = $res->{biblionumber};
1629     }
1630
1631     if ( $rank eq "del" ) {
1632          CancelReserve({ reserve_id => $reserve_id });
1633     }
1634     elsif ( $rank eq "W" || $rank eq "0" ) {
1635
1636         # make sure priority for waiting or in-transit items is 0
1637         my $query = "
1638             UPDATE reserves
1639             SET    priority = 0
1640             WHERE reserve_id = ?
1641             AND found IN ('W', 'T')
1642         ";
1643         my $sth = $dbh->prepare($query);
1644         $sth->execute( $reserve_id );
1645     }
1646     my @priority;
1647
1648     # get whats left
1649     my $query = "
1650         SELECT reserve_id, borrowernumber, reservedate, constrainttype
1651         FROM   reserves
1652         WHERE  biblionumber   = ?
1653           AND  ((found <> 'W' AND found <> 'T') OR found IS NULL)
1654         ORDER BY priority ASC
1655     ";
1656     my $sth = $dbh->prepare($query);
1657     $sth->execute( $biblionumber );
1658     while ( my $line = $sth->fetchrow_hashref ) {
1659         push( @priority,     $line );
1660     }
1661
1662     # To find the matching index
1663     my $i;
1664     my $key = -1;    # to allow for 0 to be a valid result
1665     for ( $i = 0 ; $i < @priority ; $i++ ) {
1666         if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1667             $key = $i;    # save the index
1668             last;
1669         }
1670     }
1671
1672     # if index exists in array then move it to new position
1673     if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1674         my $new_rank = $rank -
1675           1;    # $new_rank is what you want the new index to be in the array
1676         my $moving_item = splice( @priority, $key, 1 );
1677         splice( @priority, $new_rank, 0, $moving_item );
1678     }
1679
1680     # now fix the priority on those that are left....
1681     $query = "
1682         UPDATE reserves
1683         SET    priority = ?
1684         WHERE  reserve_id = ?
1685     ";
1686     $sth = $dbh->prepare($query);
1687     for ( my $j = 0 ; $j < @priority ; $j++ ) {
1688         $sth->execute(
1689             $j + 1,
1690             $priority[$j]->{'reserve_id'}
1691         );
1692     }
1693
1694     $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1695     $sth->execute();
1696
1697     unless ( $ignoreSetLowestRank ) {
1698       while ( my $res = $sth->fetchrow_hashref() ) {
1699         _FixPriority({
1700             reserve_id => $res->{'reserve_id'},
1701             rank => '999999',
1702             ignoreSetLowestRank => 1
1703         });
1704       }
1705     }
1706 }
1707
1708 =head2 _Findgroupreserve
1709
1710   @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead);
1711
1712 Looks for an item-specific match first, then for a title-level match, returning the
1713 first match found.  If neither, then we look for a 3rd kind of match based on
1714 reserve constraints.
1715 Lookahead is the number of days to look in advance.
1716
1717 TODO: add more explanation about reserve constraints
1718
1719 C<&_Findgroupreserve> returns :
1720 C<@results> is an array of references-to-hash whose keys are mostly
1721 fields from the reserves table of the Koha database, plus
1722 C<biblioitemnumber>.
1723
1724 =cut
1725
1726 sub _Findgroupreserve {
1727     my ( $bibitem, $biblio, $itemnumber, $lookahead) = @_;
1728     my $dbh   = C4::Context->dbh;
1729
1730     # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1731     # check for exact targetted match
1732     my $item_level_target_query = qq/
1733         SELECT reserves.biblionumber        AS biblionumber,
1734                reserves.borrowernumber      AS borrowernumber,
1735                reserves.reservedate         AS reservedate,
1736                reserves.branchcode          AS branchcode,
1737                reserves.cancellationdate    AS cancellationdate,
1738                reserves.found               AS found,
1739                reserves.reservenotes        AS reservenotes,
1740                reserves.priority            AS priority,
1741                reserves.timestamp           AS timestamp,
1742                biblioitems.biblioitemnumber AS biblioitemnumber,
1743                reserves.itemnumber          AS itemnumber,
1744                reserves.reserve_id          AS reserve_id
1745         FROM reserves
1746         JOIN biblioitems USING (biblionumber)
1747         JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1748         WHERE found IS NULL
1749         AND priority > 0
1750         AND item_level_request = 1
1751         AND itemnumber = ?
1752         AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1753         AND suspend = 0
1754     /;
1755     my $sth = $dbh->prepare($item_level_target_query);
1756     $sth->execute($itemnumber, $lookahead||0);
1757     my @results;
1758     if ( my $data = $sth->fetchrow_hashref ) {
1759         push( @results, $data );
1760     }
1761     return @results if @results;
1762
1763     # check for title-level targetted match
1764     my $title_level_target_query = qq/
1765         SELECT reserves.biblionumber        AS biblionumber,
1766                reserves.borrowernumber      AS borrowernumber,
1767                reserves.reservedate         AS reservedate,
1768                reserves.branchcode          AS branchcode,
1769                reserves.cancellationdate    AS cancellationdate,
1770                reserves.found               AS found,
1771                reserves.reservenotes        AS reservenotes,
1772                reserves.priority            AS priority,
1773                reserves.timestamp           AS timestamp,
1774                biblioitems.biblioitemnumber AS biblioitemnumber,
1775                reserves.itemnumber          AS itemnumber
1776         FROM reserves
1777         JOIN biblioitems USING (biblionumber)
1778         JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1779         WHERE found IS NULL
1780         AND priority > 0
1781         AND item_level_request = 0
1782         AND hold_fill_targets.itemnumber = ?
1783         AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1784         AND suspend = 0
1785     /;
1786     $sth = $dbh->prepare($title_level_target_query);
1787     $sth->execute($itemnumber, $lookahead||0);
1788     @results = ();
1789     if ( my $data = $sth->fetchrow_hashref ) {
1790         push( @results, $data );
1791     }
1792     return @results if @results;
1793
1794     my $query = qq/
1795         SELECT reserves.biblionumber               AS biblionumber,
1796                reserves.borrowernumber             AS borrowernumber,
1797                reserves.reservedate                AS reservedate,
1798                reserves.waitingdate                AS waitingdate,
1799                reserves.branchcode                 AS branchcode,
1800                reserves.cancellationdate           AS cancellationdate,
1801                reserves.found                      AS found,
1802                reserves.reservenotes               AS reservenotes,
1803                reserves.priority                   AS priority,
1804                reserves.timestamp                  AS timestamp,
1805                reserveconstraints.biblioitemnumber AS biblioitemnumber,
1806                reserves.itemnumber                 AS itemnumber
1807         FROM reserves
1808           LEFT JOIN reserveconstraints ON reserves.biblionumber = reserveconstraints.biblionumber
1809         WHERE reserves.biblionumber = ?
1810           AND ( ( reserveconstraints.biblioitemnumber = ?
1811           AND reserves.borrowernumber = reserveconstraints.borrowernumber
1812           AND reserves.reservedate    = reserveconstraints.reservedate )
1813           OR  reserves.constrainttype='a' )
1814           AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1815           AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1816           AND suspend = 0
1817     /;
1818     $sth = $dbh->prepare($query);
1819     $sth->execute( $biblio, $bibitem, $itemnumber, $lookahead||0);
1820     @results = ();
1821     while ( my $data = $sth->fetchrow_hashref ) {
1822         push( @results, $data );
1823     }
1824     return @results;
1825 }
1826
1827 =head2 _koha_notify_reserve
1828
1829   _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber );
1830
1831 Sends a notification to the patron that their hold has been filled (through
1832 ModReserveAffect, _not_ ModReserveFill)
1833
1834 =cut
1835
1836 sub _koha_notify_reserve {
1837     my ($itemnumber, $borrowernumber, $biblionumber) = @_;
1838
1839     my $dbh = C4::Context->dbh;
1840     my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
1841
1842     # Try to get the borrower's email address
1843     my $to_address = C4::Members::GetNoticeEmailAddress($borrowernumber);
1844
1845     my $letter_code;
1846     my $print_mode = 0;
1847     my $messagingprefs;
1848     if ( $to_address || $borrower->{'smsalertnumber'} ) {
1849         $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber, message_name => 'Hold_Filled' } );
1850     } else {
1851         $print_mode = 1;
1852     }
1853
1854     my $sth = $dbh->prepare("
1855         SELECT *
1856         FROM   reserves
1857         WHERE  borrowernumber = ?
1858             AND biblionumber = ?
1859     ");
1860     $sth->execute( $borrowernumber, $biblionumber );
1861     my $reserve = $sth->fetchrow_hashref;
1862     my $branch_details = GetBranchDetail( $reserve->{'branchcode'} );
1863
1864     my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
1865
1866     my %letter_params = (
1867         module => 'reserves',
1868         branchcode => $reserve->{branchcode},
1869         tables => {
1870             'branches'  => $branch_details,
1871             'borrowers' => $borrower,
1872             'biblio'    => $biblionumber,
1873             'reserves'  => $reserve,
1874             'items', $reserve->{'itemnumber'},
1875         },
1876         substitute => { today => C4::Dates->new()->output() },
1877     );
1878
1879
1880     if ( $print_mode ) {
1881         $letter_params{ 'letter_code' } = 'HOLD_PRINT';
1882         my $letter =  C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1883
1884         C4::Letters::EnqueueLetter( {
1885             letter => $letter,
1886             borrowernumber => $borrowernumber,
1887             message_transport_type => 'print',
1888         } );
1889
1890         return;
1891     }
1892
1893     if ( $to_address && defined $messagingprefs->{transports}->{'email'} ) {
1894         $letter_params{ 'letter_code' } = $messagingprefs->{transports}->{'email'};
1895         my $letter =  C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1896
1897         C4::Letters::EnqueueLetter(
1898             {   letter                 => $letter,
1899                 borrowernumber         => $borrowernumber,
1900                 message_transport_type => 'email',
1901                 from_address           => $admin_email_address,
1902             }
1903         );
1904     }
1905
1906     if ( $borrower->{'smsalertnumber'} && defined $messagingprefs->{transports}->{'sms'} ) {
1907         $letter_params{ 'letter_code' } = $messagingprefs->{transports}->{'sms'};
1908         my $letter =  C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1909
1910         C4::Letters::EnqueueLetter(
1911             {   letter                 => $letter,
1912                 borrowernumber         => $borrowernumber,
1913                 message_transport_type => 'sms',
1914             }
1915         );
1916     }
1917 }
1918
1919 =head2 _ShiftPriorityByDateAndPriority
1920
1921   $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
1922
1923 This increments the priority of all reserves after the one
1924 with either the lowest date after C<$reservedate>
1925 or the lowest priority after C<$priority>.
1926
1927 It effectively makes room for a new reserve to be inserted with a certain
1928 priority, which is returned.
1929
1930 This is most useful when the reservedate can be set by the user.  It allows
1931 the new reserve to be placed before other reserves that have a later
1932 reservedate.  Since priority also is set by the form in reserves/request.pl
1933 the sub accounts for that too.
1934
1935 =cut
1936
1937 sub _ShiftPriorityByDateAndPriority {
1938     my ( $biblio, $resdate, $new_priority ) = @_;
1939
1940     my $dbh = C4::Context->dbh;
1941     my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
1942     my $sth = $dbh->prepare( $query );
1943     $sth->execute( $biblio, $resdate, $new_priority );
1944     my $min_priority = $sth->fetchrow;
1945     # if no such matches are found, $new_priority remains as original value
1946     $new_priority = $min_priority if ( $min_priority );
1947
1948     # Shift the priority up by one; works in conjunction with the next SQL statement
1949     $query = "UPDATE reserves
1950               SET priority = priority+1
1951               WHERE biblionumber = ?
1952               AND borrowernumber = ?
1953               AND reservedate = ?
1954               AND found IS NULL";
1955     my $sth_update = $dbh->prepare( $query );
1956
1957     # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1958     $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1959     $sth = $dbh->prepare( $query );
1960     $sth->execute( $new_priority, $biblio );
1961     while ( my $row = $sth->fetchrow_hashref ) {
1962         $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1963     }
1964
1965     return $new_priority;  # so the caller knows what priority they wind up receiving
1966 }
1967
1968 =head2 MoveReserve
1969
1970   MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
1971
1972 Use when checking out an item to handle reserves
1973 If $cancelreserve boolean is set to true, it will remove existing reserve
1974
1975 =cut
1976
1977 sub MoveReserve {
1978     my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
1979
1980     my ( $restype, $res, $all_reserves ) = CheckReserves( $itemnumber );
1981     return unless $res;
1982
1983     my $biblionumber     =  $res->{biblionumber};
1984     my $biblioitemnumber = $res->{biblioitemnumber};
1985
1986     if ($res->{borrowernumber} == $borrowernumber) {
1987         ModReserveFill($res);
1988     }
1989     else {
1990         # warn "Reserved";
1991         # The item is reserved by someone else.
1992         # Find this item in the reserves
1993
1994         my $borr_res;
1995         foreach (@$all_reserves) {
1996             $_->{'borrowernumber'} == $borrowernumber or next;
1997             $_->{'biblionumber'}   == $biblionumber   or next;
1998
1999             $borr_res = $_;
2000             last;
2001         }
2002
2003         if ( $borr_res ) {
2004             # The item is reserved by the current patron
2005             ModReserveFill($borr_res);
2006         }
2007
2008         if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2009             RevertWaitingStatus({ itemnumber => $itemnumber });
2010         }
2011         elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2012             CancelReserve({
2013                 biblionumber   => $res->{'biblionumber'},
2014                 itemnumber     => $res->{'itemnumber'},
2015                 borrowernumber => $res->{'borrowernumber'}
2016             });
2017         }
2018     }
2019 }
2020
2021 =head2 MergeHolds
2022
2023   MergeHolds($dbh,$to_biblio, $from_biblio);
2024
2025 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2026
2027 =cut
2028
2029 sub MergeHolds {
2030     my ( $dbh, $to_biblio, $from_biblio ) = @_;
2031     my $sth = $dbh->prepare(
2032         "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2033     );
2034     $sth->execute($from_biblio);
2035     if ( my $data = $sth->fetchrow_hashref() ) {
2036
2037         # holds exist on old record, if not we don't need to do anything
2038         $sth = $dbh->prepare(
2039             "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2040         $sth->execute( $to_biblio, $from_biblio );
2041
2042         # Reorder by date
2043         # don't reorder those already waiting
2044
2045         $sth = $dbh->prepare(
2046 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
2047         );
2048         my $upd_sth = $dbh->prepare(
2049 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2050         AND reservedate = ? AND constrainttype = ? AND (itemnumber = ? or itemnumber is NULL) "
2051         );
2052         $sth->execute( $to_biblio, 'W', 'T' );
2053         my $priority = 1;
2054         while ( my $reserve = $sth->fetchrow_hashref() ) {
2055             $upd_sth->execute(
2056                 $priority,                    $to_biblio,
2057                 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2058                 $reserve->{'constrainttype'}, $reserve->{'itemnumber'}
2059             );
2060             $priority++;
2061         }
2062     }
2063 }
2064
2065 =head2 RevertWaitingStatus
2066
2067   $success = RevertWaitingStatus({ itemnumber => $itemnumber });
2068
2069   Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2070
2071   Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2072           item level hold, even if it was only a bibliolevel hold to
2073           begin with. This is because we can no longer know if a hold
2074           was item-level or bib-level after a hold has been set to
2075           waiting status.
2076
2077 =cut
2078
2079 sub RevertWaitingStatus {
2080     my ( $params ) = @_;
2081     my $itemnumber = $params->{'itemnumber'};
2082
2083     return unless ( $itemnumber );
2084
2085     my $dbh = C4::Context->dbh;
2086
2087     ## Get the waiting reserve we want to revert
2088     my $query = "
2089         SELECT * FROM reserves
2090         WHERE itemnumber = ?
2091         AND found IS NOT NULL
2092     ";
2093     my $sth = $dbh->prepare( $query );
2094     $sth->execute( $itemnumber );
2095     my $reserve = $sth->fetchrow_hashref();
2096
2097     ## Increment the priority of all other non-waiting
2098     ## reserves for this bib record
2099     $query = "
2100         UPDATE reserves
2101         SET
2102           priority = priority + 1
2103         WHERE
2104           biblionumber =  ?
2105         AND
2106           priority > 0
2107     ";
2108     $sth = $dbh->prepare( $query );
2109     $sth->execute( $reserve->{'biblionumber'} );
2110
2111     ## Fix up the currently waiting reserve
2112     $query = "
2113     UPDATE reserves
2114     SET
2115       priority = 1,
2116       found = NULL,
2117       waitingdate = NULL
2118     WHERE
2119       reserve_id = ?
2120     ";
2121     $sth = $dbh->prepare( $query );
2122     return $sth->execute( $reserve->{'reserve_id'} );
2123 }
2124
2125 =head2 GetReserveId
2126
2127   $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber [, itemnumber => $itemnumber ] });
2128
2129   Returnes the first reserve id that matches the given criteria
2130
2131 =cut
2132
2133 sub GetReserveId {
2134     my ( $params ) = @_;
2135
2136     return unless ( ( $params->{'biblionumber'} || $params->{'itemnumber'} ) && $params->{'borrowernumber'} );
2137
2138     my $dbh = C4::Context->dbh();
2139
2140     my $sql = "SELECT reserve_id FROM reserves WHERE ";
2141
2142     my @params;
2143     my @limits;
2144     foreach my $key ( keys %$params ) {
2145         if ( defined( $params->{$key} ) ) {
2146             push( @limits, "$key = ?" );
2147             push( @params, $params->{$key} );
2148         }
2149     }
2150
2151     $sql .= join( " AND ", @limits );
2152
2153     my $sth = $dbh->prepare( $sql );
2154     $sth->execute( @params );
2155     my $row = $sth->fetchrow_hashref();
2156
2157     return $row->{'reserve_id'};
2158 }
2159
2160 =head2 ReserveSlip
2161
2162   ReserveSlip($branchcode, $borrowernumber, $biblionumber)
2163
2164   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2165
2166 =cut
2167
2168 sub ReserveSlip {
2169     my ($branch, $borrowernumber, $biblionumber) = @_;
2170
2171 #   return unless ( C4::Context->boolean_preference('printreserveslips') );
2172
2173     my $reserve_id = GetReserveId({
2174         biblionumber => $biblionumber,
2175         borrowernumber => $borrowernumber
2176     }) or return;
2177     my $reserve = GetReserveInfo($reserve_id) or return;
2178
2179     return  C4::Letters::GetPreparedLetter (
2180         module => 'circulation',
2181         letter_code => 'RESERVESLIP',
2182         branchcode => $branch,
2183         tables => {
2184             'reserves'    => $reserve,
2185             'branches'    => $reserve->{branchcode},
2186             'borrowers'   => $reserve->{borrowernumber},
2187             'biblio'      => $reserve->{biblionumber},
2188             'items'       => $reserve->{itemnumber},
2189         },
2190     );
2191 }
2192
2193 =head2 GetReservesControlBranch
2194
2195   my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2196
2197   Return the branchcode to be used to determine which reserves
2198   policy applies to a transaction.
2199
2200   C<$item> is a hashref for an item. Only 'homebranch' is used.
2201
2202   C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2203
2204 =cut
2205
2206 sub GetReservesControlBranch {
2207     my ( $item, $borrower ) = @_;
2208
2209     my $reserves_control = C4::Context->preference('ReservesControlBranch');
2210
2211     my $branchcode =
2212         ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2213       : ( $reserves_control eq 'PatronLibrary' )   ? $borrower->{'branchcode'}
2214       :                                              undef;
2215
2216     return $branchcode;
2217 }
2218
2219 =head1 AUTHOR
2220
2221 Koha Development Team <http://koha-community.org/>
2222
2223 =cut
2224
2225 1;