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::CirculationRules;
41 use Koha::DateUtils qw( dt_from_string output_pref );
50 use List::MoreUtils qw( any );
54 C4::Reserves - Koha functions for dealing with reservation.
62 This modules provides somes functions to deal with reservations.
64 Reserves are stored in reserves table.
65 The following columns contains important values :
66 - priority >0 : then the reserve is at 1st stage, and not yet affected to any item.
67 =0 : then the reserve is being dealed
68 - found : NULL : means the patron requested the 1st available, and we haven't chosen the item
69 T(ransit) : the reserve is linked to an item but is in transit to the pickup branch
70 W(aiting) : the reserve is linked to an item, is at the pickup branch, and is waiting on the hold shelf
71 F(inished) : the reserve has been completed, and is done
72 P(rocessing) : reserved item has been returned using self-check machine and reserve needs to be confirmed
73 by librarian before notice is send and status changed to waiting.
74 Applicable only if HoldsNeedProcessingSIP system preference is set.
75 - itemnumber : empty : the reserve is still unaffected to an item
76 filled: the reserve is attached to an item
77 The complete workflow is :
78 ==== 1st use case ====
79 patron request a document, 1st available : P >0, F=NULL, I=NULL
80 a library having it run "transfertodo", and clic on the list
81 if there is no transfer to do, the reserve waiting
82 patron can pick it up P =0, F=W, I=filled
83 if there is a transfer to do, write in branchtransfer P =0, F=T, I=filled
84 The pickup library receive the book, it check in P =0, F=W, I=filled
85 The patron borrow the book P =0, F=F, I=filled
87 ==== 2nd use case ====
88 patron requests a document, a given item,
89 If pickup is holding branch P =0, F=W, I=filled
90 If transfer needed, write in branchtransfer P =0, F=T, I=filled
91 The pickup library receive the book, it checks it in P =0, F=W, I=filled
92 The patron borrow the book P =0, F=F, I=filled
98 our (@ISA, @EXPORT_OK);
115 ModReserveMinusPriority
121 CanReserveBeCanceledFromOpac
122 CancelExpiredReserves
124 AutoUnsuspendReserves
126 IsAvailableForItemLevelRequest
127 ItemsAnyAvailableAndNotRestricted
136 GetReservesControlBranch
142 GetMaxPatronHoldsForRecord
154 branchcode => $branchcode,
155 borrowernumber => $borrowernumber,
156 biblionumber => $biblionumber,
157 priority => $priority,
158 reservation_date => $reservation_date,
159 expiration_date => $expiration_date,
162 itemnumber => $itemnumber,
164 itemtype => $itemtype,
165 item_group_id => $item_group_id
169 Adds reserve and generates HOLDPLACED message.
171 The following tables are available witin the HOLDPLACED message:
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 my $item_group_id = $params->{item_group_id};
198 $resdate ||= dt_from_string;
200 # if we have an item selectionned, and the pickup branch is the same as the holdingbranch
201 # of the document, we force the value $priority and $found .
202 if ( $checkitem and not C4::Context->preference('ReservesNeedReturns') ) {
203 my $item = Koha::Items->find( $checkitem ); # FIXME Prevent bad calls
206 # If item is already checked out, it cannot be set waiting
209 # The item can't be waiting if it needs a transfer
210 && $item->holdingbranch eq $branch
212 # Similarly, if in transit it can't be waiting
213 && !$item->get_transfer
215 # If we can't hold damaged items, and it is damaged, it can't be waiting
216 && ( $item->damaged && C4::Context->preference('AllowHoldsOnDamagedItems') || !$item->damaged )
218 # Lastly, if this already has holds, we shouldn't make it waiting for the new hold
219 && !$item->current_holds->count )
225 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
226 # Make room in reserves for this if passed a priority
227 $priority = _ShiftPriority( $biblionumber, $priority );
232 # If the reserv had the waiting status, we had the value of the resdate
233 if ( $found && $found eq 'W' ) {
234 $waitingdate = $resdate;
237 # Don't add itemtype limit if specific item is selected
238 $itemtype = undef if $checkitem;
240 # updates take place here
241 my $hold = Koha::Hold->new(
243 borrowernumber => $borrowernumber,
244 biblionumber => $biblionumber,
245 item_group_id => $item_group_id,
246 reservedate => $resdate,
247 branchcode => $branch,
248 priority => $priority,
249 reservenotes => $notes,
250 itemnumber => $checkitem,
252 waitingdate => $waitingdate,
253 patron_expiration_date => $patron_expiration_date,
254 itemtype => $itemtype,
255 item_level_hold => $checkitem ? 1 : 0,
256 non_priority => $non_priority ? 1 : 0,
259 $hold->set_waiting() if $found && $found eq 'W';
261 logaction( 'HOLDS', 'CREATE', $hold->id, $hold )
262 if C4::Context->preference('HoldsLog');
264 my $reserve_id = $hold->id();
266 # add a reserve fee if needed
267 if ( C4::Context->preference('HoldFeeMode') ne 'any_time_is_collected' ) {
268 my $reserve_fee = GetReserveFee( $borrowernumber, $biblionumber );
269 ChargeReserveFee( $borrowernumber, $reserve_fee, $title );
272 _FixPriority({ biblionumber => $biblionumber});
274 # Send e-mail to librarian if syspref is active
275 if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
276 my $patron = Koha::Patrons->find( $borrowernumber );
277 my $library = $patron->library;
278 if ( my $letter = C4::Letters::GetPreparedLetter (
279 module => 'reserves',
280 letter_code => 'HOLDPLACED',
281 branchcode => $branch,
282 lang => $patron->lang,
284 'branches' => $library->unblessed,
285 'borrowers' => $patron->unblessed,
286 'biblio' => $biblionumber,
287 'biblioitems' => $biblionumber,
288 'items' => $checkitem,
289 'reserves' => $hold->unblessed,
293 my $branch_email_address = $library->inbound_email_address;
295 C4::Letters::EnqueueLetter(
298 borrowernumber => $borrowernumber,
299 message_transport_type => 'email',
300 to_address => $branch_email_address,
306 Koha::Plugins->call('after_hold_create', $hold);
311 payload => { hold => $hold->get_from_storage }
315 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
317 biblio_ids => [ $biblionumber ]
319 ) if C4::Context->preference('RealTimeHoldsQueue');
324 =head2 CanBookBeReserved
326 $canReserve = &CanBookBeReserved($borrowernumber, $biblionumber, $branchcode, $params)
327 if ($canReserve eq 'OK') { #We can reserve this Item! }
329 $params are passed directly through to CanItemBeReserved
331 See CanItemBeReserved() for possible return values.
335 sub CanBookBeReserved{
336 my ($borrowernumber, $biblionumber, $pickup_branchcode, $params) = @_;
338 # Check that patron have not checked out this biblio (if AllowHoldsOnPatronsPossessions set)
339 if ( !C4::Context->preference('AllowHoldsOnPatronsPossessions')
340 && C4::Circulation::CheckIfIssuedToPatron( $borrowernumber, $biblionumber ) ) {
341 return { status =>'alreadypossession' };
344 if ( $params->{itemtype} ) {
346 # biblio-level, item type-contrained
347 my $patron = Koha::Patrons->find($borrowernumber);
348 my $reservesallowed = Koha::CirculationRules->get_effective_rule(
350 itemtype => $params->{itemtype},
351 categorycode => $patron->categorycode,
352 branchcode => $pickup_branchcode,
353 rule_name => 'reservesallowed',
357 $reservesallowed = ( $reservesallowed eq '' ) ? undef : $reservesallowed;
359 my $count = $patron->holds->search(
362 { 'me.itemtype' => $params->{itemtype} },
363 { 'item.itype' => $params->{itemtype} }
371 return { status => '' }
372 if defined $reservesallowed and $reservesallowed < $count + 1;
376 #get items linked via host records
377 my @hostitemnumbers = get_hostitemnumbers_of($biblionumber);
378 if (@hostitemnumbers){
379 $items = Koha::Items->search({
381 biblionumber => $biblionumber,
382 itemnumber => { -in => @hostitemnumbers }
386 $items = Koha::Items->search({ biblionumber => $biblionumber});
389 my $canReserve = { status => '' };
390 my $patron = Koha::Patrons->find( $borrowernumber );
391 while ( my $item = $items->next ) {
392 $canReserve = CanItemBeReserved( $patron, $item, $pickup_branchcode, $params );
393 return { status => 'OK' } if $canReserve->{status} eq 'OK';
398 =head2 CanItemBeReserved
400 $canReserve = &CanItemBeReserved($patron, $item, $branchcode, $params)
401 if ($canReserve->{status} eq 'OK') { #We can reserve this Item! }
404 'ignore_hold_counts' - we use this routine to check if an item can fill a hold - on this case we
405 should not check if there are too many holds as we only care about reservability
407 @RETURNS { status => OK }, if the Item can be reserved.
408 { status => ageRestricted }, if the Item is age restricted for this borrower.
409 { status => damaged }, if the Item is damaged.
410 { status => cannotReserveFromOtherBranches }, if syspref 'canreservefromotherbranches' is OK.
411 { status => branchNotInHoldGroup }, if borrower home library is not in hold group, and holds are only allowed from hold groups.
412 { status => tooManyReserves, limit => $limit }, if the borrower has exceeded their maximum reserve amount.
413 { status => notReservable }, if holds on this item are not allowed
414 { status => libraryNotFound }, if given branchcode is not an existing library
415 { status => libraryNotPickupLocation }, if given branchcode is not configured to be a pickup location
416 { status => cannotBeTransferred }, if branch transfer limit applies on given item and branchcode
417 { status => pickupNotInHoldGroup }, pickup location is not in hold group, and pickup locations are only allowed from hold groups.
418 { status => recall }, if the borrower has already placed a recall on this item
422 sub CanItemBeReserved {
423 my ( $patron, $item, $pickup_branchcode, $params ) = @_;
425 my $dbh = C4::Context->dbh;
426 my $ruleitemtype; # itemtype of the matching issuing rule
427 my $allowedreserves = 0; # Total number of holds allowed across all records, default to none
429 # We check item branch if IndependentBranches is ON
430 # and canreservefromotherbranches is OFF
431 if ( C4::Context->preference('IndependentBranches')
432 and !C4::Context->preference('canreservefromotherbranches') )
434 if ( $item->homebranch ne $patron->branchcode ) {
435 return { status => 'cannotReserveFromOtherBranches' };
439 # we retrieve borrowers and items informations #
440 # item->{itype} will come for biblioitems if necessery
441 my $borrower = $patron->unblessed;
443 # If an item is damaged and we don't allow holds on damaged items, we can stop right here
444 return { status =>'damaged' }
446 && !C4::Context->preference('AllowHoldsOnDamagedItems') );
448 if( GetMarcFromKohaField('biblioitems.agerestriction') ){
449 my $biblio = $item->biblio;
450 # Check for the age restriction
451 my ( $ageRestriction, $daysToAgeRestriction ) =
452 C4::Circulation::GetAgeRestriction( $biblio->biblioitem->agerestriction, $borrower );
453 return { status => 'ageRestricted' } if $daysToAgeRestriction && $daysToAgeRestriction > 0;
456 # Check that the patron doesn't have an item level hold on this item already
457 return { status =>'itemAlreadyOnHold' }
458 if ( !$params->{ignore_hold_counts} && Koha::Holds->search( { borrowernumber => $patron->borrowernumber, itemnumber => $item->itemnumber } )->count() );
460 # Check that patron have not checked out this biblio (if AllowHoldsOnPatronsPossessions set)
461 if ( !C4::Context->preference('AllowHoldsOnPatronsPossessions')
462 && C4::Circulation::CheckIfIssuedToPatron( $patron->borrowernumber, $item->biblionumber ) ) {
463 return { status =>'alreadypossession' };
466 # check if a recall exists on this item from this borrower
467 return { status => 'recall' }
468 if $patron->recalls->filter_by_current->search({ item_id => $item->itemnumber })->count;
470 my $controlbranch = C4::Context->preference('ReservesControlBranch');
472 my $reserves_control_branch;
473 my $branchfield = "reserves.branchcode";
475 if ( $controlbranch eq "ItemHomeLibrary" ) {
476 $branchfield = "items.homebranch";
477 $reserves_control_branch = $item->homebranch;
479 elsif ( $controlbranch eq "PatronLibrary" ) {
480 $branchfield = "borrowers.branchcode";
481 $reserves_control_branch = $borrower->{branchcode};
486 my $reservesallowed = Koha::CirculationRules->get_effective_rule({
487 itemtype => $item->effective_itemtype,
488 categorycode => $borrower->{categorycode},
489 branchcode => $reserves_control_branch,
490 rule_name => 'reservesallowed',
493 $ruleitemtype = $reservesallowed->itemtype;
494 $allowedreserves = $reservesallowed->rule_value // 0; #undefined is 0, blank is unlimited
497 $ruleitemtype = undef;
500 my $rights = Koha::CirculationRules->get_effective_rules({
501 categorycode => $borrower->{'categorycode'},
502 itemtype => $item->effective_itemtype,
503 branchcode => $reserves_control_branch,
504 rules => ['holds_per_record','holds_per_day']
506 my $holds_per_record = $rights->{holds_per_record} // 1;
507 my $holds_per_day = $rights->{holds_per_day};
509 if ( defined $holds_per_record && $holds_per_record ne '' ){
510 if ( $holds_per_record == 0 ) {
511 return { status => "noReservesAllowed" };
513 if ( !$params->{ignore_hold_counts} ) {
514 my $search_params = {
515 borrowernumber => $patron->borrowernumber,
516 biblionumber => $item->biblionumber,
518 my $holds = Koha::Holds->search($search_params);
519 return { status => "tooManyHoldsForThisRecord", limit => $holds_per_record } if $holds->count() >= $holds_per_record;
523 if (!$params->{ignore_hold_counts} && defined $holds_per_day && $holds_per_day ne '')
525 my $today_holds = Koha::Holds->search({
526 borrowernumber => $patron->borrowernumber,
527 reservedate => dt_from_string->date
529 return { status => 'tooManyReservesToday', limit => $holds_per_day } if $today_holds->count() >= $holds_per_day;
532 # we check if it's ok or not
533 if ( defined $allowedreserves && $allowedreserves ne '' ){
534 if( $allowedreserves == 0 ){
535 return { status => 'noReservesAllowed' };
537 if ( !$params->{ignore_hold_counts} ) {
540 SELECT count(*) AS count
542 LEFT JOIN items USING (itemnumber)
543 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
544 LEFT JOIN borrowers USING (borrowernumber)
545 WHERE borrowernumber = ?
547 $querycount .= "AND ( $branchfield = ? OR $branchfield IS NULL )";
549 # If using item-level itypes, fall back to the record
550 # level itemtype if the hold has no associated item
551 if ( defined $ruleitemtype ) {
552 if ( C4::Context->preference('item-level_itypes') ) {
554 AND ( COALESCE( items.itype, biblioitems.itemtype ) = ?
555 OR reserves.itemtype = ? )
560 AND ( biblioitems.itemtype = ?
561 OR reserves.itemtype = ? )
566 my $sthcount = $dbh->prepare($querycount);
568 if ( defined $ruleitemtype ) {
569 $sthcount->execute( $patron->borrowernumber, $reserves_control_branch, $ruleitemtype, $ruleitemtype );
572 $sthcount->execute( $patron->borrowernumber, $reserves_control_branch );
575 my $reservecount = "0";
576 if ( my $rowcount = $sthcount->fetchrow_hashref() ) {
577 $reservecount = $rowcount->{count};
580 return { status => 'tooManyReserves', limit => $allowedreserves } if $reservecount >= $allowedreserves;
584 # Now we need to check hold limits by patron category
585 my $rule = Koha::CirculationRules->get_effective_rule(
587 categorycode => $patron->categorycode,
588 branchcode => $reserves_control_branch,
589 rule_name => 'max_holds',
592 if (!$params->{ignore_hold_counts} && $rule && defined( $rule->rule_value ) && $rule->rule_value ne '' ) {
593 my $total_holds_count = Koha::Holds->search(
595 borrowernumber => $patron->borrowernumber
599 return { status => 'tooManyReserves', limit => $rule->rule_value} if $total_holds_count >= $rule->rule_value;
603 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $item->effective_itemtype );
605 if ( $branchitemrule->{holdallowed} eq 'not_allowed' ) {
606 return { status => 'notReservable' };
609 if ( $branchitemrule->{holdallowed} eq 'from_home_library'
610 && $borrower->{branchcode} ne $item->homebranch )
612 return { status => 'cannotReserveFromOtherBranches' };
615 my $item_library = Koha::Libraries->find( {branchcode => $item->homebranch} );
616 if ( $branchitemrule->{holdallowed} eq 'from_local_hold_group') {
617 if($patron->branchcode ne $item->homebranch && !$item_library->validate_hold_sibling( {branchcode => $patron->branchcode} )) {
618 return { status => 'branchNotInHoldGroup' };
622 if ($pickup_branchcode) {
623 my $destination = Koha::Libraries->find({
624 branchcode => $pickup_branchcode,
627 unless ($destination) {
628 return { status => 'libraryNotFound' };
630 unless ($destination->pickup_location) {
631 return { status => 'libraryNotPickupLocation' };
633 unless ($item->can_be_transferred({ to => $destination })) {
634 return { status => 'cannotBeTransferred' };
636 if ($branchitemrule->{hold_fulfillment_policy} eq 'holdgroup' && !$item_library->validate_hold_sibling( {branchcode => $pickup_branchcode} )) {
637 return { status => 'pickupNotInHoldGroup' };
639 if ($branchitemrule->{hold_fulfillment_policy} eq 'patrongroup' && !Koha::Libraries->find({branchcode => $borrower->{branchcode}})->validate_hold_sibling({branchcode => $pickup_branchcode})) {
640 return { status => 'pickupNotInHoldGroup' };
644 return { status => 'OK' };
647 =head2 CanReserveBeCanceledFromOpac
649 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
651 returns 1 if reserve can be cancelled by user from OPAC.
652 First check if reserve belongs to user, next checks if reserve is not in
653 transfer or waiting status
657 sub CanReserveBeCanceledFromOpac {
658 my ($reserve_id, $borrowernumber) = @_;
660 return unless $reserve_id and $borrowernumber;
661 my $reserve = Koha::Holds->find($reserve_id) or return;
663 return 0 unless $reserve->borrowernumber == $borrowernumber;
664 return $reserve->is_cancelable_from_opac;
667 =head2 GetOtherReserves
669 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
671 Check queued list of this document and check if this document must be transferred
675 sub GetOtherReserves {
676 my ($itemnumber) = @_;
679 my $item = Koha::Items->find($itemnumber);
680 my ( undef, $checkreserves, undef ) = CheckReserves($item);
681 if ($checkreserves) {
682 if ( $item->holdingbranch ne $checkreserves->{'branchcode'} ) {
683 $messages->{'transfert'} = $checkreserves->{'branchcode'};
684 #minus priorities of others reservs
685 ModReserveMinusPriority(
687 $checkreserves->{'reserve_id'},
690 #launch the subroutine dotransfer
691 C4::Items::ModItemTransfer(
693 $item->holdingbranch,
694 $checkreserves->{'branchcode'},
700 #step 2b : case of a reservation on the same branch, set the waiting status
702 $messages->{'waiting'} = 1;
703 ModReserveMinusPriority(
705 $checkreserves->{'reserve_id'},
707 ModReserveStatus($itemnumber,'W');
710 $nextreservinfo = $checkreserves;
713 return ( $messages, $nextreservinfo );
716 =head2 ChargeReserveFee
718 $fee = ChargeReserveFee( $borrowernumber, $fee, $title );
720 Charge the fee for a reserve (if $fee > 0)
724 sub ChargeReserveFee {
725 my ( $borrowernumber, $fee, $title ) = @_;
726 return if !$fee || $fee == 0; # the last test is needed to include 0.00
727 Koha::Account->new( { patron_id => $borrowernumber } )->add_debit(
730 description => $title,
732 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
733 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
734 interface => C4::Context->interface,
735 invoice_type => undef,
744 $fee = GetReserveFee( $borrowernumber, $biblionumber );
746 Calculate the fee for a reserve (if applicable).
751 my ( $borrowernumber, $biblionumber ) = @_;
753 SELECT reservefee FROM borrowers LEFT JOIN categories ON borrowers.categorycode = categories.categorycode WHERE borrowernumber = ?
756 SELECT COUNT(*) FROM items
757 LEFT JOIN issues USING (itemnumber)
758 WHERE items.biblionumber=? AND issues.issue_id IS NULL
761 SELECT COUNT(*) FROM reserves WHERE biblionumber=? AND borrowernumber<>?
764 my $dbh = C4::Context->dbh;
765 my ( $fee ) = $dbh->selectrow_array( $borquery, undef, ($borrowernumber) );
767 my $hold_fee_mode = C4::Context->preference('HoldFeeMode') || 'not_always';
768 if( $fee and $fee > 0 and $hold_fee_mode eq 'not_always' ) {
769 # This is a reconstruction of the old code:
770 # Compare number of items with items issued, and optionally check holds
771 # If not all items are issued and there are no holds: charge no fee
772 # NOTE: Lost, damaged, not-for-loan, etc. are just ignored here
773 my ( $notissued, $reserved );
774 ( $notissued ) = $dbh->selectrow_array( $issue_qry, undef,
776 if( $notissued == 0 ) {
777 # all items are issued
778 ( $reserved ) = $dbh->selectrow_array( $holds_qry, undef,
779 ( $biblionumber, $borrowernumber ) );
780 $fee = 0 if $reserved == 0;
788 =head2 GetReserveStatus
790 $reservestatus = GetReserveStatus($itemnumber);
792 Takes an itemnumber and returns the status of the reserve placed on it.
793 If several reserves exist, the reserve with the lower priority is given.
797 ## FIXME: I don't think this does what it thinks it does.
798 ## It only ever checks the first reserve result, even though
799 ## multiple reserves for that bib can have the itemnumber set
800 ## the sub is only used once in the codebase.
801 sub GetReserveStatus {
802 my ($itemnumber) = @_;
804 my $dbh = C4::Context->dbh;
806 my ($sth, $found, $priority);
808 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
809 $sth->execute($itemnumber);
810 ($found, $priority) = $sth->fetchrow_array;
814 return 'Waiting' if $found eq 'W' and $priority == 0;
815 return 'Processing' if $found eq 'P';
816 return 'Finished' if $found eq 'F';
819 return 'Reserved' if defined $priority && $priority > 0;
821 return ''; # empty string here will remove need for checking undef, or less log lines
826 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($item);
827 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($item, $lookahead);
829 Find a book in the reserves.
831 C<$item> is the book's item.
832 C<$lookahead> is the number of days to look in advance for future reserves.
834 As I understand it, C<&CheckReserves> looks for the given item in the
835 reserves. If it is found, that's a match, and C<$status> is set to
838 Otherwise, it finds the most important item in the reserves with the
839 same biblio number as this book (I'm not clear on this) and returns it
840 with C<$status> set to C<Reserved>.
842 C<&CheckReserves> returns a two-element list:
844 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
846 C<$reserve> is the reserve item that matched. It is a
847 reference-to-hash whose keys are mostly the fields of the reserves
848 table in the Koha database.
853 my ( $item, $lookahead_days, $ignore_borrowers ) = @_;
854 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
856 return unless $item; # bail if we got nothing.
858 return if ( $item->damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
860 # if item is not for loan it cannot be reserved either.....
861 # except where items.notforloan < 0 : This indicates the item is holdable.
863 my @SkipHoldTrapOnNotForLoanValue = split( '\|', C4::Context->preference('SkipHoldTrapOnNotForLoanValue') );
864 return if grep { $_ eq $item->notforloan } @SkipHoldTrapOnNotForLoanValue;
866 my $dont_trap = C4::Context->preference('TrapHoldsOnOrder') ? $item->notforloan > 0 : $item->notforloan;
868 my $item_type = $item->effective_itemtype;
870 return if Koha::ItemTypes->find( $item_type )->notforloan;
877 # Find this item in the reserves
878 my @reserves = _Findgroupreserve( $item->biblionumber, $item->itemnumber, $lookahead_days, $ignore_borrowers);
880 # $priority and $highest are used to find the most important item
881 # in the list returned by &_Findgroupreserve. (The lower $priority,
882 # the more important the item.)
883 # $highest is the most important item we've seen so far.
886 if (scalar @reserves) {
887 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
888 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
889 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
890 my $priority = 10000000;
892 foreach my $res (@reserves) {
893 if ($res->{'found'} && $res->{'found'} eq 'W') {
894 return ( "Waiting", $res, \@reserves ); # Found it, it is waiting
895 } elsif ($res->{'found'} && $res->{'found'} eq 'P') {
896 return ( "Processing", $res, \@reserves ); # Found determinated hold, e. g. the transferred one
897 } elsif ($res->{'found'} && $res->{'found'} eq 'T') {
898 return ( "Transferred", $res, \@reserves ); # Found determinated hold, e. g. the transferred one
901 my $local_hold_match;
903 if ($LocalHoldsPriority) {
904 $patron = Koha::Patrons->find( $res->{borrowernumber} );
906 unless ($item->exclude_from_local_holds_priority || $patron->category->exclude_from_local_holds_priority) {
907 my $local_holds_priority_item_branchcode =
908 $item->$LocalHoldsPriorityItemControl;
909 my $local_holds_priority_patron_branchcode =
910 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
912 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
913 ? $patron->branchcode
916 $local_holds_priority_item_branchcode eq
917 $local_holds_priority_patron_branchcode;
921 # See if this item is more important than what we've got so far
922 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
923 next if $res->{item_group_id} && ( !$item->item_group || $item->item_group->id != $res->{item_group_id} );
924 next if $res->{itemtype} && $res->{itemtype} ne $item->effective_itemtype;
925 $patron //= Koha::Patrons->find( $res->{borrowernumber} );
926 my $branch = GetReservesControlBranch( $item->unblessed, $patron->unblessed );
927 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$item->effective_itemtype);
928 next if ($branchitemrule->{'holdallowed'} eq 'not_allowed');
929 next if (($branchitemrule->{'holdallowed'} eq 'from_home_library') && ($item->homebranch ne $patron->branchcode));
930 my $library = Koha::Libraries->find({branchcode=>$item->homebranch});
931 next if (($branchitemrule->{'holdallowed'} eq 'from_local_hold_group') && (!$library->validate_hold_sibling({branchcode => $patron->branchcode}) ));
932 my $hold_fulfillment_policy = $branchitemrule->{hold_fulfillment_policy};
933 next if ( ($hold_fulfillment_policy eq 'holdgroup') && (!$library->validate_hold_sibling({branchcode => $res->{branchcode}})) );
934 next if ( ($hold_fulfillment_policy eq 'homebranch') && ($res->{branchcode} ne $item->$hold_fulfillment_policy) );
935 next if ( ($hold_fulfillment_policy eq 'holdingbranch') && ($res->{branchcode} ne $item->$hold_fulfillment_policy) );
936 next unless $item->can_be_transferred( { to => Koha::Libraries->find( $res->{branchcode} ) } );
937 $priority = $res->{'priority'};
939 last if $local_hold_match;
945 # If we get this far, then no exact match was found.
946 # We return the most important (i.e. next) reservation.
948 $highest->{'itemnumber'} = $item->itemnumber;
949 return ( "Reserved", $highest, \@reserves );
955 =head2 CancelExpiredReserves
957 CancelExpiredReserves();
959 Cancels all reserves with an expiration date from before today.
963 sub CancelExpiredReserves {
964 my $cancellation_reason = shift;
965 my $today = dt_from_string();
966 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
967 my $expireWaiting = C4::Context->preference('ExpireReservesMaxPickUpDelay');
969 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
972 { expirationdate => { '<', $dtf->format_date($today) } },
973 { patron_expiration_date => { '<' => $dtf->format_date($today) } }
977 $params->{found} = [ { '!=', 'W' }, undef ] unless $expireWaiting;
979 # FIXME To move to Koha::Holds->search_expired (?)
980 my $holds = Koha::Holds->search( $params );
982 while ( my $hold = $holds->next ) {
983 my $calendar = Koha::Calendar->new( branchcode => $hold->branchcode );
985 next if !$cancel_on_holidays && $calendar->is_holiday( $today );
987 my $cancel_params = {};
988 $cancel_params->{cancellation_reason} = $cancellation_reason if defined($cancellation_reason);
989 if ( defined($hold->found) && $hold->found eq 'W' ) {
990 $cancel_params->{charge_cancel_fee} = 1;
992 $cancel_params->{autofill} = C4::Context->preference('ExpireReservesAutoFill');
993 $hold->cancel( $cancel_params );
997 =head2 AutoUnsuspendReserves
999 AutoUnsuspendReserves();
1001 Unsuspends all suspended reserves with a suspend_until date from before today.
1005 sub AutoUnsuspendReserves {
1006 my $today = dt_from_string();
1008 my @holds = Koha::Holds->search( { suspend_until => { '<=' => $today->ymd() } } )->as_list;
1010 map { $_->resume() } @holds;
1015 ModReserve({ rank => $rank,
1016 reserve_id => $reserve_id,
1017 branchcode => $branchcode
1018 [, itemnumber => $itemnumber ]
1019 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1022 Change a hold request's priority or cancel it.
1024 C<$rank> specifies the effect of the change. If C<$rank>
1025 is 'n', nothing happens. This corresponds to leaving a
1026 request alone when changing its priority in the holds queue
1029 If C<$rank> is 'del', the hold request is cancelled.
1031 If C<$rank> is an integer greater than zero, the priority of
1032 the request is set to that value. Since priority != 0 means
1033 that the item is not waiting on the hold shelf, setting the
1034 priority to a non-zero value also sets the request's found
1035 status and waiting date to NULL.
1037 If the hold is 'found' (waiting, in-transit, processing) the
1038 only field that can be updated is the expiration date.
1040 The optional C<$itemnumber> parameter is used only when
1041 C<$rank> is a non-zero integer; if supplied, the itemnumber
1042 of the hold request is set accordingly; if omitted, the itemnumber
1045 B<FIXME:> Note that the forgoing can have the effect of causing
1046 item-level hold requests to turn into title-level requests. This
1047 will be fixed once reserves has separate columns for requested
1048 itemnumber and supplying itemnumber.
1053 my ( $params ) = @_;
1055 my $rank = $params->{'rank'};
1056 my $reserve_id = $params->{'reserve_id'};
1057 my $branchcode = $params->{'branchcode'};
1058 my $itemnumber = $params->{'itemnumber'};
1059 my $suspend_until = $params->{'suspend_until'};
1060 my $borrowernumber = $params->{'borrowernumber'};
1061 my $biblionumber = $params->{'biblionumber'};
1062 my $cancellation_reason = $params->{'cancellation_reason'};
1063 my $date = $params->{expirationdate};
1065 return if defined $rank && $rank eq "n";
1067 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1070 unless ( $reserve_id ) {
1071 my $holds = Koha::Holds->search({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber });
1072 return unless $holds->count; # FIXME Should raise an exception
1073 $hold = $holds->next;
1074 $reserve_id = $hold->reserve_id;
1077 $hold ||= Koha::Holds->find($reserve_id);
1079 # FIXME Other calls may fail
1080 Koha::Exceptions::ObjectNotFound->throw( 'No hold with id ' . $reserve_id ) unless $hold;
1082 if ( $rank eq "del" ) {
1083 $hold->cancel({ cancellation_reason => $cancellation_reason });
1085 elsif ($hold->found && $hold->priority eq '0' && $date) {
1086 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, $hold )
1087 if C4::Context->preference('HoldsLog');
1089 # The only column that can be updated for a found hold is the expiration date
1090 $hold->expirationdate($date)->store();
1092 elsif ($rank =~ /^\d+/ and $rank > 0) {
1093 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, $hold )
1094 if C4::Context->preference('HoldsLog');
1098 branchcode => $branchcode,
1099 itemnumber => $itemnumber,
1101 waitingdate => undef
1103 if (exists $params->{reservedate}) {
1104 $properties->{reservedate} = $params->{reservedate} || undef;
1106 if (exists $params->{expirationdate}) {
1107 $properties->{expirationdate} = $params->{expirationdate} || undef;
1110 $hold->set($properties)->store();
1112 if ( defined( $suspend_until ) ) {
1113 if ( $suspend_until ) {
1114 $hold->suspend_hold( $suspend_until );
1116 # If the hold is suspended leave the hold suspended, but convert it to an indefinite hold.
1117 # If the hold is not suspended, this does nothing.
1118 $hold->set( { suspend_until => undef } )->store();
1122 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
1126 =head2 ModReserveStatus
1128 &ModReserveStatus($itemnumber, $newstatus);
1130 Update the reserve status for the active (priority=0) reserve.
1132 $itemnumber is the itemnumber the reserve is on
1134 $newstatus is the new status.
1138 sub ModReserveStatus {
1140 #first : check if we have a reservation for this item .
1141 my ($itemnumber, $newstatus) = @_;
1142 my $dbh = C4::Context->dbh;
1144 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1145 my $sth_set = $dbh->prepare($query);
1146 $sth_set->execute( $newstatus, $itemnumber );
1148 my $item = Koha::Items->find($itemnumber);
1149 if ( $item->location && $item->location eq 'CART'
1150 && ( !$item->permanent_location || $item->permanent_location ne 'CART' )
1152 CartToShelf( $itemnumber );
1156 =head2 ModReserveAffect
1158 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend,$reserve_id, $desk_id, $notify_library);
1160 This function affect an item and a status for a given reserve, either fetched directly
1161 by record_id, or by borrowernumber and itemnumber or biblionumber. If only biblionumber
1162 is given, only first reserve returned is affected, which is ok for anything but
1165 if $transferToDo is not set, then the status is set to "Waiting" as well.
1166 otherwise, a transfer is on the way, and the end of the transfer will
1167 take care of the waiting status
1169 This function also removes any entry of the hold in holds queue table.
1173 sub ModReserveAffect {
1174 my ( $itemnumber, $borrowernumber, $transferToDo, $reserve_id, $desk_id, $notify_library ) = @_;
1175 my $dbh = C4::Context->dbh;
1177 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1178 # attached to $itemnumber
1179 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1180 $sth->execute($itemnumber);
1181 my ($biblionumber) = $sth->fetchrow;
1183 # get request - need to find out if item is already
1184 # waiting in order to not send duplicate hold filled notifications
1187 # Find hold by id if we have it
1188 $hold = Koha::Holds->find( $reserve_id ) if $reserve_id;
1189 # Find item level hold for this item if there is one
1190 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->next();
1191 # Find record level hold if there is no item level hold
1192 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, biblionumber => $biblionumber } )->next();
1194 return unless $hold;
1196 my $already_on_shelf = $hold->found && $hold->found eq 'W';
1198 $hold->itemnumber($itemnumber);
1200 if ($transferToDo) {
1201 $hold->set_transfer();
1202 } elsif (C4::Context->preference('HoldsNeedProcessingSIP')
1203 && C4::Context->interface eq 'sip'
1204 && !$already_on_shelf) {
1205 $hold->set_processing();
1207 $hold->set_waiting($desk_id);
1208 _koha_notify_reserve( $hold->reserve_id ) unless $already_on_shelf;
1209 # Complete transfer if one exists
1210 my $transfer = $hold->item->get_transfer;
1211 $transfer->receive if $transfer;
1214 _koha_notify_hold_changed( $hold ) if $notify_library;
1216 _FixPriority( { biblionumber => $biblionumber } );
1217 my $item = Koha::Items->find($itemnumber);
1218 if ( $item->location && $item->location eq 'CART'
1219 && ( !$item->permanent_location || $item->permanent_location ne 'CART' ) ) {
1220 CartToShelf( $itemnumber );
1223 my $std = $dbh->prepare(q{
1225 FROM tmp_holdsqueue q
1226 INNER JOIN hold_fill_targets t
1227 ON q.borrowernumber = t.borrowernumber
1228 AND q.biblionumber = t.biblionumber
1229 AND q.itemnumber = t.itemnumber
1230 AND q.item_level_request = t.item_level_request
1231 AND q.holdingbranch = t.source_branchcode
1232 WHERE t.reserve_id = ?
1234 $std->execute($hold->reserve_id);
1236 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, $hold )
1237 if C4::Context->preference('HoldsLog');
1242 =head2 ModReserveCancelAll
1244 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber,$reason);
1246 function to cancel reserv,check other reserves, and transfer document if it's necessary
1250 sub ModReserveCancelAll {
1253 my ( $itemnumber, $borrowernumber, $cancellation_reason ) = @_;
1255 #step 1 : cancel the reservation
1256 my $holds = Koha::Holds->search({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1257 return unless $holds->count;
1258 $holds->next->cancel({ cancellation_reason => $cancellation_reason });
1260 #step 2 launch the subroutine of the others reserves
1261 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1263 return ( $messages, $nextreservinfo->{borrowernumber} );
1266 =head2 ModReserveMinusPriority
1268 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1270 Reduce the values of queued list
1274 sub ModReserveMinusPriority {
1275 my ( $itemnumber, $reserve_id ) = @_;
1277 #first step update the value of the first person on reserv
1278 my $dbh = C4::Context->dbh;
1281 SET priority = 0 , itemnumber = ?
1282 WHERE reserve_id = ?
1284 my $sth_upd = $dbh->prepare($query);
1285 $sth_upd->execute( $itemnumber, $reserve_id );
1286 # second step update all others reserves
1287 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1290 =head2 IsAvailableForItemLevelRequest
1292 my $is_available = IsAvailableForItemLevelRequest( $item_record, $borrower_record, $pickup_branchcode );
1294 Checks whether a given item record is available for an
1295 item-level hold request. An item is available if
1297 * it is not lost AND
1298 * it is not damaged AND
1299 * it is not withdrawn AND
1300 * a waiting or in transit reserve is placed on
1301 * does not have a not for loan value > 0
1303 Need to check the issuingrules onshelfholds column,
1304 if this is set items on the shelf can be placed on hold
1306 Note that IsAvailableForItemLevelRequest() does not
1307 check if the staff operator is authorized to place
1308 a request on the item - in particular,
1309 this routine does not check IndependentBranches
1310 and canreservefromotherbranches.
1312 Note also that this subroutine does not checks smart
1313 rules limits for item by reservesallowed/holds_per_record
1314 values, this complemented in calling code with calls and
1315 checks with CanItemBeReserved or CanBookBeReserved.
1319 sub IsAvailableForItemLevelRequest {
1322 my $pickup_branchcode = shift;
1323 # items_any_available is precalculated status passed from request.pl when set of items
1324 # looped outside of IsAvailableForItemLevelRequest to avoid nested loops:
1325 my $items_any_available = shift;
1327 my $dbh = C4::Context->dbh;
1328 # must check the notforloan setting of the itemtype
1329 # FIXME - a lot of places in the code do this
1330 # or something similar - need to be
1332 my $itemtype = $item->effective_itemtype;
1334 unless defined $itemtype;
1335 my $notforloan_per_itemtype = Koha::ItemTypes->find($itemtype)->notforloan;
1338 $notforloan_per_itemtype ||
1340 $item->notforloan > 0 || # item with negative or zero notforloan value is holdable
1342 ($item->damaged && !C4::Context->preference('AllowHoldsOnDamagedItems'));
1344 if ($pickup_branchcode) {
1345 my $destination = Koha::Libraries->find($pickup_branchcode);
1346 return 0 unless $destination;
1347 return 0 unless $destination->pickup_location;
1348 return 0 unless $item->can_be_transferred( { to => $destination } );
1349 my $reserves_control_branch =
1350 GetReservesControlBranch( $item->unblessed(), $patron->unblessed() );
1351 my $branchitemrule =
1352 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $item->itype );
1353 my $home_library = Koha::Libraries->find( {branchcode => $item->homebranch} );
1354 return 0 unless $branchitemrule->{hold_fulfillment_policy} ne 'holdgroup' || $home_library->validate_hold_sibling( {branchcode => $pickup_branchcode} );
1357 my $on_shelf_holds = Koha::CirculationRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
1359 if ( $on_shelf_holds == 1 ) {
1361 } elsif ( $on_shelf_holds == 2 ) {
1363 # if we have this param predefined from outer caller sub, we just need
1364 # to return it, so we saving from having loop inside other loop:
1365 return $items_any_available ? 0 : 1
1366 if defined $items_any_available;
1368 my $any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron });
1369 return $any_available ? 0 : 1;
1370 } else { # on_shelf_holds == 0 "If any unavailable" (the description is rather cryptic and could still be improved)
1371 return $item->onloan || IsItemOnHoldAndFound( $item->itemnumber );
1375 =head2 ItemsAnyAvailableAndNotRestricted
1377 ItemsAnyAvailableAndNotRestricted( { biblionumber => $biblionumber, patron => $patron });
1379 This function checks all items for specified biblionumber (numeric) against patron (object)
1380 and returns true (1) if at least one item available for loan/check out/present/not held
1381 and also checks other parameters logic which not restricts item for hold at all (for ex.
1382 AllowHoldsOnDamagedItems or 'holdallowed' own/sibling library)
1386 sub ItemsAnyAvailableAndNotRestricted {
1389 my @items = Koha::Items->search( { biblionumber => $param->{biblionumber} } )->as_list;
1391 foreach my $i (@items) {
1392 my $reserves_control_branch =
1393 GetReservesControlBranch( $i->unblessed(), $param->{patron}->unblessed );
1394 my $branchitemrule =
1395 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $i->itype );
1396 my $item_library = Koha::Libraries->find( { branchcode => $i->homebranch } );
1398 # we can return (end the loop) when first one found:
1401 || $i->notforloan # items with non-zero notforloan cannot be checked out
1404 || IsItemOnHoldAndFound( $i->id )
1406 && ! C4::Context->preference('AllowHoldsOnDamagedItems') )
1407 || Koha::ItemTypes->find( $i->effective_itemtype() )->notforloan
1408 || $branchitemrule->{holdallowed} eq 'from_home_library' && $param->{patron}->branchcode ne $i->homebranch
1409 || $branchitemrule->{holdallowed} eq 'from_local_hold_group' && ! $item_library->validate_hold_sibling( { branchcode => $param->{patron}->branchcode } )
1410 || CanItemBeReserved( $param->{patron}, $i )->{status} ne 'OK';
1416 =head2 AlterPriority
1418 AlterPriority( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority );
1420 This function changes a reserve's priority up, down, to the top, or to the bottom.
1421 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1426 my ( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority ) = @_;
1428 my $hold = Koha::Holds->find( $reserve_id );
1429 return unless $hold;
1431 if ( $hold->cancellationdate ) {
1432 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (" . $hold->cancellationdate . ')';
1436 if ( $where eq 'up' ) {
1437 return unless $prev_priority;
1438 _FixPriority({ reserve_id => $reserve_id, rank => $prev_priority })
1439 } elsif ( $where eq 'down' ) {
1440 return unless $next_priority;
1441 _FixPriority({ reserve_id => $reserve_id, rank => $next_priority })
1442 } elsif ( $where eq 'top' ) {
1443 _FixPriority({ reserve_id => $reserve_id, rank => $first_priority })
1444 } elsif ( $where eq 'bottom' ) {
1445 _FixPriority({ reserve_id => $reserve_id, rank => $last_priority });
1448 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1450 biblio_ids => [ $hold->biblionumber ]
1452 ) if C4::Context->preference('RealTimeHoldsQueue');
1453 # FIXME Should return the new priority
1456 =head2 ToggleLowestPriority
1458 ToggleLowestPriority( $borrowernumber, $biblionumber );
1460 This function sets the lowestPriority field to true if is false, and false if it is true.
1464 sub ToggleLowestPriority {
1465 my ( $reserve_id ) = @_;
1467 my $dbh = C4::Context->dbh;
1469 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1470 $sth->execute( $reserve_id );
1472 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1475 =head2 ToggleSuspend
1477 ToggleSuspend( $reserve_id );
1479 This function sets the suspend field to true if is false, and false if it is true.
1480 If the reserve is currently suspended with a suspend_until date, that date will
1481 be cleared when it is unsuspended.
1486 my ( $reserve_id, $suspend_until ) = @_;
1488 my $hold = Koha::Holds->find( $reserve_id );
1490 if ( $hold->is_suspended ) {
1493 $hold->suspend_hold( $suspend_until );
1500 borrowernumber => $borrowernumber,
1501 [ biblionumber => $biblionumber, ]
1502 [ suspend_until => $suspend_until, ]
1503 [ suspend => $suspend ]
1506 This function accepts a set of hash keys as its parameters.
1507 It requires either borrowernumber or biblionumber, or both.
1509 suspend_until is wholly optional.
1516 my $borrowernumber = $params{'borrowernumber'} || undef;
1517 my $biblionumber = $params{'biblionumber'} || undef;
1518 my $suspend_until = $params{'suspend_until'} || undef;
1519 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1521 return unless ( $borrowernumber || $biblionumber );
1524 $params->{found} = undef;
1525 $params->{borrowernumber} = $borrowernumber if $borrowernumber;
1526 $params->{biblionumber} = $biblionumber if $biblionumber;
1528 my @holds = Koha::Holds->search($params)->as_list;
1531 map { $_->suspend_hold($suspend_until) } @holds;
1534 map { $_->resume() } @holds;
1542 reserve_id => $reserve_id,
1544 [ignoreSetLowestRank => $ignoreSetLowestRank]
1549 _FixPriority({ biblionumber => $biblionumber});
1551 This routine adjusts the priority of a hold request and holds
1554 In the first form, where a reserve_id is passed, the priority of the
1555 hold is set to supplied rank, and other holds for that bib are adjusted
1556 accordingly. If the rank is "del", the hold is cancelled. If no rank
1557 is supplied, all of the holds on that bib have their priority adjusted
1558 as if the second form had been used.
1560 In the second form, where a biblionumber is passed, the holds on that
1561 bib (that are not captured) are sorted in order of increasing priority,
1562 then have reserves.priority set so that the first non-captured hold
1563 has its priority set to 1, the second non-captured hold has its priority
1564 set to 2, and so forth.
1566 In both cases, holds that have the lowestPriority flag on are have their
1567 priority adjusted to ensure that they remain at the end of the line.
1569 Note that the ignoreSetLowestRank parameter is meant to be used only
1570 when _FixPriority calls itself.
1575 my ( $params ) = @_;
1576 my $reserve_id = $params->{reserve_id};
1577 my $rank = $params->{rank} // '';
1578 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1579 my $biblionumber = $params->{biblionumber};
1581 my $dbh = C4::Context->dbh;
1584 if ( $reserve_id ) {
1585 $hold = Koha::Holds->find( $reserve_id );
1586 if (!defined $hold){
1587 # may have already been checked out and hold fulfilled
1588 $hold = Koha::Old::Holds->find( $reserve_id );
1590 return unless $hold;
1593 unless ( $biblionumber ) { # FIXME This is a very weird API
1594 $biblionumber = $hold->biblionumber;
1597 if ( $rank eq "del" ) { # FIXME will crash if called without $hold
1600 elsif ( $reserve_id && ( $rank eq "W" || $rank eq "0" ) ) {
1602 # make sure priority for waiting or in-transit items is 0
1606 WHERE reserve_id = ?
1607 AND found IN ('W', 'T', 'P')
1609 my $sth = $dbh->prepare($query);
1610 $sth->execute( $reserve_id );
1616 SELECT reserve_id, borrowernumber, reservedate
1618 WHERE biblionumber = ?
1619 AND ((found <> 'W' AND found <> 'T' AND found <> 'P') OR found IS NULL)
1620 ORDER BY priority ASC
1622 my $sth = $dbh->prepare($query);
1623 $sth->execute( $biblionumber );
1624 while ( my $line = $sth->fetchrow_hashref ) {
1625 push( @priority, $line );
1628 # FIXME This whole sub must be rewritten, especially to highlight what is done when reserve_id is not given
1629 # To find the matching index
1631 my $key = -1; # to allow for 0 to be a valid result
1632 for ( $i = 0 ; $i < @priority ; $i++ ) {
1633 if ( $reserve_id && $reserve_id == $priority[$i]->{'reserve_id'} ) {
1634 $key = $i; # save the index
1639 # if index exists in array then move it to new position
1640 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1641 my $new_rank = $rank - 1; # $new_rank is what you want the new index to be in the array
1642 my $moving_item = splice( @priority, $key, 1 );
1643 $new_rank = scalar @priority if $new_rank > scalar @priority;
1644 splice( @priority, $new_rank, 0, $moving_item );
1647 # now fix the priority on those that are left....
1651 WHERE reserve_id = ?
1653 $sth = $dbh->prepare($query);
1654 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1657 $priority[$j]->{'reserve_id'}
1661 unless ( $ignoreSetLowestRank ) {
1662 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 AND biblionumber = ? ORDER BY priority" );
1663 $sth->execute($biblionumber);
1664 while ( my $res = $sth->fetchrow_hashref() ) {
1666 reserve_id => $res->{'reserve_id'},
1668 ignoreSetLowestRank => 1
1674 =head2 _Findgroupreserve
1676 @results = &_Findgroupreserve($biblionumber, $itemnumber, $lookahead, $ignore_borrowers);
1678 Looks for a holds-queue based item-specific match first, then for a holds-queue title-level match, returning the
1679 first match found. If neither, then we look for non-holds-queue based holds.
1680 Lookahead is the number of days to look in advance.
1682 C<&_Findgroupreserve> returns :
1683 C<@results> is an array of references-to-hash whose keys are mostly
1684 fields from the reserves table of the Koha database, plus
1685 C<biblioitemnumber>.
1687 This routine with either return:
1688 1 - Item specific holds from the holds queue
1689 2 - Title level holds from the holds queue
1690 3 - All holds for this biblionumber
1692 All return values will respect any borrowernumbers passed as arrayref in $ignore_borrowers
1696 sub _Findgroupreserve {
1697 my ( $biblionumber, $itemnumber, $lookahead, $ignore_borrowers) = @_;
1698 my $dbh = C4::Context->dbh;
1700 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1701 # check for exact targeted match
1702 my $item_level_target_query = qq{
1703 SELECT reserves.biblionumber AS biblionumber,
1704 reserves.borrowernumber AS borrowernumber,
1705 reserves.reservedate AS reservedate,
1706 reserves.branchcode AS branchcode,
1707 reserves.cancellationdate AS cancellationdate,
1708 reserves.found AS found,
1709 reserves.reservenotes AS reservenotes,
1710 reserves.priority AS priority,
1711 reserves.timestamp AS timestamp,
1712 biblioitems.biblioitemnumber AS biblioitemnumber,
1713 reserves.itemnumber AS itemnumber,
1714 reserves.reserve_id AS reserve_id,
1715 reserves.itemtype AS itemtype,
1716 reserves.non_priority AS non_priority,
1717 reserves.item_group_id AS item_group_id
1719 JOIN biblioitems USING (biblionumber)
1720 JOIN hold_fill_targets USING (reserve_id)
1723 AND item_level_request = 1
1724 AND hold_fill_targets.itemnumber = ?
1725 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1729 my $sth = $dbh->prepare($item_level_target_query);
1730 $sth->execute($itemnumber, $lookahead||0);
1732 if ( my $data = $sth->fetchrow_hashref ) {
1733 push( @results, $data )
1734 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1736 return @results if @results;
1738 # check for title-level targeted match
1739 my $title_level_target_query = qq{
1740 SELECT reserves.biblionumber AS biblionumber,
1741 reserves.borrowernumber AS borrowernumber,
1742 reserves.reservedate AS reservedate,
1743 reserves.branchcode AS branchcode,
1744 reserves.cancellationdate AS cancellationdate,
1745 reserves.found AS found,
1746 reserves.reservenotes AS reservenotes,
1747 reserves.priority AS priority,
1748 reserves.timestamp AS timestamp,
1749 biblioitems.biblioitemnumber AS biblioitemnumber,
1750 reserves.itemnumber AS itemnumber,
1751 reserves.reserve_id AS reserve_id,
1752 reserves.itemtype AS itemtype,
1753 reserves.non_priority AS non_priority,
1754 reserves.item_group_id AS item_group_id
1756 JOIN biblioitems USING (biblionumber)
1757 JOIN hold_fill_targets USING (reserve_id)
1758 LEFT JOIN item_group_items ON ( item_group_items.item_id = hold_fill_targets.itemnumber )
1761 AND item_level_request = 0
1762 AND hold_fill_targets.itemnumber = ?
1763 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1765 AND reserves.item_group_id = item_group_items.item_group_id
1768 $sth = $dbh->prepare($title_level_target_query);
1769 $sth->execute($itemnumber, $lookahead||0);
1771 if ( my $data = $sth->fetchrow_hashref ) {
1772 push( @results, $data )
1773 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1775 return @results if @results;
1778 SELECT reserves.biblionumber AS biblionumber,
1779 reserves.borrowernumber AS borrowernumber,
1780 reserves.reservedate AS reservedate,
1781 reserves.waitingdate AS waitingdate,
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 reserves.itemnumber AS itemnumber,
1789 reserves.reserve_id AS reserve_id,
1790 reserves.itemtype AS itemtype,
1791 reserves.non_priority AS non_priority,
1792 reserves.item_group_id AS item_group_id
1794 WHERE reserves.biblionumber = ?
1795 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1796 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1800 $sth = $dbh->prepare($query);
1801 $sth->execute( $biblionumber, $itemnumber, $lookahead||0);
1803 while ( my $data = $sth->fetchrow_hashref ) {
1804 push( @results, $data )
1805 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1810 =head2 _koha_notify_reserve
1812 _koha_notify_reserve( $hold->reserve_id );
1814 Sends a notification to the patron that their hold has been filled (through
1817 The letter code for this notice may be found using the following query:
1819 select distinct letter_code
1820 from message_transports
1821 inner join message_attributes using (message_attribute_id)
1822 where message_name = 'Hold_Filled'
1824 This will probably sipmly be 'HOLD', but because it is defined in the database,
1825 it is subject to addition or change.
1827 The following tables are availalbe witin the notice:
1838 sub _koha_notify_reserve {
1839 my $reserve_id = shift;
1841 my $hold = Koha::Holds->find($reserve_id);
1842 my $borrowernumber = $hold->borrowernumber;
1844 my $patron = Koha::Patrons->find( $borrowernumber );
1846 # Try to get the borrower's email address
1847 my $to_address = $patron->notice_email_address;
1849 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
1850 borrowernumber => $borrowernumber,
1851 message_name => 'Hold_Filled'
1854 my $library = Koha::Libraries->find( $hold->branchcode );
1855 my $from_email_address = $library->from_email_address;
1857 my %letter_params = (
1858 module => 'reserves',
1859 branchcode => $hold->branchcode,
1860 lang => $patron->lang,
1862 'branches' => $library->unblessed,
1863 'borrowers' => $patron->unblessed,
1864 'biblio' => $hold->biblionumber,
1865 'biblioitems' => $hold->biblionumber,
1866 'reserves' => $hold->unblessed,
1867 'items' => $hold->itemnumber,
1871 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.
1872 my $send_notification = sub {
1873 my ( $mtt, $letter_code ) = (@_);
1874 return unless defined $letter_code;
1875 $letter_params{letter_code} = $letter_code;
1876 $letter_params{message_transport_type} = $mtt;
1877 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
1879 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
1883 C4::Letters::EnqueueLetter( {
1885 borrowernumber => $borrowernumber,
1886 from_address => $from_email_address,
1887 message_transport_type => $mtt,
1891 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
1893 ( $mtt eq 'email' and not $to_address ) # No email address
1894 or ( $mtt eq 'sms' and not $patron->smsalertnumber ) # No SMS number
1895 or ( $mtt eq 'itiva' and C4::Context->preference('TalkingTechItivaPhoneNotification') ) # Notice is handled by TalkingTech_itiva_outbound.pl
1896 or ( $mtt eq 'phone' and not $patron->phone ) # No phone number to call
1899 &$send_notification($mtt, $letter_code);
1900 $notification_sent++;
1902 #Making sure that a print notification is sent if no other transport types can be utilized.
1903 if (! $notification_sent) {
1904 &$send_notification('print', 'HOLD');
1909 =head2 _koha_notify_hold_changed
1911 _koha_notify_hold_changed( $hold_object );
1915 sub _koha_notify_hold_changed {
1918 my $patron = $hold->patron;
1919 my $library = $hold->branch;
1921 my $letter = C4::Letters::GetPreparedLetter(
1922 module => 'reserves',
1923 letter_code => 'HOLD_CHANGED',
1924 branchcode => $hold->branchcode,
1925 substitute => { today => output_pref( dt_from_string ) },
1927 'branches' => $library->unblessed,
1928 'borrowers' => $patron->unblessed,
1929 'biblio' => $hold->biblionumber,
1930 'biblioitems' => $hold->biblionumber,
1931 'reserves' => $hold->unblessed,
1932 'items' => $hold->itemnumber,
1936 return unless $letter;
1939 C4::Context->preference('ExpireReservesAutoFillEmail')
1940 || $library->inbound_email_address;
1942 C4::Letters::EnqueueLetter(
1945 borrowernumber => $patron->id,
1946 message_transport_type => 'email',
1947 from_address => $library->from_email_address,
1948 to_address => $email,
1953 =head2 _ShiftPriority
1955 $new_priority = _ShiftPriority( $biblionumber, $priority );
1957 This increments the priority of all reserves after the one
1958 with either the lowest date after C<$reservedate>
1959 or the lowest priority after C<$priority>.
1961 It effectively makes room for a new reserve to be inserted with a certain
1962 priority, which is returned.
1964 This is most useful when the reservedate can be set by the user. It allows
1965 the new reserve to be placed before other reserves that have a later
1966 reservedate. Since priority also is set by the form in reserves/request.pl
1967 the sub accounts for that too.
1971 sub _ShiftPriority {
1972 my ( $biblio, $new_priority ) = @_;
1974 my $dbh = C4::Context->dbh;
1975 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND priority > ? ORDER BY priority ASC LIMIT 1";
1976 my $sth = $dbh->prepare( $query );
1977 $sth->execute( $biblio, $new_priority );
1978 my $min_priority = $sth->fetchrow;
1979 # if no such matches are found, $new_priority remains as original value
1980 $new_priority = $min_priority if ( $min_priority );
1982 # Shift the priority up by one; works in conjunction with the next SQL statement
1983 $query = "UPDATE reserves
1984 SET priority = priority+1
1985 WHERE biblionumber = ?
1986 AND borrowernumber = ?
1989 my $sth_update = $dbh->prepare( $query );
1991 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1992 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1993 $sth = $dbh->prepare( $query );
1994 $sth->execute( $new_priority, $biblio );
1995 while ( my $row = $sth->fetchrow_hashref ) {
1996 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1999 return $new_priority; # so the caller knows what priority they wind up receiving
2004 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
2006 Use when checking out an item to handle reserves
2007 If $cancelreserve boolean is set to true, it will remove existing reserve
2012 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
2014 $cancelreserve //= 0;
2016 my $lookahead = C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2017 my $item = Koha::Items->find($itemnumber);
2018 my ( $restype, $res, undef ) = CheckReserves( $item, $lookahead );
2021 my $biblionumber = $res->{biblionumber};
2023 if ($res->{borrowernumber} == $borrowernumber) {
2024 my $hold = Koha::Holds->find( $res->{reserve_id} );
2029 # The item is reserved by someone else.
2030 # Find this item in the reserves
2032 my $borr_res = Koha::Holds->search({
2033 borrowernumber => $borrowernumber,
2034 biblionumber => $biblionumber,
2036 order_by => 'priority'
2040 # The item is reserved by the current patron
2044 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2045 RevertWaitingStatus({ itemnumber => $itemnumber });
2047 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2048 my $hold = Koha::Holds->find( $res->{reserve_id} );
2056 MergeHolds($dbh,$to_biblio, $from_biblio);
2058 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2063 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2064 my $sth = $dbh->prepare(
2065 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2067 $sth->execute($from_biblio);
2068 if ( my $data = $sth->fetchrow_hashref() ) {
2070 # holds exist on old record, if not we don't need to do anything
2071 $sth = $dbh->prepare(
2072 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2073 $sth->execute( $to_biblio, $from_biblio );
2076 # don't reorder those already waiting
2078 $sth = $dbh->prepare(
2079 "SELECT * FROM reserves WHERE biblionumber = ? AND (found NOT IN ('W', 'T', 'P') OR found is NULL) ORDER BY reservedate ASC"
2081 my $upd_sth = $dbh->prepare(
2082 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2083 AND reservedate = ? AND (itemnumber = ? or itemnumber is NULL) "
2085 $sth->execute( $to_biblio );
2087 while ( my $reserve = $sth->fetchrow_hashref() ) {
2089 $priority, $to_biblio,
2090 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2091 $reserve->{'itemnumber'}
2098 =head2 RevertWaitingStatus
2100 RevertWaitingStatus({ itemnumber => $itemnumber });
2102 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2104 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2105 item level hold, even if it was only a bibliolevel hold to
2106 begin with. This is because we can no longer know if a hold
2107 was item-level or bib-level after a hold has been set to
2112 sub RevertWaitingStatus {
2113 my ( $params ) = @_;
2114 my $itemnumber = $params->{'itemnumber'};
2116 return unless ( $itemnumber );
2118 my $dbh = C4::Context->dbh;
2120 ## Get the waiting reserve we want to revert
2121 my $hold = Koha::Holds->search(
2123 itemnumber => $itemnumber,
2124 found => { not => undef },
2128 ## Increment the priority of all other non-waiting
2129 ## reserves for this bib record
2130 my $holds = Koha::Holds->search({ biblionumber => $hold->biblionumber, priority => { '>' => 0 } })
2131 ->update({ priority => \'priority + 1' }, { no_triggers => 1 });
2133 ## Fix up the currently waiting reserve
2138 waitingdate => undef,
2139 expirationdate => $hold->patron_expiration_date,
2140 itemnumber => $hold->item_level_hold ? $hold->itemnumber : undef,
2144 _FixPriority( { biblionumber => $hold->biblionumber } );
2146 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2148 biblio_ids => [ $hold->biblionumber ]
2150 ) if C4::Context->preference('RealTimeHoldsQueue');
2160 branchcode => $branchcode,
2161 borrowernumber => $borrowernumber,
2162 biblionumber => $biblionumber,
2163 [ itemnumber => $itemnumber, ]
2164 [ barcode => $barcode, ]
2168 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2170 The letter code will be HOLD_SLIP, and the following tables are
2171 available within the slip:
2184 my $branchcode = $args->{branchcode};
2185 my $reserve_id = $args->{reserve_id};
2187 my $hold = Koha::Holds->find($reserve_id);
2188 return unless $hold;
2190 my $patron = $hold->borrower;
2191 my $reserve = $hold->unblessed;
2193 return C4::Letters::GetPreparedLetter (
2194 module => 'circulation',
2195 letter_code => 'HOLD_SLIP',
2196 branchcode => $branchcode,
2197 lang => $patron->lang,
2199 'reserves' => $reserve,
2200 'branches' => $reserve->{branchcode},
2201 'borrowers' => $reserve->{borrowernumber},
2202 'biblio' => $reserve->{biblionumber},
2203 'biblioitems' => $reserve->{biblionumber},
2204 'items' => $reserve->{itemnumber},
2209 =head2 GetReservesControlBranch
2211 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2213 Return the branchcode to be used to determine which reserves
2214 policy applies to a transaction.
2216 C<$item> is a hashref for an item. Only 'homebranch' is used.
2218 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2222 sub GetReservesControlBranch {
2223 my ( $item, $borrower ) = @_;
2225 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2228 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2229 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2235 =head2 CalculatePriority
2237 my $p = CalculatePriority($biblionumber, $resdate);
2239 Calculate priority for a new reserve on biblionumber, placing it at
2240 the end of the line of all holds whose start date falls before
2241 the current system time and that are neither on the hold shelf
2244 The reserve date parameter is optional; if it is supplied, the
2245 priority is based on the set of holds whose start date falls before
2246 the parameter value.
2248 After calculation of this priority, it is recommended to call
2249 _ShiftPriority. Note that this is currently done in
2254 sub CalculatePriority {
2255 my ( $biblionumber, $resdate ) = @_;
2258 SELECT COUNT(*) FROM reserves
2259 WHERE biblionumber = ?
2261 AND (found IS NULL OR found = '')
2263 #skip found==W or found==T or found==P (waiting, transit or processing holds)
2265 $sql.= ' AND ( reservedate <= ? )';
2268 $sql.= ' AND ( reservedate < NOW() )';
2270 my $dbh = C4::Context->dbh();
2271 my @row = $dbh->selectrow_array(
2274 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
2277 return @row ? $row[0]+1 : 1;
2280 =head2 IsItemOnHoldAndFound
2282 my $bool = IsItemFoundHold( $itemnumber );
2284 Returns true if the item is currently on hold
2285 and that hold has a non-null found status ( W, T, etc. )
2289 sub IsItemOnHoldAndFound {
2290 my ($itemnumber) = @_;
2292 my $rs = Koha::Database->new()->schema()->resultset('Reserve');
2294 my $found = $rs->count(
2296 itemnumber => $itemnumber,
2297 found => { '!=' => undef }
2304 =head2 GetMaxPatronHoldsForRecord
2306 my $holds_per_record = ReservesControlBranch( $borrowernumber, $biblionumber );
2308 For multiple holds on a given record for a given patron, the max
2309 number of record level holds that a patron can be placed is the highest
2310 value of the holds_per_record rule for each item if the record for that
2311 patron. This subroutine finds and returns the highest holds_per_record
2312 rule value for a given patron id and record id.
2316 sub GetMaxPatronHoldsForRecord {
2317 my ( $borrowernumber, $biblionumber ) = @_;
2319 my $patron = Koha::Patrons->find($borrowernumber);
2320 my @items = Koha::Items->search( { biblionumber => $biblionumber } )->as_list;
2322 my $controlbranch = C4::Context->preference('ReservesControlBranch');
2324 my $categorycode = $patron->categorycode;
2326 $branchcode = $patron->branchcode if ( $controlbranch eq "PatronLibrary" );
2329 foreach my $item (@items) {
2330 my $itemtype = $item->effective_itemtype();
2332 $branchcode = $item->homebranch if ( $controlbranch eq "ItemHomeLibrary" );
2334 my $rule = Koha::CirculationRules->get_effective_rule({
2335 categorycode => $categorycode,
2336 itemtype => $itemtype,
2337 branchcode => $branchcode,
2338 rule_name => 'holds_per_record'
2340 my $holds_per_record = $rule ? $rule->rule_value : 0;
2341 $max = $holds_per_record if $holds_per_record > $max;
2349 Koha Development Team <http://koha-community.org/>