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>.
25 #use warnings; FIXME - Bug 2505
34 use C4::Members::Messaging;
36 use Koha::Account::Lines;
39 use Koha::CirculationRules;
44 use Koha::IssuingRules;
53 use List::MoreUtils qw( firstidx any );
55 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
59 C4::Reserves - Koha functions for dealing with reservation.
67 This modules provides somes functions to deal with reservations.
69 Reserves are stored in reserves table.
70 The following columns contains important values :
71 - priority >0 : then the reserve is at 1st stage, and not yet affected to any item.
72 =0 : then the reserve is being dealed
73 - found : NULL : means the patron requested the 1st available, and we haven't chosen the item
74 T(ransit) : the reserve is linked to an item but is in transit to the pickup branch
75 W(aiting) : the reserve is linked to an item, is at the pickup branch, and is waiting on the hold shelf
76 F(inished) : the reserve has been completed, and is done
77 - itemnumber : empty : the reserve is still unaffected to an item
78 filled: the reserve is attached to an item
79 The complete workflow is :
80 ==== 1st use case ====
81 patron request a document, 1st available : P >0, F=NULL, I=NULL
82 a library having it run "transfertodo", and clic on the list
83 if there is no transfer to do, the reserve waiting
84 patron can pick it up P =0, F=W, I=filled
85 if there is a transfer to do, write in branchtransfer P =0, F=T, I=filled
86 The pickup library receive the book, it check in P =0, F=W, I=filled
87 The patron borrow the book P =0, F=F, I=filled
89 ==== 2nd use case ====
90 patron requests a document, a given item,
91 If pickup is holding branch P =0, F=W, I=filled
92 If transfer needed, write in branchtransfer P =0, F=T, I=filled
93 The pickup library receive the book, it checks it in P =0, F=W, I=filled
94 The patron borrow the book P =0, F=F, I=filled
115 &ModReserveMinusPriority
121 &CanReserveBeCanceledFromOpac
122 &CancelExpiredReserves
124 &AutoUnsuspendReserves
126 &IsAvailableForItemLevelRequest
129 &ToggleLowestPriority
135 &GetReservesControlBranch
139 GetMaxPatronHoldsForRecord
141 @EXPORT_OK = qw( MergeHolds );
146 AddReserve($branch,$borrowernumber,$biblionumber,$bibitems,$priority,$resdate,$expdate,$notes,$title,$checkitem,$found)
148 Adds reserve and generates HOLDPLACED message.
150 The following tables are available witin the HOLDPLACED message:
163 $branch, $borrowernumber, $biblionumber, $bibitems,
164 $priority, $resdate, $expdate, $notes,
165 $title, $checkitem, $found, $itemtype
168 $resdate = output_pref( { str => dt_from_string( $resdate ), dateonly => 1, dateformat => 'iso' })
169 or output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
171 $expdate = output_pref({ str => $expdate, dateonly => 1, dateformat => 'iso' });
173 # if we have an item selectionned, and the pickup branch is the same as the holdingbranch
174 # of the document, we force the value $priority and $found .
175 if ( $checkitem and not C4::Context->preference('ReservesNeedReturns') ) {
176 my $item = Koha::Items->find( $checkitem ); # FIXME Prevent bad calls
179 # If item is already checked out, it cannot be set waiting
182 # The item can't be waiting if it needs a transfer
183 && $item->holdingbranch eq $branch
185 # Similarly, if in transit it can't be waiting
186 && !$item->get_transfer
188 # If we can't hold damaged items, and it is damaged, it can't be waiting
189 && ( $item->damaged && C4::Context->preference('AllowHoldsOnDamagedItems') || !$item->damaged )
191 # Lastly, if this already has holds, we shouldn't make it waiting for the new hold
192 && !$item->current_holds->count )
199 if ( C4::Context->preference('AllowHoldDateInFuture') ) {
201 # Make room in reserves for this before those of a later reserve date
202 $priority = _ShiftPriorityByDateAndPriority( $biblionumber, $resdate, $priority );
207 # If the reserv had the waiting status, we had the value of the resdate
208 if ( $found eq 'W' ) {
209 $waitingdate = $resdate;
212 # Don't add itemtype limit if specific item is selected
213 $itemtype = undef if $checkitem;
215 # updates take place here
216 my $hold = Koha::Hold->new(
218 borrowernumber => $borrowernumber,
219 biblionumber => $biblionumber,
220 reservedate => $resdate,
221 branchcode => $branch,
222 priority => $priority,
223 reservenotes => $notes,
224 itemnumber => $checkitem,
226 waitingdate => $waitingdate,
227 expirationdate => $expdate,
228 itemtype => $itemtype,
229 item_level_hold => $checkitem ? 1 : 0,
232 $hold->set_waiting() if $found eq 'W';
234 logaction( 'HOLDS', 'CREATE', $hold->id, Dumper($hold->unblessed) )
235 if C4::Context->preference('HoldsLog');
237 my $reserve_id = $hold->id();
239 # add a reserve fee if needed
240 if ( C4::Context->preference('HoldFeeMode') ne 'any_time_is_collected' ) {
241 my $reserve_fee = GetReserveFee( $borrowernumber, $biblionumber );
242 ChargeReserveFee( $borrowernumber, $reserve_fee, $title );
245 _FixPriority({ biblionumber => $biblionumber});
247 # Send e-mail to librarian if syspref is active
248 if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
249 my $patron = Koha::Patrons->find( $borrowernumber );
250 my $library = $patron->library;
251 if ( my $letter = C4::Letters::GetPreparedLetter (
252 module => 'reserves',
253 letter_code => 'HOLDPLACED',
254 branchcode => $branch,
255 lang => $patron->lang,
257 'branches' => $library->unblessed,
258 'borrowers' => $patron->unblessed,
259 'biblio' => $biblionumber,
260 'biblioitems' => $biblionumber,
261 'items' => $checkitem,
262 'reserves' => $hold->unblessed,
266 my $admin_email_address = $library->branchemail || C4::Context->preference('KohaAdminEmailAddress');
268 C4::Letters::EnqueueLetter(
270 borrowernumber => $borrowernumber,
271 message_transport_type => 'email',
272 from_address => $admin_email_address,
273 to_address => $admin_email_address,
282 =head2 CanBookBeReserved
284 $canReserve = &CanBookBeReserved($borrowernumber, $biblionumber, $branchcode)
285 if ($canReserve eq 'OK') { #We can reserve this Item! }
287 See CanItemBeReserved() for possible return values.
291 sub CanBookBeReserved{
292 my ($borrowernumber, $biblionumber, $pickup_branchcode) = @_;
294 my @itemnumbers = Koha::Items->search({ biblionumber => $biblionumber})->get_column("itemnumber");
295 #get items linked via host records
296 my @hostitems = get_hostitemnumbers_of($biblionumber);
298 push (@itemnumbers, @hostitems);
301 my $canReserve = { status => '' };
302 foreach my $itemnumber (@itemnumbers) {
303 $canReserve = CanItemBeReserved( $borrowernumber, $itemnumber, $pickup_branchcode );
304 return { status => 'OK' } if $canReserve->{status} eq 'OK';
309 =head2 CanItemBeReserved
311 $canReserve = &CanItemBeReserved($borrowernumber, $itemnumber, $branchcode)
312 if ($canReserve->{status} eq 'OK') { #We can reserve this Item! }
314 @RETURNS { status => OK }, if the Item can be reserved.
315 { status => ageRestricted }, if the Item is age restricted for this borrower.
316 { status => damaged }, if the Item is damaged.
317 { status => cannotReserveFromOtherBranches }, if syspref 'canreservefromotherbranches' is OK.
318 { status => tooManyReserves, limit => $limit }, if the borrower has exceeded their maximum reserve amount.
319 { status => notReservable }, if holds on this item are not allowed
320 { status => libraryNotFound }, if given branchcode is not an existing library
321 { status => libraryNotPickupLocation }, if given branchcode is not configured to be a pickup location
322 { status => cannotBeTransferred }, if branch transfer limit applies on given item and branchcode
326 sub CanItemBeReserved {
327 my ( $borrowernumber, $itemnumber, $pickup_branchcode ) = @_;
329 my $dbh = C4::Context->dbh;
330 my $ruleitemtype; # itemtype of the matching issuing rule
331 my $allowedreserves = 0; # Total number of holds allowed across all records
332 my $holds_per_record = 1; # Total number of holds allowed for this one given record
333 my $holds_per_day; # Default to unlimited
335 # we retrieve borrowers and items informations #
336 # item->{itype} will come for biblioitems if necessery
337 my $item = Koha::Items->find($itemnumber);
338 my $biblio = $item->biblio;
339 my $patron = Koha::Patrons->find( $borrowernumber );
340 my $borrower = $patron->unblessed;
342 # If an item is damaged and we don't allow holds on damaged items, we can stop right here
343 return { status =>'damaged' }
345 && !C4::Context->preference('AllowHoldsOnDamagedItems') );
347 # Check for the age restriction
348 my ( $ageRestriction, $daysToAgeRestriction ) =
349 C4::Circulation::GetAgeRestriction( $biblio->biblioitem->agerestriction, $borrower );
350 return { status => 'ageRestricted' } if $daysToAgeRestriction && $daysToAgeRestriction > 0;
352 # Check that the patron doesn't have an item level hold on this item already
353 return { status =>'itemAlreadyOnHold' }
354 if Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->count();
356 my $controlbranch = C4::Context->preference('ReservesControlBranch');
359 SELECT count(*) AS count
361 LEFT JOIN items USING (itemnumber)
362 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
363 LEFT JOIN borrowers USING (borrowernumber)
364 WHERE borrowernumber = ?
368 my $branchfield = "reserves.branchcode";
370 if ( $controlbranch eq "ItemHomeLibrary" ) {
371 $branchfield = "items.homebranch";
372 $branchcode = $item->homebranch;
374 elsif ( $controlbranch eq "PatronLibrary" ) {
375 $branchfield = "borrowers.branchcode";
376 $branchcode = $borrower->{branchcode};
380 if ( my $rights = GetHoldRule( $borrower->{'categorycode'}, $item->effective_itemtype, $branchcode ) ) {
381 $ruleitemtype = $rights->{itemtype};
382 $allowedreserves = $rights->{reservesallowed};
383 $holds_per_record = $rights->{holds_per_record};
384 $holds_per_day = $rights->{holds_per_day};
390 my $holds = Koha::Holds->search(
392 borrowernumber => $borrowernumber,
393 biblionumber => $item->biblionumber,
396 if ( $holds->count() >= $holds_per_record ) {
397 return { status => "tooManyHoldsForThisRecord", limit => $holds_per_record };
400 my $today_holds = Koha::Holds->search({
401 borrowernumber => $borrowernumber,
402 reservedate => dt_from_string->date
405 if ( defined $holds_per_day &&
406 ( ( $holds_per_day > 0 && $today_holds->count() >= $holds_per_day )
407 or ( $holds_per_day == 0 ) )
409 return { status => 'tooManyReservesToday', limit => $holds_per_day };
414 $querycount .= "AND ( $branchfield = ? OR $branchfield IS NULL )";
416 # If using item-level itypes, fall back to the record
417 # level itemtype if the hold has no associated item
419 C4::Context->preference('item-level_itypes')
420 ? " AND COALESCE( items.itype, biblioitems.itemtype ) = ?"
421 : " AND biblioitems.itemtype = ?"
422 if ( $ruleitemtype ne "*" );
424 my $sthcount = $dbh->prepare($querycount);
426 if ( $ruleitemtype eq "*" ) {
427 $sthcount->execute( $borrowernumber, $branchcode );
430 $sthcount->execute( $borrowernumber, $branchcode, $ruleitemtype );
433 my $reservecount = "0";
434 if ( my $rowcount = $sthcount->fetchrow_hashref() ) {
435 $reservecount = $rowcount->{count};
438 # we check if it's ok or not
439 if ( $reservecount >= $allowedreserves ) {
440 return { status => 'tooManyReserves', limit => $allowedreserves };
443 # Now we need to check hold limits by patron category
444 my $rule = Koha::CirculationRules->get_effective_rule(
446 categorycode => $borrower->{categorycode},
447 branchcode => $branchcode,
448 rule_name => 'max_holds',
451 if ( $rule && defined( $rule->rule_value ) && $rule->rule_value ne '' ) {
452 my $total_holds_count = Koha::Holds->search(
454 borrowernumber => $borrower->{borrowernumber}
458 return { status => 'tooManyReserves', limit => $rule->rule_value} if $total_holds_count >= $rule->rule_value;
461 my $reserves_control_branch =
462 GetReservesControlBranch( $item->unblessed(), $borrower );
464 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $item->itype ); # FIXME Should not be item->effective_itemtype?
466 if ( $branchitemrule->{holdallowed} == 0 ) {
467 return { status => 'notReservable' };
470 if ( $branchitemrule->{holdallowed} == 1
471 && $borrower->{branchcode} ne $item->homebranch )
473 return { status => 'cannotReserveFromOtherBranches' };
476 # If reservecount is ok, we check item branch if IndependentBranches is ON
477 # and canreservefromotherbranches is OFF
478 if ( C4::Context->preference('IndependentBranches')
479 and !C4::Context->preference('canreservefromotherbranches') )
481 if ( $item->homebranch ne $borrower->{branchcode} ) {
482 return { status => 'cannotReserveFromOtherBranches' };
486 if ($pickup_branchcode) {
487 my $destination = Koha::Libraries->find({
488 branchcode => $pickup_branchcode,
491 unless ($destination) {
492 return { status => 'libraryNotFound' };
494 unless ($destination->pickup_location) {
495 return { status => 'libraryNotPickupLocation' };
497 unless ($item->can_be_transferred({ to => $destination })) {
498 return { status => 'cannotBeTransferred' };
502 return { status => 'OK' };
505 =head2 CanReserveBeCanceledFromOpac
507 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
509 returns 1 if reserve can be cancelled by user from OPAC.
510 First check if reserve belongs to user, next checks if reserve is not in
511 transfer or waiting status
515 sub CanReserveBeCanceledFromOpac {
516 my ($reserve_id, $borrowernumber) = @_;
518 return unless $reserve_id and $borrowernumber;
519 my $reserve = Koha::Holds->find($reserve_id);
521 return 0 unless $reserve->borrowernumber == $borrowernumber;
522 return 0 if ( $reserve->found eq 'W' ) or ( $reserve->found eq 'T' );
528 =head2 GetOtherReserves
530 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
532 Check queued list of this document and check if this document must be transferred
536 sub GetOtherReserves {
537 my ($itemnumber) = @_;
540 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
541 if ($checkreserves) {
542 my $item = Koha::Items->find($itemnumber);
543 if ( $item->holdingbranch ne $checkreserves->{'branchcode'} ) {
544 $messages->{'transfert'} = $checkreserves->{'branchcode'};
545 #minus priorities of others reservs
546 ModReserveMinusPriority(
548 $checkreserves->{'reserve_id'},
551 #launch the subroutine dotransfer
552 C4::Items::ModItemTransfer(
554 $item->holdingbranch,
555 $checkreserves->{'branchcode'}
560 #step 2b : case of a reservation on the same branch, set the waiting status
562 $messages->{'waiting'} = 1;
563 ModReserveMinusPriority(
565 $checkreserves->{'reserve_id'},
567 ModReserveStatus($itemnumber,'W');
570 $nextreservinfo = $checkreserves->{'borrowernumber'};
573 return ( $messages, $nextreservinfo );
576 =head2 ChargeReserveFee
578 $fee = ChargeReserveFee( $borrowernumber, $fee, $title );
580 Charge the fee for a reserve (if $fee > 0)
584 sub ChargeReserveFee {
585 my ( $borrowernumber, $fee, $title ) = @_;
586 return if !$fee || $fee == 0; # the last test is needed to include 0.00
587 Koha::Account->new( { patron_id => $borrowernumber } )->add_debit(
590 description => $title,
592 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
593 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
594 interface => C4::Context->interface,
595 invoice_type => undef,
604 $fee = GetReserveFee( $borrowernumber, $biblionumber );
606 Calculate the fee for a reserve (if applicable).
611 my ( $borrowernumber, $biblionumber ) = @_;
613 SELECT reservefee FROM borrowers LEFT JOIN categories ON borrowers.categorycode = categories.categorycode WHERE borrowernumber = ?
616 SELECT COUNT(*) FROM items
617 LEFT JOIN issues USING (itemnumber)
618 WHERE items.biblionumber=? AND issues.issue_id IS NULL
621 SELECT COUNT(*) FROM reserves WHERE biblionumber=? AND borrowernumber<>?
624 my $dbh = C4::Context->dbh;
625 my ( $fee ) = $dbh->selectrow_array( $borquery, undef, ($borrowernumber) );
626 my $hold_fee_mode = C4::Context->preference('HoldFeeMode') || 'not_always';
627 if( $fee and $fee > 0 and $hold_fee_mode eq 'not_always' ) {
628 # This is a reconstruction of the old code:
629 # Compare number of items with items issued, and optionally check holds
630 # If not all items are issued and there are no holds: charge no fee
631 # NOTE: Lost, damaged, not-for-loan, etc. are just ignored here
632 my ( $notissued, $reserved );
633 ( $notissued ) = $dbh->selectrow_array( $issue_qry, undef,
636 ( $reserved ) = $dbh->selectrow_array( $holds_qry, undef,
637 ( $biblionumber, $borrowernumber ) );
638 $fee = 0 if $reserved == 0;
644 =head2 GetReserveStatus
646 $reservestatus = GetReserveStatus($itemnumber);
648 Takes an itemnumber and returns the status of the reserve placed on it.
649 If several reserves exist, the reserve with the lower priority is given.
653 ## FIXME: I don't think this does what it thinks it does.
654 ## It only ever checks the first reserve result, even though
655 ## multiple reserves for that bib can have the itemnumber set
656 ## the sub is only used once in the codebase.
657 sub GetReserveStatus {
658 my ($itemnumber) = @_;
660 my $dbh = C4::Context->dbh;
662 my ($sth, $found, $priority);
664 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
665 $sth->execute($itemnumber);
666 ($found, $priority) = $sth->fetchrow_array;
670 return 'Waiting' if $found eq 'W' and $priority == 0;
671 return 'Finished' if $found eq 'F';
674 return 'Reserved' if $priority > 0;
676 return ''; # empty string here will remove need for checking undef, or less log lines
681 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($itemnumber);
682 ($status, $matched_reserve, $possible_reserves) = &CheckReserves(undef, $barcode);
683 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
685 Find a book in the reserves.
687 C<$itemnumber> is the book's item number.
688 C<$lookahead> is the number of days to look in advance for future reserves.
690 As I understand it, C<&CheckReserves> looks for the given item in the
691 reserves. If it is found, that's a match, and C<$status> is set to
694 Otherwise, it finds the most important item in the reserves with the
695 same biblio number as this book (I'm not clear on this) and returns it
696 with C<$status> set to C<Reserved>.
698 C<&CheckReserves> returns a two-element list:
700 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
702 C<$reserve> is the reserve item that matched. It is a
703 reference-to-hash whose keys are mostly the fields of the reserves
704 table in the Koha database.
709 my ( $item, $barcode, $lookahead_days, $ignore_borrowers) = @_;
710 my $dbh = C4::Context->dbh;
713 if (C4::Context->preference('item-level_itypes')){
715 SELECT items.biblionumber,
716 items.biblioitemnumber,
717 itemtypes.notforloan,
718 items.notforloan AS itemnotforloan,
724 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
725 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
730 SELECT items.biblionumber,
731 items.biblioitemnumber,
732 itemtypes.notforloan,
733 items.notforloan AS itemnotforloan,
739 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
740 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
745 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
746 $sth->execute($item);
749 $sth = $dbh->prepare("$select WHERE barcode = ?");
750 $sth->execute($barcode);
752 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
753 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber, $damaged, $item_homebranch, $item_holdingbranch ) = $sth->fetchrow_array;
754 return if ( $damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
756 return unless $itemnumber; # bail if we got nothing.
757 # if item is not for loan it cannot be reserved either.....
758 # except where items.notforloan < 0 : This indicates the item is holdable.
759 return if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
761 # Find this item in the reserves
762 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days, $ignore_borrowers);
764 # $priority and $highest are used to find the most important item
765 # in the list returned by &_Findgroupreserve. (The lower $priority,
766 # the more important the item.)
767 # $highest is the most important item we've seen so far.
769 if (scalar @reserves) {
770 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
771 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
772 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
774 my $priority = 10000000;
775 foreach my $res (@reserves) {
776 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
777 if ($res->{'found'} eq 'W') {
778 return ( "Waiting", $res, \@reserves ); # Found it, it is waiting
780 return ( "Reserved", $res, \@reserves ); # Found determinated hold, e. g. the tranferred one
785 my $local_hold_match;
787 if ($LocalHoldsPriority) {
788 $patron = Koha::Patrons->find( $res->{borrowernumber} );
789 $item = Koha::Items->find($itemnumber);
791 my $local_holds_priority_item_branchcode =
792 $item->$LocalHoldsPriorityItemControl;
793 my $local_holds_priority_patron_branchcode =
794 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
796 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
797 ? $patron->branchcode
800 $local_holds_priority_item_branchcode eq
801 $local_holds_priority_patron_branchcode;
804 # See if this item is more important than what we've got so far
805 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
806 $item ||= Koha::Items->find($itemnumber);
807 next if $res->{itemtype} && $res->{itemtype} ne $item->effective_itemtype;
808 $patron ||= Koha::Patrons->find( $res->{borrowernumber} );
809 my $branch = GetReservesControlBranch( $item->unblessed, $patron->unblessed );
810 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$item->effective_itemtype);
811 next if ($branchitemrule->{'holdallowed'} == 0);
812 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $patron->branchcode));
813 my $hold_fulfillment_policy = $branchitemrule->{hold_fulfillment_policy};
815 if $hold_fulfillment_policy ne 'any'
817 $hold_fulfillment_policy eq ''
818 || ( $res->{branchcode} ne
819 $item->$hold_fulfillment_policy )
821 next unless $item->can_be_transferred( { to => Koha::Libraries->find( $res->{branchcode} ) } );
822 $priority = $res->{'priority'};
824 last if $local_hold_match;
830 # If we get this far, then no exact match was found.
831 # We return the most important (i.e. next) reservation.
833 $highest->{'itemnumber'} = $item;
834 return ( "Reserved", $highest, \@reserves );
840 =head2 CancelExpiredReserves
842 CancelExpiredReserves();
844 Cancels all reserves with an expiration date from before today.
848 sub CancelExpiredReserves {
849 my $today = dt_from_string();
850 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
851 my $expireWaiting = C4::Context->preference('ExpireReservesMaxPickUpDelay');
853 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
854 my $params = { expirationdate => { '<', $dtf->format_date($today) } };
855 $params->{found} = [ { '!=', 'W' }, undef ] unless $expireWaiting;
857 # FIXME To move to Koha::Holds->search_expired (?)
858 my $holds = Koha::Holds->search( $params );
860 while ( my $hold = $holds->next ) {
861 my $calendar = Koha::Calendar->new( branchcode => $hold->branchcode );
863 next if !$cancel_on_holidays && $calendar->is_holiday( $today );
865 my $cancel_params = {};
866 if ( $hold->found eq 'W' ) {
867 $cancel_params->{charge_cancel_fee} = 1;
869 $hold->cancel( $cancel_params );
873 =head2 AutoUnsuspendReserves
875 AutoUnsuspendReserves();
877 Unsuspends all suspended reserves with a suspend_until date from before today.
881 sub AutoUnsuspendReserves {
882 my $today = dt_from_string();
884 my @holds = Koha::Holds->search( { suspend_until => { '<=' => $today->ymd() } } );
886 map { $_->resume() } @holds;
891 ModReserve({ rank => $rank,
892 reserve_id => $reserve_id,
893 branchcode => $branchcode
894 [, itemnumber => $itemnumber ]
895 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
898 Change a hold request's priority or cancel it.
900 C<$rank> specifies the effect of the change. If C<$rank>
901 is 'W' or 'n', nothing happens. This corresponds to leaving a
902 request alone when changing its priority in the holds queue
905 If C<$rank> is 'del', the hold request is cancelled.
907 If C<$rank> is an integer greater than zero, the priority of
908 the request is set to that value. Since priority != 0 means
909 that the item is not waiting on the hold shelf, setting the
910 priority to a non-zero value also sets the request's found
911 status and waiting date to NULL.
913 The optional C<$itemnumber> parameter is used only when
914 C<$rank> is a non-zero integer; if supplied, the itemnumber
915 of the hold request is set accordingly; if omitted, the itemnumber
918 B<FIXME:> Note that the forgoing can have the effect of causing
919 item-level hold requests to turn into title-level requests. This
920 will be fixed once reserves has separate columns for requested
921 itemnumber and supplying itemnumber.
928 my $rank = $params->{'rank'};
929 my $reserve_id = $params->{'reserve_id'};
930 my $branchcode = $params->{'branchcode'};
931 my $itemnumber = $params->{'itemnumber'};
932 my $suspend_until = $params->{'suspend_until'};
933 my $borrowernumber = $params->{'borrowernumber'};
934 my $biblionumber = $params->{'biblionumber'};
936 return if $rank eq "W";
937 return if $rank eq "n";
939 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
942 unless ( $reserve_id ) {
943 my $holds = Koha::Holds->search({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber });
944 return unless $holds->count; # FIXME Should raise an exception
945 $hold = $holds->next;
946 $reserve_id = $hold->reserve_id;
949 $hold ||= Koha::Holds->find($reserve_id);
951 if ( $rank eq "del" ) {
954 elsif ($rank =~ /^\d+/ and $rank > 0) {
955 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, Dumper($hold->unblessed) )
956 if C4::Context->preference('HoldsLog');
960 branchcode => $branchcode,
961 itemnumber => $itemnumber,
965 if (exists $params->{reservedate}) {
966 $properties->{reservedate} = $params->{reservedate} || undef;
968 if (exists $params->{expirationdate}) {
969 $properties->{expirationdate} = $params->{expirationdate} || undef;
972 $hold->set($properties)->store();
974 if ( defined( $suspend_until ) ) {
975 if ( $suspend_until ) {
976 $suspend_until = eval { dt_from_string( $suspend_until ) };
977 $hold->suspend_hold( $suspend_until );
979 # If the hold is suspended leave the hold suspended, but convert it to an indefinite hold.
980 # If the hold is not suspended, this does nothing.
981 $hold->set( { suspend_until => undef } )->store();
985 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
989 =head2 ModReserveFill
991 &ModReserveFill($reserve);
993 Fill a reserve. If I understand this correctly, this means that the
994 reserved book has been found and given to the patron who reserved it.
996 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
997 whose keys are fields from the reserves table in the Koha database.
1001 sub ModReserveFill {
1003 my $reserve_id = $res->{'reserve_id'};
1005 my $hold = Koha::Holds->find($reserve_id);
1006 # get the priority on this record....
1007 my $priority = $hold->priority;
1009 # update the hold statuses, no need to store it though, we will be deleting it anyway
1017 # FIXME Must call Koha::Hold->cancel ? => No, should call ->filled and add the correct log
1018 Koha::Old::Hold->new( $hold->unblessed() )->store();
1022 if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
1023 my $reserve_fee = GetReserveFee( $hold->borrowernumber, $hold->biblionumber );
1024 ChargeReserveFee( $hold->borrowernumber, $reserve_fee, $hold->biblio->title );
1027 # now fix the priority on the others (if the priority wasn't
1028 # already sorted!)....
1029 unless ( $priority == 0 ) {
1030 _FixPriority( { reserve_id => $reserve_id, biblionumber => $hold->biblionumber } );
1034 =head2 ModReserveStatus
1036 &ModReserveStatus($itemnumber, $newstatus);
1038 Update the reserve status for the active (priority=0) reserve.
1040 $itemnumber is the itemnumber the reserve is on
1042 $newstatus is the new status.
1046 sub ModReserveStatus {
1048 #first : check if we have a reservation for this item .
1049 my ($itemnumber, $newstatus) = @_;
1050 my $dbh = C4::Context->dbh;
1052 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1053 my $sth_set = $dbh->prepare($query);
1054 $sth_set->execute( $newstatus, $itemnumber );
1056 my $item = Koha::Items->find($itemnumber);
1057 if ( ( $item->location eq 'CART' && $item->permanent_location ne 'CART' ) && $newstatus ) {
1058 CartToShelf( $itemnumber );
1062 =head2 ModReserveAffect
1064 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend,$reserve_id);
1066 This function affect an item and a status for a given reserve, either fetched directly
1067 by record_id, or by borrowernumber and itemnumber or biblionumber. If only biblionumber
1068 is given, only first reserve returned is affected, which is ok for anything but
1071 if $transferToDo is not set, then the status is set to "Waiting" as well.
1072 otherwise, a transfer is on the way, and the end of the transfer will
1073 take care of the waiting status
1077 sub ModReserveAffect {
1078 my ( $itemnumber, $borrowernumber, $transferToDo, $reserve_id ) = @_;
1079 my $dbh = C4::Context->dbh;
1081 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1082 # attached to $itemnumber
1083 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1084 $sth->execute($itemnumber);
1085 my ($biblionumber) = $sth->fetchrow;
1087 # get request - need to find out if item is already
1088 # waiting in order to not send duplicate hold filled notifications
1091 # Find hold by id if we have it
1092 $hold = Koha::Holds->find( $reserve_id ) if $reserve_id;
1093 # Find item level hold for this item if there is one
1094 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->next();
1095 # Find record level hold if there is no item level hold
1096 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, biblionumber => $biblionumber } )->next();
1098 return unless $hold;
1100 my $already_on_shelf = $hold->found && $hold->found eq 'W';
1102 $hold->itemnumber($itemnumber);
1103 $hold->set_waiting($transferToDo);
1105 _koha_notify_reserve( $hold->reserve_id )
1106 if ( !$transferToDo && !$already_on_shelf );
1108 _FixPriority( { biblionumber => $biblionumber } );
1109 my $item = Koha::Items->find($itemnumber);
1110 if ( ( $item->location eq 'CART' && $item->permanent_location ne 'CART' ) ) {
1111 CartToShelf( $itemnumber );
1117 =head2 ModReserveCancelAll
1119 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1121 function to cancel reserv,check other reserves, and transfer document if it's necessary
1125 sub ModReserveCancelAll {
1128 my ( $itemnumber, $borrowernumber ) = @_;
1130 #step 1 : cancel the reservation
1131 my $holds = Koha::Holds->search({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1132 return unless $holds->count;
1133 $holds->next->cancel;
1135 #step 2 launch the subroutine of the others reserves
1136 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1138 return ( $messages, $nextreservinfo );
1141 =head2 ModReserveMinusPriority
1143 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1145 Reduce the values of queued list
1149 sub ModReserveMinusPriority {
1150 my ( $itemnumber, $reserve_id ) = @_;
1152 #first step update the value of the first person on reserv
1153 my $dbh = C4::Context->dbh;
1156 SET priority = 0 , itemnumber = ?
1157 WHERE reserve_id = ?
1159 my $sth_upd = $dbh->prepare($query);
1160 $sth_upd->execute( $itemnumber, $reserve_id );
1161 # second step update all others reserves
1162 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1165 =head2 IsAvailableForItemLevelRequest
1167 my $is_available = IsAvailableForItemLevelRequest( $item_record, $borrower_record, $pickup_branchcode );
1169 Checks whether a given item record is available for an
1170 item-level hold request. An item is available if
1172 * it is not lost AND
1173 * it is not damaged AND
1174 * it is not withdrawn AND
1175 * a waiting or in transit reserve is placed on
1176 * does not have a not for loan value > 0
1178 Need to check the issuingrules onshelfholds column,
1179 if this is set items on the shelf can be placed on hold
1181 Note that IsAvailableForItemLevelRequest() does not
1182 check if the staff operator is authorized to place
1183 a request on the item - in particular,
1184 this routine does not check IndependentBranches
1185 and canreservefromotherbranches.
1189 sub IsAvailableForItemLevelRequest {
1190 my ( $item, $patron, $pickup_branchcode ) = @_;
1192 my $dbh = C4::Context->dbh;
1193 # must check the notforloan setting of the itemtype
1194 # FIXME - a lot of places in the code do this
1195 # or something similar - need to be
1197 my $itemtype = $item->effective_itemtype;
1198 my $notforloan_per_itemtype = Koha::ItemTypes->find($itemtype)->notforloan;
1201 $notforloan_per_itemtype ||
1203 $item->notforloan > 0 ||
1205 ($item->damaged && !C4::Context->preference('AllowHoldsOnDamagedItems'));
1207 my $on_shelf_holds = Koha::IssuingRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
1209 if ($pickup_branchcode) {
1210 my $destination = Koha::Libraries->find($pickup_branchcode);
1211 return 0 unless $destination;
1212 return 0 unless $destination->pickup_location;
1213 return 0 unless $item->can_be_transferred( { to => $destination } );
1216 if ( $on_shelf_holds == 1 ) {
1218 } elsif ( $on_shelf_holds == 2 ) {
1220 Koha::Items->search( { biblionumber => $item->biblionumber } );
1222 my $any_available = 0;
1224 foreach my $i (@items) {
1225 my $reserves_control_branch = GetReservesControlBranch( $i->unblessed(), $patron->unblessed );
1226 my $branchitemrule = C4::Circulation::GetBranchItemRule( $reserves_control_branch, $i->itype );
1230 || $i->notforloan > 0
1233 || IsItemOnHoldAndFound( $i->id )
1235 && !C4::Context->preference('AllowHoldsOnDamagedItems') )
1236 || Koha::ItemTypes->find( $i->effective_itemtype() )->notforloan
1237 || $branchitemrule->{holdallowed} == 1 && $patron->branchcode ne $i->homebranch;
1240 return $any_available ? 0 : 1;
1241 } else { # on_shelf_holds == 0 "If any unavailable" (the description is rather cryptic and could still be improved)
1242 return $item->onloan || IsItemOnHoldAndFound( $item->itemnumber );
1250 if (C4::Context->preference('item-level_itypes')) {
1251 # We can't trust GetItem to honour the syspref, so safest to do it ourselves
1252 # When GetItem is fixed, we can remove this
1253 $itype = $item->{itype};
1256 # XXX This is a bit dodgy. It relies on biblio itemtype column having different name.
1257 # So if we already have a biblioitems join when calling this function,
1258 # we don't need to access the database again
1259 $itype = $item->{itemtype};
1262 my $dbh = C4::Context->dbh;
1263 my $query = "SELECT itemtype FROM biblioitems WHERE biblioitemnumber = ? ";
1264 my $sth = $dbh->prepare($query);
1265 $sth->execute($item->{biblioitemnumber});
1266 if (my $data = $sth->fetchrow_hashref()){
1267 $itype = $data->{itemtype};
1273 =head2 AlterPriority
1275 AlterPriority( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority );
1277 This function changes a reserve's priority up, down, to the top, or to the bottom.
1278 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1283 my ( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority ) = @_;
1285 my $hold = Koha::Holds->find( $reserve_id );
1286 return unless $hold;
1288 if ( $hold->cancellationdate ) {
1289 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (" . $hold->cancellationdate . ')';
1293 if ( $where eq 'up' ) {
1294 return unless $prev_priority;
1295 _FixPriority({ reserve_id => $reserve_id, rank => $prev_priority })
1296 } elsif ( $where eq 'down' ) {
1297 return unless $next_priority;
1298 _FixPriority({ reserve_id => $reserve_id, rank => $next_priority })
1299 } elsif ( $where eq 'top' ) {
1300 _FixPriority({ reserve_id => $reserve_id, rank => $first_priority })
1301 } elsif ( $where eq 'bottom' ) {
1302 _FixPriority({ reserve_id => $reserve_id, rank => $last_priority });
1305 # FIXME Should return the new priority
1308 =head2 ToggleLowestPriority
1310 ToggleLowestPriority( $borrowernumber, $biblionumber );
1312 This function sets the lowestPriority field to true if is false, and false if it is true.
1316 sub ToggleLowestPriority {
1317 my ( $reserve_id ) = @_;
1319 my $dbh = C4::Context->dbh;
1321 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1322 $sth->execute( $reserve_id );
1324 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1327 =head2 ToggleSuspend
1329 ToggleSuspend( $reserve_id );
1331 This function sets the suspend field to true if is false, and false if it is true.
1332 If the reserve is currently suspended with a suspend_until date, that date will
1333 be cleared when it is unsuspended.
1338 my ( $reserve_id, $suspend_until ) = @_;
1340 $suspend_until = dt_from_string($suspend_until) if ($suspend_until);
1342 my $hold = Koha::Holds->find( $reserve_id );
1344 if ( $hold->is_suspended ) {
1347 $hold->suspend_hold( $suspend_until );
1354 borrowernumber => $borrowernumber,
1355 [ biblionumber => $biblionumber, ]
1356 [ suspend_until => $suspend_until, ]
1357 [ suspend => $suspend ]
1360 This function accepts a set of hash keys as its parameters.
1361 It requires either borrowernumber or biblionumber, or both.
1363 suspend_until is wholly optional.
1370 my $borrowernumber = $params{'borrowernumber'} || undef;
1371 my $biblionumber = $params{'biblionumber'} || undef;
1372 my $suspend_until = $params{'suspend_until'} || undef;
1373 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1375 $suspend_until = eval { dt_from_string($suspend_until) }
1376 if ( defined($suspend_until) );
1378 return unless ( $borrowernumber || $biblionumber );
1381 $params->{found} = undef;
1382 $params->{borrowernumber} = $borrowernumber if $borrowernumber;
1383 $params->{biblionumber} = $biblionumber if $biblionumber;
1385 my @holds = Koha::Holds->search($params);
1388 map { $_->suspend_hold($suspend_until) } @holds;
1391 map { $_->resume() } @holds;
1399 reserve_id => $reserve_id,
1401 [ignoreSetLowestRank => $ignoreSetLowestRank]
1406 _FixPriority({ biblionumber => $biblionumber});
1408 This routine adjusts the priority of a hold request and holds
1411 In the first form, where a reserve_id is passed, the priority of the
1412 hold is set to supplied rank, and other holds for that bib are adjusted
1413 accordingly. If the rank is "del", the hold is cancelled. If no rank
1414 is supplied, all of the holds on that bib have their priority adjusted
1415 as if the second form had been used.
1417 In the second form, where a biblionumber is passed, the holds on that
1418 bib (that are not captured) are sorted in order of increasing priority,
1419 then have reserves.priority set so that the first non-captured hold
1420 has its priority set to 1, the second non-captured hold has its priority
1421 set to 2, and so forth.
1423 In both cases, holds that have the lowestPriority flag on are have their
1424 priority adjusted to ensure that they remain at the end of the line.
1426 Note that the ignoreSetLowestRank parameter is meant to be used only
1427 when _FixPriority calls itself.
1432 my ( $params ) = @_;
1433 my $reserve_id = $params->{reserve_id};
1434 my $rank = $params->{rank} // '';
1435 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1436 my $biblionumber = $params->{biblionumber};
1438 my $dbh = C4::Context->dbh;
1441 if ( $reserve_id ) {
1442 $hold = Koha::Holds->find( $reserve_id );
1443 if (!defined $hold){
1444 # may have already been checked out and hold fulfilled
1445 $hold = Koha::Old::Holds->find( $reserve_id );
1447 return unless $hold;
1450 unless ( $biblionumber ) { # FIXME This is a very weird API
1451 $biblionumber = $hold->biblionumber;
1454 if ( $rank eq "del" ) { # FIXME will crash if called without $hold
1457 elsif ( $rank eq "W" || $rank eq "0" ) {
1459 # make sure priority for waiting or in-transit items is 0
1463 WHERE reserve_id = ?
1464 AND found IN ('W', 'T')
1466 my $sth = $dbh->prepare($query);
1467 $sth->execute( $reserve_id );
1473 SELECT reserve_id, borrowernumber, reservedate
1475 WHERE biblionumber = ?
1476 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1477 ORDER BY priority ASC
1479 my $sth = $dbh->prepare($query);
1480 $sth->execute( $biblionumber );
1481 while ( my $line = $sth->fetchrow_hashref ) {
1482 push( @priority, $line );
1485 # To find the matching index
1487 my $key = -1; # to allow for 0 to be a valid result
1488 for ( $i = 0 ; $i < @priority ; $i++ ) {
1489 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1490 $key = $i; # save the index
1495 # if index exists in array then move it to new position
1496 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1497 my $new_rank = $rank -
1498 1; # $new_rank is what you want the new index to be in the array
1499 my $moving_item = splice( @priority, $key, 1 );
1500 splice( @priority, $new_rank, 0, $moving_item );
1503 # now fix the priority on those that are left....
1507 WHERE reserve_id = ?
1509 $sth = $dbh->prepare($query);
1510 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1513 $priority[$j]->{'reserve_id'}
1517 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1520 unless ( $ignoreSetLowestRank ) {
1521 while ( my $res = $sth->fetchrow_hashref() ) {
1523 reserve_id => $res->{'reserve_id'},
1525 ignoreSetLowestRank => 1
1531 =head2 _Findgroupreserve
1533 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead, $ignore_borrowers);
1535 Looks for a holds-queue based item-specific match first, then for a holds-queue title-level match, returning the
1536 first match found. If neither, then we look for non-holds-queue based holds.
1537 Lookahead is the number of days to look in advance.
1539 C<&_Findgroupreserve> returns :
1540 C<@results> is an array of references-to-hash whose keys are mostly
1541 fields from the reserves table of the Koha database, plus
1542 C<biblioitemnumber>.
1544 This routine with either return:
1545 1 - Item specific holds from the holds queue
1546 2 - Title level holds from the holds queue
1547 3 - All holds for this biblionumber
1549 All return values will respect any borrowernumbers passed as arrayref in $ignore_borrowers
1553 sub _Findgroupreserve {
1554 my ( $bibitem, $biblio, $itemnumber, $lookahead, $ignore_borrowers) = @_;
1555 my $dbh = C4::Context->dbh;
1557 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1558 # check for exact targeted match
1559 my $item_level_target_query = qq{
1560 SELECT reserves.biblionumber AS biblionumber,
1561 reserves.borrowernumber AS borrowernumber,
1562 reserves.reservedate AS reservedate,
1563 reserves.branchcode AS branchcode,
1564 reserves.cancellationdate AS cancellationdate,
1565 reserves.found AS found,
1566 reserves.reservenotes AS reservenotes,
1567 reserves.priority AS priority,
1568 reserves.timestamp AS timestamp,
1569 biblioitems.biblioitemnumber AS biblioitemnumber,
1570 reserves.itemnumber AS itemnumber,
1571 reserves.reserve_id AS reserve_id,
1572 reserves.itemtype AS itemtype
1574 JOIN biblioitems USING (biblionumber)
1575 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1578 AND item_level_request = 1
1580 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1584 my $sth = $dbh->prepare($item_level_target_query);
1585 $sth->execute($itemnumber, $lookahead||0);
1587 if ( my $data = $sth->fetchrow_hashref ) {
1588 push( @results, $data )
1589 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1591 return @results if @results;
1593 # check for title-level targeted match
1594 my $title_level_target_query = qq{
1595 SELECT reserves.biblionumber AS biblionumber,
1596 reserves.borrowernumber AS borrowernumber,
1597 reserves.reservedate AS reservedate,
1598 reserves.branchcode AS branchcode,
1599 reserves.cancellationdate AS cancellationdate,
1600 reserves.found AS found,
1601 reserves.reservenotes AS reservenotes,
1602 reserves.priority AS priority,
1603 reserves.timestamp AS timestamp,
1604 biblioitems.biblioitemnumber AS biblioitemnumber,
1605 reserves.itemnumber AS itemnumber,
1606 reserves.reserve_id AS reserve_id,
1607 reserves.itemtype AS itemtype
1609 JOIN biblioitems USING (biblionumber)
1610 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1613 AND item_level_request = 0
1614 AND hold_fill_targets.itemnumber = ?
1615 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1619 $sth = $dbh->prepare($title_level_target_query);
1620 $sth->execute($itemnumber, $lookahead||0);
1622 if ( my $data = $sth->fetchrow_hashref ) {
1623 push( @results, $data )
1624 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1626 return @results if @results;
1629 SELECT reserves.biblionumber AS biblionumber,
1630 reserves.borrowernumber AS borrowernumber,
1631 reserves.reservedate AS reservedate,
1632 reserves.waitingdate AS waitingdate,
1633 reserves.branchcode AS branchcode,
1634 reserves.cancellationdate AS cancellationdate,
1635 reserves.found AS found,
1636 reserves.reservenotes AS reservenotes,
1637 reserves.priority AS priority,
1638 reserves.timestamp AS timestamp,
1639 reserves.itemnumber AS itemnumber,
1640 reserves.reserve_id AS reserve_id,
1641 reserves.itemtype AS itemtype
1643 WHERE reserves.biblionumber = ?
1644 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1645 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1649 $sth = $dbh->prepare($query);
1650 $sth->execute( $biblio, $itemnumber, $lookahead||0);
1652 while ( my $data = $sth->fetchrow_hashref ) {
1653 push( @results, $data )
1654 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1659 =head2 _koha_notify_reserve
1661 _koha_notify_reserve( $hold->reserve_id );
1663 Sends a notification to the patron that their hold has been filled (through
1664 ModReserveAffect, _not_ ModReserveFill)
1666 The letter code for this notice may be found using the following query:
1668 select distinct letter_code
1669 from message_transports
1670 inner join message_attributes using (message_attribute_id)
1671 where message_name = 'Hold_Filled'
1673 This will probably sipmly be 'HOLD', but because it is defined in the database,
1674 it is subject to addition or change.
1676 The following tables are availalbe witin the notice:
1687 sub _koha_notify_reserve {
1688 my $reserve_id = shift;
1689 my $hold = Koha::Holds->find($reserve_id);
1690 my $borrowernumber = $hold->borrowernumber;
1692 my $patron = Koha::Patrons->find( $borrowernumber );
1694 # Try to get the borrower's email address
1695 my $to_address = $patron->notice_email_address;
1697 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
1698 borrowernumber => $borrowernumber,
1699 message_name => 'Hold_Filled'
1702 my $library = Koha::Libraries->find( $hold->branchcode )->unblessed;
1704 my $admin_email_address = $library->{branchemail} || C4::Context->preference('KohaAdminEmailAddress');
1706 my %letter_params = (
1707 module => 'reserves',
1708 branchcode => $hold->branchcode,
1709 lang => $patron->lang,
1711 'branches' => $library,
1712 'borrowers' => $patron->unblessed,
1713 'biblio' => $hold->biblionumber,
1714 'biblioitems' => $hold->biblionumber,
1715 'reserves' => $hold->unblessed,
1716 'items' => $hold->itemnumber,
1720 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.
1721 my $send_notification = sub {
1722 my ( $mtt, $letter_code ) = (@_);
1723 return unless defined $letter_code;
1724 $letter_params{letter_code} = $letter_code;
1725 $letter_params{message_transport_type} = $mtt;
1726 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
1728 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
1732 C4::Letters::EnqueueLetter( {
1734 borrowernumber => $borrowernumber,
1735 from_address => $admin_email_address,
1736 message_transport_type => $mtt,
1740 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
1742 ( $mtt eq 'email' and not $to_address ) # No email address
1743 or ( $mtt eq 'sms' and not $patron->smsalertnumber ) # No SMS number
1744 or ( $mtt eq 'phone' and C4::Context->preference('TalkingTechItivaPhoneNotification') ) # Notice is handled by TalkingTech_itiva_outbound.pl
1747 &$send_notification($mtt, $letter_code);
1748 $notification_sent++;
1750 #Making sure that a print notification is sent if no other transport types can be utilized.
1751 if (! $notification_sent) {
1752 &$send_notification('print', 'HOLD');
1757 =head2 _ShiftPriorityByDateAndPriority
1759 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
1761 This increments the priority of all reserves after the one
1762 with either the lowest date after C<$reservedate>
1763 or the lowest priority after C<$priority>.
1765 It effectively makes room for a new reserve to be inserted with a certain
1766 priority, which is returned.
1768 This is most useful when the reservedate can be set by the user. It allows
1769 the new reserve to be placed before other reserves that have a later
1770 reservedate. Since priority also is set by the form in reserves/request.pl
1771 the sub accounts for that too.
1775 sub _ShiftPriorityByDateAndPriority {
1776 my ( $biblio, $resdate, $new_priority ) = @_;
1778 my $dbh = C4::Context->dbh;
1779 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
1780 my $sth = $dbh->prepare( $query );
1781 $sth->execute( $biblio, $resdate, $new_priority );
1782 my $min_priority = $sth->fetchrow;
1783 # if no such matches are found, $new_priority remains as original value
1784 $new_priority = $min_priority if ( $min_priority );
1786 # Shift the priority up by one; works in conjunction with the next SQL statement
1787 $query = "UPDATE reserves
1788 SET priority = priority+1
1789 WHERE biblionumber = ?
1790 AND borrowernumber = ?
1793 my $sth_update = $dbh->prepare( $query );
1795 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1796 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1797 $sth = $dbh->prepare( $query );
1798 $sth->execute( $new_priority, $biblio );
1799 while ( my $row = $sth->fetchrow_hashref ) {
1800 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1803 return $new_priority; # so the caller knows what priority they wind up receiving
1808 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
1810 Use when checking out an item to handle reserves
1811 If $cancelreserve boolean is set to true, it will remove existing reserve
1816 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
1818 my $lookahead = C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1819 my ( $restype, $res, undef ) = CheckReserves( $itemnumber, undef, $lookahead );
1822 my $biblionumber = $res->{biblionumber};
1824 if ($res->{borrowernumber} == $borrowernumber) {
1825 ModReserveFill($res);
1829 # The item is reserved by someone else.
1830 # Find this item in the reserves
1832 my $borr_res = Koha::Holds->search({
1833 borrowernumber => $borrowernumber,
1834 biblionumber => $biblionumber,
1836 order_by => 'priority'
1840 # The item is reserved by the current patron
1841 ModReserveFill($borr_res->unblessed);
1844 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
1845 RevertWaitingStatus({ itemnumber => $itemnumber });
1847 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
1848 my $hold = Koha::Holds->find( $res->{reserve_id} );
1856 MergeHolds($dbh,$to_biblio, $from_biblio);
1858 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
1863 my ( $dbh, $to_biblio, $from_biblio ) = @_;
1864 my $sth = $dbh->prepare(
1865 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
1867 $sth->execute($from_biblio);
1868 if ( my $data = $sth->fetchrow_hashref() ) {
1870 # holds exist on old record, if not we don't need to do anything
1871 $sth = $dbh->prepare(
1872 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
1873 $sth->execute( $to_biblio, $from_biblio );
1876 # don't reorder those already waiting
1878 $sth = $dbh->prepare(
1879 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
1881 my $upd_sth = $dbh->prepare(
1882 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
1883 AND reservedate = ? AND (itemnumber = ? or itemnumber is NULL) "
1885 $sth->execute( $to_biblio, 'W', 'T' );
1887 while ( my $reserve = $sth->fetchrow_hashref() ) {
1889 $priority, $to_biblio,
1890 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
1891 $reserve->{'itemnumber'}
1898 =head2 RevertWaitingStatus
1900 RevertWaitingStatus({ itemnumber => $itemnumber });
1902 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
1904 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
1905 item level hold, even if it was only a bibliolevel hold to
1906 begin with. This is because we can no longer know if a hold
1907 was item-level or bib-level after a hold has been set to
1912 sub RevertWaitingStatus {
1913 my ( $params ) = @_;
1914 my $itemnumber = $params->{'itemnumber'};
1916 return unless ( $itemnumber );
1918 my $dbh = C4::Context->dbh;
1920 ## Get the waiting reserve we want to revert
1922 SELECT * FROM reserves
1923 WHERE itemnumber = ?
1924 AND found IS NOT NULL
1926 my $sth = $dbh->prepare( $query );
1927 $sth->execute( $itemnumber );
1928 my $reserve = $sth->fetchrow_hashref();
1930 my $hold = Koha::Holds->find( $reserve->{reserve_id} ); # TODO Remove the next raw SQL statements and use this instead
1932 ## Increment the priority of all other non-waiting
1933 ## reserves for this bib record
1937 priority = priority + 1
1943 $sth = $dbh->prepare( $query );
1944 $sth->execute( $reserve->{'biblionumber'} );
1950 waitingdate => undef,
1951 itemnumber => $hold->item_level_hold ? $hold->itemnumber : undef,
1955 _FixPriority( { biblionumber => $reserve->{biblionumber} } );
1964 branchcode => $branchcode,
1965 borrowernumber => $borrowernumber,
1966 biblionumber => $biblionumber,
1967 [ itemnumber => $itemnumber, ]
1968 [ barcode => $barcode, ]
1972 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
1974 The letter code will be HOLD_SLIP, and the following tables are
1975 available within the slip:
1988 my $branchcode = $args->{branchcode};
1989 my $borrowernumber = $args->{borrowernumber};
1990 my $biblionumber = $args->{biblionumber};
1991 my $itemnumber = $args->{itemnumber};
1992 my $barcode = $args->{barcode};
1995 my $patron = Koha::Patrons->find($borrowernumber);
1998 if ($itemnumber || $barcode ) {
1999 $itemnumber ||= Koha::Items->find( { barcode => $barcode } )->itemnumber;
2001 $hold = Koha::Holds->search(
2003 biblionumber => $biblionumber,
2004 borrowernumber => $borrowernumber,
2005 itemnumber => $itemnumber
2010 $hold = Koha::Holds->search(
2012 biblionumber => $biblionumber,
2013 borrowernumber => $borrowernumber
2018 return unless $hold;
2019 my $reserve = $hold->unblessed;
2021 return C4::Letters::GetPreparedLetter (
2022 module => 'circulation',
2023 letter_code => 'HOLD_SLIP',
2024 branchcode => $branchcode,
2025 lang => $patron->lang,
2027 'reserves' => $reserve,
2028 'branches' => $reserve->{branchcode},
2029 'borrowers' => $reserve->{borrowernumber},
2030 'biblio' => $reserve->{biblionumber},
2031 'biblioitems' => $reserve->{biblionumber},
2032 'items' => $reserve->{itemnumber},
2037 =head2 GetReservesControlBranch
2039 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2041 Return the branchcode to be used to determine which reserves
2042 policy applies to a transaction.
2044 C<$item> is a hashref for an item. Only 'homebranch' is used.
2046 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2050 sub GetReservesControlBranch {
2051 my ( $item, $borrower ) = @_;
2053 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2056 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2057 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2063 =head2 CalculatePriority
2065 my $p = CalculatePriority($biblionumber, $resdate);
2067 Calculate priority for a new reserve on biblionumber, placing it at
2068 the end of the line of all holds whose start date falls before
2069 the current system time and that are neither on the hold shelf
2072 The reserve date parameter is optional; if it is supplied, the
2073 priority is based on the set of holds whose start date falls before
2074 the parameter value.
2076 After calculation of this priority, it is recommended to call
2077 _ShiftPriorityByDateAndPriority. Note that this is currently done in
2082 sub CalculatePriority {
2083 my ( $biblionumber, $resdate ) = @_;
2086 SELECT COUNT(*) FROM reserves
2087 WHERE biblionumber = ?
2089 AND (found IS NULL OR found = '')
2091 #skip found==W or found==T (waiting or transit holds)
2093 $sql.= ' AND ( reservedate <= ? )';
2096 $sql.= ' AND ( reservedate < NOW() )';
2098 my $dbh = C4::Context->dbh();
2099 my @row = $dbh->selectrow_array(
2102 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
2105 return @row ? $row[0]+1 : 1;
2108 =head2 IsItemOnHoldAndFound
2110 my $bool = IsItemFoundHold( $itemnumber );
2112 Returns true if the item is currently on hold
2113 and that hold has a non-null found status ( W, T, etc. )
2117 sub IsItemOnHoldAndFound {
2118 my ($itemnumber) = @_;
2120 my $rs = Koha::Database->new()->schema()->resultset('Reserve');
2122 my $found = $rs->count(
2124 itemnumber => $itemnumber,
2125 found => { '!=' => undef }
2132 =head2 GetMaxPatronHoldsForRecord
2134 my $holds_per_record = ReservesControlBranch( $borrowernumber, $biblionumber );
2136 For multiple holds on a given record for a given patron, the max
2137 number of record level holds that a patron can be placed is the highest
2138 value of the holds_per_record rule for each item if the record for that
2139 patron. This subroutine finds and returns the highest holds_per_record
2140 rule value for a given patron id and record id.
2144 sub GetMaxPatronHoldsForRecord {
2145 my ( $borrowernumber, $biblionumber ) = @_;
2147 my $patron = Koha::Patrons->find($borrowernumber);
2148 my @items = Koha::Items->search( { biblionumber => $biblionumber } );
2150 my $controlbranch = C4::Context->preference('ReservesControlBranch');
2152 my $categorycode = $patron->categorycode;
2154 $branchcode = $patron->branchcode if ( $controlbranch eq "PatronLibrary" );
2157 foreach my $item (@items) {
2158 my $itemtype = $item->effective_itemtype();
2160 $branchcode = $item->homebranch if ( $controlbranch eq "ItemHomeLibrary" );
2162 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2163 my $holds_per_record = $rule ? $rule->{holds_per_record} : 0;
2164 $max = $holds_per_record if $holds_per_record > $max;
2172 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2174 Returns the matching hold related issuingrule fields for a given
2175 patron category, itemtype, and library.
2180 my ( $categorycode, $itemtype, $branchcode ) = @_;
2182 my $dbh = C4::Context->dbh;
2184 my $sth = $dbh->prepare(
2186 SELECT categorycode, itemtype, branchcode, reservesallowed, holds_per_record, holds_per_day
2188 WHERE (categorycode in (?,'*') )
2189 AND (itemtype IN (?,'*'))
2190 AND (branchcode IN (?,'*'))
2191 ORDER BY categorycode DESC,
2197 $sth->execute( $categorycode, $itemtype, $branchcode );
2199 return $sth->fetchrow_hashref();
2204 Koha Development Team <http://koha-community.org/>