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,
379 if ( $holds->count() >= $holds_per_record ) {
380 return { status => "tooManyHoldsForThisRecord", limit => $holds_per_record };
383 my $today_holds = Koha::Holds->search({
384 borrowernumber => $borrowernumber,
385 reservedate => dt_from_string->date
388 if ( defined $holds_per_day &&
389 ( ( $holds_per_day > 0 && $today_holds->count() >= $holds_per_day )
390 or ( $holds_per_day == 0 ) )
392 return { status => 'tooManyReservesToday', limit => $holds_per_day };
397 $querycount .= "AND ( $branchfield = ? OR $branchfield IS NULL )";
399 # If using item-level itypes, fall back to the record
400 # level itemtype if the hold has no associated item
402 C4::Context->preference('item-level_itypes')
403 ? " AND COALESCE( items.itype, biblioitems.itemtype ) = ?"
404 : " AND biblioitems.itemtype = ?"
405 if ( $ruleitemtype ne "*" );
407 my $sthcount = $dbh->prepare($querycount);
409 if ( $ruleitemtype eq "*" ) {
410 $sthcount->execute( $borrowernumber, $branchcode );
413 $sthcount->execute( $borrowernumber, $branchcode, $ruleitemtype );
416 my $reservecount = "0";
417 if ( my $rowcount = $sthcount->fetchrow_hashref() ) {
418 $reservecount = $rowcount->{count};
421 # we check if it's ok or not
422 if ( $reservecount >= $allowedreserves ) {
423 return { status => 'tooManyReserves', limit => $allowedreserves };
426 # Now we need to check hold limits by patron category
427 my $rule = Koha::CirculationRules->get_effective_rule(
429 categorycode => $borrower->{categorycode},
430 branchcode => $branchcode,
431 rule_name => 'max_holds',
434 if ( $rule && defined( $rule->rule_value ) && $rule->rule_value ne '' ) {
435 my $total_holds_count = Koha::Holds->search(
437 borrowernumber => $borrower->{borrowernumber}
441 return { status => 'tooManyReserves', limit => $rule->rule_value} if $total_holds_count >= $rule->rule_value;
444 my $reserves_control_branch =
445 GetReservesControlBranch( $item->unblessed(), $borrower );
447 C4::Circulation::GetBranchItemRule( $reserves_control_branch, $item->itype ); # FIXME Should not be item->effective_itemtype?
449 if ( $branchitemrule->{holdallowed} == 0 ) {
450 return { status => 'notReservable' };
453 if ( $branchitemrule->{holdallowed} == 1
454 && $borrower->{branchcode} ne $item->homebranch )
456 return { status => 'cannotReserveFromOtherBranches' };
459 # If reservecount is ok, we check item branch if IndependentBranches is ON
460 # and canreservefromotherbranches is OFF
461 if ( C4::Context->preference('IndependentBranches')
462 and !C4::Context->preference('canreservefromotherbranches') )
464 if ( $item->homebranch ne $borrower->{branchcode} ) {
465 return { status => 'cannotReserveFromOtherBranches' };
469 if ($pickup_branchcode) {
470 my $destination = Koha::Libraries->find({
471 branchcode => $pickup_branchcode,
474 unless ($destination) {
475 return { status => 'libraryNotFound' };
477 unless ($destination->pickup_location) {
478 return { status => 'libraryNotPickupLocation' };
480 unless ($item->can_be_transferred({ to => $destination })) {
481 return { status => 'cannotBeTransferred' };
485 return { status => 'OK' };
488 =head2 CanReserveBeCanceledFromOpac
490 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
492 returns 1 if reserve can be cancelled by user from OPAC.
493 First check if reserve belongs to user, next checks if reserve is not in
494 transfer or waiting status
498 sub CanReserveBeCanceledFromOpac {
499 my ($reserve_id, $borrowernumber) = @_;
501 return unless $reserve_id and $borrowernumber;
502 my $reserve = Koha::Holds->find($reserve_id);
504 return 0 unless $reserve->borrowernumber == $borrowernumber;
505 return 0 if ( $reserve->found eq 'W' ) or ( $reserve->found eq 'T' );
511 =head2 GetOtherReserves
513 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
515 Check queued list of this document and check if this document must be transferred
519 sub GetOtherReserves {
520 my ($itemnumber) = @_;
523 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
524 if ($checkreserves) {
525 my $item = Koha::Items->find($itemnumber);
526 if ( $item->holdingbranch ne $checkreserves->{'branchcode'} ) {
527 $messages->{'transfert'} = $checkreserves->{'branchcode'};
528 #minus priorities of others reservs
529 ModReserveMinusPriority(
531 $checkreserves->{'reserve_id'},
534 #launch the subroutine dotransfer
535 C4::Items::ModItemTransfer(
537 $item->holdingbranch,
538 $checkreserves->{'branchcode'}
543 #step 2b : case of a reservation on the same branch, set the waiting status
545 $messages->{'waiting'} = 1;
546 ModReserveMinusPriority(
548 $checkreserves->{'reserve_id'},
550 ModReserveStatus($itemnumber,'W');
553 $nextreservinfo = $checkreserves->{'borrowernumber'};
556 return ( $messages, $nextreservinfo );
559 =head2 ChargeReserveFee
561 $fee = ChargeReserveFee( $borrowernumber, $fee, $title );
563 Charge the fee for a reserve (if $fee > 0)
567 sub ChargeReserveFee {
568 my ( $borrowernumber, $fee, $title ) = @_;
569 return if !$fee || $fee == 0; # the last test is needed to include 0.00
570 Koha::Account->new( { patron_id => $borrowernumber } )->add_debit(
573 description => $title,
575 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
576 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
577 interface => C4::Context->interface,
579 invoice_type => undef,
588 $fee = GetReserveFee( $borrowernumber, $biblionumber );
590 Calculate the fee for a reserve (if applicable).
595 my ( $borrowernumber, $biblionumber ) = @_;
597 SELECT reservefee FROM borrowers LEFT JOIN categories ON borrowers.categorycode = categories.categorycode WHERE borrowernumber = ?
600 SELECT COUNT(*) FROM items
601 LEFT JOIN issues USING (itemnumber)
602 WHERE items.biblionumber=? AND issues.issue_id IS NULL
605 SELECT COUNT(*) FROM reserves WHERE biblionumber=? AND borrowernumber<>?
608 my $dbh = C4::Context->dbh;
609 my ( $fee ) = $dbh->selectrow_array( $borquery, undef, ($borrowernumber) );
610 my $hold_fee_mode = C4::Context->preference('HoldFeeMode') || 'not_always';
611 if( $fee and $fee > 0 and $hold_fee_mode eq 'not_always' ) {
612 # This is a reconstruction of the old code:
613 # Compare number of items with items issued, and optionally check holds
614 # If not all items are issued and there are no holds: charge no fee
615 # NOTE: Lost, damaged, not-for-loan, etc. are just ignored here
616 my ( $notissued, $reserved );
617 ( $notissued ) = $dbh->selectrow_array( $issue_qry, undef,
620 ( $reserved ) = $dbh->selectrow_array( $holds_qry, undef,
621 ( $biblionumber, $borrowernumber ) );
622 $fee = 0 if $reserved == 0;
628 =head2 GetReserveStatus
630 $reservestatus = GetReserveStatus($itemnumber);
632 Takes an itemnumber and returns the status of the reserve placed on it.
633 If several reserves exist, the reserve with the lower priority is given.
637 ## FIXME: I don't think this does what it thinks it does.
638 ## It only ever checks the first reserve result, even though
639 ## multiple reserves for that bib can have the itemnumber set
640 ## the sub is only used once in the codebase.
641 sub GetReserveStatus {
642 my ($itemnumber) = @_;
644 my $dbh = C4::Context->dbh;
646 my ($sth, $found, $priority);
648 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
649 $sth->execute($itemnumber);
650 ($found, $priority) = $sth->fetchrow_array;
654 return 'Waiting' if $found eq 'W' and $priority == 0;
655 return 'Finished' if $found eq 'F';
658 return 'Reserved' if $priority > 0;
660 return ''; # empty string here will remove need for checking undef, or less log lines
665 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($itemnumber);
666 ($status, $matched_reserve, $possible_reserves) = &CheckReserves(undef, $barcode);
667 ($status, $matched_reserve, $possible_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
669 Find a book in the reserves.
671 C<$itemnumber> is the book's item number.
672 C<$lookahead> is the number of days to look in advance for future reserves.
674 As I understand it, C<&CheckReserves> looks for the given item in the
675 reserves. If it is found, that's a match, and C<$status> is set to
678 Otherwise, it finds the most important item in the reserves with the
679 same biblio number as this book (I'm not clear on this) and returns it
680 with C<$status> set to C<Reserved>.
682 C<&CheckReserves> returns a two-element list:
684 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
686 C<$reserve> is the reserve item that matched. It is a
687 reference-to-hash whose keys are mostly the fields of the reserves
688 table in the Koha database.
693 my ( $item, $barcode, $lookahead_days, $ignore_borrowers) = @_;
694 my $dbh = C4::Context->dbh;
697 if (C4::Context->preference('item-level_itypes')){
699 SELECT items.biblionumber,
700 items.biblioitemnumber,
701 itemtypes.notforloan,
702 items.notforloan AS itemnotforloan,
708 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
709 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
714 SELECT items.biblionumber,
715 items.biblioitemnumber,
716 itemtypes.notforloan,
717 items.notforloan AS itemnotforloan,
723 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
724 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
729 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
730 $sth->execute($item);
733 $sth = $dbh->prepare("$select WHERE barcode = ?");
734 $sth->execute($barcode);
736 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
737 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber, $damaged, $item_homebranch, $item_holdingbranch ) = $sth->fetchrow_array;
738 return if ( $damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
740 return unless $itemnumber; # bail if we got nothing.
741 # if item is not for loan it cannot be reserved either.....
742 # except where items.notforloan < 0 : This indicates the item is holdable.
743 return if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
745 # Find this item in the reserves
746 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days, $ignore_borrowers);
748 # $priority and $highest are used to find the most important item
749 # in the list returned by &_Findgroupreserve. (The lower $priority,
750 # the more important the item.)
751 # $highest is the most important item we've seen so far.
753 if (scalar @reserves) {
754 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
755 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
756 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
758 my $priority = 10000000;
759 foreach my $res (@reserves) {
760 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
761 if ($res->{'found'} eq 'W') {
762 return ( "Waiting", $res, \@reserves ); # Found it, it is waiting
764 return ( "Reserved", $res, \@reserves ); # Found determinated hold, e. g. the tranferred one
769 my $local_hold_match;
771 if ($LocalHoldsPriority) {
772 $patron = Koha::Patrons->find( $res->{borrowernumber} );
773 $item = Koha::Items->find($itemnumber);
775 my $local_holds_priority_item_branchcode =
776 $item->$LocalHoldsPriorityItemControl;
777 my $local_holds_priority_patron_branchcode =
778 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
780 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
781 ? $patron->branchcode
784 $local_holds_priority_item_branchcode eq
785 $local_holds_priority_patron_branchcode;
788 # See if this item is more important than what we've got so far
789 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
790 $item ||= Koha::Items->find($itemnumber);
791 next if $res->{itemtype} && $res->{itemtype} ne $item->effective_itemtype;
792 $patron ||= Koha::Patrons->find( $res->{borrowernumber} );
793 my $branch = GetReservesControlBranch( $item->unblessed, $patron->unblessed );
794 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$item->effective_itemtype);
795 next if ($branchitemrule->{'holdallowed'} == 0);
796 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $patron->branchcode));
797 my $hold_fulfillment_policy = $branchitemrule->{hold_fulfillment_policy};
799 if $hold_fulfillment_policy ne 'any'
801 $hold_fulfillment_policy eq ''
802 || ( $res->{branchcode} ne
803 $item->$hold_fulfillment_policy )
805 next unless $item->can_be_transferred( { to => scalar Koha::Libraries->find( $res->{branchcode} ) } );
806 $priority = $res->{'priority'};
808 last if $local_hold_match;
814 # If we get this far, then no exact match was found.
815 # We return the most important (i.e. next) reservation.
817 $highest->{'itemnumber'} = $item;
818 return ( "Reserved", $highest, \@reserves );
824 =head2 CancelExpiredReserves
826 CancelExpiredReserves();
828 Cancels all reserves with an expiration date from before today.
832 sub CancelExpiredReserves {
833 my $today = dt_from_string();
834 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
835 my $expireWaiting = C4::Context->preference('ExpireReservesMaxPickUpDelay');
837 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
838 my $params = { expirationdate => { '<', $dtf->format_date($today) } };
839 $params->{found} = undef unless $expireWaiting;
841 # FIXME To move to Koha::Holds->search_expired (?)
842 my $holds = Koha::Holds->search( $params );
844 while ( my $hold = $holds->next ) {
845 my $calendar = Koha::Calendar->new( branchcode => $hold->branchcode );
847 next if !$cancel_on_holidays && $calendar->is_holiday( $today );
849 my $cancel_params = {};
850 if ( $hold->found eq 'W' ) {
851 $cancel_params->{charge_cancel_fee} = 1;
853 $hold->cancel( $cancel_params );
857 =head2 AutoUnsuspendReserves
859 AutoUnsuspendReserves();
861 Unsuspends all suspended reserves with a suspend_until date from before today.
865 sub AutoUnsuspendReserves {
866 my $today = dt_from_string();
868 my @holds = Koha::Holds->search( { suspend_until => { '<=' => $today->ymd() } } );
870 map { $_->resume() } @holds;
875 ModReserve({ rank => $rank,
876 reserve_id => $reserve_id,
877 branchcode => $branchcode
878 [, itemnumber => $itemnumber ]
879 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
882 Change a hold request's priority or cancel it.
884 C<$rank> specifies the effect of the change. If C<$rank>
885 is 'W' or 'n', nothing happens. This corresponds to leaving a
886 request alone when changing its priority in the holds queue
889 If C<$rank> is 'del', the hold request is cancelled.
891 If C<$rank> is an integer greater than zero, the priority of
892 the request is set to that value. Since priority != 0 means
893 that the item is not waiting on the hold shelf, setting the
894 priority to a non-zero value also sets the request's found
895 status and waiting date to NULL.
897 The optional C<$itemnumber> parameter is used only when
898 C<$rank> is a non-zero integer; if supplied, the itemnumber
899 of the hold request is set accordingly; if omitted, the itemnumber
902 B<FIXME:> Note that the forgoing can have the effect of causing
903 item-level hold requests to turn into title-level requests. This
904 will be fixed once reserves has separate columns for requested
905 itemnumber and supplying itemnumber.
912 my $rank = $params->{'rank'};
913 my $reserve_id = $params->{'reserve_id'};
914 my $branchcode = $params->{'branchcode'};
915 my $itemnumber = $params->{'itemnumber'};
916 my $suspend_until = $params->{'suspend_until'};
917 my $borrowernumber = $params->{'borrowernumber'};
918 my $biblionumber = $params->{'biblionumber'};
920 return if $rank eq "W";
921 return if $rank eq "n";
923 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
926 unless ( $reserve_id ) {
927 my $holds = Koha::Holds->search({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber });
928 return unless $holds->count; # FIXME Should raise an exception
929 $hold = $holds->next;
930 $reserve_id = $hold->reserve_id;
933 $hold ||= Koha::Holds->find($reserve_id);
935 if ( $rank eq "del" ) {
938 elsif ($rank =~ /^\d+/ and $rank > 0) {
939 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, Dumper($hold->unblessed) )
940 if C4::Context->preference('HoldsLog');
945 branchcode => $branchcode,
946 itemnumber => $itemnumber,
952 if ( defined( $suspend_until ) ) {
953 if ( $suspend_until ) {
954 $suspend_until = eval { dt_from_string( $suspend_until ) };
955 $hold->suspend_hold( $suspend_until );
957 # If the hold is suspended leave the hold suspended, but convert it to an indefinite hold.
958 # If the hold is not suspended, this does nothing.
959 $hold->set( { suspend_until => undef } )->store();
963 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
967 =head2 ModReserveFill
969 &ModReserveFill($reserve);
971 Fill a reserve. If I understand this correctly, this means that the
972 reserved book has been found and given to the patron who reserved it.
974 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
975 whose keys are fields from the reserves table in the Koha database.
981 my $reserve_id = $res->{'reserve_id'};
983 my $hold = Koha::Holds->find($reserve_id);
984 # get the priority on this record....
985 my $priority = $hold->priority;
987 # update the hold statuses, no need to store it though, we will be deleting it anyway
995 # FIXME Must call Koha::Hold->cancel ? => No, should call ->filled and add the correct log
996 Koha::Old::Hold->new( $hold->unblessed() )->store();
1000 if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
1001 my $reserve_fee = GetReserveFee( $hold->borrowernumber, $hold->biblionumber );
1002 ChargeReserveFee( $hold->borrowernumber, $reserve_fee, $hold->biblio->title );
1005 # now fix the priority on the others (if the priority wasn't
1006 # already sorted!)....
1007 unless ( $priority == 0 ) {
1008 _FixPriority( { reserve_id => $reserve_id, biblionumber => $hold->biblionumber } );
1012 =head2 ModReserveStatus
1014 &ModReserveStatus($itemnumber, $newstatus);
1016 Update the reserve status for the active (priority=0) reserve.
1018 $itemnumber is the itemnumber the reserve is on
1020 $newstatus is the new status.
1024 sub ModReserveStatus {
1026 #first : check if we have a reservation for this item .
1027 my ($itemnumber, $newstatus) = @_;
1028 my $dbh = C4::Context->dbh;
1030 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1031 my $sth_set = $dbh->prepare($query);
1032 $sth_set->execute( $newstatus, $itemnumber );
1034 my $item = Koha::Items->find($itemnumber);
1035 if ( ( $item->location eq 'CART' && $item->permanent_location ne 'CART' ) && $newstatus ) {
1036 CartToShelf( $itemnumber );
1040 =head2 ModReserveAffect
1042 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend,$reserve_id);
1044 This function affect an item and a status for a given reserve, either fetched directly
1045 by record_id, or by borrowernumber and itemnumber or biblionumber. If only biblionumber
1046 is given, only first reserve returned is affected, which is ok for anything but
1049 if $transferToDo is not set, then the status is set to "Waiting" as well.
1050 otherwise, a transfer is on the way, and the end of the transfer will
1051 take care of the waiting status
1055 sub ModReserveAffect {
1056 my ( $itemnumber, $borrowernumber, $transferToDo, $reserve_id ) = @_;
1057 my $dbh = C4::Context->dbh;
1059 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1060 # attached to $itemnumber
1061 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1062 $sth->execute($itemnumber);
1063 my ($biblionumber) = $sth->fetchrow;
1065 # get request - need to find out if item is already
1066 # waiting in order to not send duplicate hold filled notifications
1069 # Find hold by id if we have it
1070 $hold = Koha::Holds->find( $reserve_id ) if $reserve_id;
1071 # Find item level hold for this item if there is one
1072 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->next();
1073 # Find record level hold if there is no item level hold
1074 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, biblionumber => $biblionumber } )->next();
1076 return unless $hold;
1078 my $already_on_shelf = $hold->found && $hold->found eq 'W';
1080 $hold->itemnumber($itemnumber);
1081 $hold->set_waiting($transferToDo);
1083 _koha_notify_reserve( $hold->reserve_id )
1084 if ( !$transferToDo && !$already_on_shelf );
1086 _FixPriority( { biblionumber => $biblionumber } );
1087 my $item = Koha::Items->find($itemnumber);
1088 if ( ( $item->location eq 'CART' && $item->permanent_location ne 'CART' ) ) {
1089 CartToShelf( $itemnumber );
1095 =head2 ModReserveCancelAll
1097 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1099 function to cancel reserv,check other reserves, and transfer document if it's necessary
1103 sub ModReserveCancelAll {
1106 my ( $itemnumber, $borrowernumber ) = @_;
1108 #step 1 : cancel the reservation
1109 my $holds = Koha::Holds->search({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1110 return unless $holds->count;
1111 $holds->next->cancel;
1113 #step 2 launch the subroutine of the others reserves
1114 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1116 return ( $messages, $nextreservinfo );
1119 =head2 ModReserveMinusPriority
1121 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1123 Reduce the values of queued list
1127 sub ModReserveMinusPriority {
1128 my ( $itemnumber, $reserve_id ) = @_;
1130 #first step update the value of the first person on reserv
1131 my $dbh = C4::Context->dbh;
1134 SET priority = 0 , itemnumber = ?
1135 WHERE reserve_id = ?
1137 my $sth_upd = $dbh->prepare($query);
1138 $sth_upd->execute( $itemnumber, $reserve_id );
1139 # second step update all others reserves
1140 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1143 =head2 IsAvailableForItemLevelRequest
1145 my $is_available = IsAvailableForItemLevelRequest( $item_record, $borrower_record, $pickup_branchcode );
1147 Checks whether a given item record is available for an
1148 item-level hold request. An item is available if
1150 * it is not lost AND
1151 * it is not damaged AND
1152 * it is not withdrawn AND
1153 * a waiting or in transit reserve is placed on
1154 * does not have a not for loan value > 0
1156 Need to check the issuingrules onshelfholds column,
1157 if this is set items on the shelf can be placed on hold
1159 Note that IsAvailableForItemLevelRequest() does not
1160 check if the staff operator is authorized to place
1161 a request on the item - in particular,
1162 this routine does not check IndependentBranches
1163 and canreservefromotherbranches.
1167 sub IsAvailableForItemLevelRequest {
1168 my ( $item, $patron, $pickup_branchcode ) = @_;
1170 my $dbh = C4::Context->dbh;
1171 # must check the notforloan setting of the itemtype
1172 # FIXME - a lot of places in the code do this
1173 # or something similar - need to be
1175 my $itemtype = $item->effective_itemtype;
1176 my $notforloan_per_itemtype = Koha::ItemTypes->find($itemtype)->notforloan;
1179 $notforloan_per_itemtype ||
1181 $item->notforloan > 0 ||
1183 ($item->damaged && !C4::Context->preference('AllowHoldsOnDamagedItems'));
1185 my $on_shelf_holds = Koha::IssuingRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
1187 if ($pickup_branchcode) {
1188 my $destination = Koha::Libraries->find($pickup_branchcode);
1189 return 0 unless $destination;
1190 return 0 unless $destination->pickup_location;
1191 return 0 unless $item->can_be_transferred( { to => $destination } );
1194 if ( $on_shelf_holds == 1 ) {
1196 } elsif ( $on_shelf_holds == 2 ) {
1198 Koha::Items->search( { biblionumber => $item->biblionumber } );
1200 my $any_available = 0;
1202 foreach my $i (@items) {
1203 my $reserves_control_branch = GetReservesControlBranch( $i->unblessed(), $patron->unblessed );
1204 my $branchitemrule = C4::Circulation::GetBranchItemRule( $reserves_control_branch, $i->itype );
1208 || $i->notforloan > 0
1211 || IsItemOnHoldAndFound( $i->id )
1213 && !C4::Context->preference('AllowHoldsOnDamagedItems') )
1214 || Koha::ItemTypes->find( $i->effective_itemtype() )->notforloan
1215 || $branchitemrule->{holdallowed} == 1 && $patron->branchcode ne $i->homebranch;
1218 return $any_available ? 0 : 1;
1219 } else { # on_shelf_holds == 0 "If any unavailable" (the description is rather cryptic and could still be improved)
1220 return $item->onloan || IsItemOnHoldAndFound( $item->itemnumber );
1228 if (C4::Context->preference('item-level_itypes')) {
1229 # We can't trust GetItem to honour the syspref, so safest to do it ourselves
1230 # When GetItem is fixed, we can remove this
1231 $itype = $item->{itype};
1234 # XXX This is a bit dodgy. It relies on biblio itemtype column having different name.
1235 # So if we already have a biblioitems join when calling this function,
1236 # we don't need to access the database again
1237 $itype = $item->{itemtype};
1240 my $dbh = C4::Context->dbh;
1241 my $query = "SELECT itemtype FROM biblioitems WHERE biblioitemnumber = ? ";
1242 my $sth = $dbh->prepare($query);
1243 $sth->execute($item->{biblioitemnumber});
1244 if (my $data = $sth->fetchrow_hashref()){
1245 $itype = $data->{itemtype};
1251 =head2 AlterPriority
1253 AlterPriority( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority );
1255 This function changes a reserve's priority up, down, to the top, or to the bottom.
1256 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1261 my ( $where, $reserve_id, $prev_priority, $next_priority, $first_priority, $last_priority ) = @_;
1263 my $hold = Koha::Holds->find( $reserve_id );
1264 return unless $hold;
1266 if ( $hold->cancellationdate ) {
1267 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (" . $hold->cancellationdate . ')';
1271 if ( $where eq 'up' ) {
1272 return unless $prev_priority;
1273 _FixPriority({ reserve_id => $reserve_id, rank => $prev_priority })
1274 } elsif ( $where eq 'down' ) {
1275 return unless $next_priority;
1276 _FixPriority({ reserve_id => $reserve_id, rank => $next_priority })
1277 } elsif ( $where eq 'top' ) {
1278 _FixPriority({ reserve_id => $reserve_id, rank => $first_priority })
1279 } elsif ( $where eq 'bottom' ) {
1280 _FixPriority({ reserve_id => $reserve_id, rank => $last_priority });
1283 # FIXME Should return the new priority
1286 =head2 ToggleLowestPriority
1288 ToggleLowestPriority( $borrowernumber, $biblionumber );
1290 This function sets the lowestPriority field to true if is false, and false if it is true.
1294 sub ToggleLowestPriority {
1295 my ( $reserve_id ) = @_;
1297 my $dbh = C4::Context->dbh;
1299 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1300 $sth->execute( $reserve_id );
1302 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1305 =head2 ToggleSuspend
1307 ToggleSuspend( $reserve_id );
1309 This function sets the suspend field to true if is false, and false if it is true.
1310 If the reserve is currently suspended with a suspend_until date, that date will
1311 be cleared when it is unsuspended.
1316 my ( $reserve_id, $suspend_until ) = @_;
1318 $suspend_until = dt_from_string($suspend_until) if ($suspend_until);
1320 my $hold = Koha::Holds->find( $reserve_id );
1322 if ( $hold->is_suspended ) {
1325 $hold->suspend_hold( $suspend_until );
1332 borrowernumber => $borrowernumber,
1333 [ biblionumber => $biblionumber, ]
1334 [ suspend_until => $suspend_until, ]
1335 [ suspend => $suspend ]
1338 This function accepts a set of hash keys as its parameters.
1339 It requires either borrowernumber or biblionumber, or both.
1341 suspend_until is wholly optional.
1348 my $borrowernumber = $params{'borrowernumber'} || undef;
1349 my $biblionumber = $params{'biblionumber'} || undef;
1350 my $suspend_until = $params{'suspend_until'} || undef;
1351 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1353 $suspend_until = eval { dt_from_string($suspend_until) }
1354 if ( defined($suspend_until) );
1356 return unless ( $borrowernumber || $biblionumber );
1359 $params->{found} = undef;
1360 $params->{borrowernumber} = $borrowernumber if $borrowernumber;
1361 $params->{biblionumber} = $biblionumber if $biblionumber;
1363 my @holds = Koha::Holds->search($params);
1366 map { $_->suspend_hold($suspend_until) } @holds;
1369 map { $_->resume() } @holds;
1377 reserve_id => $reserve_id,
1379 [ignoreSetLowestRank => $ignoreSetLowestRank]
1384 _FixPriority({ biblionumber => $biblionumber});
1386 This routine adjusts the priority of a hold request and holds
1389 In the first form, where a reserve_id is passed, the priority of the
1390 hold is set to supplied rank, and other holds for that bib are adjusted
1391 accordingly. If the rank is "del", the hold is cancelled. If no rank
1392 is supplied, all of the holds on that bib have their priority adjusted
1393 as if the second form had been used.
1395 In the second form, where a biblionumber is passed, the holds on that
1396 bib (that are not captured) are sorted in order of increasing priority,
1397 then have reserves.priority set so that the first non-captured hold
1398 has its priority set to 1, the second non-captured hold has its priority
1399 set to 2, and so forth.
1401 In both cases, holds that have the lowestPriority flag on are have their
1402 priority adjusted to ensure that they remain at the end of the line.
1404 Note that the ignoreSetLowestRank parameter is meant to be used only
1405 when _FixPriority calls itself.
1410 my ( $params ) = @_;
1411 my $reserve_id = $params->{reserve_id};
1412 my $rank = $params->{rank} // '';
1413 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1414 my $biblionumber = $params->{biblionumber};
1416 my $dbh = C4::Context->dbh;
1419 if ( $reserve_id ) {
1420 $hold = Koha::Holds->find( $reserve_id );
1421 return unless $hold;
1424 unless ( $biblionumber ) { # FIXME This is a very weird API
1425 $biblionumber = $hold->biblionumber;
1428 if ( $rank eq "del" ) { # FIXME will crash if called without $hold
1431 elsif ( $rank eq "W" || $rank eq "0" ) {
1433 # make sure priority for waiting or in-transit items is 0
1437 WHERE reserve_id = ?
1438 AND found IN ('W', 'T')
1440 my $sth = $dbh->prepare($query);
1441 $sth->execute( $reserve_id );
1447 SELECT reserve_id, borrowernumber, reservedate
1449 WHERE biblionumber = ?
1450 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1451 ORDER BY priority ASC
1453 my $sth = $dbh->prepare($query);
1454 $sth->execute( $biblionumber );
1455 while ( my $line = $sth->fetchrow_hashref ) {
1456 push( @priority, $line );
1459 # To find the matching index
1461 my $key = -1; # to allow for 0 to be a valid result
1462 for ( $i = 0 ; $i < @priority ; $i++ ) {
1463 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1464 $key = $i; # save the index
1469 # if index exists in array then move it to new position
1470 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1471 my $new_rank = $rank -
1472 1; # $new_rank is what you want the new index to be in the array
1473 my $moving_item = splice( @priority, $key, 1 );
1474 splice( @priority, $new_rank, 0, $moving_item );
1477 # now fix the priority on those that are left....
1481 WHERE reserve_id = ?
1483 $sth = $dbh->prepare($query);
1484 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1487 $priority[$j]->{'reserve_id'}
1491 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1494 unless ( $ignoreSetLowestRank ) {
1495 while ( my $res = $sth->fetchrow_hashref() ) {
1497 reserve_id => $res->{'reserve_id'},
1499 ignoreSetLowestRank => 1
1505 =head2 _Findgroupreserve
1507 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead, $ignore_borrowers);
1509 Looks for a holds-queue based item-specific match first, then for a holds-queue title-level match, returning the
1510 first match found. If neither, then we look for non-holds-queue based holds.
1511 Lookahead is the number of days to look in advance.
1513 C<&_Findgroupreserve> returns :
1514 C<@results> is an array of references-to-hash whose keys are mostly
1515 fields from the reserves table of the Koha database, plus
1516 C<biblioitemnumber>.
1518 This routine with either return:
1519 1 - Item specific holds from the holds queue
1520 2 - Title level holds from the holds queue
1521 3 - All holds for this biblionumber
1523 All return values will respect any borrowernumbers passed as arrayref in $ignore_borrowers
1527 sub _Findgroupreserve {
1528 my ( $bibitem, $biblio, $itemnumber, $lookahead, $ignore_borrowers) = @_;
1529 my $dbh = C4::Context->dbh;
1531 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1532 # check for exact targeted match
1533 my $item_level_target_query = qq{
1534 SELECT reserves.biblionumber AS biblionumber,
1535 reserves.borrowernumber AS borrowernumber,
1536 reserves.reservedate AS reservedate,
1537 reserves.branchcode AS branchcode,
1538 reserves.cancellationdate AS cancellationdate,
1539 reserves.found AS found,
1540 reserves.reservenotes AS reservenotes,
1541 reserves.priority AS priority,
1542 reserves.timestamp AS timestamp,
1543 biblioitems.biblioitemnumber AS biblioitemnumber,
1544 reserves.itemnumber AS itemnumber,
1545 reserves.reserve_id AS reserve_id,
1546 reserves.itemtype AS itemtype
1548 JOIN biblioitems USING (biblionumber)
1549 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1552 AND item_level_request = 1
1554 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1558 my $sth = $dbh->prepare($item_level_target_query);
1559 $sth->execute($itemnumber, $lookahead||0);
1561 if ( my $data = $sth->fetchrow_hashref ) {
1562 push( @results, $data )
1563 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1565 return @results if @results;
1567 # check for title-level targeted match
1568 my $title_level_target_query = qq{
1569 SELECT reserves.biblionumber AS biblionumber,
1570 reserves.borrowernumber AS borrowernumber,
1571 reserves.reservedate AS reservedate,
1572 reserves.branchcode AS branchcode,
1573 reserves.cancellationdate AS cancellationdate,
1574 reserves.found AS found,
1575 reserves.reservenotes AS reservenotes,
1576 reserves.priority AS priority,
1577 reserves.timestamp AS timestamp,
1578 biblioitems.biblioitemnumber AS biblioitemnumber,
1579 reserves.itemnumber AS itemnumber,
1580 reserves.reserve_id AS reserve_id,
1581 reserves.itemtype AS itemtype
1583 JOIN biblioitems USING (biblionumber)
1584 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1587 AND item_level_request = 0
1588 AND hold_fill_targets.itemnumber = ?
1589 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1593 $sth = $dbh->prepare($title_level_target_query);
1594 $sth->execute($itemnumber, $lookahead||0);
1596 if ( my $data = $sth->fetchrow_hashref ) {
1597 push( @results, $data )
1598 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1600 return @results if @results;
1603 SELECT reserves.biblionumber AS biblionumber,
1604 reserves.borrowernumber AS borrowernumber,
1605 reserves.reservedate AS reservedate,
1606 reserves.waitingdate AS waitingdate,
1607 reserves.branchcode AS branchcode,
1608 reserves.cancellationdate AS cancellationdate,
1609 reserves.found AS found,
1610 reserves.reservenotes AS reservenotes,
1611 reserves.priority AS priority,
1612 reserves.timestamp AS timestamp,
1613 reserves.itemnumber AS itemnumber,
1614 reserves.reserve_id AS reserve_id,
1615 reserves.itemtype AS itemtype
1617 WHERE reserves.biblionumber = ?
1618 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1619 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1623 $sth = $dbh->prepare($query);
1624 $sth->execute( $biblio, $itemnumber, $lookahead||0);
1626 while ( my $data = $sth->fetchrow_hashref ) {
1627 push( @results, $data )
1628 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1633 =head2 _koha_notify_reserve
1635 _koha_notify_reserve( $hold->reserve_id );
1637 Sends a notification to the patron that their hold has been filled (through
1638 ModReserveAffect, _not_ ModReserveFill)
1640 The letter code for this notice may be found using the following query:
1642 select distinct letter_code
1643 from message_transports
1644 inner join message_attributes using (message_attribute_id)
1645 where message_name = 'Hold_Filled'
1647 This will probably sipmly be 'HOLD', but because it is defined in the database,
1648 it is subject to addition or change.
1650 The following tables are availalbe witin the notice:
1661 sub _koha_notify_reserve {
1662 my $reserve_id = shift;
1663 my $hold = Koha::Holds->find($reserve_id);
1664 my $borrowernumber = $hold->borrowernumber;
1666 my $patron = Koha::Patrons->find( $borrowernumber );
1668 # Try to get the borrower's email address
1669 my $to_address = $patron->notice_email_address;
1671 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
1672 borrowernumber => $borrowernumber,
1673 message_name => 'Hold_Filled'
1676 my $library = Koha::Libraries->find( $hold->branchcode )->unblessed;
1678 my $admin_email_address = $library->{branchemail} || C4::Context->preference('KohaAdminEmailAddress');
1680 my %letter_params = (
1681 module => 'reserves',
1682 branchcode => $hold->branchcode,
1683 lang => $patron->lang,
1685 'branches' => $library,
1686 'borrowers' => $patron->unblessed,
1687 'biblio' => $hold->biblionumber,
1688 'biblioitems' => $hold->biblionumber,
1689 'reserves' => $hold->unblessed,
1690 'items' => $hold->itemnumber,
1694 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.
1695 my $send_notification = sub {
1696 my ( $mtt, $letter_code ) = (@_);
1697 return unless defined $letter_code;
1698 $letter_params{letter_code} = $letter_code;
1699 $letter_params{message_transport_type} = $mtt;
1700 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
1702 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
1706 C4::Letters::EnqueueLetter( {
1708 borrowernumber => $borrowernumber,
1709 from_address => $admin_email_address,
1710 message_transport_type => $mtt,
1714 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
1716 ( $mtt eq 'email' and not $to_address ) # No email address
1717 or ( $mtt eq 'sms' and not $patron->smsalertnumber ) # No SMS number
1718 or ( $mtt eq 'phone' and C4::Context->preference('TalkingTechItivaPhoneNotification') ) # Notice is handled by TalkingTech_itiva_outbound.pl
1721 &$send_notification($mtt, $letter_code);
1722 $notification_sent++;
1724 #Making sure that a print notification is sent if no other transport types can be utilized.
1725 if (! $notification_sent) {
1726 &$send_notification('print', 'HOLD');
1731 =head2 _ShiftPriorityByDateAndPriority
1733 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
1735 This increments the priority of all reserves after the one
1736 with either the lowest date after C<$reservedate>
1737 or the lowest priority after C<$priority>.
1739 It effectively makes room for a new reserve to be inserted with a certain
1740 priority, which is returned.
1742 This is most useful when the reservedate can be set by the user. It allows
1743 the new reserve to be placed before other reserves that have a later
1744 reservedate. Since priority also is set by the form in reserves/request.pl
1745 the sub accounts for that too.
1749 sub _ShiftPriorityByDateAndPriority {
1750 my ( $biblio, $resdate, $new_priority ) = @_;
1752 my $dbh = C4::Context->dbh;
1753 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
1754 my $sth = $dbh->prepare( $query );
1755 $sth->execute( $biblio, $resdate, $new_priority );
1756 my $min_priority = $sth->fetchrow;
1757 # if no such matches are found, $new_priority remains as original value
1758 $new_priority = $min_priority if ( $min_priority );
1760 # Shift the priority up by one; works in conjunction with the next SQL statement
1761 $query = "UPDATE reserves
1762 SET priority = priority+1
1763 WHERE biblionumber = ?
1764 AND borrowernumber = ?
1767 my $sth_update = $dbh->prepare( $query );
1769 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1770 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1771 $sth = $dbh->prepare( $query );
1772 $sth->execute( $new_priority, $biblio );
1773 while ( my $row = $sth->fetchrow_hashref ) {
1774 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1777 return $new_priority; # so the caller knows what priority they wind up receiving
1782 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
1784 Use when checking out an item to handle reserves
1785 If $cancelreserve boolean is set to true, it will remove existing reserve
1790 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
1792 my $lookahead = C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1793 my ( $restype, $res, undef ) = CheckReserves( $itemnumber, undef, $lookahead );
1796 my $biblionumber = $res->{biblionumber};
1798 if ($res->{borrowernumber} == $borrowernumber) {
1799 ModReserveFill($res);
1803 # The item is reserved by someone else.
1804 # Find this item in the reserves
1806 my $borr_res = Koha::Holds->search({
1807 borrowernumber => $borrowernumber,
1808 biblionumber => $biblionumber,
1810 order_by => 'priority'
1814 # The item is reserved by the current patron
1815 ModReserveFill($borr_res->unblessed);
1818 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
1819 RevertWaitingStatus({ itemnumber => $itemnumber });
1821 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
1822 my $hold = Koha::Holds->find( $res->{reserve_id} );
1830 MergeHolds($dbh,$to_biblio, $from_biblio);
1832 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
1837 my ( $dbh, $to_biblio, $from_biblio ) = @_;
1838 my $sth = $dbh->prepare(
1839 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
1841 $sth->execute($from_biblio);
1842 if ( my $data = $sth->fetchrow_hashref() ) {
1844 # holds exist on old record, if not we don't need to do anything
1845 $sth = $dbh->prepare(
1846 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
1847 $sth->execute( $to_biblio, $from_biblio );
1850 # don't reorder those already waiting
1852 $sth = $dbh->prepare(
1853 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
1855 my $upd_sth = $dbh->prepare(
1856 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
1857 AND reservedate = ? AND (itemnumber = ? or itemnumber is NULL) "
1859 $sth->execute( $to_biblio, 'W', 'T' );
1861 while ( my $reserve = $sth->fetchrow_hashref() ) {
1863 $priority, $to_biblio,
1864 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
1865 $reserve->{'itemnumber'}
1872 =head2 RevertWaitingStatus
1874 RevertWaitingStatus({ itemnumber => $itemnumber });
1876 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
1878 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
1879 item level hold, even if it was only a bibliolevel hold to
1880 begin with. This is because we can no longer know if a hold
1881 was item-level or bib-level after a hold has been set to
1886 sub RevertWaitingStatus {
1887 my ( $params ) = @_;
1888 my $itemnumber = $params->{'itemnumber'};
1890 return unless ( $itemnumber );
1892 my $dbh = C4::Context->dbh;
1894 ## Get the waiting reserve we want to revert
1896 SELECT * FROM reserves
1897 WHERE itemnumber = ?
1898 AND found IS NOT NULL
1900 my $sth = $dbh->prepare( $query );
1901 $sth->execute( $itemnumber );
1902 my $reserve = $sth->fetchrow_hashref();
1904 ## Increment the priority of all other non-waiting
1905 ## reserves for this bib record
1909 priority = priority + 1
1915 $sth = $dbh->prepare( $query );
1916 $sth->execute( $reserve->{'biblionumber'} );
1918 ## Fix up the currently waiting reserve
1928 $sth = $dbh->prepare( $query );
1929 $sth->execute( $reserve->{'reserve_id'} );
1930 _FixPriority( { biblionumber => $reserve->{biblionumber} } );
1937 branchcode => $branchcode,
1938 borrowernumber => $borrowernumber,
1939 biblionumber => $biblionumber,
1940 [ itemnumber => $itemnumber, ]
1941 [ barcode => $barcode, ]
1945 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
1947 The letter code will be HOLD_SLIP, and the following tables are
1948 available within the slip:
1961 my $branchcode = $args->{branchcode};
1962 my $borrowernumber = $args->{borrowernumber};
1963 my $biblionumber = $args->{biblionumber};
1964 my $itemnumber = $args->{itemnumber};
1965 my $barcode = $args->{barcode};
1968 my $patron = Koha::Patrons->find($borrowernumber);
1971 if ($itemnumber || $barcode ) {
1972 $itemnumber ||= Koha::Items->find( { barcode => $barcode } )->itemnumber;
1974 $hold = Koha::Holds->search(
1976 biblionumber => $biblionumber,
1977 borrowernumber => $borrowernumber,
1978 itemnumber => $itemnumber
1983 $hold = Koha::Holds->search(
1985 biblionumber => $biblionumber,
1986 borrowernumber => $borrowernumber
1991 return unless $hold;
1992 my $reserve = $hold->unblessed;
1994 return C4::Letters::GetPreparedLetter (
1995 module => 'circulation',
1996 letter_code => 'HOLD_SLIP',
1997 branchcode => $branchcode,
1998 lang => $patron->lang,
2000 'reserves' => $reserve,
2001 'branches' => $reserve->{branchcode},
2002 'borrowers' => $reserve->{borrowernumber},
2003 'biblio' => $reserve->{biblionumber},
2004 'biblioitems' => $reserve->{biblionumber},
2005 'items' => $reserve->{itemnumber},
2010 =head2 GetReservesControlBranch
2012 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2014 Return the branchcode to be used to determine which reserves
2015 policy applies to a transaction.
2017 C<$item> is a hashref for an item. Only 'homebranch' is used.
2019 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2023 sub GetReservesControlBranch {
2024 my ( $item, $borrower ) = @_;
2026 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2029 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2030 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2036 =head2 CalculatePriority
2038 my $p = CalculatePriority($biblionumber, $resdate);
2040 Calculate priority for a new reserve on biblionumber, placing it at
2041 the end of the line of all holds whose start date falls before
2042 the current system time and that are neither on the hold shelf
2045 The reserve date parameter is optional; if it is supplied, the
2046 priority is based on the set of holds whose start date falls before
2047 the parameter value.
2049 After calculation of this priority, it is recommended to call
2050 _ShiftPriorityByDateAndPriority. Note that this is currently done in
2055 sub CalculatePriority {
2056 my ( $biblionumber, $resdate ) = @_;
2059 SELECT COUNT(*) FROM reserves
2060 WHERE biblionumber = ?
2062 AND (found IS NULL OR found = '')
2064 #skip found==W or found==T (waiting or transit holds)
2066 $sql.= ' AND ( reservedate <= ? )';
2069 $sql.= ' AND ( reservedate < NOW() )';
2071 my $dbh = C4::Context->dbh();
2072 my @row = $dbh->selectrow_array(
2075 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
2078 return @row ? $row[0]+1 : 1;
2081 =head2 IsItemOnHoldAndFound
2083 my $bool = IsItemFoundHold( $itemnumber );
2085 Returns true if the item is currently on hold
2086 and that hold has a non-null found status ( W, T, etc. )
2090 sub IsItemOnHoldAndFound {
2091 my ($itemnumber) = @_;
2093 my $rs = Koha::Database->new()->schema()->resultset('Reserve');
2095 my $found = $rs->count(
2097 itemnumber => $itemnumber,
2098 found => { '!=' => undef }
2105 =head2 GetMaxPatronHoldsForRecord
2107 my $holds_per_record = ReservesControlBranch( $borrowernumber, $biblionumber );
2109 For multiple holds on a given record for a given patron, the max
2110 number of record level holds that a patron can be placed is the highest
2111 value of the holds_per_record rule for each item if the record for that
2112 patron. This subroutine finds and returns the highest holds_per_record
2113 rule value for a given patron id and record id.
2117 sub GetMaxPatronHoldsForRecord {
2118 my ( $borrowernumber, $biblionumber ) = @_;
2120 my $patron = Koha::Patrons->find($borrowernumber);
2121 my @items = Koha::Items->search( { biblionumber => $biblionumber } );
2123 my $controlbranch = C4::Context->preference('ReservesControlBranch');
2125 my $categorycode = $patron->categorycode;
2127 $branchcode = $patron->branchcode if ( $controlbranch eq "PatronLibrary" );
2130 foreach my $item (@items) {
2131 my $itemtype = $item->effective_itemtype();
2133 $branchcode = $item->homebranch if ( $controlbranch eq "ItemHomeLibrary" );
2135 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2136 my $holds_per_record = $rule ? $rule->{holds_per_record} : 0;
2137 $max = $holds_per_record if $holds_per_record > $max;
2145 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2147 Returns the matching hold related issuingrule fields for a given
2148 patron category, itemtype, and library.
2153 my ( $categorycode, $itemtype, $branchcode ) = @_;
2155 my $dbh = C4::Context->dbh;
2157 my $sth = $dbh->prepare(
2159 SELECT categorycode, itemtype, branchcode, reservesallowed, holds_per_record, holds_per_day
2161 WHERE (categorycode in (?,'*') )
2162 AND (itemtype IN (?,'*'))
2163 AND (branchcode IN (?,'*'))
2164 ORDER BY categorycode DESC,
2170 $sth->execute( $categorycode, $itemtype, $branchcode );
2172 return $sth->fetchrow_hashref();
2177 Koha Development Team <http://koha-community.org/>