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