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