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