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