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') ) {
177 my $item = Koha::Items->find( $checkitem ); # FIXME Prevent bad calls
178 if ( $item->holdingbranch eq $branch ) {
183 if ( C4::Context->preference('AllowHoldDateInFuture') ) {
185 # Make room in reserves for this before those of a later reserve date
186 $priority = _ShiftPriorityByDateAndPriority( $biblionumber, $resdate, $priority );
191 # If the reserv had the waiting status, we had the value of the resdate
192 if ( $found eq 'W' ) {
193 $waitingdate = $resdate;
196 # Don't add itemtype limit if specific item is selected
197 $itemtype = undef if $checkitem;
199 # updates take place here
200 my $hold = Koha::Hold->new(
202 borrowernumber => $borrowernumber,
203 biblionumber => $biblionumber,
204 reservedate => $resdate,
205 branchcode => $branch,
206 priority => $priority,
207 reservenotes => $notes,
208 itemnumber => $checkitem,
210 waitingdate => $waitingdate,
211 expirationdate => $expdate,
212 itemtype => $itemtype,
215 $hold->set_waiting() if $found eq 'W';
217 logaction( 'HOLDS', 'CREATE', $hold->id, Dumper($hold->unblessed) )
218 if C4::Context->preference('HoldsLog');
220 my $reserve_id = $hold->id();
222 # add a reserve fee if needed
223 if ( C4::Context->preference('HoldFeeMode') ne 'any_time_is_collected' ) {
224 my $reserve_fee = GetReserveFee( $borrowernumber, $biblionumber );
225 ChargeReserveFee( $borrowernumber, $reserve_fee, $title );
228 _FixPriority({ biblionumber => $biblionumber});
230 # Send e-mail to librarian if syspref is active
231 if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
232 my $patron = Koha::Patrons->find( $borrowernumber );
233 my $library = $patron->library;
234 if ( my $letter = C4::Letters::GetPreparedLetter (
235 module => 'reserves',
236 letter_code => 'HOLDPLACED',
237 branchcode => $branch,
238 lang => $patron->lang,
240 'branches' => $library->unblessed,
241 'borrowers' => $patron->unblessed,
242 'biblio' => $biblionumber,
243 'biblioitems' => $biblionumber,
244 'items' => $checkitem,
245 'reserves' => $hold->unblessed,
249 my $admin_email_address = $library->branchemail || C4::Context->preference('KohaAdminEmailAddress');
251 C4::Letters::EnqueueLetter(
253 borrowernumber => $borrowernumber,
254 message_transport_type => 'email',
255 from_address => $admin_email_address,
256 to_address => $admin_email_address,
265 =head2 CanBookBeReserved
267 $canReserve = &CanBookBeReserved($borrowernumber, $biblionumber, $branchcode)
268 if ($canReserve eq 'OK') { #We can reserve this Item! }
270 See CanItemBeReserved() for possible return values.
274 sub CanBookBeReserved{
275 my ($borrowernumber, $biblionumber, $pickup_branchcode) = @_;
277 my @itemnumbers = Koha::Items->search({ biblionumber => $biblionumber})->get_column("itemnumber");
278 #get items linked via host records
279 my @hostitems = get_hostitemnumbers_of($biblionumber);
281 push (@itemnumbers, @hostitems);
284 my $canReserve = { status => '' };
285 foreach my $itemnumber (@itemnumbers) {
286 $canReserve = CanItemBeReserved( $borrowernumber, $itemnumber, $pickup_branchcode );
287 return { status => 'OK' } if $canReserve->{status} eq 'OK';
292 =head2 CanItemBeReserved
294 $canReserve = &CanItemBeReserved($borrowernumber, $itemnumber, $branchcode)
295 if ($canReserve->{status} eq 'OK') { #We can reserve this Item! }
297 @RETURNS { status => OK }, if the Item can be reserved.
298 { status => ageRestricted }, if the Item is age restricted for this borrower.
299 { status => damaged }, if the Item is damaged.
300 { status => cannotReserveFromOtherBranches }, if syspref 'canreservefromotherbranches' is OK.
301 { status => tooManyReserves, limit => $limit }, if the borrower has exceeded their maximum reserve amount.
302 { status => notReservable }, if holds on this item are not allowed
303 { status => libraryNotFound }, if given branchcode is not an existing library
304 { status => libraryNotPickupLocation }, if given branchcode is not configured to be a pickup location
305 { status => cannotBeTransferred }, if branch transfer limit applies on given item and branchcode
309 sub CanItemBeReserved {
310 my ( $borrowernumber, $itemnumber, $pickup_branchcode ) = @_;
312 my $dbh = C4::Context->dbh;
313 my $ruleitemtype; # itemtype of the matching issuing rule
314 my $allowedreserves = 0; # Total number of holds allowed across all records
315 my $holds_per_record = 1; # Total number of holds allowed for this one given record
316 my $holds_per_day; # Default to unlimited
318 # we retrieve borrowers and items informations #
319 # item->{itype} will come for biblioitems if necessery
320 my $item = Koha::Items->find($itemnumber);
321 my $biblio = $item->biblio;
322 my $patron = Koha::Patrons->find( $borrowernumber );
323 my $borrower = $patron->unblessed;
325 # If an item is damaged and we don't allow holds on damaged items, we can stop right here
326 return { status =>'damaged' }
328 && !C4::Context->preference('AllowHoldsOnDamagedItems') );
330 # Check for the age restriction
331 my ( $ageRestriction, $daysToAgeRestriction ) =
332 C4::Circulation::GetAgeRestriction( $biblio->biblioitem->agerestriction, $borrower );
333 return { status => 'ageRestricted' } if $daysToAgeRestriction && $daysToAgeRestriction > 0;
335 # Check that the patron doesn't have an item level hold on this item already
336 return { status =>'itemAlreadyOnHold' }
337 if Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->count();
339 my $controlbranch = C4::Context->preference('ReservesControlBranch');
342 SELECT count(*) AS count
344 LEFT JOIN items USING (itemnumber)
345 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
346 LEFT JOIN borrowers USING (borrowernumber)
347 WHERE borrowernumber = ?
351 my $branchfield = "reserves.branchcode";
353 if ( $controlbranch eq "ItemHomeLibrary" ) {
354 $branchfield = "items.homebranch";
355 $branchcode = $item->homebranch;
357 elsif ( $controlbranch eq "PatronLibrary" ) {
358 $branchfield = "borrowers.branchcode";
359 $branchcode = $borrower->{branchcode};
363 if ( my $rights = GetHoldRule( $borrower->{'categorycode'}, $item->effective_itemtype, $branchcode ) ) {
364 $ruleitemtype = $rights->{itemtype};
365 $allowedreserves = $rights->{reservesallowed};
366 $holds_per_record = $rights->{holds_per_record};
367 $holds_per_day = $rights->{holds_per_day};
373 my $holds = Koha::Holds->search(
375 borrowernumber => $borrowernumber,
376 biblionumber => $item->biblionumber,
377 found => undef, # Found holds don't count against a patron's holds limit
380 if ( $holds->count() >= $holds_per_record ) {
381 return { status => "tooManyHoldsForThisRecord", limit => $holds_per_record };
384 my $today_holds = Koha::Holds->search({
385 borrowernumber => $borrowernumber,
386 reservedate => dt_from_string->date
389 if ( defined $holds_per_day &&
390 ( ( $holds_per_day > 0 && $today_holds->count() >= $holds_per_day )
391 or ( $holds_per_day == 0 ) )
393 return { status => 'tooManyReservesToday', limit => $holds_per_day };
398 $querycount .= "AND ( $branchfield = ? OR $branchfield IS NULL )";
400 # If using item-level itypes, fall back to the record
401 # level itemtype if the hold has no associated item
403 C4::Context->preference('item-level_itypes')
404 ? " AND COALESCE( items.itype, biblioitems.itemtype ) = ?"
405 : " AND biblioitems.itemtype = ?"
406 if ( $ruleitemtype ne "*" );
408 my $sthcount = $dbh->prepare($querycount);
410 if ( $ruleitemtype eq "*" ) {
411 $sthcount->execute( $borrowernumber, $branchcode );
414 $sthcount->execute( $borrowernumber, $branchcode, $ruleitemtype );
417 my $reservecount = "0";
418 if ( my $rowcount = $sthcount->fetchrow_hashref() ) {
419 $reservecount = $rowcount->{count};
422 # we check if it's ok or not
423 if ( $reservecount >= $allowedreserves ) {
424 return { status => 'tooManyReserves', limit => $allowedreserves };
427 # Now we need to check hold limits by patron category
428 my $rule = Koha::CirculationRules->get_effective_rule(
430 categorycode => $borrower->{categorycode},
431 branchcode => $branchcode,
432 rule_name => 'max_holds',
435 if ( $rule && defined( $rule->rule_value ) && $rule->rule_value ne '' ) {
436 my $total_holds_count = Koha::Holds->search(
438 borrowernumber => $borrower->{borrowernumber}
442 return { status => 'tooManyReserves', limit => $rule->rule_value} if $total_holds_count >= $rule->rule_value;
445 my $reserves_control_branch =
446 GetReservesControlBranch( $item->unblessed(), $borrower );
448 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $item->itype ); # FIXME Should not be item->effective_itemtype?
450 if ( $branchitemrule->{holdallowed} == 0 ) {
451 return { status => 'notReservable' };
454 if ( $branchitemrule->{holdallowed} == 1
455 && $borrower->{branchcode} ne $item->homebranch )
457 return { status => 'cannotReserveFromOtherBranches' };
460 # If reservecount is ok, we check item branch if IndependentBranches is ON
461 # and canreservefromotherbranches is OFF
462 if ( C4::Context->preference('IndependentBranches')
463 and !C4::Context->preference('canreservefromotherbranches') )
465 if ( $item->homebranch ne $borrower->{branchcode} ) {
466 return { status => 'cannotReserveFromOtherBranches' };
470 if ($pickup_branchcode) {
471 my $destination = Koha::Libraries->find({
472 branchcode => $pickup_branchcode,
475 unless ($destination) {
476 return { status => 'libraryNotFound' };
478 unless ($destination->pickup_location) {
479 return { status => 'libraryNotPickupLocation' };
481 unless ($item->can_be_transferred({ to => $destination })) {
482 return { status => 'cannotBeTransferred' };
486 return { status => 'OK' };
489 =head2 CanReserveBeCanceledFromOpac
491 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
493 returns 1 if reserve can be cancelled by user from OPAC.
494 First check if reserve belongs to user, next checks if reserve is not in
495 transfer or waiting status
499 sub CanReserveBeCanceledFromOpac {
500 my ($reserve_id, $borrowernumber) = @_;
502 return unless $reserve_id and $borrowernumber;
503 my $reserve = Koha::Holds->find($reserve_id);
505 return 0 unless $reserve->borrowernumber == $borrowernumber;
506 return 0 if ( $reserve->found eq 'W' ) or ( $reserve->found eq 'T' );
512 =head2 GetOtherReserves
514 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
516 Check queued list of this document and check if this document must be transferred
520 sub GetOtherReserves {
521 my ($itemnumber) = @_;
524 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
525 if ($checkreserves) {
526 my $item = Koha::Items->find($itemnumber);
527 if ( $item->holdingbranch ne $checkreserves->{'branchcode'} ) {
528 $messages->{'transfert'} = $checkreserves->{'branchcode'};
529 #minus priorities of others reservs
530 ModReserveMinusPriority(
532 $checkreserves->{'reserve_id'},
535 #launch the subroutine dotransfer
536 C4::Items::ModItemTransfer(
538 $item->holdingbranch,
539 $checkreserves->{'branchcode'}
544 #step 2b : case of a reservation on the same branch, set the waiting status
546 $messages->{'waiting'} = 1;
547 ModReserveMinusPriority(
549 $checkreserves->{'reserve_id'},
551 ModReserveStatus($itemnumber,'W');
554 $nextreservinfo = $checkreserves->{'borrowernumber'};
557 return ( $messages, $nextreservinfo );
560 =head2 ChargeReserveFee
562 $fee = ChargeReserveFee( $borrowernumber, $fee, $title );
564 Charge the fee for a reserve (if $fee > 0)
568 sub ChargeReserveFee {
569 my ( $borrowernumber, $fee, $title ) = @_;
570 return if !$fee || $fee == 0; # the last test is needed to include 0.00
571 Koha::Account->new( { patron_id => $borrowernumber } )->add_debit(
574 description => $title,
576 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
577 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
578 interface => C4::Context->interface,
580 invoice_type => undef,
589 $fee = GetReserveFee( $borrowernumber, $biblionumber );
591 Calculate the fee for a reserve (if applicable).
596 my ( $borrowernumber, $biblionumber ) = @_;
598 SELECT reservefee FROM borrowers LEFT JOIN categories ON borrowers.categorycode = categories.categorycode WHERE borrowernumber = ?
601 SELECT COUNT(*) FROM items
602 LEFT JOIN issues USING (itemnumber)
603 WHERE items.biblionumber=? AND issues.issue_id IS NULL
606 SELECT COUNT(*) FROM reserves WHERE biblionumber=? AND borrowernumber<>?
609 my $dbh = C4::Context->dbh;
610 my ( $fee ) = $dbh->selectrow_array( $borquery, undef, ($borrowernumber) );
611 my $hold_fee_mode = C4::Context->preference('HoldFeeMode') || 'not_always';
612 if( $fee and $fee > 0 and $hold_fee_mode eq 'not_always' ) {
613 # This is a reconstruction of the old code:
614 # Compare number of items with items issued, and optionally check holds
615 # If not all items are issued and there are no holds: charge no fee
616 # NOTE: Lost, damaged, not-for-loan, etc. are just ignored here
617 my ( $notissued, $reserved );
618 ( $notissued ) = $dbh->selectrow_array( $issue_qry, undef,
621 ( $reserved ) = $dbh->selectrow_array( $holds_qry, undef,
622 ( $biblionumber, $borrowernumber ) );
623 $fee = 0 if $reserved == 0;
629 =head2 GetReserveStatus
631 $reservestatus = GetReserveStatus($itemnumber);
633 Takes an itemnumber and returns the status of the reserve placed on it.
634 If several reserves exist, the reserve with the lower priority is given.
638 ## FIXME: I don't think this does what it thinks it does.
639 ## It only ever checks the first reserve result, even though
640 ## multiple reserves for that bib can have the itemnumber set
641 ## the sub is only used once in the codebase.
642 sub GetReserveStatus {
643 my ($itemnumber) = @_;
645 my $dbh = C4::Context->dbh;
647 my ($sth, $found, $priority);
649 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
650 $sth->execute($itemnumber);
651 ($found, $priority) = $sth->fetchrow_array;
655 return 'Waiting' if $found eq 'W' and $priority == 0;
656 return 'Finished' if $found eq 'F';
659 return 'Reserved' if $priority > 0;
661 return ''; # empty string here will remove need for checking undef, or less log lines
666 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($itemnumber);
667 ($status, $matched_reserve, $possible_reserves) = &CheckReserves(undef, $barcode);
668 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
670 Find a book in the reserves.
672 C<$itemnumber> is the book's item number.
673 C<$lookahead> is the number of days to look in advance for future reserves.
675 As I understand it, C<&CheckReserves> looks for the given item in the
676 reserves. If it is found, that's a match, and C<$status> is set to
679 Otherwise, it finds the most important item in the reserves with the
680 same biblio number as this book (I'm not clear on this) and returns it
681 with C<$status> set to C<Reserved>.
683 C<&CheckReserves> returns a two-element list:
685 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
687 C<$reserve> is the reserve item that matched. It is a
688 reference-to-hash whose keys are mostly the fields of the reserves
689 table in the Koha database.
694 my ( $item, $barcode, $lookahead_days, $ignore_borrowers) = @_;
695 my $dbh = C4::Context->dbh;
698 if (C4::Context->preference('item-level_itypes')){
700 SELECT items.biblionumber,
701 items.biblioitemnumber,
702 itemtypes.notforloan,
703 items.notforloan AS itemnotforloan,
709 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
710 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
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 biblioitems.itemtype = itemtypes.itemtype
730 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
731 $sth->execute($item);
734 $sth = $dbh->prepare("$select WHERE barcode = ?");
735 $sth->execute($barcode);
737 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
738 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber, $damaged, $item_homebranch, $item_holdingbranch ) = $sth->fetchrow_array;
739 return if ( $damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
741 return unless $itemnumber; # bail if we got nothing.
742 # if item is not for loan it cannot be reserved either.....
743 # except where items.notforloan < 0 : This indicates the item is holdable.
744 return if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
746 # Find this item in the reserves
747 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days, $ignore_borrowers);
749 # $priority and $highest are used to find the most important item
750 # in the list returned by &_Findgroupreserve. (The lower $priority,
751 # the more important the item.)
752 # $highest is the most important item we've seen so far.
754 if (scalar @reserves) {
755 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
756 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
757 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
759 my $priority = 10000000;
760 foreach my $res (@reserves) {
761 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
762 if ($res->{'found'} eq 'W') {
763 return ( "Waiting", $res, \@reserves ); # Found it, it is waiting
765 return ( "Reserved", $res, \@reserves ); # Found determinated hold, e. g. the tranferred one
770 my $local_hold_match;
772 if ($LocalHoldsPriority) {
773 $patron = Koha::Patrons->find( $res->{borrowernumber} );
774 $item = Koha::Items->find($itemnumber);
776 my $local_holds_priority_item_branchcode =
777 $item->$LocalHoldsPriorityItemControl;
778 my $local_holds_priority_patron_branchcode =
779 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
781 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
782 ? $patron->branchcode
785 $local_holds_priority_item_branchcode eq
786 $local_holds_priority_patron_branchcode;
789 # See if this item is more important than what we've got so far
790 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
791 $item ||= Koha::Items->find($itemnumber);
792 next if $res->{itemtype} && $res->{itemtype} ne $item->effective_itemtype;
793 $patron ||= Koha::Patrons->find( $res->{borrowernumber} );
794 my $branch = GetReservesControlBranch( $item->unblessed, $patron->unblessed );
795 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$item->effective_itemtype);
796 next if ($branchitemrule->{'holdallowed'} == 0);
797 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $patron->branchcode));
798 my $hold_fulfillment_policy = $branchitemrule->{hold_fulfillment_policy};
799 next if ( ($branchitemrule->{hold_fulfillment_policy} ne 'any') && ($res->{branchcode} ne $item->$hold_fulfillment_policy) );
800 next unless $item->can_be_transferred( { to => scalar Koha::Libraries->find( $res->{branchcode} ) } );
801 $priority = $res->{'priority'};
803 last if $local_hold_match;
809 # If we get this far, then no exact match was found.
810 # We return the most important (i.e. next) reservation.
812 $highest->{'itemnumber'} = $item;
813 return ( "Reserved", $highest, \@reserves );
819 =head2 CancelExpiredReserves
821 CancelExpiredReserves();
823 Cancels all reserves with an expiration date from before today.
827 sub CancelExpiredReserves {
828 my $today = dt_from_string();
829 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
830 my $expireWaiting = C4::Context->preference('ExpireReservesMaxPickUpDelay');
832 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
833 my $params = { expirationdate => { '<', $dtf->format_date($today) } };
834 $params->{found} = undef unless $expireWaiting;
836 # FIXME To move to Koha::Holds->search_expired (?)
837 my $holds = Koha::Holds->search( $params );
839 while ( my $hold = $holds->next ) {
840 my $calendar = Koha::Calendar->new( branchcode => $hold->branchcode );
842 next if !$cancel_on_holidays && $calendar->is_holiday( $today );
844 my $cancel_params = {};
845 if ( $hold->found eq 'W' ) {
846 $cancel_params->{charge_cancel_fee} = 1;
848 $hold->cancel( $cancel_params );
852 =head2 AutoUnsuspendReserves
854 AutoUnsuspendReserves();
856 Unsuspends all suspended reserves with a suspend_until date from before today.
860 sub AutoUnsuspendReserves {
861 my $today = dt_from_string();
863 my @holds = Koha::Holds->search( { suspend_until => { '<=' => $today->ymd() } } );
865 map { $_->resume() } @holds;
870 ModReserve({ rank => $rank,
871 reserve_id => $reserve_id,
872 branchcode => $branchcode
873 [, itemnumber => $itemnumber ]
874 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
877 Change a hold request's priority or cancel it.
879 C<$rank> specifies the effect of the change. If C<$rank>
880 is 'W' or 'n', nothing happens. This corresponds to leaving a
881 request alone when changing its priority in the holds queue
884 If C<$rank> is 'del', the hold request is cancelled.
886 If C<$rank> is an integer greater than zero, the priority of
887 the request is set to that value. Since priority != 0 means
888 that the item is not waiting on the hold shelf, setting the
889 priority to a non-zero value also sets the request's found
890 status and waiting date to NULL.
892 The optional C<$itemnumber> parameter is used only when
893 C<$rank> is a non-zero integer; if supplied, the itemnumber
894 of the hold request is set accordingly; if omitted, the itemnumber
897 B<FIXME:> Note that the forgoing can have the effect of causing
898 item-level hold requests to turn into title-level requests. This
899 will be fixed once reserves has separate columns for requested
900 itemnumber and supplying itemnumber.
907 my $rank = $params->{'rank'};
908 my $reserve_id = $params->{'reserve_id'};
909 my $branchcode = $params->{'branchcode'};
910 my $itemnumber = $params->{'itemnumber'};
911 my $suspend_until = $params->{'suspend_until'};
912 my $borrowernumber = $params->{'borrowernumber'};
913 my $biblionumber = $params->{'biblionumber'};
915 return if $rank eq "W";
916 return if $rank eq "n";
918 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
921 unless ( $reserve_id ) {
922 my $holds = Koha::Holds->search({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber });
923 return unless $holds->count; # FIXME Should raise an exception
924 $hold = $holds->next;
925 $reserve_id = $hold->reserve_id;
928 $hold ||= Koha::Holds->find($reserve_id);
930 if ( $rank eq "del" ) {
933 elsif ($rank =~ /^\d+/ and $rank > 0) {
934 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, Dumper($hold->unblessed) )
935 if C4::Context->preference('HoldsLog');
940 branchcode => $branchcode,
941 itemnumber => $itemnumber,
947 if ( defined( $suspend_until ) ) {
948 if ( $suspend_until ) {
949 $suspend_until = eval { dt_from_string( $suspend_until ) };
950 $hold->suspend_hold( $suspend_until );
952 # If the hold is suspended leave the hold suspended, but convert it to an indefinite hold.
953 # If the hold is not suspended, this does nothing.
954 $hold->set( { suspend_until => undef } )->store();
958 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
962 =head2 ModReserveFill
964 &ModReserveFill($reserve);
966 Fill a reserve. If I understand this correctly, this means that the
967 reserved book has been found and given to the patron who reserved it.
969 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
970 whose keys are fields from the reserves table in the Koha database.
976 my $reserve_id = $res->{'reserve_id'};
978 my $hold = Koha::Holds->find($reserve_id);
979 # get the priority on this record....
980 my $priority = $hold->priority;
982 # update the hold statuses, no need to store it though, we will be deleting it anyway
990 # FIXME Must call Koha::Hold->cancel ? => No, should call ->filled and add the correct log
991 Koha::Old::Hold->new( $hold->unblessed() )->store();
995 if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
996 my $reserve_fee = GetReserveFee( $hold->borrowernumber, $hold->biblionumber );
997 ChargeReserveFee( $hold->borrowernumber, $reserve_fee, $hold->biblio->title );
1000 # now fix the priority on the others (if the priority wasn't
1001 # already sorted!)....
1002 unless ( $priority == 0 ) {
1003 _FixPriority( { reserve_id => $reserve_id, biblionumber => $hold->biblionumber } );
1007 =head2 ModReserveStatus
1009 &ModReserveStatus($itemnumber, $newstatus);
1011 Update the reserve status for the active (priority=0) reserve.
1013 $itemnumber is the itemnumber the reserve is on
1015 $newstatus is the new status.
1019 sub ModReserveStatus {
1021 #first : check if we have a reservation for this item .
1022 my ($itemnumber, $newstatus) = @_;
1023 my $dbh = C4::Context->dbh;
1025 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1026 my $sth_set = $dbh->prepare($query);
1027 $sth_set->execute( $newstatus, $itemnumber );
1029 my $item = Koha::Items->find($itemnumber);
1030 if ( ( $item->location eq 'CART' && $item->permanent_location ne 'CART' ) && $newstatus ) {
1031 CartToShelf( $itemnumber );
1035 =head2 ModReserveAffect
1037 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend,$reserve_id);
1039 This function affect an item and a status for a given reserve, either fetched directly
1040 by record_id, or by borrowernumber and itemnumber or biblionumber. If only biblionumber
1041 is given, only first reserve returned is affected, which is ok for anything but
1044 if $transferToDo is not set, then the status is set to "Waiting" as well.
1045 otherwise, a transfer is on the way, and the end of the transfer will
1046 take care of the waiting status
1050 sub ModReserveAffect {
1051 my ( $itemnumber, $borrowernumber, $transferToDo, $reserve_id ) = @_;
1052 my $dbh = C4::Context->dbh;
1054 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1055 # attached to $itemnumber
1056 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1057 $sth->execute($itemnumber);
1058 my ($biblionumber) = $sth->fetchrow;
1060 # get request - need to find out if item is already
1061 # waiting in order to not send duplicate hold filled notifications
1064 # Find hold by id if we have it
1065 $hold = Koha::Holds->find( $reserve_id ) if $reserve_id;
1066 # Find item level hold for this item if there is one
1067 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->next();
1068 # Find record level hold if there is no item level hold
1069 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, biblionumber => $biblionumber } )->next();
1071 return unless $hold;
1073 my $already_on_shelf = $hold->found && $hold->found eq 'W';
1075 $hold->itemnumber($itemnumber);
1076 $hold->set_waiting($transferToDo);
1078 _koha_notify_reserve( $hold->reserve_id )
1079 if ( !$transferToDo && !$already_on_shelf );
1081 _FixPriority( { biblionumber => $biblionumber } );
1082 my $item = Koha::Items->find($itemnumber);
1083 if ( ( $item->location eq 'CART' && $item->permanent_location ne 'CART' ) ) {
1084 CartToShelf( $itemnumber );
1090 =head2 ModReserveCancelAll
1092 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1094 function to cancel reserv,check other reserves, and transfer document if it's necessary
1098 sub ModReserveCancelAll {
1101 my ( $itemnumber, $borrowernumber ) = @_;
1103 #step 1 : cancel the reservation
1104 my $holds = Koha::Holds->search({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1105 return unless $holds->count;
1106 $holds->next->cancel;
1108 #step 2 launch the subroutine of the others reserves
1109 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1111 return ( $messages, $nextreservinfo );
1114 =head2 ModReserveMinusPriority
1116 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1118 Reduce the values of queued list
1122 sub ModReserveMinusPriority {
1123 my ( $itemnumber, $reserve_id ) = @_;
1125 #first step update the value of the first person on reserv
1126 my $dbh = C4::Context->dbh;
1129 SET priority = 0 , itemnumber = ?
1130 WHERE reserve_id = ?
1132 my $sth_upd = $dbh->prepare($query);
1133 $sth_upd->execute( $itemnumber, $reserve_id );
1134 # second step update all others reserves
1135 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1138 =head2 IsAvailableForItemLevelRequest
1140 my $is_available = IsAvailableForItemLevelRequest( $item_record, $borrower_record, $pickup_branchcode );
1142 Checks whether a given item record is available for an
1143 item-level hold request. An item is available if
1145 * it is not lost AND
1146 * it is not damaged AND
1147 * it is not withdrawn AND
1148 * a waiting or in transit reserve is placed on
1149 * does not have a not for loan value > 0
1151 Need to check the issuingrules onshelfholds column,
1152 if this is set items on the shelf can be placed on hold
1154 Note that IsAvailableForItemLevelRequest() does not
1155 check if the staff operator is authorized to place
1156 a request on the item - in particular,
1157 this routine does not check IndependentBranches
1158 and canreservefromotherbranches.
1162 sub IsAvailableForItemLevelRequest {
1163 my ( $item, $patron, $pickup_branchcode ) = @_;
1165 my $dbh = C4::Context->dbh;
1166 # must check the notforloan setting of the itemtype
1167 # FIXME - a lot of places in the code do this
1168 # or something similar - need to be
1170 my $itemtype = $item->effective_itemtype;
1171 my $notforloan_per_itemtype = Koha::ItemTypes->find($itemtype)->notforloan;
1174 $notforloan_per_itemtype ||
1176 $item->notforloan > 0 ||
1178 ($item->damaged && !C4::Context->preference('AllowHoldsOnDamagedItems'));
1180 my $on_shelf_holds = Koha::IssuingRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
1182 if ($pickup_branchcode) {
1183 my $destination = Koha::Libraries->find($pickup_branchcode);
1184 return 0 unless $destination;
1185 return 0 unless $destination->pickup_location;
1186 return 0 unless $item->can_be_transferred( { to => $destination } );
1189 if ( $on_shelf_holds == 1 ) {
1191 } elsif ( $on_shelf_holds == 2 ) {
1193 Koha::Items->search( { biblionumber => $item->biblionumber } );
1195 my $any_available = 0;
1197 foreach my $i (@items) {
1198 my $reserves_control_branch = GetReservesControlBranch( $i->unblessed(), $patron->unblessed );
1199 my $branchitemrule = C4::Circulation::GetBranchItemRule( $reserves_control_branch, $i->itype );
1203 || $i->notforloan > 0
1206 || IsItemOnHoldAndFound( $i->id )
1208 && !C4::Context->preference('AllowHoldsOnDamagedItems') )
1209 || Koha::ItemTypes->find( $i->effective_itemtype() )->notforloan
1210 || $branchitemrule->{holdallowed} == 1 && $patron->branchcode ne $i->homebranch;
1213 return $any_available ? 0 : 1;
1214 } else { # on_shelf_holds == 0 "If any unavailable" (the description is rather cryptic and could still be improved)
1215 return $item->onloan || IsItemOnHoldAndFound( $item->itemnumber );
1223 if (C4::Context->preference('item-level_itypes')) {
1224 # We can't trust GetItem to honour the syspref, so safest to do it ourselves
1225 # When GetItem is fixed, we can remove this
1226 $itype = $item->{itype};
1229 # XXX This is a bit dodgy. It relies on biblio itemtype column having different name.
1230 # So if we already have a biblioitems join when calling this function,
1231 # we don't need to access the database again
1232 $itype = $item->{itemtype};
1235 my $dbh = C4::Context->dbh;
1236 my $query = "SELECT itemtype FROM biblioitems WHERE biblioitemnumber = ? ";
1237 my $sth = $dbh->prepare($query);
1238 $sth->execute($item->{biblioitemnumber});
1239 if (my $data = $sth->fetchrow_hashref()){
1240 $itype = $data->{itemtype};
1246 =head2 AlterPriority
1248 AlterPriority( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority );
1250 This function changes a reserve's priority up, down, to the top, or to the bottom.
1251 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1256 my ( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority ) = @_;
1258 my $hold = Koha::Holds->find( $reserve_id );
1259 return unless $hold;
1261 if ( $hold->cancellationdate ) {
1262 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (" . $hold->cancellationdate . ')';
1266 if ( $where eq 'up' ) {
1267 return unless $prev_priority;
1268 _FixPriority({ reserve_id => $reserve_id, rank => $prev_priority })
1269 } elsif ( $where eq 'down' ) {
1270 return unless $next_priority;
1271 _FixPriority({ reserve_id => $reserve_id, rank => $next_priority })
1272 } elsif ( $where eq 'top' ) {
1273 _FixPriority({ reserve_id => $reserve_id, rank => $first_priority })
1274 } elsif ( $where eq 'bottom' ) {
1275 _FixPriority({ reserve_id => $reserve_id, rank => $last_priority });
1278 # FIXME Should return the new priority
1281 =head2 ToggleLowestPriority
1283 ToggleLowestPriority( $borrowernumber, $biblionumber );
1285 This function sets the lowestPriority field to true if is false, and false if it is true.
1289 sub ToggleLowestPriority {
1290 my ( $reserve_id ) = @_;
1292 my $dbh = C4::Context->dbh;
1294 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1295 $sth->execute( $reserve_id );
1297 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1300 =head2 ToggleSuspend
1302 ToggleSuspend( $reserve_id );
1304 This function sets the suspend field to true if is false, and false if it is true.
1305 If the reserve is currently suspended with a suspend_until date, that date will
1306 be cleared when it is unsuspended.
1311 my ( $reserve_id, $suspend_until ) = @_;
1313 $suspend_until = dt_from_string($suspend_until) if ($suspend_until);
1315 my $hold = Koha::Holds->find( $reserve_id );
1317 if ( $hold->is_suspended ) {
1320 $hold->suspend_hold( $suspend_until );
1327 borrowernumber => $borrowernumber,
1328 [ biblionumber => $biblionumber, ]
1329 [ suspend_until => $suspend_until, ]
1330 [ suspend => $suspend ]
1333 This function accepts a set of hash keys as its parameters.
1334 It requires either borrowernumber or biblionumber, or both.
1336 suspend_until is wholly optional.
1343 my $borrowernumber = $params{'borrowernumber'} || undef;
1344 my $biblionumber = $params{'biblionumber'} || undef;
1345 my $suspend_until = $params{'suspend_until'} || undef;
1346 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1348 $suspend_until = eval { dt_from_string($suspend_until) }
1349 if ( defined($suspend_until) );
1351 return unless ( $borrowernumber || $biblionumber );
1354 $params->{found} = undef;
1355 $params->{borrowernumber} = $borrowernumber if $borrowernumber;
1356 $params->{biblionumber} = $biblionumber if $biblionumber;
1358 my @holds = Koha::Holds->search($params);
1361 map { $_->suspend_hold($suspend_until) } @holds;
1364 map { $_->resume() } @holds;
1372 reserve_id => $reserve_id,
1374 [ignoreSetLowestRank => $ignoreSetLowestRank]
1379 _FixPriority({ biblionumber => $biblionumber});
1381 This routine adjusts the priority of a hold request and holds
1384 In the first form, where a reserve_id is passed, the priority of the
1385 hold is set to supplied rank, and other holds for that bib are adjusted
1386 accordingly. If the rank is "del", the hold is cancelled. If no rank
1387 is supplied, all of the holds on that bib have their priority adjusted
1388 as if the second form had been used.
1390 In the second form, where a biblionumber is passed, the holds on that
1391 bib (that are not captured) are sorted in order of increasing priority,
1392 then have reserves.priority set so that the first non-captured hold
1393 has its priority set to 1, the second non-captured hold has its priority
1394 set to 2, and so forth.
1396 In both cases, holds that have the lowestPriority flag on are have their
1397 priority adjusted to ensure that they remain at the end of the line.
1399 Note that the ignoreSetLowestRank parameter is meant to be used only
1400 when _FixPriority calls itself.
1405 my ( $params ) = @_;
1406 my $reserve_id = $params->{reserve_id};
1407 my $rank = $params->{rank} // '';
1408 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1409 my $biblionumber = $params->{biblionumber};
1411 my $dbh = C4::Context->dbh;
1414 if ( $reserve_id ) {
1415 $hold = Koha::Holds->find( $reserve_id );
1416 return unless $hold;
1419 unless ( $biblionumber ) { # FIXME This is a very weird API
1420 $biblionumber = $hold->biblionumber;
1423 if ( $rank eq "del" ) { # FIXME will crash if called without $hold
1426 elsif ( $rank eq "W" || $rank eq "0" ) {
1428 # make sure priority for waiting or in-transit items is 0
1432 WHERE reserve_id = ?
1433 AND found IN ('W', 'T')
1435 my $sth = $dbh->prepare($query);
1436 $sth->execute( $reserve_id );
1442 SELECT reserve_id, borrowernumber, reservedate
1444 WHERE biblionumber = ?
1445 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1446 ORDER BY priority ASC
1448 my $sth = $dbh->prepare($query);
1449 $sth->execute( $biblionumber );
1450 while ( my $line = $sth->fetchrow_hashref ) {
1451 push( @priority, $line );
1454 # To find the matching index
1456 my $key = -1; # to allow for 0 to be a valid result
1457 for ( $i = 0 ; $i < @priority ; $i++ ) {
1458 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1459 $key = $i; # save the index
1464 # if index exists in array then move it to new position
1465 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1466 my $new_rank = $rank -
1467 1; # $new_rank is what you want the new index to be in the array
1468 my $moving_item = splice( @priority, $key, 1 );
1469 splice( @priority, $new_rank, 0, $moving_item );
1472 # now fix the priority on those that are left....
1476 WHERE reserve_id = ?
1478 $sth = $dbh->prepare($query);
1479 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1482 $priority[$j]->{'reserve_id'}
1486 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1489 unless ( $ignoreSetLowestRank ) {
1490 while ( my $res = $sth->fetchrow_hashref() ) {
1492 reserve_id => $res->{'reserve_id'},
1494 ignoreSetLowestRank => 1
1500 =head2 _Findgroupreserve
1502 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead, $ignore_borrowers);
1504 Looks for a holds-queue based item-specific match first, then for a holds-queue title-level match, returning the
1505 first match found. If neither, then we look for non-holds-queue based holds.
1506 Lookahead is the number of days to look in advance.
1508 C<&_Findgroupreserve> returns :
1509 C<@results> is an array of references-to-hash whose keys are mostly
1510 fields from the reserves table of the Koha database, plus
1511 C<biblioitemnumber>.
1513 This routine with either return:
1514 1 - Item specific holds from the holds queue
1515 2 - Title level holds from the holds queue
1516 3 - All holds for this biblionumber
1518 All return values will respect any borrowernumbers passed as arrayref in $ignore_borrowers
1522 sub _Findgroupreserve {
1523 my ( $bibitem, $biblio, $itemnumber, $lookahead, $ignore_borrowers) = @_;
1524 my $dbh = C4::Context->dbh;
1526 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1527 # check for exact targeted match
1528 my $item_level_target_query = qq{
1529 SELECT reserves.biblionumber AS biblionumber,
1530 reserves.borrowernumber AS borrowernumber,
1531 reserves.reservedate AS reservedate,
1532 reserves.branchcode AS branchcode,
1533 reserves.cancellationdate AS cancellationdate,
1534 reserves.found AS found,
1535 reserves.reservenotes AS reservenotes,
1536 reserves.priority AS priority,
1537 reserves.timestamp AS timestamp,
1538 biblioitems.biblioitemnumber AS biblioitemnumber,
1539 reserves.itemnumber AS itemnumber,
1540 reserves.reserve_id AS reserve_id,
1541 reserves.itemtype AS itemtype
1543 JOIN biblioitems USING (biblionumber)
1544 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1547 AND item_level_request = 1
1549 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1553 my $sth = $dbh->prepare($item_level_target_query);
1554 $sth->execute($itemnumber, $lookahead||0);
1556 if ( my $data = $sth->fetchrow_hashref ) {
1557 push( @results, $data )
1558 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1560 return @results if @results;
1562 # check for title-level targeted match
1563 my $title_level_target_query = qq{
1564 SELECT reserves.biblionumber AS biblionumber,
1565 reserves.borrowernumber AS borrowernumber,
1566 reserves.reservedate AS reservedate,
1567 reserves.branchcode AS branchcode,
1568 reserves.cancellationdate AS cancellationdate,
1569 reserves.found AS found,
1570 reserves.reservenotes AS reservenotes,
1571 reserves.priority AS priority,
1572 reserves.timestamp AS timestamp,
1573 biblioitems.biblioitemnumber AS biblioitemnumber,
1574 reserves.itemnumber AS itemnumber,
1575 reserves.reserve_id AS reserve_id,
1576 reserves.itemtype AS itemtype
1578 JOIN biblioitems USING (biblionumber)
1579 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1582 AND item_level_request = 0
1583 AND hold_fill_targets.itemnumber = ?
1584 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1588 $sth = $dbh->prepare($title_level_target_query);
1589 $sth->execute($itemnumber, $lookahead||0);
1591 if ( my $data = $sth->fetchrow_hashref ) {
1592 push( @results, $data )
1593 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1595 return @results if @results;
1598 SELECT reserves.biblionumber AS biblionumber,
1599 reserves.borrowernumber AS borrowernumber,
1600 reserves.reservedate AS reservedate,
1601 reserves.waitingdate AS waitingdate,
1602 reserves.branchcode AS branchcode,
1603 reserves.cancellationdate AS cancellationdate,
1604 reserves.found AS found,
1605 reserves.reservenotes AS reservenotes,
1606 reserves.priority AS priority,
1607 reserves.timestamp AS timestamp,
1608 reserves.itemnumber AS itemnumber,
1609 reserves.reserve_id AS reserve_id,
1610 reserves.itemtype AS itemtype
1612 WHERE reserves.biblionumber = ?
1613 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1614 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1618 $sth = $dbh->prepare($query);
1619 $sth->execute( $biblio, $itemnumber, $lookahead||0);
1621 while ( my $data = $sth->fetchrow_hashref ) {
1622 push( @results, $data )
1623 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1628 =head2 _koha_notify_reserve
1630 _koha_notify_reserve( $hold->reserve_id );
1632 Sends a notification to the patron that their hold has been filled (through
1633 ModReserveAffect, _not_ ModReserveFill)
1635 The letter code for this notice may be found using the following query:
1637 select distinct letter_code
1638 from message_transports
1639 inner join message_attributes using (message_attribute_id)
1640 where message_name = 'Hold_Filled'
1642 This will probably sipmly be 'HOLD', but because it is defined in the database,
1643 it is subject to addition or change.
1645 The following tables are availalbe witin the notice:
1656 sub _koha_notify_reserve {
1657 my $reserve_id = shift;
1658 my $hold = Koha::Holds->find($reserve_id);
1659 my $borrowernumber = $hold->borrowernumber;
1661 my $patron = Koha::Patrons->find( $borrowernumber );
1663 # Try to get the borrower's email address
1664 my $to_address = $patron->notice_email_address;
1666 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
1667 borrowernumber => $borrowernumber,
1668 message_name => 'Hold_Filled'
1671 my $library = Koha::Libraries->find( $hold->branchcode )->unblessed;
1673 my $admin_email_address = $library->{branchemail} || C4::Context->preference('KohaAdminEmailAddress');
1675 my %letter_params = (
1676 module => 'reserves',
1677 branchcode => $hold->branchcode,
1678 lang => $patron->lang,
1680 'branches' => $library,
1681 'borrowers' => $patron->unblessed,
1682 'biblio' => $hold->biblionumber,
1683 'biblioitems' => $hold->biblionumber,
1684 'reserves' => $hold->unblessed,
1685 'items' => $hold->itemnumber,
1689 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.
1690 my $send_notification = sub {
1691 my ( $mtt, $letter_code ) = (@_);
1692 return unless defined $letter_code;
1693 $letter_params{letter_code} = $letter_code;
1694 $letter_params{message_transport_type} = $mtt;
1695 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
1697 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
1701 C4::Letters::EnqueueLetter( {
1703 borrowernumber => $borrowernumber,
1704 from_address => $admin_email_address,
1705 message_transport_type => $mtt,
1709 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
1711 ( $mtt eq 'email' and not $to_address ) # No email address
1712 or ( $mtt eq 'sms' and not $patron->smsalertnumber ) # No SMS number
1713 or ( $mtt eq 'phone' and C4::Context->preference('TalkingTechItivaPhoneNotification') ) # Notice is handled by TalkingTech_itiva_outbound.pl
1716 &$send_notification($mtt, $letter_code);
1717 $notification_sent++;
1719 #Making sure that a print notification is sent if no other transport types can be utilized.
1720 if (! $notification_sent) {
1721 &$send_notification('print', 'HOLD');
1726 =head2 _ShiftPriorityByDateAndPriority
1728 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
1730 This increments the priority of all reserves after the one
1731 with either the lowest date after C<$reservedate>
1732 or the lowest priority after C<$priority>.
1734 It effectively makes room for a new reserve to be inserted with a certain
1735 priority, which is returned.
1737 This is most useful when the reservedate can be set by the user. It allows
1738 the new reserve to be placed before other reserves that have a later
1739 reservedate. Since priority also is set by the form in reserves/request.pl
1740 the sub accounts for that too.
1744 sub _ShiftPriorityByDateAndPriority {
1745 my ( $biblio, $resdate, $new_priority ) = @_;
1747 my $dbh = C4::Context->dbh;
1748 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
1749 my $sth = $dbh->prepare( $query );
1750 $sth->execute( $biblio, $resdate, $new_priority );
1751 my $min_priority = $sth->fetchrow;
1752 # if no such matches are found, $new_priority remains as original value
1753 $new_priority = $min_priority if ( $min_priority );
1755 # Shift the priority up by one; works in conjunction with the next SQL statement
1756 $query = "UPDATE reserves
1757 SET priority = priority+1
1758 WHERE biblionumber = ?
1759 AND borrowernumber = ?
1762 my $sth_update = $dbh->prepare( $query );
1764 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1765 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1766 $sth = $dbh->prepare( $query );
1767 $sth->execute( $new_priority, $biblio );
1768 while ( my $row = $sth->fetchrow_hashref ) {
1769 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1772 return $new_priority; # so the caller knows what priority they wind up receiving
1777 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
1779 Use when checking out an item to handle reserves
1780 If $cancelreserve boolean is set to true, it will remove existing reserve
1785 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
1787 my $lookahead = C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1788 my ( $restype, $res, undef ) = CheckReserves( $itemnumber, undef, $lookahead );
1791 my $biblionumber = $res->{biblionumber};
1793 if ($res->{borrowernumber} == $borrowernumber) {
1794 ModReserveFill($res);
1798 # The item is reserved by someone else.
1799 # Find this item in the reserves
1801 my $borr_res = Koha::Holds->search({
1802 borrowernumber => $borrowernumber,
1803 biblionumber => $biblionumber,
1805 order_by => 'priority'
1809 # The item is reserved by the current patron
1810 ModReserveFill($borr_res->unblessed);
1813 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
1814 RevertWaitingStatus({ itemnumber => $itemnumber });
1816 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
1817 my $hold = Koha::Holds->find( $res->{reserve_id} );
1825 MergeHolds($dbh,$to_biblio, $from_biblio);
1827 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
1832 my ( $dbh, $to_biblio, $from_biblio ) = @_;
1833 my $sth = $dbh->prepare(
1834 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
1836 $sth->execute($from_biblio);
1837 if ( my $data = $sth->fetchrow_hashref() ) {
1839 # holds exist on old record, if not we don't need to do anything
1840 $sth = $dbh->prepare(
1841 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
1842 $sth->execute( $to_biblio, $from_biblio );
1845 # don't reorder those already waiting
1847 $sth = $dbh->prepare(
1848 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
1850 my $upd_sth = $dbh->prepare(
1851 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
1852 AND reservedate = ? AND (itemnumber = ? or itemnumber is NULL) "
1854 $sth->execute( $to_biblio, 'W', 'T' );
1856 while ( my $reserve = $sth->fetchrow_hashref() ) {
1858 $priority, $to_biblio,
1859 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
1860 $reserve->{'itemnumber'}
1867 =head2 RevertWaitingStatus
1869 RevertWaitingStatus({ itemnumber => $itemnumber });
1871 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
1873 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
1874 item level hold, even if it was only a bibliolevel hold to
1875 begin with. This is because we can no longer know if a hold
1876 was item-level or bib-level after a hold has been set to
1881 sub RevertWaitingStatus {
1882 my ( $params ) = @_;
1883 my $itemnumber = $params->{'itemnumber'};
1885 return unless ( $itemnumber );
1887 my $dbh = C4::Context->dbh;
1889 ## Get the waiting reserve we want to revert
1891 SELECT * FROM reserves
1892 WHERE itemnumber = ?
1893 AND found IS NOT NULL
1895 my $sth = $dbh->prepare( $query );
1896 $sth->execute( $itemnumber );
1897 my $reserve = $sth->fetchrow_hashref();
1899 ## Increment the priority of all other non-waiting
1900 ## reserves for this bib record
1904 priority = priority + 1
1910 $sth = $dbh->prepare( $query );
1911 $sth->execute( $reserve->{'biblionumber'} );
1913 ## Fix up the currently waiting reserve
1923 $sth = $dbh->prepare( $query );
1924 $sth->execute( $reserve->{'reserve_id'} );
1925 _FixPriority( { biblionumber => $reserve->{biblionumber} } );
1932 branchcode => $branchcode,
1933 borrowernumber => $borrowernumber,
1934 biblionumber => $biblionumber,
1935 [ itemnumber => $itemnumber, ]
1936 [ barcode => $barcode, ]
1940 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
1942 The letter code will be HOLD_SLIP, and the following tables are
1943 available within the slip:
1956 my $branchcode = $args->{branchcode};
1957 my $borrowernumber = $args->{borrowernumber};
1958 my $biblionumber = $args->{biblionumber};
1959 my $itemnumber = $args->{itemnumber};
1960 my $barcode = $args->{barcode};
1963 my $patron = Koha::Patrons->find($borrowernumber);
1966 if ($itemnumber || $barcode ) {
1967 $itemnumber ||= Koha::Items->find( { barcode => $barcode } )->itemnumber;
1969 $hold = Koha::Holds->search(
1971 biblionumber => $biblionumber,
1972 borrowernumber => $borrowernumber,
1973 itemnumber => $itemnumber
1978 $hold = Koha::Holds->search(
1980 biblionumber => $biblionumber,
1981 borrowernumber => $borrowernumber
1986 return unless $hold;
1987 my $reserve = $hold->unblessed;
1989 return C4::Letters::GetPreparedLetter (
1990 module => 'circulation',
1991 letter_code => 'HOLD_SLIP',
1992 branchcode => $branchcode,
1993 lang => $patron->lang,
1995 'reserves' => $reserve,
1996 'branches' => $reserve->{branchcode},
1997 'borrowers' => $reserve->{borrowernumber},
1998 'biblio' => $reserve->{biblionumber},
1999 'biblioitems' => $reserve->{biblionumber},
2000 'items' => $reserve->{itemnumber},
2005 =head2 GetReservesControlBranch
2007 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2009 Return the branchcode to be used to determine which reserves
2010 policy applies to a transaction.
2012 C<$item> is a hashref for an item. Only 'homebranch' is used.
2014 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2018 sub GetReservesControlBranch {
2019 my ( $item, $borrower ) = @_;
2021 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2024 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2025 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2031 =head2 CalculatePriority
2033 my $p = CalculatePriority($biblionumber, $resdate);
2035 Calculate priority for a new reserve on biblionumber, placing it at
2036 the end of the line of all holds whose start date falls before
2037 the current system time and that are neither on the hold shelf
2040 The reserve date parameter is optional; if it is supplied, the
2041 priority is based on the set of holds whose start date falls before
2042 the parameter value.
2044 After calculation of this priority, it is recommended to call
2045 _ShiftPriorityByDateAndPriority. Note that this is currently done in
2050 sub CalculatePriority {
2051 my ( $biblionumber, $resdate ) = @_;
2054 SELECT COUNT(*) FROM reserves
2055 WHERE biblionumber = ?
2057 AND (found IS NULL OR found = '')
2059 #skip found==W or found==T (waiting or transit holds)
2061 $sql.= ' AND ( reservedate <= ? )';
2064 $sql.= ' AND ( reservedate < NOW() )';
2066 my $dbh = C4::Context->dbh();
2067 my @row = $dbh->selectrow_array(
2070 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
2073 return @row ? $row[0]+1 : 1;
2076 =head2 IsItemOnHoldAndFound
2078 my $bool = IsItemFoundHold( $itemnumber );
2080 Returns true if the item is currently on hold
2081 and that hold has a non-null found status ( W, T, etc. )
2085 sub IsItemOnHoldAndFound {
2086 my ($itemnumber) = @_;
2088 my $rs = Koha::Database->new()->schema()->resultset('Reserve');
2090 my $found = $rs->count(
2092 itemnumber => $itemnumber,
2093 found => { '!=' => undef }
2100 =head2 GetMaxPatronHoldsForRecord
2102 my $holds_per_record = ReservesControlBranch( $borrowernumber, $biblionumber );
2104 For multiple holds on a given record for a given patron, the max
2105 number of record level holds that a patron can be placed is the highest
2106 value of the holds_per_record rule for each item if the record for that
2107 patron. This subroutine finds and returns the highest holds_per_record
2108 rule value for a given patron id and record id.
2112 sub GetMaxPatronHoldsForRecord {
2113 my ( $borrowernumber, $biblionumber ) = @_;
2115 my $patron = Koha::Patrons->find($borrowernumber);
2116 my @items = Koha::Items->search( { biblionumber => $biblionumber } );
2118 my $controlbranch = C4::Context->preference('ReservesControlBranch');
2120 my $categorycode = $patron->categorycode;
2122 $branchcode = $patron->branchcode if ( $controlbranch eq "PatronLibrary" );
2125 foreach my $item (@items) {
2126 my $itemtype = $item->effective_itemtype();
2128 $branchcode = $item->homebranch if ( $controlbranch eq "ItemHomeLibrary" );
2130 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2131 my $holds_per_record = $rule ? $rule->{holds_per_record} : 0;
2132 $max = $holds_per_record if $holds_per_record > $max;
2140 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2142 Returns the matching hold related issuingrule fields for a given
2143 patron category, itemtype, and library.
2148 my ( $categorycode, $itemtype, $branchcode ) = @_;
2150 my $dbh = C4::Context->dbh;
2152 my $sth = $dbh->prepare(
2154 SELECT categorycode, itemtype, branchcode, reservesallowed, holds_per_record, holds_per_day
2156 WHERE (categorycode in (?,'*') )
2157 AND (itemtype IN (?,'*'))
2158 AND (branchcode IN (?,'*'))
2159 ORDER BY categorycode DESC,
2165 $sth->execute( $categorycode, $itemtype, $branchcode );
2167 return $sth->fetchrow_hashref();
2172 Koha Development Team <http://koha-community.org/>