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,
168 Adds reserve and generates HOLDPLACED message.
170 The following tables are available witin the HOLDPLACED message:
183 my $branch = $params->{branchcode};
184 my $borrowernumber = $params->{borrowernumber};
185 my $biblionumber = $params->{biblionumber};
186 my $priority = $params->{priority};
187 my $resdate = $params->{reservation_date};
188 my $patron_expiration_date = $params->{expiration_date};
189 my $notes = $params->{notes};
190 my $title = $params->{title};
191 my $checkitem = $params->{itemnumber};
192 my $found = $params->{found};
193 my $itemtype = $params->{itemtype};
194 my $non_priority = $params->{non_priority};
195 my $item_group_id = $params->{item_group_id};
197 $resdate ||= dt_from_string;
199 # if we have an item selectionned, and the pickup branch is the same as the holdingbranch
200 # of the document, we force the value $priority and $found .
201 if ( $checkitem and not C4::Context->preference('ReservesNeedReturns') ) {
202 my $item = Koha::Items->find( $checkitem ); # FIXME Prevent bad calls
205 # If item is already checked out, it cannot be set waiting
208 # The item can't be waiting if it needs a transfer
209 && $item->holdingbranch eq $branch
211 # Similarly, if in transit it can't be waiting
212 && !$item->get_transfer
214 # If we can't hold damaged items, and it is damaged, it can't be waiting
215 && ( $item->damaged && C4::Context->preference('AllowHoldsOnDamagedItems') || !$item->damaged )
217 # Lastly, if this already has holds, we shouldn't make it waiting for the new hold
218 && !$item->current_holds->count )
224 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
225 # Make room in reserves for this if passed a priority
226 $priority = _ShiftPriority( $biblionumber, $priority );
231 # If the reserv had the waiting status, we had the value of the resdate
232 if ( $found && $found eq 'W' ) {
233 $waitingdate = $resdate;
236 # Don't add itemtype limit if specific item is selected
237 $itemtype = undef if $checkitem;
239 # updates take place here
240 my $hold = Koha::Hold->new(
242 borrowernumber => $borrowernumber,
243 biblionumber => $biblionumber,
244 item_group_id => $item_group_id,
245 reservedate => $resdate,
246 branchcode => $branch,
247 priority => $priority,
248 reservenotes => $notes,
249 itemnumber => $checkitem,
251 waitingdate => $waitingdate,
252 patron_expiration_date => $patron_expiration_date,
253 itemtype => $itemtype,
254 item_level_hold => $checkitem ? 1 : 0,
255 non_priority => $non_priority ? 1 : 0,
258 $hold->set_waiting() if $found && $found eq 'W';
260 logaction( 'HOLDS', 'CREATE', $hold->id, $hold )
261 if C4::Context->preference('HoldsLog');
263 my $reserve_id = $hold->id();
265 # add a reserve fee if needed
266 if ( C4::Context->preference('HoldFeeMode') ne 'any_time_is_collected' ) {
267 my $reserve_fee = GetReserveFee( $borrowernumber, $biblionumber );
268 ChargeReserveFee( $borrowernumber, $reserve_fee, $title );
271 _FixPriority({ biblionumber => $biblionumber});
273 # Send e-mail to librarian if syspref is active
274 if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
275 my $patron = Koha::Patrons->find( $borrowernumber );
276 my $library = $patron->library;
277 if ( my $letter = C4::Letters::GetPreparedLetter (
278 module => 'reserves',
279 letter_code => 'HOLDPLACED',
280 branchcode => $branch,
281 lang => $patron->lang,
283 'branches' => $library->unblessed,
284 'borrowers' => $patron->unblessed,
285 'biblio' => $biblionumber,
286 'biblioitems' => $biblionumber,
287 'items' => $checkitem,
288 'reserves' => $hold->unblessed,
292 my $branch_email_address = $library->inbound_email_address;
294 C4::Letters::EnqueueLetter(
297 borrowernumber => $borrowernumber,
298 message_transport_type => 'email',
299 to_address => $branch_email_address,
305 Koha::Plugins->call('after_hold_create', $hold);
310 payload => { hold => $hold->get_from_storage }
314 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
316 biblio_ids => [ $biblionumber ]
318 ) if C4::Context->preference('RealTimeHoldsQueue');
323 =head2 CanBookBeReserved
325 $canReserve = &CanBookBeReserved($borrowernumber, $biblionumber, $branchcode, $params)
326 if ($canReserve eq 'OK') { #We can reserve this Item! }
328 $params are passed directly through to CanItemBeReserved
330 See CanItemBeReserved() for possible return values.
334 sub CanBookBeReserved{
335 my ($borrowernumber, $biblionumber, $pickup_branchcode, $params) = @_;
337 # Check that patron have not checked out this biblio (if AllowHoldsOnPatronsPossessions set)
338 if ( !C4::Context->preference('AllowHoldsOnPatronsPossessions')
339 && C4::Circulation::CheckIfIssuedToPatron( $borrowernumber, $biblionumber ) ) {
340 return { status =>'alreadypossession' };
343 if ( $params->{itemtype} ) {
345 # biblio-level, item type-contrained
346 my $patron = Koha::Patrons->find($borrowernumber);
347 my $reservesallowed = Koha::CirculationRules->get_effective_rule(
349 itemtype => $params->{itemtype},
350 categorycode => $patron->categorycode,
351 branchcode => $pickup_branchcode,
352 rule_name => 'reservesallowed',
356 $reservesallowed = ( $reservesallowed eq '' ) ? undef : $reservesallowed;
358 my $count = $patron->holds->search(
361 { 'me.itemtype' => $params->{itemtype} },
362 { 'item.itype' => $params->{itemtype} }
370 return { status => '' }
371 if defined $reservesallowed and $reservesallowed < $count + 1;
375 #get items linked via host records
376 my @hostitemnumbers = get_hostitemnumbers_of($biblionumber);
377 if (@hostitemnumbers){
378 $items = Koha::Items->search({
380 biblionumber => $biblionumber,
381 itemnumber => { -in => @hostitemnumbers }
385 $items = Koha::Items->search({ biblionumber => $biblionumber});
388 my $canReserve = { status => '' };
389 my $patron = Koha::Patrons->find( $borrowernumber );
390 while ( my $item = $items->next ) {
391 $canReserve = CanItemBeReserved( $patron, $item, $pickup_branchcode, $params );
392 return { status => 'OK' } if $canReserve->{status} eq 'OK';
397 =head2 CanItemBeReserved
399 $canReserve = &CanItemBeReserved($patron, $item, $branchcode, $params)
400 if ($canReserve->{status} eq 'OK') { #We can reserve this Item! }
403 'ignore_hold_counts' - we use this routine to check if an item can fill a hold - on this case we
404 should not check if there are too many holds as we only care about reservability
406 @RETURNS { status => OK }, if the Item can be reserved.
407 { status => ageRestricted }, if the Item is age restricted for this borrower.
408 { status => damaged }, if the Item is damaged.
409 { status => cannotReserveFromOtherBranches }, if syspref 'canreservefromotherbranches' is OK.
410 { status => branchNotInHoldGroup }, if borrower home library is not in hold group, and holds are only allowed from hold groups.
411 { status => tooManyReserves, limit => $limit }, if the borrower has exceeded their maximum reserve amount.
412 { status => notReservable }, if holds on this item are not allowed
413 { status => libraryNotFound }, if given branchcode is not an existing library
414 { status => libraryNotPickupLocation }, if given branchcode is not configured to be a pickup location
415 { status => cannotBeTransferred }, if branch transfer limit applies on given item and branchcode
416 { status => pickupNotInHoldGroup }, pickup location is not in hold group, and pickup locations are only allowed from hold groups.
417 { status => recall }, if the borrower has already placed a recall on this item
421 sub CanItemBeReserved {
422 my ( $patron, $item, $pickup_branchcode, $params ) = @_;
424 my $dbh = C4::Context->dbh;
425 my $ruleitemtype; # itemtype of the matching issuing rule
426 my $allowedreserves = 0; # Total number of holds allowed across all records, default to none
428 # We check item branch if IndependentBranches is ON
429 # and canreservefromotherbranches is OFF
430 if ( C4::Context->preference('IndependentBranches')
431 and !C4::Context->preference('canreservefromotherbranches') )
433 if ( $item->homebranch ne $patron->branchcode ) {
434 return { status => 'cannotReserveFromOtherBranches' };
438 # we retrieve borrowers and items informations #
439 # item->{itype} will come for biblioitems if necessery
440 my $borrower = $patron->unblessed;
442 # If an item is damaged and we don't allow holds on damaged items, we can stop right here
443 return { status =>'damaged' }
445 && !C4::Context->preference('AllowHoldsOnDamagedItems') );
447 if( GetMarcFromKohaField('biblioitems.agerestriction') ){
448 my $biblio = $item->biblio;
449 # Check for the age restriction
450 my ( $ageRestriction, $daysToAgeRestriction ) =
451 C4::Circulation::GetAgeRestriction( $biblio->biblioitem->agerestriction, $borrower );
452 return { status => 'ageRestricted' } if $daysToAgeRestriction && $daysToAgeRestriction > 0;
455 # Check that the patron doesn't have an item level hold on this item already
456 return { status =>'itemAlreadyOnHold' }
457 if ( !$params->{ignore_hold_counts} && Koha::Holds->search( { borrowernumber => $patron->borrowernumber, itemnumber => $item->itemnumber } )->count() );
459 # Check that patron have not checked out this biblio (if AllowHoldsOnPatronsPossessions set)
460 if ( !C4::Context->preference('AllowHoldsOnPatronsPossessions')
461 && C4::Circulation::CheckIfIssuedToPatron( $patron->borrowernumber, $item->biblionumber ) ) {
462 return { status =>'alreadypossession' };
465 # check if a recall exists on this item from this borrower
466 return { status => 'recall' }
467 if $patron->recalls->filter_by_current->search({ item_id => $item->itemnumber })->count;
469 my $controlbranch = C4::Context->preference('ReservesControlBranch');
471 my $reserves_control_branch;
472 my $branchfield = "reserves.branchcode";
474 if ( $controlbranch eq "ItemHomeLibrary" ) {
475 $branchfield = "items.homebranch";
476 $reserves_control_branch = $item->homebranch;
478 elsif ( $controlbranch eq "PatronLibrary" ) {
479 $branchfield = "borrowers.branchcode";
480 $reserves_control_branch = $borrower->{branchcode};
485 my $reservesallowed = Koha::CirculationRules->get_effective_rule({
486 itemtype => $item->effective_itemtype,
487 categorycode => $borrower->{categorycode},
488 branchcode => $reserves_control_branch,
489 rule_name => 'reservesallowed',
492 $ruleitemtype = $reservesallowed->itemtype;
493 $allowedreserves = $reservesallowed->rule_value // 0; #undefined is 0, blank is unlimited
496 $ruleitemtype = undef;
499 my $rights = Koha::CirculationRules->get_effective_rules({
500 categorycode => $borrower->{'categorycode'},
501 itemtype => $item->effective_itemtype,
502 branchcode => $reserves_control_branch,
503 rules => ['holds_per_record','holds_per_day']
505 my $holds_per_record = $rights->{holds_per_record} // 1;
506 my $holds_per_day = $rights->{holds_per_day};
508 if ( defined $holds_per_record && $holds_per_record ne '' ){
509 if ( $holds_per_record == 0 ) {
510 return { status => "noReservesAllowed" };
512 if ( !$params->{ignore_hold_counts} ) {
513 my $search_params = {
514 borrowernumber => $patron->borrowernumber,
515 biblionumber => $item->biblionumber,
517 my $holds = Koha::Holds->search($search_params);
518 return { status => "tooManyHoldsForThisRecord", limit => $holds_per_record } if $holds->count() >= $holds_per_record;
522 if (!$params->{ignore_hold_counts} && defined $holds_per_day && $holds_per_day ne '')
524 my $today_holds = Koha::Holds->search({
525 borrowernumber => $patron->borrowernumber,
526 reservedate => dt_from_string->date
528 return { status => 'tooManyReservesToday', limit => $holds_per_day } if $today_holds->count() >= $holds_per_day;
531 # we check if it's ok or not
532 if ( defined $allowedreserves && $allowedreserves ne '' ){
533 if( $allowedreserves == 0 ){
534 return { status => 'noReservesAllowed' };
536 if ( !$params->{ignore_hold_counts} ) {
539 SELECT count(*) AS count
541 LEFT JOIN items USING (itemnumber)
542 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
543 LEFT JOIN borrowers USING (borrowernumber)
544 WHERE borrowernumber = ?
546 $querycount .= "AND ( $branchfield = ? OR $branchfield IS NULL )";
548 # If using item-level itypes, fall back to the record
549 # level itemtype if the hold has no associated item
550 if ( defined $ruleitemtype ) {
551 if ( C4::Context->preference('item-level_itypes') ) {
553 AND ( COALESCE( items.itype, biblioitems.itemtype ) = ?
554 OR reserves.itemtype = ? )
559 AND ( biblioitems.itemtype = ?
560 OR reserves.itemtype = ? )
565 my $sthcount = $dbh->prepare($querycount);
567 if ( defined $ruleitemtype ) {
568 $sthcount->execute( $patron->borrowernumber, $reserves_control_branch, $ruleitemtype, $ruleitemtype );
571 $sthcount->execute( $patron->borrowernumber, $reserves_control_branch );
574 my $reservecount = "0";
575 if ( my $rowcount = $sthcount->fetchrow_hashref() ) {
576 $reservecount = $rowcount->{count};
579 return { status => 'tooManyReserves', limit => $allowedreserves } if $reservecount >= $allowedreserves;
583 # Now we need to check hold limits by patron category
584 my $rule = Koha::CirculationRules->get_effective_rule(
586 categorycode => $patron->categorycode,
587 branchcode => $reserves_control_branch,
588 rule_name => 'max_holds',
591 if (!$params->{ignore_hold_counts} && $rule && defined( $rule->rule_value ) && $rule->rule_value ne '' ) {
592 my $total_holds_count = Koha::Holds->search(
594 borrowernumber => $patron->borrowernumber
598 return { status => 'tooManyReserves', limit => $rule->rule_value} if $total_holds_count >= $rule->rule_value;
602 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $item->effective_itemtype );
604 if ( $branchitemrule->{holdallowed} eq 'not_allowed' ) {
605 return { status => 'notReservable' };
608 if ( $branchitemrule->{holdallowed} eq 'from_home_library'
609 && $borrower->{branchcode} ne $item->homebranch )
611 return { status => 'cannotReserveFromOtherBranches' };
614 my $item_library = Koha::Libraries->find( {branchcode => $item->homebranch} );
615 if ( $branchitemrule->{holdallowed} eq 'from_local_hold_group') {
616 if($patron->branchcode ne $item->homebranch && !$item_library->validate_hold_sibling( {branchcode => $patron->branchcode} )) {
617 return { status => 'branchNotInHoldGroup' };
621 if ($pickup_branchcode) {
622 my $destination = Koha::Libraries->find({
623 branchcode => $pickup_branchcode,
626 unless ($destination) {
627 return { status => 'libraryNotFound' };
629 unless ($destination->pickup_location) {
630 return { status => 'libraryNotPickupLocation' };
632 unless ($item->can_be_transferred({ to => $destination })) {
633 return { status => 'cannotBeTransferred' };
635 if ($branchitemrule->{hold_fulfillment_policy} eq 'holdgroup' && !$item_library->validate_hold_sibling( {branchcode => $pickup_branchcode} )) {
636 return { status => 'pickupNotInHoldGroup' };
638 if ($branchitemrule->{hold_fulfillment_policy} eq 'patrongroup' && !Koha::Libraries->find({branchcode => $borrower->{branchcode}})->validate_hold_sibling({branchcode => $pickup_branchcode})) {
639 return { status => 'pickupNotInHoldGroup' };
643 return { status => 'OK' };
646 =head2 CanReserveBeCanceledFromOpac
648 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
650 returns 1 if reserve can be cancelled by user from OPAC.
651 First check if reserve belongs to user, next checks if reserve is not in
652 transfer or waiting status
656 sub CanReserveBeCanceledFromOpac {
657 my ($reserve_id, $borrowernumber) = @_;
659 return unless $reserve_id and $borrowernumber;
660 my $reserve = Koha::Holds->find($reserve_id) or return;
662 return 0 unless $reserve->borrowernumber == $borrowernumber;
663 return $reserve->is_cancelable_from_opac;
666 =head2 GetOtherReserves
668 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
670 Check queued list of this document and check if this document must be transferred
674 sub GetOtherReserves {
675 my ($itemnumber) = @_;
678 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
679 if ($checkreserves) {
680 my $item = Koha::Items->find($itemnumber);
681 if ( $item->holdingbranch ne $checkreserves->{'branchcode'} ) {
682 $messages->{'transfert'} = $checkreserves->{'branchcode'};
683 #minus priorities of others reservs
684 ModReserveMinusPriority(
686 $checkreserves->{'reserve_id'},
689 #launch the subroutine dotransfer
690 C4::Items::ModItemTransfer(
692 $item->holdingbranch,
693 $checkreserves->{'branchcode'},
699 #step 2b : case of a reservation on the same branch, set the waiting status
701 $messages->{'waiting'} = 1;
702 ModReserveMinusPriority(
704 $checkreserves->{'reserve_id'},
706 ModReserveStatus($itemnumber,'W');
709 $nextreservinfo = $checkreserves;
712 return ( $messages, $nextreservinfo );
715 =head2 ChargeReserveFee
717 $fee = ChargeReserveFee( $borrowernumber, $fee, $title );
719 Charge the fee for a reserve (if $fee > 0)
723 sub ChargeReserveFee {
724 my ( $borrowernumber, $fee, $title ) = @_;
725 return if !$fee || $fee == 0; # the last test is needed to include 0.00
726 Koha::Account->new( { patron_id => $borrowernumber } )->add_debit(
729 description => $title,
731 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
732 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
733 interface => C4::Context->interface,
734 invoice_type => undef,
743 $fee = GetReserveFee( $borrowernumber, $biblionumber );
745 Calculate the fee for a reserve (if applicable).
750 my ( $borrowernumber, $biblionumber ) = @_;
752 SELECT reservefee FROM borrowers LEFT JOIN categories ON borrowers.categorycode = categories.categorycode WHERE borrowernumber = ?
755 SELECT COUNT(*) FROM items
756 LEFT JOIN issues USING (itemnumber)
757 WHERE items.biblionumber=? AND issues.issue_id IS NULL
760 SELECT COUNT(*) FROM reserves WHERE biblionumber=? AND borrowernumber<>?
763 my $dbh = C4::Context->dbh;
764 my ( $fee ) = $dbh->selectrow_array( $borquery, undef, ($borrowernumber) );
765 my $hold_fee_mode = C4::Context->preference('HoldFeeMode') || 'not_always';
766 if( $fee and $fee > 0 and $hold_fee_mode eq 'not_always' ) {
767 # This is a reconstruction of the old code:
768 # Compare number of items with items issued, and optionally check holds
769 # If not all items are issued and there are no holds: charge no fee
770 # NOTE: Lost, damaged, not-for-loan, etc. are just ignored here
771 my ( $notissued, $reserved );
772 ( $notissued ) = $dbh->selectrow_array( $issue_qry, undef,
774 if( $notissued == 0 ) {
775 # all items are issued
776 ( $reserved ) = $dbh->selectrow_array( $holds_qry, undef,
777 ( $biblionumber, $borrowernumber ) );
778 $fee = 0 if $reserved == 0;
786 =head2 GetReserveStatus
788 $reservestatus = GetReserveStatus($itemnumber);
790 Takes an itemnumber and returns the status of the reserve placed on it.
791 If several reserves exist, the reserve with the lower priority is given.
795 ## FIXME: I don't think this does what it thinks it does.
796 ## It only ever checks the first reserve result, even though
797 ## multiple reserves for that bib can have the itemnumber set
798 ## the sub is only used once in the codebase.
799 sub GetReserveStatus {
800 my ($itemnumber) = @_;
802 my $dbh = C4::Context->dbh;
804 my ($sth, $found, $priority);
806 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
807 $sth->execute($itemnumber);
808 ($found, $priority) = $sth->fetchrow_array;
812 return 'Waiting' if $found eq 'W' and $priority == 0;
813 return 'Processing' if $found eq 'P';
814 return 'Finished' if $found eq 'F';
817 return 'Reserved' if defined $priority && $priority > 0;
819 return ''; # empty string here will remove need for checking undef, or less log lines
824 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($itemnumber);
825 ($status, $matched_reserve, $possible_reserves) = &CheckReserves(undef, $barcode);
826 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
828 Find a book in the reserves.
830 C<$itemnumber> is the book's item number.
831 C<$lookahead> is the number of days to look in advance for future reserves.
833 As I understand it, C<&CheckReserves> looks for the given item in the
834 reserves. If it is found, that's a match, and C<$status> is set to
837 Otherwise, it finds the most important item in the reserves with the
838 same biblio number as this book (I'm not clear on this) and returns it
839 with C<$status> set to C<Reserved>.
841 C<&CheckReserves> returns a two-element list:
843 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
845 C<$reserve> is the reserve item that matched. It is a
846 reference-to-hash whose keys are mostly the fields of the reserves
847 table in the Koha database.
852 my ( $item, $barcode, $lookahead_days, $ignore_borrowers) = @_;
853 my $dbh = C4::Context->dbh;
856 if (C4::Context->preference('item-level_itypes')){
858 SELECT items.biblionumber,
859 items.biblioitemnumber,
860 itemtypes.notforloan,
861 items.notforloan AS itemnotforloan,
867 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
868 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
873 SELECT items.biblionumber,
874 items.biblioitemnumber,
875 itemtypes.notforloan,
876 items.notforloan AS itemnotforloan,
882 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
883 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
888 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
889 $sth->execute($item);
892 $sth = $dbh->prepare("$select WHERE barcode = ?");
893 $sth->execute($barcode);
895 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
896 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber, $damaged, $item_homebranch, $item_holdingbranch ) = $sth->fetchrow_array;
897 return if ( $damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
899 return unless $itemnumber; # bail if we got nothing.
900 # if item is not for loan it cannot be reserved either.....
901 # except where items.notforloan < 0 : This indicates the item is holdable.
903 my @SkipHoldTrapOnNotForLoanValue = split( '\|', C4::Context->preference('SkipHoldTrapOnNotForLoanValue') );
904 return if grep { $_ eq $notforloan_per_item } @SkipHoldTrapOnNotForLoanValue;
906 my $dont_trap = C4::Context->preference('TrapHoldsOnOrder') ? ($notforloan_per_item > 0) : ($notforloan_per_item && 1 );
907 return if $dont_trap or $notforloan_per_itemtype;
909 # Find this item in the reserves
910 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days, $ignore_borrowers);
912 # $priority and $highest are used to find the most important item
913 # in the list returned by &_Findgroupreserve. (The lower $priority,
914 # the more important the item.)
915 # $highest is the most important item we've seen so far.
918 if (scalar @reserves) {
919 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
920 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
921 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
923 my $priority = 10000000;
924 foreach my $res (@reserves) {
925 if ($res->{'found'} && $res->{'found'} eq 'W') {
926 return ( "Waiting", $res, \@reserves ); # Found it, it is waiting
927 } elsif ($res->{'found'} && $res->{'found'} eq 'P') {
928 return ( "Processing", $res, \@reserves ); # Found determinated hold, e. g. the transferred one
929 } elsif ($res->{'found'} && $res->{'found'} eq 'T') {
930 return ( "Transferred", $res, \@reserves ); # Found determinated hold, e. g. the transferred one
934 my $local_hold_match;
936 if ($LocalHoldsPriority) {
937 $patron = Koha::Patrons->find( $res->{borrowernumber} );
938 $item = Koha::Items->find($itemnumber);
940 unless ($item->exclude_from_local_holds_priority || $patron->category->exclude_from_local_holds_priority) {
941 my $local_holds_priority_item_branchcode =
942 $item->$LocalHoldsPriorityItemControl;
943 my $local_holds_priority_patron_branchcode =
944 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
946 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
947 ? $patron->branchcode
950 $local_holds_priority_item_branchcode eq
951 $local_holds_priority_patron_branchcode;
955 # See if this item is more important than what we've got so far
956 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
957 $item ||= Koha::Items->find($itemnumber);
958 next if $res->{itemtype} && $res->{itemtype} ne $item->effective_itemtype;
959 $patron ||= Koha::Patrons->find( $res->{borrowernumber} );
960 my $branch = GetReservesControlBranch( $item->unblessed, $patron->unblessed );
961 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$item->effective_itemtype);
962 next if ($branchitemrule->{'holdallowed'} eq 'not_allowed');
963 next if (($branchitemrule->{'holdallowed'} eq 'from_home_library') && ($item->homebranch ne $patron->branchcode));
964 my $library = Koha::Libraries->find({branchcode=>$item->homebranch});
965 next if (($branchitemrule->{'holdallowed'} eq 'from_local_hold_group') && (!$library->validate_hold_sibling({branchcode => $patron->branchcode}) ));
966 my $hold_fulfillment_policy = $branchitemrule->{hold_fulfillment_policy};
967 next if ( ($hold_fulfillment_policy eq 'holdgroup') && (!$library->validate_hold_sibling({branchcode => $res->{branchcode}})) );
968 next if ( ($hold_fulfillment_policy eq 'homebranch') && ($res->{branchcode} ne $item->$hold_fulfillment_policy) );
969 next if ( ($hold_fulfillment_policy eq 'holdingbranch') && ($res->{branchcode} ne $item->$hold_fulfillment_policy) );
970 next unless $item->can_be_transferred( { to => Koha::Libraries->find( $res->{branchcode} ) } );
971 $priority = $res->{'priority'};
973 last if $local_hold_match;
979 # If we get this far, then no exact match was found.
980 # We return the most important (i.e. next) reservation.
982 $highest->{'itemnumber'} = $item;
983 return ( "Reserved", $highest, \@reserves );
989 =head2 CancelExpiredReserves
991 CancelExpiredReserves();
993 Cancels all reserves with an expiration date from before today.
997 sub CancelExpiredReserves {
998 my $cancellation_reason = shift;
999 my $today = dt_from_string();
1000 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
1001 my $expireWaiting = C4::Context->preference('ExpireReservesMaxPickUpDelay');
1003 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
1006 { expirationdate => { '<', $dtf->format_date($today) } },
1007 { patron_expiration_date => { '<' => $dtf->format_date($today) } }
1011 $params->{found} = [ { '!=', 'W' }, undef ] unless $expireWaiting;
1013 # FIXME To move to Koha::Holds->search_expired (?)
1014 my $holds = Koha::Holds->search( $params );
1016 while ( my $hold = $holds->next ) {
1017 my $calendar = Koha::Calendar->new( branchcode => $hold->branchcode );
1019 next if !$cancel_on_holidays && $calendar->is_holiday( $today );
1021 my $cancel_params = {};
1022 $cancel_params->{cancellation_reason} = $cancellation_reason if defined($cancellation_reason);
1023 if ( defined($hold->found) && $hold->found eq 'W' ) {
1024 $cancel_params->{charge_cancel_fee} = 1;
1026 $cancel_params->{autofill} = C4::Context->preference('ExpireReservesAutoFill');
1027 $hold->cancel( $cancel_params );
1031 =head2 AutoUnsuspendReserves
1033 AutoUnsuspendReserves();
1035 Unsuspends all suspended reserves with a suspend_until date from before today.
1039 sub AutoUnsuspendReserves {
1040 my $today = dt_from_string();
1042 my @holds = Koha::Holds->search( { suspend_until => { '<=' => $today->ymd() } } )->as_list;
1044 map { $_->resume() } @holds;
1049 ModReserve({ rank => $rank,
1050 reserve_id => $reserve_id,
1051 branchcode => $branchcode
1052 [, itemnumber => $itemnumber ]
1053 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1056 Change a hold request's priority or cancel it.
1058 C<$rank> specifies the effect of the change. If C<$rank>
1059 is 'n', nothing happens. This corresponds to leaving a
1060 request alone when changing its priority in the holds queue
1063 If C<$rank> is 'del', the hold request is cancelled.
1065 If C<$rank> is an integer greater than zero, the priority of
1066 the request is set to that value. Since priority != 0 means
1067 that the item is not waiting on the hold shelf, setting the
1068 priority to a non-zero value also sets the request's found
1069 status and waiting date to NULL.
1071 If the hold is 'found' (waiting, in-transit, processing) the
1072 only field that can be updated is the expiration date.
1074 The optional C<$itemnumber> parameter is used only when
1075 C<$rank> is a non-zero integer; if supplied, the itemnumber
1076 of the hold request is set accordingly; if omitted, the itemnumber
1079 B<FIXME:> Note that the forgoing can have the effect of causing
1080 item-level hold requests to turn into title-level requests. This
1081 will be fixed once reserves has separate columns for requested
1082 itemnumber and supplying itemnumber.
1087 my ( $params ) = @_;
1089 my $rank = $params->{'rank'};
1090 my $reserve_id = $params->{'reserve_id'};
1091 my $branchcode = $params->{'branchcode'};
1092 my $itemnumber = $params->{'itemnumber'};
1093 my $suspend_until = $params->{'suspend_until'};
1094 my $borrowernumber = $params->{'borrowernumber'};
1095 my $biblionumber = $params->{'biblionumber'};
1096 my $cancellation_reason = $params->{'cancellation_reason'};
1097 my $date = $params->{expirationdate};
1099 return if defined $rank && $rank eq "n";
1101 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1104 unless ( $reserve_id ) {
1105 my $holds = Koha::Holds->search({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber });
1106 return unless $holds->count; # FIXME Should raise an exception
1107 $hold = $holds->next;
1108 $reserve_id = $hold->reserve_id;
1111 $hold ||= Koha::Holds->find($reserve_id);
1113 # FIXME Other calls may fail
1114 Koha::Exceptions::ObjectNotFound->throw( 'No hold with id ' . $reserve_id ) unless $hold;
1116 if ( $rank eq "del" ) {
1117 $hold->cancel({ cancellation_reason => $cancellation_reason });
1119 elsif ($hold->found && $hold->priority eq '0' && $date) {
1120 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, $hold )
1121 if C4::Context->preference('HoldsLog');
1123 # The only column that can be updated for a found hold is the expiration date
1124 $hold->expirationdate($date)->store();
1126 elsif ($rank =~ /^\d+/ and $rank > 0) {
1127 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, $hold )
1128 if C4::Context->preference('HoldsLog');
1132 branchcode => $branchcode,
1133 itemnumber => $itemnumber,
1135 waitingdate => undef
1137 if (exists $params->{reservedate}) {
1138 $properties->{reservedate} = $params->{reservedate} || undef;
1140 if (exists $params->{expirationdate}) {
1141 $properties->{expirationdate} = $params->{expirationdate} || undef;
1144 $hold->set($properties)->store();
1146 if ( defined( $suspend_until ) ) {
1147 if ( $suspend_until ) {
1148 $hold->suspend_hold( $suspend_until );
1150 # If the hold is suspended leave the hold suspended, but convert it to an indefinite hold.
1151 # If the hold is not suspended, this does nothing.
1152 $hold->set( { suspend_until => undef } )->store();
1156 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
1160 =head2 ModReserveStatus
1162 &ModReserveStatus($itemnumber, $newstatus);
1164 Update the reserve status for the active (priority=0) reserve.
1166 $itemnumber is the itemnumber the reserve is on
1168 $newstatus is the new status.
1172 sub ModReserveStatus {
1174 #first : check if we have a reservation for this item .
1175 my ($itemnumber, $newstatus) = @_;
1176 my $dbh = C4::Context->dbh;
1178 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1179 my $sth_set = $dbh->prepare($query);
1180 $sth_set->execute( $newstatus, $itemnumber );
1182 my $item = Koha::Items->find($itemnumber);
1183 if ( $item->location && $item->location eq 'CART'
1184 && ( !$item->permanent_location || $item->permanent_location ne 'CART' )
1186 CartToShelf( $itemnumber );
1190 =head2 ModReserveAffect
1192 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend,$reserve_id, $desk_id, $notify_library);
1194 This function affect an item and a status for a given reserve, either fetched directly
1195 by record_id, or by borrowernumber and itemnumber or biblionumber. If only biblionumber
1196 is given, only first reserve returned is affected, which is ok for anything but
1199 if $transferToDo is not set, then the status is set to "Waiting" as well.
1200 otherwise, a transfer is on the way, and the end of the transfer will
1201 take care of the waiting status
1203 This function also removes any entry of the hold in holds queue table.
1207 sub ModReserveAffect {
1208 my ( $itemnumber, $borrowernumber, $transferToDo, $reserve_id, $desk_id, $notify_library ) = @_;
1209 my $dbh = C4::Context->dbh;
1211 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1212 # attached to $itemnumber
1213 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1214 $sth->execute($itemnumber);
1215 my ($biblionumber) = $sth->fetchrow;
1217 # get request - need to find out if item is already
1218 # waiting in order to not send duplicate hold filled notifications
1221 # Find hold by id if we have it
1222 $hold = Koha::Holds->find( $reserve_id ) if $reserve_id;
1223 # Find item level hold for this item if there is one
1224 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->next();
1225 # Find record level hold if there is no item level hold
1226 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, biblionumber => $biblionumber } )->next();
1228 return unless $hold;
1230 my $already_on_shelf = $hold->found && $hold->found eq 'W';
1232 $hold->itemnumber($itemnumber);
1234 if ($transferToDo) {
1235 $hold->set_transfer();
1236 } elsif (C4::Context->preference('HoldsNeedProcessingSIP')
1237 && C4::Context->interface eq 'sip'
1238 && !$already_on_shelf) {
1239 $hold->set_processing();
1241 $hold->set_waiting($desk_id);
1242 _koha_notify_reserve( $hold->reserve_id ) unless $already_on_shelf;
1243 # Complete transfer if one exists
1244 my $transfer = $hold->item->get_transfer;
1245 $transfer->receive if $transfer;
1248 _koha_notify_hold_changed( $hold ) if $notify_library;
1250 _FixPriority( { biblionumber => $biblionumber } );
1251 my $item = Koha::Items->find($itemnumber);
1252 if ( $item->location && $item->location eq 'CART'
1253 && ( !$item->permanent_location || $item->permanent_location ne 'CART' ) ) {
1254 CartToShelf( $itemnumber );
1257 my $std = $dbh->prepare(q{
1259 FROM tmp_holdsqueue q
1260 INNER JOIN hold_fill_targets t
1261 ON q.borrowernumber = t.borrowernumber
1262 AND q.biblionumber = t.biblionumber
1263 AND q.itemnumber = t.itemnumber
1264 AND q.item_level_request = t.item_level_request
1265 AND q.holdingbranch = t.source_branchcode
1266 WHERE t.reserve_id = ?
1268 $std->execute($hold->reserve_id);
1270 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, $hold )
1271 if C4::Context->preference('HoldsLog');
1276 =head2 ModReserveCancelAll
1278 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber,$reason);
1280 function to cancel reserv,check other reserves, and transfer document if it's necessary
1284 sub ModReserveCancelAll {
1287 my ( $itemnumber, $borrowernumber, $cancellation_reason ) = @_;
1289 #step 1 : cancel the reservation
1290 my $holds = Koha::Holds->search({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1291 return unless $holds->count;
1292 $holds->next->cancel({ cancellation_reason => $cancellation_reason });
1294 #step 2 launch the subroutine of the others reserves
1295 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1297 return ( $messages, $nextreservinfo->{borrowernumber} );
1300 =head2 ModReserveMinusPriority
1302 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1304 Reduce the values of queued list
1308 sub ModReserveMinusPriority {
1309 my ( $itemnumber, $reserve_id ) = @_;
1311 #first step update the value of the first person on reserv
1312 my $dbh = C4::Context->dbh;
1315 SET priority = 0 , itemnumber = ?
1316 WHERE reserve_id = ?
1318 my $sth_upd = $dbh->prepare($query);
1319 $sth_upd->execute( $itemnumber, $reserve_id );
1320 # second step update all others reserves
1321 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1324 =head2 IsAvailableForItemLevelRequest
1326 my $is_available = IsAvailableForItemLevelRequest( $item_record, $borrower_record, $pickup_branchcode );
1328 Checks whether a given item record is available for an
1329 item-level hold request. An item is available if
1331 * it is not lost AND
1332 * it is not damaged AND
1333 * it is not withdrawn AND
1334 * a waiting or in transit reserve is placed on
1335 * does not have a not for loan value > 0
1337 Need to check the issuingrules onshelfholds column,
1338 if this is set items on the shelf can be placed on hold
1340 Note that IsAvailableForItemLevelRequest() does not
1341 check if the staff operator is authorized to place
1342 a request on the item - in particular,
1343 this routine does not check IndependentBranches
1344 and canreservefromotherbranches.
1346 Note also that this subroutine does not checks smart
1347 rules limits for item by reservesallowed/holds_per_record
1348 values, this complemented in calling code with calls and
1349 checks with CanItemBeReserved or CanBookBeReserved.
1353 sub IsAvailableForItemLevelRequest {
1356 my $pickup_branchcode = shift;
1357 # items_any_available is precalculated status passed from request.pl when set of items
1358 # looped outside of IsAvailableForItemLevelRequest to avoid nested loops:
1359 my $items_any_available = shift;
1361 my $dbh = C4::Context->dbh;
1362 # must check the notforloan setting of the itemtype
1363 # FIXME - a lot of places in the code do this
1364 # or something similar - need to be
1366 my $itemtype = $item->effective_itemtype;
1368 unless defined $itemtype;
1369 my $notforloan_per_itemtype = Koha::ItemTypes->find($itemtype)->notforloan;
1372 $notforloan_per_itemtype ||
1374 $item->notforloan > 0 || # item with negative or zero notforloan value is holdable
1376 ($item->damaged && !C4::Context->preference('AllowHoldsOnDamagedItems'));
1378 if ($pickup_branchcode) {
1379 my $destination = Koha::Libraries->find($pickup_branchcode);
1380 return 0 unless $destination;
1381 return 0 unless $destination->pickup_location;
1382 return 0 unless $item->can_be_transferred( { to => $destination } );
1383 my $reserves_control_branch =
1384 GetReservesControlBranch( $item->unblessed(), $patron->unblessed() );
1385 my $branchitemrule =
1386 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $item->itype );
1387 my $home_library = Koha::Libraries->find( {branchcode => $item->homebranch} );
1388 return 0 unless $branchitemrule->{hold_fulfillment_policy} ne 'holdgroup' || $home_library->validate_hold_sibling( {branchcode => $pickup_branchcode} );
1391 my $on_shelf_holds = Koha::CirculationRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
1393 if ( $on_shelf_holds == 1 ) {
1395 } elsif ( $on_shelf_holds == 2 ) {
1397 # if we have this param predefined from outer caller sub, we just need
1398 # to return it, so we saving from having loop inside other loop:
1399 return $items_any_available ? 0 : 1
1400 if defined $items_any_available;
1402 my $any_available = ItemsAnyAvailableAndNotRestricted( { biblionumber => $item->biblionumber, patron => $patron });
1403 return $any_available ? 0 : 1;
1404 } else { # on_shelf_holds == 0 "If any unavailable" (the description is rather cryptic and could still be improved)
1405 return $item->onloan || IsItemOnHoldAndFound( $item->itemnumber );
1409 =head2 ItemsAnyAvailableAndNotRestricted
1411 ItemsAnyAvailableAndNotRestricted( { biblionumber => $biblionumber, patron => $patron });
1413 This function checks all items for specified biblionumber (numeric) against patron (object)
1414 and returns true (1) if at least one item available for loan/check out/present/not held
1415 and also checks other parameters logic which not restricts item for hold at all (for ex.
1416 AllowHoldsOnDamagedItems or 'holdallowed' own/sibling library)
1420 sub ItemsAnyAvailableAndNotRestricted {
1423 my @items = Koha::Items->search( { biblionumber => $param->{biblionumber} } )->as_list;
1425 foreach my $i (@items) {
1426 my $reserves_control_branch =
1427 GetReservesControlBranch( $i->unblessed(), $param->{patron}->unblessed );
1428 my $branchitemrule =
1429 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $i->itype );
1430 my $item_library = Koha::Libraries->find( { branchcode => $i->homebranch } );
1432 # we can return (end the loop) when first one found:
1435 || $i->notforloan # items with non-zero notforloan cannot be checked out
1438 || IsItemOnHoldAndFound( $i->id )
1440 && ! C4::Context->preference('AllowHoldsOnDamagedItems') )
1441 || Koha::ItemTypes->find( $i->effective_itemtype() )->notforloan
1442 || $branchitemrule->{holdallowed} eq 'from_home_library' && $param->{patron}->branchcode ne $i->homebranch
1443 || $branchitemrule->{holdallowed} eq 'from_local_hold_group' && ! $item_library->validate_hold_sibling( { branchcode => $param->{patron}->branchcode } )
1444 || CanItemBeReserved( $param->{patron}, $i )->{status} ne 'OK';
1450 =head2 AlterPriority
1452 AlterPriority( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority );
1454 This function changes a reserve's priority up, down, to the top, or to the bottom.
1455 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1460 my ( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority ) = @_;
1462 my $hold = Koha::Holds->find( $reserve_id );
1463 return unless $hold;
1465 if ( $hold->cancellationdate ) {
1466 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (" . $hold->cancellationdate . ')';
1470 if ( $where eq 'up' ) {
1471 return unless $prev_priority;
1472 _FixPriority({ reserve_id => $reserve_id, rank => $prev_priority })
1473 } elsif ( $where eq 'down' ) {
1474 return unless $next_priority;
1475 _FixPriority({ reserve_id => $reserve_id, rank => $next_priority })
1476 } elsif ( $where eq 'top' ) {
1477 _FixPriority({ reserve_id => $reserve_id, rank => $first_priority })
1478 } elsif ( $where eq 'bottom' ) {
1479 _FixPriority({ reserve_id => $reserve_id, rank => $last_priority });
1482 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1484 biblio_ids => [ $hold->biblionumber ]
1486 ) if C4::Context->preference('RealTimeHoldsQueue');
1487 # FIXME Should return the new priority
1490 =head2 ToggleLowestPriority
1492 ToggleLowestPriority( $borrowernumber, $biblionumber );
1494 This function sets the lowestPriority field to true if is false, and false if it is true.
1498 sub ToggleLowestPriority {
1499 my ( $reserve_id ) = @_;
1501 my $dbh = C4::Context->dbh;
1503 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1504 $sth->execute( $reserve_id );
1506 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1509 =head2 ToggleSuspend
1511 ToggleSuspend( $reserve_id );
1513 This function sets the suspend field to true if is false, and false if it is true.
1514 If the reserve is currently suspended with a suspend_until date, that date will
1515 be cleared when it is unsuspended.
1520 my ( $reserve_id, $suspend_until ) = @_;
1522 my $hold = Koha::Holds->find( $reserve_id );
1524 if ( $hold->is_suspended ) {
1527 $hold->suspend_hold( $suspend_until );
1534 borrowernumber => $borrowernumber,
1535 [ biblionumber => $biblionumber, ]
1536 [ suspend_until => $suspend_until, ]
1537 [ suspend => $suspend ]
1540 This function accepts a set of hash keys as its parameters.
1541 It requires either borrowernumber or biblionumber, or both.
1543 suspend_until is wholly optional.
1550 my $borrowernumber = $params{'borrowernumber'} || undef;
1551 my $biblionumber = $params{'biblionumber'} || undef;
1552 my $suspend_until = $params{'suspend_until'} || undef;
1553 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1555 return unless ( $borrowernumber || $biblionumber );
1558 $params->{found} = undef;
1559 $params->{borrowernumber} = $borrowernumber if $borrowernumber;
1560 $params->{biblionumber} = $biblionumber if $biblionumber;
1562 my @holds = Koha::Holds->search($params)->as_list;
1565 map { $_->suspend_hold($suspend_until) } @holds;
1568 map { $_->resume() } @holds;
1576 reserve_id => $reserve_id,
1578 [ignoreSetLowestRank => $ignoreSetLowestRank]
1583 _FixPriority({ biblionumber => $biblionumber});
1585 This routine adjusts the priority of a hold request and holds
1588 In the first form, where a reserve_id is passed, the priority of the
1589 hold is set to supplied rank, and other holds for that bib are adjusted
1590 accordingly. If the rank is "del", the hold is cancelled. If no rank
1591 is supplied, all of the holds on that bib have their priority adjusted
1592 as if the second form had been used.
1594 In the second form, where a biblionumber is passed, the holds on that
1595 bib (that are not captured) are sorted in order of increasing priority,
1596 then have reserves.priority set so that the first non-captured hold
1597 has its priority set to 1, the second non-captured hold has its priority
1598 set to 2, and so forth.
1600 In both cases, holds that have the lowestPriority flag on are have their
1601 priority adjusted to ensure that they remain at the end of the line.
1603 Note that the ignoreSetLowestRank parameter is meant to be used only
1604 when _FixPriority calls itself.
1609 my ( $params ) = @_;
1610 my $reserve_id = $params->{reserve_id};
1611 my $rank = $params->{rank} // '';
1612 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1613 my $biblionumber = $params->{biblionumber};
1615 my $dbh = C4::Context->dbh;
1618 if ( $reserve_id ) {
1619 $hold = Koha::Holds->find( $reserve_id );
1620 if (!defined $hold){
1621 # may have already been checked out and hold fulfilled
1622 $hold = Koha::Old::Holds->find( $reserve_id );
1624 return unless $hold;
1627 unless ( $biblionumber ) { # FIXME This is a very weird API
1628 $biblionumber = $hold->biblionumber;
1631 if ( $rank eq "del" ) { # FIXME will crash if called without $hold
1634 elsif ( $reserve_id && ( $rank eq "W" || $rank eq "0" ) ) {
1636 # make sure priority for waiting or in-transit items is 0
1640 WHERE reserve_id = ?
1641 AND found IN ('W', 'T', 'P')
1643 my $sth = $dbh->prepare($query);
1644 $sth->execute( $reserve_id );
1650 SELECT reserve_id, borrowernumber, reservedate
1652 WHERE biblionumber = ?
1653 AND ((found <> 'W' AND found <> 'T' AND found <> 'P') OR found IS NULL)
1654 ORDER BY priority ASC
1656 my $sth = $dbh->prepare($query);
1657 $sth->execute( $biblionumber );
1658 while ( my $line = $sth->fetchrow_hashref ) {
1659 push( @priority, $line );
1662 # FIXME This whole sub must be rewritten, especially to highlight what is done when reserve_id is not given
1663 # To find the matching index
1665 my $key = -1; # to allow for 0 to be a valid result
1666 for ( $i = 0 ; $i < @priority ; $i++ ) {
1667 if ( $reserve_id && $reserve_id == $priority[$i]->{'reserve_id'} ) {
1668 $key = $i; # save the index
1673 # if index exists in array then move it to new position
1674 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1675 my $new_rank = $rank - 1; # $new_rank is what you want the new index to be in the array
1676 my $moving_item = splice( @priority, $key, 1 );
1677 $new_rank = scalar @priority if $new_rank > scalar @priority;
1678 splice( @priority, $new_rank, 0, $moving_item );
1681 # now fix the priority on those that are left....
1685 WHERE reserve_id = ?
1687 $sth = $dbh->prepare($query);
1688 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1691 $priority[$j]->{'reserve_id'}
1695 unless ( $ignoreSetLowestRank ) {
1696 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 AND biblionumber = ? ORDER BY priority" );
1697 $sth->execute($biblionumber);
1698 while ( my $res = $sth->fetchrow_hashref() ) {
1700 reserve_id => $res->{'reserve_id'},
1702 ignoreSetLowestRank => 1
1708 =head2 _Findgroupreserve
1710 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead, $ignore_borrowers);
1712 Looks for a holds-queue based item-specific match first, then for a holds-queue title-level match, returning the
1713 first match found. If neither, then we look for non-holds-queue based holds.
1714 Lookahead is the number of days to look in advance.
1716 C<&_Findgroupreserve> returns :
1717 C<@results> is an array of references-to-hash whose keys are mostly
1718 fields from the reserves table of the Koha database, plus
1719 C<biblioitemnumber>.
1721 This routine with either return:
1722 1 - Item specific holds from the holds queue
1723 2 - Title level holds from the holds queue
1724 3 - All holds for this biblionumber
1726 All return values will respect any borrowernumbers passed as arrayref in $ignore_borrowers
1730 sub _Findgroupreserve {
1731 my ( $bibitem, $biblio, $itemnumber, $lookahead, $ignore_borrowers) = @_;
1732 my $dbh = C4::Context->dbh;
1734 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1735 # check for exact targeted match
1736 my $item_level_target_query = qq{
1737 SELECT reserves.biblionumber AS biblionumber,
1738 reserves.borrowernumber AS borrowernumber,
1739 reserves.reservedate AS reservedate,
1740 reserves.branchcode AS branchcode,
1741 reserves.cancellationdate AS cancellationdate,
1742 reserves.found AS found,
1743 reserves.reservenotes AS reservenotes,
1744 reserves.priority AS priority,
1745 reserves.timestamp AS timestamp,
1746 biblioitems.biblioitemnumber AS biblioitemnumber,
1747 reserves.itemnumber AS itemnumber,
1748 reserves.reserve_id AS reserve_id,
1749 reserves.itemtype AS itemtype,
1750 reserves.non_priority AS non_priority
1752 JOIN biblioitems USING (biblionumber)
1753 JOIN hold_fill_targets USING (reserve_id)
1756 AND item_level_request = 1
1757 AND hold_fill_targets.itemnumber = ?
1758 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1762 my $sth = $dbh->prepare($item_level_target_query);
1763 $sth->execute($itemnumber, $lookahead||0);
1765 if ( my $data = $sth->fetchrow_hashref ) {
1766 push( @results, $data )
1767 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1769 return @results if @results;
1771 # check for title-level targeted match
1772 my $title_level_target_query = qq{
1773 SELECT reserves.biblionumber AS biblionumber,
1774 reserves.borrowernumber AS borrowernumber,
1775 reserves.reservedate AS reservedate,
1776 reserves.branchcode AS branchcode,
1777 reserves.cancellationdate AS cancellationdate,
1778 reserves.found AS found,
1779 reserves.reservenotes AS reservenotes,
1780 reserves.priority AS priority,
1781 reserves.timestamp AS timestamp,
1782 biblioitems.biblioitemnumber AS biblioitemnumber,
1783 reserves.itemnumber AS itemnumber,
1784 reserves.reserve_id AS reserve_id,
1785 reserves.itemtype AS itemtype,
1786 reserves.non_priority AS non_priority
1788 JOIN biblioitems USING (biblionumber)
1789 JOIN hold_fill_targets USING (reserve_id)
1792 AND item_level_request = 0
1793 AND hold_fill_targets.itemnumber = ?
1794 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1798 $sth = $dbh->prepare($title_level_target_query);
1799 $sth->execute($itemnumber, $lookahead||0);
1801 if ( my $data = $sth->fetchrow_hashref ) {
1802 push( @results, $data )
1803 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1805 return @results if @results;
1808 SELECT reserves.biblionumber AS biblionumber,
1809 reserves.borrowernumber AS borrowernumber,
1810 reserves.reservedate AS reservedate,
1811 reserves.waitingdate AS waitingdate,
1812 reserves.branchcode AS branchcode,
1813 reserves.cancellationdate AS cancellationdate,
1814 reserves.found AS found,
1815 reserves.reservenotes AS reservenotes,
1816 reserves.priority AS priority,
1817 reserves.timestamp AS timestamp,
1818 reserves.itemnumber AS itemnumber,
1819 reserves.reserve_id AS reserve_id,
1820 reserves.itemtype AS itemtype,
1821 reserves.non_priority AS non_priority
1823 WHERE reserves.biblionumber = ?
1824 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1825 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1829 $sth = $dbh->prepare($query);
1830 $sth->execute( $biblio, $itemnumber, $lookahead||0);
1832 while ( my $data = $sth->fetchrow_hashref ) {
1833 push( @results, $data )
1834 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1839 =head2 _koha_notify_reserve
1841 _koha_notify_reserve( $hold->reserve_id );
1843 Sends a notification to the patron that their hold has been filled (through
1846 The letter code for this notice may be found using the following query:
1848 select distinct letter_code
1849 from message_transports
1850 inner join message_attributes using (message_attribute_id)
1851 where message_name = 'Hold_Filled'
1853 This will probably sipmly be 'HOLD', but because it is defined in the database,
1854 it is subject to addition or change.
1856 The following tables are availalbe witin the notice:
1867 sub _koha_notify_reserve {
1868 my $reserve_id = shift;
1870 my $hold = Koha::Holds->find($reserve_id);
1871 my $borrowernumber = $hold->borrowernumber;
1873 my $patron = Koha::Patrons->find( $borrowernumber );
1875 # Try to get the borrower's email address
1876 my $to_address = $patron->notice_email_address;
1878 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
1879 borrowernumber => $borrowernumber,
1880 message_name => 'Hold_Filled'
1883 my $library = Koha::Libraries->find( $hold->branchcode );
1884 my $inbound_email_address = $library->inbound_email_address;
1886 my %letter_params = (
1887 module => 'reserves',
1888 branchcode => $hold->branchcode,
1889 lang => $patron->lang,
1891 'branches' => $library->unblessed,
1892 'borrowers' => $patron->unblessed,
1893 'biblio' => $hold->biblionumber,
1894 'biblioitems' => $hold->biblionumber,
1895 'reserves' => $hold->unblessed,
1896 'items' => $hold->itemnumber,
1900 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.
1901 my $send_notification = sub {
1902 my ( $mtt, $letter_code ) = (@_);
1903 return unless defined $letter_code;
1904 $letter_params{letter_code} = $letter_code;
1905 $letter_params{message_transport_type} = $mtt;
1906 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
1908 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
1912 C4::Letters::EnqueueLetter( {
1914 borrowernumber => $borrowernumber,
1915 from_address => $inbound_email_address,
1916 message_transport_type => $mtt,
1920 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
1922 ( $mtt eq 'email' and not $to_address ) # No email address
1923 or ( $mtt eq 'sms' and not $patron->smsalertnumber ) # No SMS number
1924 or ( $mtt eq 'itiva' and C4::Context->preference('TalkingTechItivaPhoneNotification') ) # Notice is handled by TalkingTech_itiva_outbound.pl
1925 or ( $mtt eq 'phone' and not $patron->phone ) # No phone number to call
1928 &$send_notification($mtt, $letter_code);
1929 $notification_sent++;
1931 #Making sure that a print notification is sent if no other transport types can be utilized.
1932 if (! $notification_sent) {
1933 &$send_notification('print', 'HOLD');
1938 =head2 _koha_notify_hold_changed
1940 _koha_notify_hold_changed( $hold_object );
1944 sub _koha_notify_hold_changed {
1947 my $patron = $hold->patron;
1948 my $library = $hold->branch;
1950 my $letter = C4::Letters::GetPreparedLetter(
1951 module => 'reserves',
1952 letter_code => 'HOLD_CHANGED',
1953 branchcode => $hold->branchcode,
1954 substitute => { today => output_pref( dt_from_string ) },
1956 'branches' => $library->unblessed,
1957 'borrowers' => $patron->unblessed,
1958 'biblio' => $hold->biblionumber,
1959 'biblioitems' => $hold->biblionumber,
1960 'reserves' => $hold->unblessed,
1961 'items' => $hold->itemnumber,
1965 return unless $letter;
1968 C4::Context->preference('ExpireReservesAutoFillEmail')
1969 || $library->inbound_email_address;
1971 C4::Letters::EnqueueLetter(
1974 borrowernumber => $patron->id,
1975 message_transport_type => 'email',
1976 from_address => $email,
1977 to_address => $email,
1982 =head2 _ShiftPriority
1984 $new_priority = _ShiftPriority( $biblionumber, $priority );
1986 This increments the priority of all reserves after the one
1987 with either the lowest date after C<$reservedate>
1988 or the lowest priority after C<$priority>.
1990 It effectively makes room for a new reserve to be inserted with a certain
1991 priority, which is returned.
1993 This is most useful when the reservedate can be set by the user. It allows
1994 the new reserve to be placed before other reserves that have a later
1995 reservedate. Since priority also is set by the form in reserves/request.pl
1996 the sub accounts for that too.
2000 sub _ShiftPriority {
2001 my ( $biblio, $new_priority ) = @_;
2003 my $dbh = C4::Context->dbh;
2004 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND priority > ? ORDER BY priority ASC LIMIT 1";
2005 my $sth = $dbh->prepare( $query );
2006 $sth->execute( $biblio, $new_priority );
2007 my $min_priority = $sth->fetchrow;
2008 # if no such matches are found, $new_priority remains as original value
2009 $new_priority = $min_priority if ( $min_priority );
2011 # Shift the priority up by one; works in conjunction with the next SQL statement
2012 $query = "UPDATE reserves
2013 SET priority = priority+1
2014 WHERE biblionumber = ?
2015 AND borrowernumber = ?
2018 my $sth_update = $dbh->prepare( $query );
2020 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
2021 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
2022 $sth = $dbh->prepare( $query );
2023 $sth->execute( $new_priority, $biblio );
2024 while ( my $row = $sth->fetchrow_hashref ) {
2025 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
2028 return $new_priority; # so the caller knows what priority they wind up receiving
2033 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
2035 Use when checking out an item to handle reserves
2036 If $cancelreserve boolean is set to true, it will remove existing reserve
2041 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
2043 $cancelreserve //= 0;
2045 my $lookahead = C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2046 my ( $restype, $res, undef ) = CheckReserves( $itemnumber, undef, $lookahead );
2049 my $biblionumber = $res->{biblionumber};
2051 if ($res->{borrowernumber} == $borrowernumber) {
2052 my $hold = Koha::Holds->find( $res->{reserve_id} );
2057 # The item is reserved by someone else.
2058 # Find this item in the reserves
2060 my $borr_res = Koha::Holds->search({
2061 borrowernumber => $borrowernumber,
2062 biblionumber => $biblionumber,
2064 order_by => 'priority'
2068 # The item is reserved by the current patron
2072 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2073 RevertWaitingStatus({ itemnumber => $itemnumber });
2075 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2076 my $hold = Koha::Holds->find( $res->{reserve_id} );
2084 MergeHolds($dbh,$to_biblio, $from_biblio);
2086 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2091 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2092 my $sth = $dbh->prepare(
2093 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2095 $sth->execute($from_biblio);
2096 if ( my $data = $sth->fetchrow_hashref() ) {
2098 # holds exist on old record, if not we don't need to do anything
2099 $sth = $dbh->prepare(
2100 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2101 $sth->execute( $to_biblio, $from_biblio );
2104 # don't reorder those already waiting
2106 $sth = $dbh->prepare(
2107 "SELECT * FROM reserves WHERE biblionumber = ? AND (found NOT IN ('W', 'T', 'P') OR found is NULL) ORDER BY reservedate ASC"
2109 my $upd_sth = $dbh->prepare(
2110 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2111 AND reservedate = ? AND (itemnumber = ? or itemnumber is NULL) "
2113 $sth->execute( $to_biblio );
2115 while ( my $reserve = $sth->fetchrow_hashref() ) {
2117 $priority, $to_biblio,
2118 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2119 $reserve->{'itemnumber'}
2126 =head2 RevertWaitingStatus
2128 RevertWaitingStatus({ itemnumber => $itemnumber });
2130 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2132 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2133 item level hold, even if it was only a bibliolevel hold to
2134 begin with. This is because we can no longer know if a hold
2135 was item-level or bib-level after a hold has been set to
2140 sub RevertWaitingStatus {
2141 my ( $params ) = @_;
2142 my $itemnumber = $params->{'itemnumber'};
2144 return unless ( $itemnumber );
2146 my $dbh = C4::Context->dbh;
2148 ## Get the waiting reserve we want to revert
2149 my $hold = Koha::Holds->search(
2151 itemnumber => $itemnumber,
2152 found => { not => undef },
2156 ## Increment the priority of all other non-waiting
2157 ## reserves for this bib record
2158 my $holds = Koha::Holds->search({ biblionumber => $hold->biblionumber, priority => { '>' => 0 } })
2159 ->update({ priority => \'priority + 1' }, { no_triggers => 1 });
2161 ## Fix up the currently waiting reserve
2166 waitingdate => undef,
2167 expirationdate => $hold->patron_expiration_date,
2168 itemnumber => $hold->item_level_hold ? $hold->itemnumber : undef,
2172 _FixPriority( { biblionumber => $hold->biblionumber } );
2174 Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2176 biblio_ids => [ $hold->biblionumber ]
2178 ) if C4::Context->preference('RealTimeHoldsQueue');
2188 branchcode => $branchcode,
2189 borrowernumber => $borrowernumber,
2190 biblionumber => $biblionumber,
2191 [ itemnumber => $itemnumber, ]
2192 [ barcode => $barcode, ]
2196 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2198 The letter code will be HOLD_SLIP, and the following tables are
2199 available within the slip:
2212 my $branchcode = $args->{branchcode};
2213 my $reserve_id = $args->{reserve_id};
2215 my $hold = Koha::Holds->find($reserve_id);
2216 return unless $hold;
2218 my $patron = $hold->borrower;
2219 my $reserve = $hold->unblessed;
2221 return C4::Letters::GetPreparedLetter (
2222 module => 'circulation',
2223 letter_code => 'HOLD_SLIP',
2224 branchcode => $branchcode,
2225 lang => $patron->lang,
2227 'reserves' => $reserve,
2228 'branches' => $reserve->{branchcode},
2229 'borrowers' => $reserve->{borrowernumber},
2230 'biblio' => $reserve->{biblionumber},
2231 'biblioitems' => $reserve->{biblionumber},
2232 'items' => $reserve->{itemnumber},
2237 =head2 GetReservesControlBranch
2239 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2241 Return the branchcode to be used to determine which reserves
2242 policy applies to a transaction.
2244 C<$item> is a hashref for an item. Only 'homebranch' is used.
2246 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2250 sub GetReservesControlBranch {
2251 my ( $item, $borrower ) = @_;
2253 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2256 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2257 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2263 =head2 CalculatePriority
2265 my $p = CalculatePriority($biblionumber, $resdate);
2267 Calculate priority for a new reserve on biblionumber, placing it at
2268 the end of the line of all holds whose start date falls before
2269 the current system time and that are neither on the hold shelf
2272 The reserve date parameter is optional; if it is supplied, the
2273 priority is based on the set of holds whose start date falls before
2274 the parameter value.
2276 After calculation of this priority, it is recommended to call
2277 _ShiftPriority. Note that this is currently done in
2282 sub CalculatePriority {
2283 my ( $biblionumber, $resdate ) = @_;
2286 SELECT COUNT(*) FROM reserves
2287 WHERE biblionumber = ?
2289 AND (found IS NULL OR found = '')
2291 #skip found==W or found==T or found==P (waiting, transit or processing holds)
2293 $sql.= ' AND ( reservedate <= ? )';
2296 $sql.= ' AND ( reservedate < NOW() )';
2298 my $dbh = C4::Context->dbh();
2299 my @row = $dbh->selectrow_array(
2302 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
2305 return @row ? $row[0]+1 : 1;
2308 =head2 IsItemOnHoldAndFound
2310 my $bool = IsItemFoundHold( $itemnumber );
2312 Returns true if the item is currently on hold
2313 and that hold has a non-null found status ( W, T, etc. )
2317 sub IsItemOnHoldAndFound {
2318 my ($itemnumber) = @_;
2320 my $rs = Koha::Database->new()->schema()->resultset('Reserve');
2322 my $found = $rs->count(
2324 itemnumber => $itemnumber,
2325 found => { '!=' => undef }
2332 =head2 GetMaxPatronHoldsForRecord
2334 my $holds_per_record = ReservesControlBranch( $borrowernumber, $biblionumber );
2336 For multiple holds on a given record for a given patron, the max
2337 number of record level holds that a patron can be placed is the highest
2338 value of the holds_per_record rule for each item if the record for that
2339 patron. This subroutine finds and returns the highest holds_per_record
2340 rule value for a given patron id and record id.
2344 sub GetMaxPatronHoldsForRecord {
2345 my ( $borrowernumber, $biblionumber ) = @_;
2347 my $patron = Koha::Patrons->find($borrowernumber);
2348 my @items = Koha::Items->search( { biblionumber => $biblionumber } )->as_list;
2350 my $controlbranch = C4::Context->preference('ReservesControlBranch');
2352 my $categorycode = $patron->categorycode;
2354 $branchcode = $patron->branchcode if ( $controlbranch eq "PatronLibrary" );
2357 foreach my $item (@items) {
2358 my $itemtype = $item->effective_itemtype();
2360 $branchcode = $item->homebranch if ( $controlbranch eq "ItemHomeLibrary" );
2362 my $rule = Koha::CirculationRules->get_effective_rule({
2363 categorycode => $categorycode,
2364 itemtype => $itemtype,
2365 branchcode => $branchcode,
2366 rule_name => 'holds_per_record'
2368 my $holds_per_record = $rule ? $rule->rule_value : 0;
2369 $max = $holds_per_record if $holds_per_record > $max;
2377 Koha Development Team <http://koha-community.org/>