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