3 # Copyright 2000-2002 Katipo Communications
4 # 2006 SAN Ouest Provence
5 # 2007-2010 BibLibre Paul POULAIN
8 # This file is part of Koha.
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.
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.
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>.
27 use C4::Biblio qw( GetMarcFromKohaField );
28 use C4::Circulation qw( CheckIfIssuedToPatron GetAgeRestriction GetBranchItemRule );
30 use C4::Items qw( CartToShelf get_hostitemnumbers_of );
32 use C4::Log qw( logaction );
33 use C4::Members::Messaging;
35 use Koha::Account::Lines;
36 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
39 use Koha::Cache::Memory::Lite;
40 use Koha::CirculationRules;
42 use Koha::DateUtils qw( dt_from_string output_pref );
51 use List::MoreUtils qw( any );
55 C4::Reserves - Koha functions for dealing with reservation.
63 This modules provides somes functions to deal with reservations.
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
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
99 our (@ISA, @EXPORT_OK);
116 ModReserveMinusPriority
122 CanReserveBeCanceledFromOpac
123 CancelExpiredReserves
125 AutoUnsuspendReserves
127 IsAvailableForItemLevelRequest
128 ItemsAnyAvailableAndNotRestricted
137 GetReservesControlBranch
143 GetMaxPatronHoldsForRecord
155 branchcode => $branchcode,
156 borrowernumber => $borrowernumber,
157 biblionumber => $biblionumber,
158 priority => $priority,
159 reservation_date => $reservation_date,
160 expiration_date => $expiration_date,
163 itemnumber => $itemnumber,
165 itemtype => $itemtype,
166 item_group_id => $item_group_id
170 Adds reserve and generates HOLDPLACED message.
172 The following tables are available witin the HOLDPLACED message:
185 my $branch = $params->{branchcode};
186 my $borrowernumber = $params->{borrowernumber};
187 my $biblionumber = $params->{biblionumber};
188 my $priority = $params->{priority};
189 my $resdate = $params->{reservation_date};
190 my $patron_expiration_date = $params->{expiration_date};
191 my $notes = $params->{notes};
192 my $title = $params->{title};
193 my $checkitem = $params->{itemnumber};
194 my $found = $params->{found};
195 my $itemtype = $params->{itemtype};
196 my $non_priority = $params->{non_priority};
197 my $item_group_id = $params->{item_group_id};
199 $resdate ||= dt_from_string;
201 # if we have an item selectionned, and the pickup branch is the same as the holdingbranch
202 # of the document, we force the value $priority and $found .
203 if ( $checkitem and not C4::Context->preference('ReservesNeedReturns') ) {
204 my $item = Koha::Items->find( $checkitem ); # FIXME Prevent bad calls
207 # If item is already checked out, it cannot be set waiting
210 # The item can't be waiting if it needs a transfer
211 && $item->holdingbranch eq $branch
213 # Similarly, if in transit it can't be waiting
214 && !$item->get_transfer
216 # If we can't hold damaged items, and it is damaged, it can't be waiting
217 && ( $item->damaged && C4::Context->preference('AllowHoldsOnDamagedItems') || !$item->damaged )
219 # Lastly, if this already has holds, we shouldn't make it waiting for the new hold
220 && !$item->current_holds->count )
226 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
227 # Make room in reserves for this if passed a priority
228 $priority = _ShiftPriority( $biblionumber, $priority );
233 # If the reserv had the waiting status, we had the value of the resdate
234 if ( $found && $found eq 'W' ) {
235 $waitingdate = $resdate;
238 # Don't add itemtype limit if specific item is selected
239 $itemtype = undef if $checkitem;
241 # updates take place here
242 my $hold = Koha::Hold->new(
244 borrowernumber => $borrowernumber,
245 biblionumber => $biblionumber,
246 item_group_id => $item_group_id,
247 reservedate => $resdate,
248 branchcode => $branch,
249 priority => $priority,
250 reservenotes => $notes,
251 itemnumber => $checkitem,
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,
260 $hold->set_waiting() if $found && $found eq 'W';
262 logaction( 'HOLDS', 'CREATE', $hold->id, $hold )
263 if C4::Context->preference('HoldsLog');
265 my $reserve_id = $hold->id();
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 );
273 _FixPriority({ biblionumber => $biblionumber});
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,
285 'branches' => $library->unblessed,
286 'borrowers' => $patron->unblessed,
287 'biblio' => $biblionumber,
288 'biblioitems' => $biblionumber,
289 'items' => $checkitem,
290 'reserves' => $hold->unblessed,
294 my $branch_email_address = $library->inbound_email_address;
296 C4::Letters::EnqueueLetter(
299 borrowernumber => $borrowernumber,
300 message_transport_type => 'email',
301 to_address => $branch_email_address,
307 Koha::Plugins->call('after_hold_create', $hold);
312 payload => { hold => $hold->get_from_storage }
316 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
318 biblio_ids => [ $biblionumber ]
320 ) if C4::Context->preference('RealTimeHoldsQueue');
325 =head2 CanBookBeReserved
327 $canReserve = &CanBookBeReserved($borrowernumber, $biblionumber, $branchcode, $params)
328 if ($canReserve eq 'OK') { #We can reserve this Item! }
330 $params are passed directly through to CanItemBeReserved
332 See CanItemBeReserved() for possible return values.
336 sub CanBookBeReserved{
337 my ($borrowernumber, $biblionumber, $pickup_branchcode, $params) = @_;
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' };
345 if ( $params->{itemtype} ) {
347 # biblio-level, item type-contrained
348 my $patron = Koha::Patrons->find($borrowernumber);
349 my $reservesallowed = Koha::CirculationRules->get_effective_rule(
351 itemtype => $params->{itemtype},
352 categorycode => $patron->categorycode,
353 branchcode => $pickup_branchcode,
354 rule_name => 'reservesallowed',
358 $reservesallowed = ( $reservesallowed eq '' ) ? undef : $reservesallowed;
360 my $count = $patron->holds->search(
363 { 'me.itemtype' => $params->{itemtype} },
364 { 'item.itype' => $params->{itemtype} }
372 return { status => '' }
373 if defined $reservesallowed and $reservesallowed < $count + 1;
377 #get items linked via host records
378 my @hostitemnumbers = get_hostitemnumbers_of($biblionumber);
379 if (@hostitemnumbers){
380 $items = Koha::Items->search({
382 biblionumber => $biblionumber,
383 itemnumber => { -in => @hostitemnumbers }
387 $items = Koha::Items->search({ biblionumber => $biblionumber});
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';
399 =head2 CanItemBeReserved
401 $canReserve = &CanItemBeReserved($patron, $item, $branchcode, $params)
402 if ($canReserve->{status} eq 'OK') { #We can reserve this Item! }
405 'ignore_hold_counts' - we use this routine to check if an item can fill a hold - on this case we
406 should not check if there are too many holds as we only care about reservability
408 @RETURNS { status => OK }, if the Item can be reserved.
409 { status => ageRestricted }, if the Item is age restricted for this borrower.
410 { status => damaged }, if the Item is damaged.
411 { status => cannotReserveFromOtherBranches }, if syspref 'canreservefromotherbranches' is OK.
412 { status => branchNotInHoldGroup }, if borrower home library is not in hold group, and holds are only allowed from hold groups.
413 { status => tooManyReserves, limit => $limit }, if the borrower has exceeded their maximum reserve amount.
414 { status => notReservable }, if holds on this item are not allowed
415 { status => libraryNotFound }, if given branchcode is not an existing library
416 { status => libraryNotPickupLocation }, if given branchcode is not configured to be a pickup location
417 { status => cannotBeTransferred }, if branch transfer limit applies on given item and branchcode
418 { status => pickupNotInHoldGroup }, pickup location is not in hold group, and pickup locations are only allowed from hold groups.
419 { status => recall }, if the borrower has already placed a recall on this item
423 our $CanItemBeReserved_cache_key;
426 my $memory_cache = Koha::Cache::Memory::Lite->get_instance();
427 $memory_cache->set_in_cache( $CanItemBeReserved_cache_key, $return );
431 sub CanItemBeReserved {
432 my ( $patron, $item, $pickup_branchcode, $params ) = @_;
434 my $memory_cache = Koha::Cache::Memory::Lite->get_instance();
435 $CanItemBeReserved_cache_key = sprintf "Hold_CanItemBeReserved:%s:%s:%s", $patron->borrowernumber, $item->itemnumber, $pickup_branchcode || "";
436 if ( $params->{get_from_cache} ) {
437 my $cached = $memory_cache->get_from_cache($CanItemBeReserved_cache_key);
438 return $cached if $cached;
441 my $dbh = C4::Context->dbh;
442 my $ruleitemtype; # itemtype of the matching issuing rule
443 my $allowedreserves = 0; # Total number of holds allowed across all records, default to none
445 # We check item branch if IndependentBranches is ON
446 # and canreservefromotherbranches is OFF
447 if ( C4::Context->preference('IndependentBranches')
448 and !C4::Context->preference('canreservefromotherbranches') )
450 if ( $item->homebranch ne $patron->branchcode ) {
451 return _cache { status => 'cannotReserveFromOtherBranches' };
455 # we retrieve borrowers and items informations #
456 # item->{itype} will come for biblioitems if necessery
457 my $borrower = $patron->unblessed;
459 # If an item is damaged and we don't allow holds on damaged items, we can stop right here
460 return _cache { status =>'damaged' }
462 && !C4::Context->preference('AllowHoldsOnDamagedItems') );
464 if( GetMarcFromKohaField('biblioitems.agerestriction') ){
465 my $biblio = $item->biblio;
466 # Check for the age restriction
467 my ( $ageRestriction, $daysToAgeRestriction ) =
468 C4::Circulation::GetAgeRestriction( $biblio->biblioitem->agerestriction, $borrower );
469 return _cache { status => 'ageRestricted' } if $daysToAgeRestriction && $daysToAgeRestriction > 0;
472 # Check that the patron doesn't have an item level hold on this item already
473 return _cache { status =>'itemAlreadyOnHold' }
474 if ( !$params->{ignore_hold_counts} && Koha::Holds->search( { borrowernumber => $patron->borrowernumber, itemnumber => $item->itemnumber } )->count() );
476 # Check that patron have not checked out this biblio (if AllowHoldsOnPatronsPossessions set)
477 if ( !C4::Context->preference('AllowHoldsOnPatronsPossessions')
478 && C4::Circulation::CheckIfIssuedToPatron( $patron->borrowernumber, $item->biblionumber ) ) {
479 return _cache { status =>'alreadypossession' };
482 # check if a recall exists on this item from this borrower
483 return _cache { status => 'recall' }
484 if $patron->recalls->filter_by_current->search({ item_id => $item->itemnumber })->count;
486 my $controlbranch = C4::Context->preference('ReservesControlBranch');
488 my $reserves_control_branch;
489 my $branchfield = "reserves.branchcode";
491 if ( $controlbranch eq "ItemHomeLibrary" ) {
492 $branchfield = "items.homebranch";
493 $reserves_control_branch = $item->homebranch;
495 elsif ( $controlbranch eq "PatronLibrary" ) {
496 $branchfield = "borrowers.branchcode";
497 $reserves_control_branch = $borrower->{branchcode};
502 my $reservesallowed = Koha::CirculationRules->get_effective_rule({
503 itemtype => $item->effective_itemtype,
504 categorycode => $borrower->{categorycode},
505 branchcode => $reserves_control_branch,
506 rule_name => 'reservesallowed',
509 $ruleitemtype = $reservesallowed->itemtype;
510 $allowedreserves = $reservesallowed->rule_value // 0; #undefined is 0, blank is unlimited
513 $ruleitemtype = undef;
516 my $rights = Koha::CirculationRules->get_effective_rules({
517 categorycode => $borrower->{'categorycode'},
518 itemtype => $item->effective_itemtype,
519 branchcode => $reserves_control_branch,
520 rules => ['holds_per_record','holds_per_day']
522 my $holds_per_record = $rights->{holds_per_record} // 1;
523 my $holds_per_day = $rights->{holds_per_day};
525 if ( defined $holds_per_record && $holds_per_record ne '' ){
526 if ( $holds_per_record == 0 ) {
527 return _cache { status => "noReservesAllowed" };
529 if ( !$params->{ignore_hold_counts} ) {
530 my $search_params = {
531 borrowernumber => $patron->borrowernumber,
532 biblionumber => $item->biblionumber,
534 my $holds = Koha::Holds->search($search_params);
535 return _cache { status => "tooManyHoldsForThisRecord", limit => $holds_per_record } if $holds->count() >= $holds_per_record;
539 if (!$params->{ignore_hold_counts} && defined $holds_per_day && $holds_per_day ne '')
541 my $today_holds = Koha::Holds->search({
542 borrowernumber => $patron->borrowernumber,
543 reservedate => dt_from_string->date
545 return _cache { status => 'tooManyReservesToday', limit => $holds_per_day } if $today_holds->count() >= $holds_per_day;
548 # we check if it's ok or not
549 if ( defined $allowedreserves && $allowedreserves ne '' ){
550 if( $allowedreserves == 0 ){
551 return _cache { status => 'noReservesAllowed' };
553 if ( !$params->{ignore_hold_counts} ) {
556 SELECT count(*) AS count
558 LEFT JOIN items USING (itemnumber)
559 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
560 LEFT JOIN borrowers USING (borrowernumber)
561 WHERE borrowernumber = ?
563 $querycount .= "AND ( $branchfield = ? OR $branchfield IS NULL )";
565 # If using item-level itypes, fall back to the record
566 # level itemtype if the hold has no associated item
567 if ( defined $ruleitemtype ) {
568 if ( C4::Context->preference('item-level_itypes') ) {
570 AND ( COALESCE( items.itype, biblioitems.itemtype ) = ?
571 OR reserves.itemtype = ? )
576 AND ( biblioitems.itemtype = ?
577 OR reserves.itemtype = ? )
582 my $sthcount = $dbh->prepare($querycount);
584 if ( defined $ruleitemtype ) {
585 $sthcount->execute( $patron->borrowernumber, $reserves_control_branch, $ruleitemtype, $ruleitemtype );
588 $sthcount->execute( $patron->borrowernumber, $reserves_control_branch );
591 my $reservecount = "0";
592 if ( my $rowcount = $sthcount->fetchrow_hashref() ) {
593 $reservecount = $rowcount->{count};
596 return _cache { status => 'tooManyReserves', limit => $allowedreserves } if $reservecount >= $allowedreserves;
600 # Now we need to check hold limits by patron category
601 my $rule = Koha::CirculationRules->get_effective_rule(
603 categorycode => $patron->categorycode,
604 branchcode => $reserves_control_branch,
605 rule_name => 'max_holds',
608 if (!$params->{ignore_hold_counts} && $rule && defined( $rule->rule_value ) && $rule->rule_value ne '' ) {
609 my $total_holds_count = Koha::Holds->search(
611 borrowernumber => $patron->borrowernumber
615 return _cache { status => 'tooManyReserves', limit => $rule->rule_value} if $total_holds_count >= $rule->rule_value;
619 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $item->effective_itemtype );
621 if ( $branchitemrule->{holdallowed} eq 'not_allowed' ) {
622 return _cache { status => 'notReservable' };
625 if ( $branchitemrule->{holdallowed} eq 'from_home_library'
626 && $borrower->{branchcode} ne $item->homebranch )
628 return _cache { status => 'cannotReserveFromOtherBranches' };
631 my $item_library = Koha::Libraries->find( {branchcode => $item->homebranch} );
632 if ( $branchitemrule->{holdallowed} eq 'from_local_hold_group') {
633 if($patron->branchcode ne $item->homebranch && !$item_library->validate_hold_sibling( {branchcode => $patron->branchcode} )) {
634 return _cache { status => 'branchNotInHoldGroup' };
638 if ($pickup_branchcode) {
639 my $destination = Koha::Libraries->find({
640 branchcode => $pickup_branchcode,
643 unless ($destination) {
644 return _cache { status => 'libraryNotFound' };
646 unless ($destination->pickup_location) {
647 return _cache { status => 'libraryNotPickupLocation' };
649 unless ($item->can_be_transferred({ to => $destination })) {
650 return _cache { status => 'cannotBeTransferred' };
652 if ($branchitemrule->{hold_fulfillment_policy} eq 'holdgroup' && !$item_library->validate_hold_sibling( {branchcode => $pickup_branchcode} )) {
653 return _cache { status => 'pickupNotInHoldGroup' };
655 if ($branchitemrule->{hold_fulfillment_policy} eq 'patrongroup' && !Koha::Libraries->find({branchcode => $borrower->{branchcode}})->validate_hold_sibling({branchcode => $pickup_branchcode})) {
656 return _cache { status => 'pickupNotInHoldGroup' };
660 return _cache { status => 'OK' };
663 =head2 CanReserveBeCanceledFromOpac
665 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
667 returns 1 if reserve can be cancelled by user from OPAC.
668 First check if reserve belongs to user, next checks if reserve is not in
669 transfer or waiting status
673 sub CanReserveBeCanceledFromOpac {
674 my ($reserve_id, $borrowernumber) = @_;
676 return unless $reserve_id and $borrowernumber;
677 my $reserve = Koha::Holds->find($reserve_id) or return;
679 return 0 unless $reserve->borrowernumber == $borrowernumber;
680 return $reserve->is_cancelable_from_opac;
683 =head2 GetOtherReserves
685 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
687 Check queued list of this document and check if this document must be transferred
691 sub GetOtherReserves {
692 my ($itemnumber) = @_;
695 my $item = Koha::Items->find($itemnumber);
696 my ( undef, $checkreserves, undef ) = CheckReserves($item);
697 if ($checkreserves) {
698 if ( $item->holdingbranch ne $checkreserves->{'branchcode'} ) {
699 $messages->{'transfert'} = $checkreserves->{'branchcode'};
700 #minus priorities of others reservs
701 ModReserveMinusPriority(
703 $checkreserves->{'reserve_id'},
706 #launch the subroutine dotransfer
707 C4::Items::ModItemTransfer(
709 $item->holdingbranch,
710 $checkreserves->{'branchcode'},
716 #step 2b : case of a reservation on the same branch, set the waiting status
718 $messages->{'waiting'} = 1;
719 ModReserveMinusPriority(
721 $checkreserves->{'reserve_id'},
723 ModReserveStatus($itemnumber,'W');
726 $nextreservinfo = $checkreserves;
729 return ( $messages, $nextreservinfo );
732 =head2 ChargeReserveFee
734 $fee = ChargeReserveFee( $borrowernumber, $fee, $title );
736 Charge the fee for a reserve (if $fee > 0)
740 sub ChargeReserveFee {
741 my ( $borrowernumber, $fee, $title ) = @_;
742 return if !$fee || $fee == 0; # the last test is needed to include 0.00
743 Koha::Account->new( { patron_id => $borrowernumber } )->add_debit(
746 description => $title,
748 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
749 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
750 interface => C4::Context->interface,
751 invoice_type => undef,
760 $fee = GetReserveFee( $borrowernumber, $biblionumber );
762 Calculate the fee for a reserve (if applicable).
767 my ( $borrowernumber, $biblionumber ) = @_;
769 SELECT reservefee FROM borrowers LEFT JOIN categories ON borrowers.categorycode = categories.categorycode WHERE borrowernumber = ?
772 SELECT COUNT(*) FROM items
773 LEFT JOIN issues USING (itemnumber)
774 WHERE items.biblionumber=? AND issues.issue_id IS NULL
777 SELECT COUNT(*) FROM reserves WHERE biblionumber=? AND borrowernumber<>?
780 my $dbh = C4::Context->dbh;
781 my ( $fee ) = $dbh->selectrow_array( $borquery, undef, ($borrowernumber) );
783 my $hold_fee_mode = C4::Context->preference('HoldFeeMode') || 'not_always';
784 if( $fee and $fee > 0 and $hold_fee_mode eq 'not_always' ) {
785 # This is a reconstruction of the old code:
786 # Compare number of items with items issued, and optionally check holds
787 # If not all items are issued and there are no holds: charge no fee
788 # NOTE: Lost, damaged, not-for-loan, etc. are just ignored here
789 my ( $notissued, $reserved );
790 ( $notissued ) = $dbh->selectrow_array( $issue_qry, undef,
792 if( $notissued == 0 ) {
793 # all items are issued
794 ( $reserved ) = $dbh->selectrow_array( $holds_qry, undef,
795 ( $biblionumber, $borrowernumber ) );
796 $fee = 0 if $reserved == 0;
804 =head2 GetReserveStatus
806 $reservestatus = GetReserveStatus($itemnumber);
808 Takes an itemnumber and returns the status of the reserve placed on it.
809 If several reserves exist, the reserve with the lower priority is given.
813 ## FIXME: I don't think this does what it thinks it does.
814 ## It only ever checks the first reserve result, even though
815 ## multiple reserves for that bib can have the itemnumber set
816 ## the sub is only used once in the codebase.
817 sub GetReserveStatus {
818 my ($itemnumber) = @_;
820 my $dbh = C4::Context->dbh;
822 my ($sth, $found, $priority);
824 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
825 $sth->execute($itemnumber);
826 ($found, $priority) = $sth->fetchrow_array;
830 return 'Waiting' if $found eq 'W' and $priority == 0;
831 return 'Processing' if $found eq 'P';
832 return 'Finished' if $found eq 'F';
835 return 'Reserved' if defined $priority && $priority > 0;
837 return ''; # empty string here will remove need for checking undef, or less log lines
842 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($item);
843 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($item, $lookahead);
845 Find a book in the reserves.
847 C<$item> is the book's item.
848 C<$lookahead> is the number of days to look in advance for future reserves.
850 As I understand it, C<&CheckReserves> looks for the given item in the
851 reserves. If it is found, that's a match, and C<$status> is set to
854 Otherwise, it finds the most important item in the reserves with the
855 same biblio number as this book (I'm not clear on this) and returns it
856 with C<$status> set to C<Reserved>.
858 C<&CheckReserves> returns a two-element list:
860 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
862 C<$reserve> is the reserve item that matched. It is a
863 reference-to-hash whose keys are mostly the fields of the reserves
864 table in the Koha database.
869 my ( $item, $lookahead_days, $ignore_borrowers ) = @_;
870 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
872 return unless $item; # bail if we got nothing.
874 return if ( $item->damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
876 # if item is not for loan it cannot be reserved either.....
877 # except where items.notforloan < 0 : This indicates the item is holdable.
879 my @SkipHoldTrapOnNotForLoanValue = split( '\|', C4::Context->preference('SkipHoldTrapOnNotForLoanValue') );
880 return if grep { $_ eq $item->notforloan } @SkipHoldTrapOnNotForLoanValue;
882 my $dont_trap = C4::Context->preference('TrapHoldsOnOrder') ? $item->notforloan > 0 : $item->notforloan;
884 my $item_type = $item->effective_itemtype;
886 return if Koha::ItemTypes->find( $item_type )->notforloan;
893 # Find this item in the reserves
894 my @reserves = _Findgroupreserve( $item->biblionumber, $item->itemnumber, $lookahead_days, $ignore_borrowers);
896 # $priority and $highest are used to find the most important item
897 # in the list returned by &_Findgroupreserve. (The lower $priority,
898 # the more important the item.)
899 # $highest is the most important item we've seen so far.
902 if (scalar @reserves) {
903 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
904 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
905 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
906 my $priority = 10000000;
908 foreach my $res (@reserves) {
909 if ($res->{'found'} && $res->{'found'} eq 'W') {
910 return ( "Waiting", $res, \@reserves ); # Found it, it is waiting
911 } elsif ($res->{'found'} && $res->{'found'} eq 'P') {
912 return ( "Processing", $res, \@reserves ); # Found determinated hold, e. g. the transferred one
913 } elsif ($res->{'found'} && $res->{'found'} eq 'T') {
914 return ( "Transferred", $res, \@reserves ); # Found determinated hold, e. g. the transferred one
917 my $local_hold_match;
919 if ($LocalHoldsPriority) {
920 $patron = Koha::Patrons->find( $res->{borrowernumber} );
922 unless ($item->exclude_from_local_holds_priority || $patron->category->exclude_from_local_holds_priority) {
923 my $local_holds_priority_item_branchcode =
924 $item->$LocalHoldsPriorityItemControl;
925 my $local_holds_priority_patron_branchcode =
926 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
928 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
929 ? $patron->branchcode
932 $local_holds_priority_item_branchcode eq
933 $local_holds_priority_patron_branchcode;
937 # See if this item is more important than what we've got so far
938 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
939 next if $res->{item_group_id} && ( !$item->item_group || $item->item_group->id != $res->{item_group_id} );
940 next if $res->{itemtype} && $res->{itemtype} ne $item->effective_itemtype;
941 $patron //= Koha::Patrons->find( $res->{borrowernumber} );
942 my $branch = GetReservesControlBranch( $item->unblessed, $patron->unblessed );
943 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$item->effective_itemtype);
944 next if ($branchitemrule->{'holdallowed'} eq 'not_allowed');
945 next if (($branchitemrule->{'holdallowed'} eq 'from_home_library') && ($item->homebranch ne $patron->branchcode));
946 my $library = Koha::Libraries->find({branchcode=>$item->homebranch});
947 next if (($branchitemrule->{'holdallowed'} eq 'from_local_hold_group') && (!$library->validate_hold_sibling({branchcode => $patron->branchcode}) ));
948 my $hold_fulfillment_policy = $branchitemrule->{hold_fulfillment_policy};
949 next if ( ($hold_fulfillment_policy eq 'holdgroup') && (!$library->validate_hold_sibling({branchcode => $res->{branchcode}})) );
950 next if ( ($hold_fulfillment_policy eq 'homebranch') && ($res->{branchcode} ne $item->$hold_fulfillment_policy) );
951 next if ( ($hold_fulfillment_policy eq 'holdingbranch') && ($res->{branchcode} ne $item->$hold_fulfillment_policy) );
952 next unless $item->can_be_transferred( { to => Koha::Libraries->find( $res->{branchcode} ) } );
953 $priority = $res->{'priority'};
955 last if $local_hold_match;
961 # If we get this far, then no exact match was found.
962 # We return the most important (i.e. next) reservation.
964 $highest->{'itemnumber'} = $item->itemnumber;
965 return ( "Reserved", $highest, \@reserves );
971 =head2 CancelExpiredReserves
973 CancelExpiredReserves();
975 Cancels all reserves with an expiration date from before today.
979 sub CancelExpiredReserves {
980 my $cancellation_reason = shift;
981 my $today = dt_from_string();
982 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
983 my $expireWaiting = C4::Context->preference('ExpireReservesMaxPickUpDelay');
985 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
988 { expirationdate => { '<', $dtf->format_date($today) } },
989 { patron_expiration_date => { '<' => $dtf->format_date($today) } }
993 $params->{found} = [ { '!=', 'W' }, undef ] unless $expireWaiting;
995 # FIXME To move to Koha::Holds->search_expired (?)
996 my $holds = Koha::Holds->search( $params );
998 while ( my $hold = $holds->next ) {
999 my $calendar = Koha::Calendar->new( branchcode => $hold->branchcode );
1001 next if !$cancel_on_holidays && $calendar->is_holiday( $today );
1003 my $cancel_params = {};
1004 $cancel_params->{cancellation_reason} = $cancellation_reason if defined($cancellation_reason);
1005 if ( defined($hold->found) && $hold->found eq 'W' ) {
1006 $cancel_params->{charge_cancel_fee} = 1;
1008 $cancel_params->{autofill} = C4::Context->preference('ExpireReservesAutoFill');
1009 $hold->cancel( $cancel_params );
1013 =head2 AutoUnsuspendReserves
1015 AutoUnsuspendReserves();
1017 Unsuspends all suspended reserves with a suspend_until date from before today.
1021 sub AutoUnsuspendReserves {
1022 my $today = dt_from_string();
1024 my @holds = Koha::Holds->search( { suspend_until => { '<=' => $today->ymd() } } )->as_list;
1026 map { $_->resume() } @holds;
1031 ModReserve({ rank => $rank,
1032 reserve_id => $reserve_id,
1033 branchcode => $branchcode
1034 [, itemnumber => $itemnumber ]
1035 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1038 Change a hold request's priority or cancel it.
1040 C<$rank> specifies the effect of the change. If C<$rank>
1041 is 'n', nothing happens. This corresponds to leaving a
1042 request alone when changing its priority in the holds queue
1045 If C<$rank> is 'del', the hold request is cancelled.
1047 If C<$rank> is an integer greater than zero, the priority of
1048 the request is set to that value. Since priority != 0 means
1049 that the item is not waiting on the hold shelf, setting the
1050 priority to a non-zero value also sets the request's found
1051 status and waiting date to NULL.
1053 If the hold is 'found' (waiting, in-transit, processing) the
1054 only field that can be updated is the expiration date.
1056 The optional C<$itemnumber> parameter is used only when
1057 C<$rank> is a non-zero integer; if supplied, the itemnumber
1058 of the hold request is set accordingly; if omitted, the itemnumber
1061 B<FIXME:> Note that the forgoing can have the effect of causing
1062 item-level hold requests to turn into title-level requests. This
1063 will be fixed once reserves has separate columns for requested
1064 itemnumber and supplying itemnumber.
1069 my ( $params ) = @_;
1071 my $rank = $params->{'rank'};
1072 my $reserve_id = $params->{'reserve_id'};
1073 my $branchcode = $params->{'branchcode'};
1074 my $itemnumber = $params->{'itemnumber'};
1075 my $suspend_until = $params->{'suspend_until'};
1076 my $borrowernumber = $params->{'borrowernumber'};
1077 my $biblionumber = $params->{'biblionumber'};
1078 my $cancellation_reason = $params->{'cancellation_reason'};
1079 my $date = $params->{expirationdate};
1081 return if defined $rank && $rank eq "n";
1083 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1086 unless ( $reserve_id ) {
1087 my $holds = Koha::Holds->search({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber });
1088 return unless $holds->count; # FIXME Should raise an exception
1089 $hold = $holds->next;
1090 $reserve_id = $hold->reserve_id;
1093 $hold ||= Koha::Holds->find($reserve_id);
1095 # FIXME Other calls may fail
1096 Koha::Exceptions::ObjectNotFound->throw( 'No hold with id ' . $reserve_id ) unless $hold;
1098 if ( $rank eq "del" ) {
1099 $hold->cancel({ cancellation_reason => $cancellation_reason });
1101 elsif ($hold->found && $hold->priority eq '0' && $date) {
1102 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, $hold )
1103 if C4::Context->preference('HoldsLog');
1105 # The only column that can be updated for a found hold is the expiration date
1106 $hold->expirationdate($date)->store();
1108 elsif ($rank =~ /^\d+/ and $rank > 0) {
1109 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, $hold )
1110 if C4::Context->preference('HoldsLog');
1114 branchcode => $branchcode,
1115 itemnumber => $itemnumber,
1117 waitingdate => undef
1119 if (exists $params->{reservedate}) {
1120 $properties->{reservedate} = $params->{reservedate} || undef;
1122 if (exists $params->{expirationdate}) {
1123 $properties->{expirationdate} = $params->{expirationdate} || undef;
1126 $hold->set($properties)->store();
1128 if ( defined( $suspend_until ) ) {
1129 if ( $suspend_until ) {
1130 $hold->suspend_hold( $suspend_until );
1132 # If the hold is suspended leave the hold suspended, but convert it to an indefinite hold.
1133 # If the hold is not suspended, this does nothing.
1134 $hold->set( { suspend_until => undef } )->store();
1138 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
1142 =head2 ModReserveStatus
1144 &ModReserveStatus($itemnumber, $newstatus);
1146 Update the reserve status for the active (priority=0) reserve.
1148 $itemnumber is the itemnumber the reserve is on
1150 $newstatus is the new status.
1154 sub ModReserveStatus {
1156 #first : check if we have a reservation for this item .
1157 my ($itemnumber, $newstatus) = @_;
1158 my $dbh = C4::Context->dbh;
1160 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1161 my $sth_set = $dbh->prepare($query);
1162 $sth_set->execute( $newstatus, $itemnumber );
1164 my $item = Koha::Items->find($itemnumber);
1165 if ( $item->location && $item->location eq 'CART'
1166 && ( !$item->permanent_location || $item->permanent_location ne 'CART' )
1168 CartToShelf( $itemnumber );
1172 =head2 ModReserveAffect
1174 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend,$reserve_id, $desk_id, $notify_library);
1176 This function affect an item and a status for a given reserve, either fetched directly
1177 by record_id, or by borrowernumber and itemnumber or biblionumber. If only biblionumber
1178 is given, only first reserve returned is affected, which is ok for anything but
1181 if $transferToDo is not set, then the status is set to "Waiting" as well.
1182 otherwise, a transfer is on the way, and the end of the transfer will
1183 take care of the waiting status
1185 This function also removes any entry of the hold in holds queue table.
1189 sub ModReserveAffect {
1190 my ( $itemnumber, $borrowernumber, $transferToDo, $reserve_id, $desk_id, $notify_library ) = @_;
1191 my $dbh = C4::Context->dbh;
1193 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1194 # attached to $itemnumber
1195 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1196 $sth->execute($itemnumber);
1197 my ($biblionumber) = $sth->fetchrow;
1199 # get request - need to find out if item is already
1200 # waiting in order to not send duplicate hold filled notifications
1203 # Find hold by id if we have it
1204 $hold = Koha::Holds->find( $reserve_id ) if $reserve_id;
1205 # Find item level hold for this item if there is one
1206 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->next();
1207 # Find record level hold if there is no item level hold
1208 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, biblionumber => $biblionumber } )->next();
1210 return unless $hold;
1212 my $already_on_shelf = $hold->found && $hold->found eq 'W';
1214 $hold->itemnumber($itemnumber);
1216 if ($transferToDo) {
1217 $hold->set_transfer();
1218 } elsif (C4::Context->preference('HoldsNeedProcessingSIP')
1219 && C4::Context->interface eq 'sip'
1220 && !$already_on_shelf) {
1221 $hold->set_processing();
1223 $hold->set_waiting($desk_id);
1224 _koha_notify_reserve( $hold->reserve_id ) unless $already_on_shelf;
1225 # Complete transfer if one exists
1226 my $transfer = $hold->item->get_transfer;
1227 $transfer->receive if $transfer;
1230 _koha_notify_hold_changed( $hold ) if $notify_library;
1232 _FixPriority( { biblionumber => $biblionumber } );
1233 my $item = Koha::Items->find($itemnumber);
1234 if ( $item->location && $item->location eq 'CART'
1235 && ( !$item->permanent_location || $item->permanent_location ne 'CART' ) ) {
1236 CartToShelf( $itemnumber );
1239 my $std = $dbh->prepare(q{
1241 FROM tmp_holdsqueue q
1242 INNER JOIN hold_fill_targets t
1243 ON q.borrowernumber = t.borrowernumber
1244 AND q.biblionumber = t.biblionumber
1245 AND q.itemnumber = t.itemnumber
1246 AND q.item_level_request = t.item_level_request
1247 AND q.holdingbranch = t.source_branchcode
1248 WHERE t.reserve_id = ?
1250 $std->execute($hold->reserve_id);
1252 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, $hold )
1253 if C4::Context->preference('HoldsLog');
1258 =head2 ModReserveCancelAll
1260 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber,$reason);
1262 function to cancel reserv,check other reserves, and transfer document if it's necessary
1266 sub ModReserveCancelAll {
1269 my ( $itemnumber, $borrowernumber, $cancellation_reason ) = @_;
1271 #step 1 : cancel the reservation
1272 my $holds = Koha::Holds->search({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1273 return unless $holds->count;
1274 $holds->next->cancel({ cancellation_reason => $cancellation_reason });
1276 #step 2 launch the subroutine of the others reserves
1277 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1279 return ( $messages, $nextreservinfo->{borrowernumber} );
1282 =head2 ModReserveMinusPriority
1284 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1286 Reduce the values of queued list
1290 sub ModReserveMinusPriority {
1291 my ( $itemnumber, $reserve_id ) = @_;
1293 #first step update the value of the first person on reserv
1294 my $dbh = C4::Context->dbh;
1297 SET priority = 0 , itemnumber = ?
1298 WHERE reserve_id = ?
1300 my $sth_upd = $dbh->prepare($query);
1301 $sth_upd->execute( $itemnumber, $reserve_id );
1302 # second step update all others reserves
1303 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1306 =head2 IsAvailableForItemLevelRequest
1308 my $is_available = IsAvailableForItemLevelRequest( $item_record, $borrower_record, $pickup_branchcode );
1310 Checks whether a given item record is available for an
1311 item-level hold request. An item is available if
1313 * it is not lost AND
1314 * it is not damaged AND
1315 * it is not withdrawn AND
1316 * a waiting or in transit reserve is placed on
1317 * does not have a not for loan value > 0
1319 Need to check the issuingrules onshelfholds column,
1320 if this is set items on the shelf can be placed on hold
1322 Note that IsAvailableForItemLevelRequest() does not
1323 check if the staff operator is authorized to place
1324 a request on the item - in particular,
1325 this routine does not check IndependentBranches
1326 and canreservefromotherbranches.
1328 Note also that this subroutine does not checks smart
1329 rules limits for item by reservesallowed/holds_per_record
1330 values, this complemented in calling code with calls and
1331 checks with CanItemBeReserved or CanBookBeReserved.
1335 sub IsAvailableForItemLevelRequest {
1338 my $pickup_branchcode = shift;
1340 my $dbh = C4::Context->dbh;
1341 # must check the notforloan setting of the itemtype
1342 # FIXME - a lot of places in the code do this
1343 # or something similar - need to be
1345 my $itemtype = $item->effective_itemtype;
1347 unless defined $itemtype;
1348 my $notforloan_per_itemtype = Koha::ItemTypes->find($itemtype)->notforloan;
1351 $notforloan_per_itemtype ||
1353 $item->notforloan > 0 || # item with negative or zero notforloan value is holdable
1355 ($item->damaged && !C4::Context->preference('AllowHoldsOnDamagedItems'));
1357 if ($pickup_branchcode) {
1358 my $destination = Koha::Libraries->find($pickup_branchcode);
1359 return 0 unless $destination;
1360 return 0 unless $destination->pickup_location;
1361 return 0 unless $item->can_be_transferred( { to => $destination } );
1362 my $reserves_control_branch =
1363 GetReservesControlBranch( $item->unblessed(), $patron->unblessed() );
1364 my $branchitemrule =
1365 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $item->itype );
1366 my $home_library = Koha::Libraries->find( {branchcode => $item->homebranch} );
1367 return 0 unless $branchitemrule->{hold_fulfillment_policy} ne 'holdgroup' || $home_library->validate_hold_sibling( {branchcode => $pickup_branchcode} );
1370 my $on_shelf_holds = Koha::CirculationRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
1372 if ( $on_shelf_holds == 1 ) {
1374 } elsif ( $on_shelf_holds == 2 ) {
1376 # These calculations work at the biblio level, and can be expensive
1377 # we use the in-memory cache to avoid calling once per item when looping items on a biblio
1379 my $memory_cache = Koha::Cache::Memory::Lite->get_instance();
1380 my $cache_key = sprintf "ItemsAnyAvailableAndNotRestricted:%s:%s", $patron->id, $item->biblionumber;
1382 my $any_available = $memory_cache->get_from_cache($cache_key);
1383 return $any_available ? 0 : 1 if defined($any_available);
1386 ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron } );
1387 $memory_cache->set_in_cache( $cache_key, $any_available );
1388 return $any_available ? 0 : 1;
1390 } else { # on_shelf_holds == 0 "If any unavailable" (the description is rather cryptic and could still be improved)
1391 return $item->notforloan < 0 || $item->onloan || IsItemOnHoldAndFound( $item->itemnumber );
1395 =head2 ItemsAnyAvailableAndNotRestricted
1397 ItemsAnyAvailableAndNotRestricted( { biblionumber => $biblionumber, patron => $patron });
1399 This function checks all items for specified biblionumber (numeric) against patron (object)
1400 and returns true (1) if at least one item available for loan/check out/present/not held
1401 and also checks other parameters logic which not restricts item for hold at all (for ex.
1402 AllowHoldsOnDamagedItems or 'holdallowed' own/sibling library)
1406 sub ItemsAnyAvailableAndNotRestricted {
1409 my @items = Koha::Items->search( { biblionumber => $param->{biblionumber} } )->as_list;
1411 foreach my $i (@items) {
1412 my $reserves_control_branch =
1413 GetReservesControlBranch( $i->unblessed(), $param->{patron}->unblessed );
1414 my $branchitemrule =
1415 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $i->itype );
1416 my $item_library = Koha::Libraries->find( { branchcode => $i->homebranch } );
1418 # we can return (end the loop) when first one found:
1421 || $i->notforloan # items with non-zero notforloan cannot be checked out
1424 || IsItemOnHoldAndFound( $i->id )
1426 && ! C4::Context->preference('AllowHoldsOnDamagedItems') )
1427 || Koha::ItemTypes->find( $i->effective_itemtype() )->notforloan
1428 || $branchitemrule->{holdallowed} eq 'from_home_library' && $param->{patron}->branchcode ne $i->homebranch
1429 || $branchitemrule->{holdallowed} eq 'from_local_hold_group' && ! $item_library->validate_hold_sibling( { branchcode => $param->{patron}->branchcode } )
1430 || CanItemBeReserved( $param->{patron}, $i )->{status} ne 'OK';
1436 =head2 AlterPriority
1438 AlterPriority( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority );
1440 This function changes a reserve's priority up, down, to the top, or to the bottom.
1441 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1446 my ( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority ) = @_;
1448 my $hold = Koha::Holds->find( $reserve_id );
1449 return unless $hold;
1451 if ( $hold->cancellationdate ) {
1452 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (" . $hold->cancellationdate . ')';
1456 if ( $where eq 'up' ) {
1457 return unless $prev_priority;
1458 _FixPriority({ reserve_id => $reserve_id, rank => $prev_priority })
1459 } elsif ( $where eq 'down' ) {
1460 return unless $next_priority;
1461 _FixPriority({ reserve_id => $reserve_id, rank => $next_priority })
1462 } elsif ( $where eq 'top' ) {
1463 _FixPriority({ reserve_id => $reserve_id, rank => $first_priority })
1464 } elsif ( $where eq 'bottom' ) {
1465 _FixPriority({ reserve_id => $reserve_id, rank => $last_priority });
1468 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1470 biblio_ids => [ $hold->biblionumber ]
1472 ) if C4::Context->preference('RealTimeHoldsQueue');
1473 # FIXME Should return the new priority
1476 =head2 ToggleLowestPriority
1478 ToggleLowestPriority( $borrowernumber, $biblionumber );
1480 This function sets the lowestPriority field to true if is false, and false if it is true.
1484 sub ToggleLowestPriority {
1485 my ( $reserve_id ) = @_;
1487 my $dbh = C4::Context->dbh;
1489 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1490 $sth->execute( $reserve_id );
1492 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1495 =head2 ToggleSuspend
1497 ToggleSuspend( $reserve_id );
1499 This function sets the suspend field to true if is false, and false if it is true.
1500 If the reserve is currently suspended with a suspend_until date, that date will
1501 be cleared when it is unsuspended.
1506 my ( $reserve_id, $suspend_until ) = @_;
1508 my $hold = Koha::Holds->find( $reserve_id );
1510 if ( $hold->is_suspended ) {
1513 $hold->suspend_hold( $suspend_until );
1520 borrowernumber => $borrowernumber,
1521 [ biblionumber => $biblionumber, ]
1522 [ suspend_until => $suspend_until, ]
1523 [ suspend => $suspend ]
1526 This function accepts a set of hash keys as its parameters.
1527 It requires either borrowernumber or biblionumber, or both.
1529 suspend_until is wholly optional.
1536 my $borrowernumber = $params{'borrowernumber'} || undef;
1537 my $biblionumber = $params{'biblionumber'} || undef;
1538 my $suspend_until = $params{'suspend_until'} || undef;
1539 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1541 return unless ( $borrowernumber || $biblionumber );
1544 $params->{found} = undef;
1545 $params->{borrowernumber} = $borrowernumber if $borrowernumber;
1546 $params->{biblionumber} = $biblionumber if $biblionumber;
1548 my @holds = Koha::Holds->search($params)->as_list;
1551 map { $_->suspend_hold($suspend_until) } @holds;
1554 map { $_->resume() } @holds;
1562 reserve_id => $reserve_id,
1564 [ignoreSetLowestRank => $ignoreSetLowestRank]
1569 _FixPriority({ biblionumber => $biblionumber});
1571 This routine adjusts the priority of a hold request and holds
1574 In the first form, where a reserve_id is passed, the priority of the
1575 hold is set to supplied rank, and other holds for that bib are adjusted
1576 accordingly. If the rank is "del", the hold is cancelled. If no rank
1577 is supplied, all of the holds on that bib have their priority adjusted
1578 as if the second form had been used.
1580 In the second form, where a biblionumber is passed, the holds on that
1581 bib (that are not captured) are sorted in order of increasing priority,
1582 then have reserves.priority set so that the first non-captured hold
1583 has its priority set to 1, the second non-captured hold has its priority
1584 set to 2, and so forth.
1586 In both cases, holds that have the lowestPriority flag on are have their
1587 priority adjusted to ensure that they remain at the end of the line.
1589 Note that the ignoreSetLowestRank parameter is meant to be used only
1590 when _FixPriority calls itself.
1595 my ( $params ) = @_;
1596 my $reserve_id = $params->{reserve_id};
1597 my $rank = $params->{rank} // '';
1598 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1599 my $biblionumber = $params->{biblionumber};
1601 my $dbh = C4::Context->dbh;
1604 if ( $reserve_id ) {
1605 $hold = Koha::Holds->find( $reserve_id );
1606 if (!defined $hold){
1607 # may have already been checked out and hold fulfilled
1608 $hold = Koha::Old::Holds->find( $reserve_id );
1610 return unless $hold;
1613 unless ( $biblionumber ) { # FIXME This is a very weird API
1614 $biblionumber = $hold->biblionumber;
1617 if ( $rank eq "del" ) { # FIXME will crash if called without $hold
1620 elsif ( $reserve_id && ( $rank eq "W" || $rank eq "0" ) ) {
1622 # make sure priority for waiting or in-transit items is 0
1626 WHERE reserve_id = ?
1627 AND found IN ('W', 'T', 'P')
1629 my $sth = $dbh->prepare($query);
1630 $sth->execute( $reserve_id );
1636 SELECT reserve_id, borrowernumber, reservedate
1638 WHERE biblionumber = ?
1639 AND ((found <> 'W' AND found <> 'T' AND found <> 'P') OR found IS NULL)
1640 ORDER BY priority ASC
1642 my $sth = $dbh->prepare($query);
1643 $sth->execute( $biblionumber );
1644 while ( my $line = $sth->fetchrow_hashref ) {
1645 push( @priority, $line );
1648 # FIXME This whole sub must be rewritten, especially to highlight what is done when reserve_id is not given
1649 # To find the matching index
1651 my $key = -1; # to allow for 0 to be a valid result
1652 for ( $i = 0 ; $i < @priority ; $i++ ) {
1653 if ( $reserve_id && $reserve_id == $priority[$i]->{'reserve_id'} ) {
1654 $key = $i; # save the index
1659 # if index exists in array then move it to new position
1660 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1661 my $new_rank = $rank - 1; # $new_rank is what you want the new index to be in the array
1662 my $moving_item = splice( @priority, $key, 1 );
1663 $new_rank = scalar @priority if $new_rank > scalar @priority;
1664 splice( @priority, $new_rank, 0, $moving_item );
1667 # now fix the priority on those that are left....
1671 WHERE reserve_id = ?
1673 $sth = $dbh->prepare($query);
1674 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1677 $priority[$j]->{'reserve_id'}
1681 unless ( $ignoreSetLowestRank ) {
1682 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 AND biblionumber = ? ORDER BY priority" );
1683 $sth->execute($biblionumber);
1684 while ( my $res = $sth->fetchrow_hashref() ) {
1686 reserve_id => $res->{'reserve_id'},
1688 ignoreSetLowestRank => 1
1694 =head2 _Findgroupreserve
1696 @results = &_Findgroupreserve($biblionumber, $itemnumber, $lookahead, $ignore_borrowers);
1698 Looks for a holds-queue based item-specific match first, then for a holds-queue title-level match, returning the
1699 first match found. If neither, then we look for non-holds-queue based holds.
1700 Lookahead is the number of days to look in advance.
1702 C<&_Findgroupreserve> returns :
1703 C<@results> is an array of references-to-hash whose keys are mostly
1704 fields from the reserves table of the Koha database, plus
1705 C<biblioitemnumber>.
1707 This routine with either return:
1708 1 - Item specific holds from the holds queue
1709 2 - Title level holds from the holds queue
1710 3 - All holds for this biblionumber
1712 All return values will respect any borrowernumbers passed as arrayref in $ignore_borrowers
1716 sub _Findgroupreserve {
1717 my ( $biblionumber, $itemnumber, $lookahead, $ignore_borrowers) = @_;
1718 my $dbh = C4::Context->dbh;
1720 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1721 # check for exact targeted match
1722 my $item_level_target_query = qq{
1723 SELECT reserves.biblionumber AS biblionumber,
1724 reserves.borrowernumber AS borrowernumber,
1725 reserves.reservedate AS reservedate,
1726 reserves.branchcode AS branchcode,
1727 reserves.cancellationdate AS cancellationdate,
1728 reserves.found AS found,
1729 reserves.reservenotes AS reservenotes,
1730 reserves.priority AS priority,
1731 reserves.timestamp AS timestamp,
1732 biblioitems.biblioitemnumber AS biblioitemnumber,
1733 reserves.itemnumber AS itemnumber,
1734 reserves.reserve_id AS reserve_id,
1735 reserves.itemtype AS itemtype,
1736 reserves.non_priority AS non_priority,
1737 reserves.item_group_id AS item_group_id
1739 JOIN biblioitems USING (biblionumber)
1740 JOIN hold_fill_targets USING (reserve_id)
1743 AND item_level_request = 1
1744 AND hold_fill_targets.itemnumber = ?
1745 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1749 my $sth = $dbh->prepare($item_level_target_query);
1750 $sth->execute($itemnumber, $lookahead||0);
1752 if ( my $data = $sth->fetchrow_hashref ) {
1753 push( @results, $data )
1754 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1756 return @results if @results;
1758 # check for title-level targeted match
1759 my $title_level_target_query = qq{
1760 SELECT reserves.biblionumber AS biblionumber,
1761 reserves.borrowernumber AS borrowernumber,
1762 reserves.reservedate AS reservedate,
1763 reserves.branchcode AS branchcode,
1764 reserves.cancellationdate AS cancellationdate,
1765 reserves.found AS found,
1766 reserves.reservenotes AS reservenotes,
1767 reserves.priority AS priority,
1768 reserves.timestamp AS timestamp,
1769 biblioitems.biblioitemnumber AS biblioitemnumber,
1770 reserves.itemnumber AS itemnumber,
1771 reserves.reserve_id AS reserve_id,
1772 reserves.itemtype AS itemtype,
1773 reserves.non_priority AS non_priority,
1774 reserves.item_group_id AS item_group_id
1776 JOIN biblioitems USING (biblionumber)
1777 JOIN hold_fill_targets USING (reserve_id)
1778 LEFT JOIN item_group_items ON ( item_group_items.item_id = hold_fill_targets.itemnumber )
1781 AND item_level_request = 0
1782 AND hold_fill_targets.itemnumber = ?
1783 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1785 AND reserves.item_group_id = item_group_items.item_group_id
1788 $sth = $dbh->prepare($title_level_target_query);
1789 $sth->execute($itemnumber, $lookahead||0);
1791 if ( my $data = $sth->fetchrow_hashref ) {
1792 push( @results, $data )
1793 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1795 return @results if @results;
1798 SELECT reserves.biblionumber AS biblionumber,
1799 reserves.borrowernumber AS borrowernumber,
1800 reserves.reservedate AS reservedate,
1801 reserves.waitingdate AS waitingdate,
1802 reserves.branchcode AS branchcode,
1803 reserves.cancellationdate AS cancellationdate,
1804 reserves.found AS found,
1805 reserves.reservenotes AS reservenotes,
1806 reserves.priority AS priority,
1807 reserves.timestamp AS timestamp,
1808 reserves.itemnumber AS itemnumber,
1809 reserves.reserve_id AS reserve_id,
1810 reserves.itemtype AS itemtype,
1811 reserves.non_priority AS non_priority,
1812 reserves.item_group_id AS item_group_id
1814 WHERE reserves.biblionumber = ?
1815 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1816 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1820 $sth = $dbh->prepare($query);
1821 $sth->execute( $biblionumber, $itemnumber, $lookahead||0);
1823 while ( my $data = $sth->fetchrow_hashref ) {
1824 push( @results, $data )
1825 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1830 =head2 _koha_notify_reserve
1832 _koha_notify_reserve( $hold->reserve_id );
1834 Sends a notification to the patron that their hold has been filled (through
1837 The letter code for this notice may be found using the following query:
1839 select distinct letter_code
1840 from message_transports
1841 inner join message_attributes using (message_attribute_id)
1842 where message_name = 'Hold_Filled'
1844 This will probably sipmly be 'HOLD', but because it is defined in the database,
1845 it is subject to addition or change.
1847 The following tables are availalbe witin the notice:
1858 sub _koha_notify_reserve {
1859 my $reserve_id = shift;
1861 my $hold = Koha::Holds->find($reserve_id);
1862 my $borrowernumber = $hold->borrowernumber;
1864 my $patron = Koha::Patrons->find( $borrowernumber );
1866 # Try to get the borrower's email address
1867 my $to_address = $patron->notice_email_address;
1869 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
1870 borrowernumber => $borrowernumber,
1871 message_name => 'Hold_Filled'
1874 my $library = Koha::Libraries->find( $hold->branchcode );
1875 my $from_email_address = $library->from_email_address;
1877 my %letter_params = (
1878 module => 'reserves',
1879 branchcode => $hold->branchcode,
1880 lang => $patron->lang,
1882 'branches' => $library->unblessed,
1883 'borrowers' => $patron->unblessed,
1884 'biblio' => $hold->biblionumber,
1885 'biblioitems' => $hold->biblionumber,
1886 'reserves' => $hold->unblessed,
1887 'items' => $hold->itemnumber,
1891 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.
1892 my $send_notification = sub {
1893 my ( $mtt, $letter_code ) = (@_);
1894 return unless defined $letter_code;
1895 $letter_params{letter_code} = $letter_code;
1896 $letter_params{message_transport_type} = $mtt;
1897 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
1899 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
1903 C4::Letters::EnqueueLetter( {
1905 borrowernumber => $borrowernumber,
1906 from_address => $from_email_address,
1907 message_transport_type => $mtt,
1911 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
1913 ( $mtt eq 'email' and not $to_address ) # No email address
1914 or ( $mtt eq 'sms' and not $patron->smsalertnumber ) # No SMS number
1915 or ( $mtt eq 'itiva' and C4::Context->preference('TalkingTechItivaPhoneNotification') ) # Notice is handled by TalkingTech_itiva_outbound.pl
1916 or ( $mtt eq 'phone' and not $patron->phone ) # No phone number to call
1919 &$send_notification($mtt, $letter_code);
1920 $notification_sent++;
1922 #Making sure that a print notification is sent if no other transport types can be utilized.
1923 if (! $notification_sent) {
1924 &$send_notification('print', 'HOLD');
1929 =head2 _koha_notify_hold_changed
1931 _koha_notify_hold_changed( $hold_object );
1935 sub _koha_notify_hold_changed {
1938 my $patron = $hold->patron;
1939 my $library = $hold->branch;
1941 my $letter = C4::Letters::GetPreparedLetter(
1942 module => 'reserves',
1943 letter_code => 'HOLD_CHANGED',
1944 branchcode => $hold->branchcode,
1945 substitute => { today => output_pref( dt_from_string ) },
1947 'branches' => $library->unblessed,
1948 'borrowers' => $patron->unblessed,
1949 'biblio' => $hold->biblionumber,
1950 'biblioitems' => $hold->biblionumber,
1951 'reserves' => $hold->unblessed,
1952 'items' => $hold->itemnumber,
1956 return unless $letter;
1959 C4::Context->preference('ExpireReservesAutoFillEmail')
1960 || $library->inbound_email_address;
1962 C4::Letters::EnqueueLetter(
1965 borrowernumber => $patron->id,
1966 message_transport_type => 'email',
1967 from_address => $library->from_email_address,
1968 to_address => $email,
1973 =head2 _ShiftPriority
1975 $new_priority = _ShiftPriority( $biblionumber, $priority );
1977 This increments the priority of all reserves after the one
1978 with either the lowest date after C<$reservedate>
1979 or the lowest priority after C<$priority>.
1981 It effectively makes room for a new reserve to be inserted with a certain
1982 priority, which is returned.
1984 This is most useful when the reservedate can be set by the user. It allows
1985 the new reserve to be placed before other reserves that have a later
1986 reservedate. Since priority also is set by the form in reserves/request.pl
1987 the sub accounts for that too.
1991 sub _ShiftPriority {
1992 my ( $biblio, $new_priority ) = @_;
1994 my $dbh = C4::Context->dbh;
1995 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND priority > ? ORDER BY priority ASC LIMIT 1";
1996 my $sth = $dbh->prepare( $query );
1997 $sth->execute( $biblio, $new_priority );
1998 my $min_priority = $sth->fetchrow;
1999 # if no such matches are found, $new_priority remains as original value
2000 $new_priority = $min_priority if ( $min_priority );
2002 # Shift the priority up by one; works in conjunction with the next SQL statement
2003 $query = "UPDATE reserves
2004 SET priority = priority+1
2005 WHERE biblionumber = ?
2006 AND borrowernumber = ?
2009 my $sth_update = $dbh->prepare( $query );
2011 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
2012 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
2013 $sth = $dbh->prepare( $query );
2014 $sth->execute( $new_priority, $biblio );
2015 while ( my $row = $sth->fetchrow_hashref ) {
2016 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
2019 return $new_priority; # so the caller knows what priority they wind up receiving
2024 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
2026 Use when checking out an item to handle reserves
2027 If $cancelreserve boolean is set to true, it will remove existing reserve
2032 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
2034 $cancelreserve //= 0;
2036 my $lookahead = C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2037 my $item = Koha::Items->find($itemnumber);
2038 my ( $restype, $res, undef ) = CheckReserves( $item, $lookahead );
2041 my $biblionumber = $res->{biblionumber};
2043 if ($res->{borrowernumber} == $borrowernumber) {
2044 my $hold = Koha::Holds->find( $res->{reserve_id} );
2045 $hold->fill({ item_id => $itemnumber });
2049 # The item is reserved by someone else.
2050 # Find this item in the reserves
2052 my $borr_res = Koha::Holds->search({
2053 borrowernumber => $borrowernumber,
2054 biblionumber => $biblionumber,
2056 order_by => 'priority'
2060 # The item is reserved by the current patron
2061 $borr_res->fill({ item_id => $itemnumber });
2064 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2065 RevertWaitingStatus({ itemnumber => $itemnumber });
2067 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2068 my $hold = Koha::Holds->find( $res->{reserve_id} );
2076 MergeHolds($dbh,$to_biblio, $from_biblio);
2078 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2083 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2084 my $sth = $dbh->prepare(
2085 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2087 $sth->execute($from_biblio);
2088 if ( my $data = $sth->fetchrow_hashref() ) {
2090 # holds exist on old record, if not we don't need to do anything
2091 $sth = $dbh->prepare(
2092 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2093 $sth->execute( $to_biblio, $from_biblio );
2096 # don't reorder those already waiting
2098 $sth = $dbh->prepare(
2099 "SELECT * FROM reserves WHERE biblionumber = ? AND (found NOT IN ('W', 'T', 'P') OR found is NULL) ORDER BY reservedate ASC"
2101 my $upd_sth = $dbh->prepare(
2102 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2103 AND reservedate = ? AND (itemnumber = ? or itemnumber is NULL) "
2105 $sth->execute( $to_biblio );
2107 while ( my $reserve = $sth->fetchrow_hashref() ) {
2109 $priority, $to_biblio,
2110 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2111 $reserve->{'itemnumber'}
2118 =head2 RevertWaitingStatus
2120 RevertWaitingStatus({ itemnumber => $itemnumber });
2122 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2124 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2125 item level hold, even if it was only a bibliolevel hold to
2126 begin with. This is because we can no longer know if a hold
2127 was item-level or bib-level after a hold has been set to
2132 sub RevertWaitingStatus {
2133 my ( $params ) = @_;
2134 my $itemnumber = $params->{'itemnumber'};
2136 return unless ( $itemnumber );
2138 my $dbh = C4::Context->dbh;
2140 ## Get the waiting reserve we want to revert
2141 my $hold = Koha::Holds->search(
2143 itemnumber => $itemnumber,
2144 found => { not => undef },
2148 ## Increment the priority of all other non-waiting
2149 ## reserves for this bib record
2150 my $holds = Koha::Holds->search({ biblionumber => $hold->biblionumber, priority => { '>' => 0 } })
2151 ->update({ priority => \'priority + 1' }, { no_triggers => 1 });
2153 ## Fix up the currently waiting reserve
2158 waitingdate => undef,
2159 expirationdate => $hold->patron_expiration_date,
2160 itemnumber => $hold->item_level_hold ? $hold->itemnumber : undef,
2164 _FixPriority( { biblionumber => $hold->biblionumber } );
2166 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2168 biblio_ids => [ $hold->biblionumber ]
2170 ) if C4::Context->preference('RealTimeHoldsQueue');
2180 branchcode => $branchcode,
2181 borrowernumber => $borrowernumber,
2182 biblionumber => $biblionumber,
2183 [ itemnumber => $itemnumber, ]
2184 [ barcode => $barcode, ]
2188 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2190 The letter code will be HOLD_SLIP, and the following tables are
2191 available within the slip:
2204 my $branchcode = $args->{branchcode};
2205 my $reserve_id = $args->{reserve_id};
2207 my $hold = Koha::Holds->find($reserve_id);
2208 return unless $hold;
2210 my $patron = $hold->borrower;
2211 my $reserve = $hold->unblessed;
2213 return C4::Letters::GetPreparedLetter (
2214 module => 'circulation',
2215 letter_code => 'HOLD_SLIP',
2216 branchcode => $branchcode,
2217 lang => $patron->lang,
2219 'reserves' => $reserve,
2220 'branches' => $reserve->{branchcode},
2221 'borrowers' => $reserve->{borrowernumber},
2222 'biblio' => $reserve->{biblionumber},
2223 'biblioitems' => $reserve->{biblionumber},
2224 'items' => $reserve->{itemnumber},
2229 =head2 GetReservesControlBranch
2231 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2233 Return the branchcode to be used to determine which reserves
2234 policy applies to a transaction.
2236 C<$item> is a hashref for an item. Only 'homebranch' is used.
2238 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2242 sub GetReservesControlBranch {
2243 my ( $item, $borrower ) = @_;
2245 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2248 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2249 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2255 =head2 CalculatePriority
2257 my $p = CalculatePriority($biblionumber, $resdate);
2259 Calculate priority for a new reserve on biblionumber, placing it at
2260 the end of the line of all holds whose start date falls before
2261 the current system time and that are neither on the hold shelf
2264 The reserve date parameter is optional; if it is supplied, the
2265 priority is based on the set of holds whose start date falls before
2266 the parameter value.
2268 After calculation of this priority, it is recommended to call
2269 _ShiftPriority. Note that this is currently done in
2274 sub CalculatePriority {
2275 my ( $biblionumber, $resdate ) = @_;
2278 SELECT COUNT(*) FROM reserves
2279 WHERE biblionumber = ?
2281 AND (found IS NULL OR found = '')
2283 #skip found==W or found==T or found==P (waiting, transit or processing holds)
2285 $sql.= ' AND ( reservedate <= ? )';
2288 $sql.= ' AND ( reservedate < NOW() )';
2290 my $dbh = C4::Context->dbh();
2291 my @row = $dbh->selectrow_array(
2294 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
2297 return @row ? $row[0]+1 : 1;
2300 =head2 IsItemOnHoldAndFound
2302 my $bool = IsItemFoundHold( $itemnumber );
2304 Returns true if the item is currently on hold
2305 and that hold has a non-null found status ( W, T, etc. )
2309 sub IsItemOnHoldAndFound {
2310 my ($itemnumber) = @_;
2312 my $rs = Koha::Database->new()->schema()->resultset('Reserve');
2314 my $found = $rs->count(
2316 itemnumber => $itemnumber,
2317 found => { '!=' => undef }
2324 =head2 GetMaxPatronHoldsForRecord
2326 my $holds_per_record = ReservesControlBranch( $borrowernumber, $biblionumber );
2328 For multiple holds on a given record for a given patron, the max
2329 number of record level holds that a patron can be placed is the highest
2330 value of the holds_per_record rule for each item if the record for that
2331 patron. This subroutine finds and returns the highest holds_per_record
2332 rule value for a given patron id and record id.
2336 sub GetMaxPatronHoldsForRecord {
2337 my ( $borrowernumber, $biblionumber ) = @_;
2339 my $patron = Koha::Patrons->find($borrowernumber);
2340 my @items = Koha::Items->search( { biblionumber => $biblionumber } )->as_list;
2342 my $controlbranch = C4::Context->preference('ReservesControlBranch');
2344 my $categorycode = $patron->categorycode;
2346 $branchcode = $patron->branchcode if ( $controlbranch eq "PatronLibrary" );
2349 foreach my $item (@items) {
2350 my $itemtype = $item->effective_itemtype();
2352 $branchcode = $item->homebranch if ( $controlbranch eq "ItemHomeLibrary" );
2354 my $rule = Koha::CirculationRules->get_effective_rule({
2355 categorycode => $categorycode,
2356 itemtype => $itemtype,
2357 branchcode => $branchcode,
2358 rule_name => 'holds_per_record'
2360 my $holds_per_record = $rule ? $rule->rule_value : 0;
2361 $max = $holds_per_record if $holds_per_record > $max;
2369 Koha Development Team <http://koha-community.org/>