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
33 # for _koha_notify_reserve
34 use C4::Members::Messaging;
47 use Koha::IssuingRules;
52 use List::MoreUtils qw( firstidx any );
56 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
60 C4::Reserves - Koha functions for dealing with reservation.
68 This modules provides somes functions to deal with reservations.
70 Reserves are stored in reserves table.
71 The following columns contains important values :
72 - priority >0 : then the reserve is at 1st stage, and not yet affected to any item.
73 =0 : then the reserve is being dealed
74 - found : NULL : means the patron requested the 1st available, and we haven't chosen the item
75 T(ransit) : the reserve is linked to an item but is in transit to the pickup branch
76 W(aiting) : the reserve is linked to an item, is at the pickup branch, and is waiting on the hold shelf
77 F(inished) : the reserve has been completed, and is done
78 - itemnumber : empty : the reserve is still unaffected to an item
79 filled: the reserve is attached to an item
80 The complete workflow is :
81 ==== 1st use case ====
82 patron request a document, 1st available : P >0, F=NULL, I=NULL
83 a library having it run "transfertodo", and clic on the list
84 if there is no transfer to do, the reserve waiting
85 patron can pick it up P =0, F=W, I=filled
86 if there is a transfer to do, write in branchtransfer P =0, F=T, I=filled
87 The pickup library receive the book, it check in P =0, F=W, I=filled
88 The patron borrow the book P =0, F=F, I=filled
90 ==== 2nd use case ====
91 patron requests a document, a given item,
92 If pickup is holding branch P =0, F=W, I=filled
93 If transfer needed, write in branchtransfer P =0, F=T, I=filled
94 The pickup library receive the book, it checks it in P =0, F=W, I=filled
95 The patron borrow the book P =0, F=F, I=filled
116 &ModReserveMinusPriority
122 &CanReserveBeCanceledFromOpac
123 &CancelExpiredReserves
125 &AutoUnsuspendReserves
127 &IsAvailableForItemLevelRequest
130 &ToggleLowestPriority
136 &GetReservesControlBranch
140 GetMaxPatronHoldsForRecord
142 @EXPORT_OK = qw( MergeHolds );
147 AddReserve($branch,$borrowernumber,$biblionumber,$bibitems,$priority,$resdate,$expdate,$notes,$title,$checkitem,$found)
149 Adds reserve and generates HOLDPLACED message.
151 The following tables are available witin the HOLDPLACED message:
164 $branch, $borrowernumber, $biblionumber, $bibitems,
165 $priority, $resdate, $expdate, $notes,
166 $title, $checkitem, $found, $itemtype
169 $resdate = output_pref( { str => dt_from_string( $resdate ), dateonly => 1, dateformat => 'iso' })
170 or output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
172 $expdate = output_pref({ str => $expdate, dateonly => 1, dateformat => 'iso' });
174 if ( C4::Context->preference('AllowHoldDateInFuture') ) {
176 # Make room in reserves for this before those of a later reserve date
177 $priority = _ShiftPriorityByDateAndPriority( $biblionumber, $resdate, $priority );
182 # If the reserv had the waiting status, we had the value of the resdate
183 if ( $found eq 'W' ) {
184 $waitingdate = $resdate;
187 # Don't add itemtype limit if specific item is selected
188 $itemtype = undef if $checkitem;
190 # updates take place here
191 my $hold = Koha::Hold->new(
193 borrowernumber => $borrowernumber,
194 biblionumber => $biblionumber,
195 reservedate => $resdate,
196 branchcode => $branch,
197 priority => $priority,
198 reservenotes => $notes,
199 itemnumber => $checkitem,
201 waitingdate => $waitingdate,
202 expirationdate => $expdate,
203 itemtype => $itemtype,
207 logaction( 'HOLDS', 'CREATE', $hold->id, Dumper($hold->unblessed) )
208 if C4::Context->preference('HoldsLog');
210 my $reserve_id = $hold->id();
212 # add a reserve fee if needed
213 if ( C4::Context->preference('HoldFeeMode') ne 'any_time_is_collected' ) {
214 my $reserve_fee = GetReserveFee( $borrowernumber, $biblionumber );
215 ChargeReserveFee( $borrowernumber, $reserve_fee, $title );
218 _FixPriority({ biblionumber => $biblionumber});
220 # Send e-mail to librarian if syspref is active
221 if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
222 my $patron = Koha::Patrons->find( $borrowernumber );
223 my $library = $patron->library;
224 if ( my $letter = C4::Letters::GetPreparedLetter (
225 module => 'reserves',
226 letter_code => 'HOLDPLACED',
227 branchcode => $branch,
228 lang => $patron->lang,
230 'branches' => $library->unblessed,
231 'borrowers' => $patron->unblessed,
232 'biblio' => $biblionumber,
233 'biblioitems' => $biblionumber,
234 'items' => $checkitem,
235 'reserves' => $hold->unblessed,
239 my $admin_email_address = $library->branchemail || C4::Context->preference('KohaAdminEmailAddress');
241 C4::Letters::EnqueueLetter(
243 borrowernumber => $borrowernumber,
244 message_transport_type => 'email',
245 from_address => $admin_email_address,
246 to_address => $admin_email_address,
255 =head2 CanBookBeReserved
257 $canReserve = &CanBookBeReserved($borrowernumber, $biblionumber)
258 if ($canReserve eq 'OK') { #We can reserve this Item! }
260 See CanItemBeReserved() for possible return values.
264 sub CanBookBeReserved{
265 my ($borrowernumber, $biblionumber) = @_;
267 my $items = GetItemnumbersForBiblio($biblionumber);
268 #get items linked via host records
269 my @hostitems = get_hostitemnumbers_of($biblionumber);
271 push (@$items,@hostitems);
275 foreach my $item (@$items) {
276 $canReserve = CanItemBeReserved( $borrowernumber, $item );
277 return 'OK' if $canReserve eq 'OK';
282 =head2 CanItemBeReserved
284 $canReserve = &CanItemBeReserved($borrowernumber, $itemnumber)
285 if ($canReserve eq 'OK') { #We can reserve this Item! }
287 @RETURNS OK, if the Item can be reserved.
288 ageRestricted, if the Item is age restricted for this borrower.
289 damaged, if the Item is damaged.
290 cannotReserveFromOtherBranches, if syspref 'canreservefromotherbranches' is OK.
291 tooManyReserves, if the borrower has exceeded his maximum reserve amount.
292 notReservable, if holds on this item are not allowed
296 sub CanItemBeReserved {
297 my ( $borrowernumber, $itemnumber ) = @_;
299 my $dbh = C4::Context->dbh;
300 my $ruleitemtype; # itemtype of the matching issuing rule
301 my $allowedreserves = 0; # Total number of holds allowed across all records
302 my $holds_per_record = 1; # Total number of holds allowed for this one given record
304 # we retrieve borrowers and items informations #
305 # item->{itype} will come for biblioitems if necessery
306 my $item = GetItem($itemnumber);
307 my $biblio = Koha::Biblios->find( $item->{biblionumber} );
308 my $patron = Koha::Patrons->find( $borrowernumber );
309 my $borrower = $patron->unblessed;
311 # If an item is damaged and we don't allow holds on damaged items, we can stop right here
313 if ( $item->{damaged}
314 && !C4::Context->preference('AllowHoldsOnDamagedItems') );
316 # Check for the age restriction
317 my ( $ageRestriction, $daysToAgeRestriction ) =
318 C4::Circulation::GetAgeRestriction( $biblio->biblioitem->agerestriction, $borrower );
319 return 'ageRestricted' if $daysToAgeRestriction && $daysToAgeRestriction > 0;
321 # Check that the patron doesn't have an item level hold on this item already
322 return 'itemAlreadyOnHold'
323 if Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->count();
325 my $controlbranch = C4::Context->preference('ReservesControlBranch');
328 SELECT count(*) AS count
330 LEFT JOIN items USING (itemnumber)
331 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
332 LEFT JOIN borrowers USING (borrowernumber)
333 WHERE borrowernumber = ?
337 my $branchfield = "reserves.branchcode";
339 if ( $controlbranch eq "ItemHomeLibrary" ) {
340 $branchfield = "items.homebranch";
341 $branchcode = $item->{homebranch};
343 elsif ( $controlbranch eq "PatronLibrary" ) {
344 $branchfield = "borrowers.branchcode";
345 $branchcode = $borrower->{branchcode};
349 if ( my $rights = GetHoldRule( $borrower->{'categorycode'}, $item->{'itype'}, $branchcode ) ) {
350 $ruleitemtype = $rights->{itemtype};
351 $allowedreserves = $rights->{reservesallowed};
352 $holds_per_record = $rights->{holds_per_record};
358 $item = Koha::Items->find( $itemnumber );
359 my $holds = Koha::Holds->search(
361 borrowernumber => $borrowernumber,
362 biblionumber => $item->biblionumber,
363 found => undef, # Found holds don't count against a patron's holds limit
366 if ( $holds->count() >= $holds_per_record ) {
367 return "tooManyHoldsForThisRecord";
372 $querycount .= "AND $branchfield = ?";
374 # If using item-level itypes, fall back to the record
375 # level itemtype if the hold has no associated item
377 C4::Context->preference('item-level_itypes')
378 ? " AND COALESCE( items.itype, biblioitems.itemtype ) = ?"
379 : " AND biblioitems.itemtype = ?"
380 if ( $ruleitemtype ne "*" );
382 my $sthcount = $dbh->prepare($querycount);
384 if ( $ruleitemtype eq "*" ) {
385 $sthcount->execute( $borrowernumber, $branchcode );
388 $sthcount->execute( $borrowernumber, $branchcode, $ruleitemtype );
391 my $reservecount = "0";
392 if ( my $rowcount = $sthcount->fetchrow_hashref() ) {
393 $reservecount = $rowcount->{count};
396 # we check if it's ok or not
397 if ( $reservecount >= $allowedreserves ) {
398 return 'tooManyReserves';
401 my $circ_control_branch =
402 C4::Circulation::_GetCircControlBranch( $item->unblessed(), $borrower );
404 C4::Circulation::GetBranchItemRule( $circ_control_branch, $item->itype );
406 if ( $branchitemrule->{holdallowed} == 0 ) {
407 return 'notReservable';
410 if ( $branchitemrule->{holdallowed} == 1
411 && $borrower->{branchcode} ne $item->homebranch )
413 return 'cannotReserveFromOtherBranches';
416 # If reservecount is ok, we check item branch if IndependentBranches is ON
417 # and canreservefromotherbranches is OFF
418 if ( C4::Context->preference('IndependentBranches')
419 and !C4::Context->preference('canreservefromotherbranches') )
421 my $itembranch = $item->homebranch;
422 if ( $itembranch ne $borrower->{branchcode} ) {
423 return 'cannotReserveFromOtherBranches';
430 =head2 CanReserveBeCanceledFromOpac
432 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
434 returns 1 if reserve can be cancelled by user from OPAC.
435 First check if reserve belongs to user, next checks if reserve is not in
436 transfer or waiting status
440 sub CanReserveBeCanceledFromOpac {
441 my ($reserve_id, $borrowernumber) = @_;
443 return unless $reserve_id and $borrowernumber;
444 my $reserve = Koha::Holds->find($reserve_id);
446 return 0 unless $reserve->borrowernumber == $borrowernumber;
447 return 0 if ( $reserve->found eq 'W' ) or ( $reserve->found eq 'T' );
453 =head2 GetOtherReserves
455 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
457 Check queued list of this document and check if this document must be transferred
461 sub GetOtherReserves {
462 my ($itemnumber) = @_;
465 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
466 if ($checkreserves) {
467 my $iteminfo = GetItem($itemnumber);
468 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
469 $messages->{'transfert'} = $checkreserves->{'branchcode'};
470 #minus priorities of others reservs
471 ModReserveMinusPriority(
473 $checkreserves->{'reserve_id'},
476 #launch the subroutine dotransfer
477 C4::Items::ModItemTransfer(
479 $iteminfo->{'holdingbranch'},
480 $checkreserves->{'branchcode'}
485 #step 2b : case of a reservation on the same branch, set the waiting status
487 $messages->{'waiting'} = 1;
488 ModReserveMinusPriority(
490 $checkreserves->{'reserve_id'},
492 ModReserveStatus($itemnumber,'W');
495 $nextreservinfo = $checkreserves->{'borrowernumber'};
498 return ( $messages, $nextreservinfo );
501 =head2 ChargeReserveFee
503 $fee = ChargeReserveFee( $borrowernumber, $fee, $title );
505 Charge the fee for a reserve (if $fee > 0)
509 sub ChargeReserveFee {
510 my ( $borrowernumber, $fee, $title ) = @_;
511 return if !$fee || $fee==0; # the last test is needed to include 0.00
513 INSERT INTO accountlines ( borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding ) VALUES (?, ?, NOW(), ?, ?, 'Res', ?)
515 my $dbh = C4::Context->dbh;
516 my $nextacctno = &getnextacctno( $borrowernumber );
517 $dbh->do( $accquery, undef, ( $borrowernumber, $nextacctno, $fee, "Reserve Charge - $title", $fee ) );
522 $fee = GetReserveFee( $borrowernumber, $biblionumber );
524 Calculate the fee for a reserve (if applicable).
529 my ( $borrowernumber, $biblionumber ) = @_;
531 SELECT reservefee FROM borrowers LEFT JOIN categories ON borrowers.categorycode = categories.categorycode WHERE borrowernumber = ?
534 SELECT COUNT(*) FROM items
535 LEFT JOIN issues USING (itemnumber)
536 WHERE items.biblionumber=? AND issues.issue_id IS NULL
539 SELECT COUNT(*) FROM reserves WHERE biblionumber=? AND borrowernumber<>?
542 my $dbh = C4::Context->dbh;
543 my ( $fee ) = $dbh->selectrow_array( $borquery, undef, ($borrowernumber) );
544 my $hold_fee_mode = C4::Context->preference('HoldFeeMode') || 'not_always';
545 if( $fee and $fee > 0 and $hold_fee_mode eq 'not_always' ) {
546 # This is a reconstruction of the old code:
547 # Compare number of items with items issued, and optionally check holds
548 # If not all items are issued and there are no holds: charge no fee
549 # NOTE: Lost, damaged, not-for-loan, etc. are just ignored here
550 my ( $notissued, $reserved );
551 ( $notissued ) = $dbh->selectrow_array( $issue_qry, undef,
554 ( $reserved ) = $dbh->selectrow_array( $holds_qry, undef,
555 ( $biblionumber, $borrowernumber ) );
556 $fee = 0 if $reserved == 0;
562 =head2 GetReserveStatus
564 $reservestatus = GetReserveStatus($itemnumber);
566 Takes an itemnumber and returns the status of the reserve placed on it.
567 If several reserves exist, the reserve with the lower priority is given.
571 ## FIXME: I don't think this does what it thinks it does.
572 ## It only ever checks the first reserve result, even though
573 ## multiple reserves for that bib can have the itemnumber set
574 ## the sub is only used once in the codebase.
575 sub GetReserveStatus {
576 my ($itemnumber) = @_;
578 my $dbh = C4::Context->dbh;
580 my ($sth, $found, $priority);
582 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
583 $sth->execute($itemnumber);
584 ($found, $priority) = $sth->fetchrow_array;
588 return 'Waiting' if $found eq 'W' and $priority == 0;
589 return 'Finished' if $found eq 'F';
592 return 'Reserved' if $priority > 0;
594 return ''; # empty string here will remove need for checking undef, or less log lines
599 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber);
600 ($status, $reserve, $all_reserves) = &CheckReserves(undef, $barcode);
601 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
603 Find a book in the reserves.
605 C<$itemnumber> is the book's item number.
606 C<$lookahead> is the number of days to look in advance for future reserves.
608 As I understand it, C<&CheckReserves> looks for the given item in the
609 reserves. If it is found, that's a match, and C<$status> is set to
612 Otherwise, it finds the most important item in the reserves with the
613 same biblio number as this book (I'm not clear on this) and returns it
614 with C<$status> set to C<Reserved>.
616 C<&CheckReserves> returns a two-element list:
618 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
620 C<$reserve> is the reserve item that matched. It is a
621 reference-to-hash whose keys are mostly the fields of the reserves
622 table in the Koha database.
627 my ( $item, $barcode, $lookahead_days, $ignore_borrowers) = @_;
628 my $dbh = C4::Context->dbh;
631 if (C4::Context->preference('item-level_itypes')){
633 SELECT items.biblionumber,
634 items.biblioitemnumber,
635 itemtypes.notforloan,
636 items.notforloan AS itemnotforloan,
642 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
643 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
648 SELECT items.biblionumber,
649 items.biblioitemnumber,
650 itemtypes.notforloan,
651 items.notforloan AS itemnotforloan,
657 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
658 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
663 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
664 $sth->execute($item);
667 $sth = $dbh->prepare("$select WHERE barcode = ?");
668 $sth->execute($barcode);
670 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
671 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber, $damaged, $item_homebranch, $item_holdingbranch ) = $sth->fetchrow_array;
673 return if ( $damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
675 return unless $itemnumber; # bail if we got nothing.
677 # if item is not for loan it cannot be reserved either.....
678 # except where items.notforloan < 0 : This indicates the item is holdable.
679 return if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
681 # Find this item in the reserves
682 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days, $ignore_borrowers);
684 # $priority and $highest are used to find the most important item
685 # in the list returned by &_Findgroupreserve. (The lower $priority,
686 # the more important the item.)
687 # $highest is the most important item we've seen so far.
689 if (scalar @reserves) {
690 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
691 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
692 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
694 my $priority = 10000000;
695 foreach my $res (@reserves) {
696 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
697 if ($res->{'found'} eq 'W') {
698 return ( "Waiting", $res, \@reserves ); # Found it, it is waiting
700 return ( "Reserved", $res, \@reserves ); # Found determinated hold, e. g. the tranferred one
705 my $local_hold_match;
707 if ($LocalHoldsPriority) {
708 $patron = Koha::Patrons->find( $res->{borrowernumber} );
709 $iteminfo = C4::Items::GetItem($itemnumber);
711 my $local_holds_priority_item_branchcode =
712 $iteminfo->{$LocalHoldsPriorityItemControl};
713 my $local_holds_priority_patron_branchcode =
714 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
716 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
717 ? $patron->branchcode
720 $local_holds_priority_item_branchcode eq
721 $local_holds_priority_patron_branchcode;
724 # See if this item is more important than what we've got so far
725 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
726 $iteminfo ||= C4::Items::GetItem($itemnumber);
727 next if $res->{itemtype} && $res->{itemtype} ne _get_itype( $iteminfo );
728 $patron ||= Koha::Patrons->find( $res->{borrowernumber} );
729 my $branch = GetReservesControlBranch( $iteminfo, $patron->unblessed );
730 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$iteminfo->{'itype'});
731 next if ($branchitemrule->{'holdallowed'} == 0);
732 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $patron->branchcode));
733 next if ( ($branchitemrule->{hold_fulfillment_policy} ne 'any') && ($res->{branchcode} ne $iteminfo->{ $branchitemrule->{hold_fulfillment_policy} }) );
734 $priority = $res->{'priority'};
736 last if $local_hold_match;
742 # If we get this far, then no exact match was found.
743 # We return the most important (i.e. next) reservation.
745 $highest->{'itemnumber'} = $item;
746 return ( "Reserved", $highest, \@reserves );
752 =head2 CancelExpiredReserves
754 CancelExpiredReserves();
756 Cancels all reserves with an expiration date from before today.
760 sub CancelExpiredReserves {
761 my $today = dt_from_string();
762 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
763 my $expireWaiting = C4::Context->preference('ExpireReservesMaxPickUpDelay');
765 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
766 my $params = { expirationdate => { '<', $dtf->format_date($today) } };
767 $params->{found} = undef unless $expireWaiting;
769 # FIXME To move to Koha::Holds->search_expired (?)
770 my $holds = Koha::Holds->search( $params );
772 while ( my $hold = $holds->next ) {
773 my $calendar = Koha::Calendar->new( branchcode => $hold->branchcode );
775 next if !$cancel_on_holidays && $calendar->is_holiday( $today );
777 my $cancel_params = {};
778 if ( $hold->found eq 'W' ) {
779 $cancel_params->{charge_cancel_fee} = 1;
781 $hold->cancel( $cancel_params );
785 =head2 AutoUnsuspendReserves
787 AutoUnsuspendReserves();
789 Unsuspends all suspended reserves with a suspend_until date from before today.
793 sub AutoUnsuspendReserves {
794 my $today = dt_from_string();
796 my @holds = Koha::Holds->search( { suspend_until => { '<' => $today->ymd() } } );
798 map { $_->suspend(0)->suspend_until(undef)->store() } @holds;
803 ModReserve({ rank => $rank,
804 reserve_id => $reserve_id,
805 branchcode => $branchcode
806 [, itemnumber => $itemnumber ]
807 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
810 Change a hold request's priority or cancel it.
812 C<$rank> specifies the effect of the change. If C<$rank>
813 is 'W' or 'n', nothing happens. This corresponds to leaving a
814 request alone when changing its priority in the holds queue
817 If C<$rank> is 'del', the hold request is cancelled.
819 If C<$rank> is an integer greater than zero, the priority of
820 the request is set to that value. Since priority != 0 means
821 that the item is not waiting on the hold shelf, setting the
822 priority to a non-zero value also sets the request's found
823 status and waiting date to NULL.
825 The optional C<$itemnumber> parameter is used only when
826 C<$rank> is a non-zero integer; if supplied, the itemnumber
827 of the hold request is set accordingly; if omitted, the itemnumber
830 B<FIXME:> Note that the forgoing can have the effect of causing
831 item-level hold requests to turn into title-level requests. This
832 will be fixed once reserves has separate columns for requested
833 itemnumber and supplying itemnumber.
840 my $rank = $params->{'rank'};
841 my $reserve_id = $params->{'reserve_id'};
842 my $branchcode = $params->{'branchcode'};
843 my $itemnumber = $params->{'itemnumber'};
844 my $suspend_until = $params->{'suspend_until'};
845 my $borrowernumber = $params->{'borrowernumber'};
846 my $biblionumber = $params->{'biblionumber'};
848 return if $rank eq "W";
849 return if $rank eq "n";
851 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
854 unless ( $reserve_id ) {
855 my $holds = Koha::Holds->search({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber });
856 return unless $holds->count; # FIXME Should raise an exception
857 $hold = $holds->next;
858 $reserve_id = $hold->reserve_id;
861 $hold ||= Koha::Holds->find($reserve_id);
863 if ( $rank eq "del" ) {
866 elsif ($rank =~ /^\d+/ and $rank > 0) {
867 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, Dumper($hold->unblessed) )
868 if C4::Context->preference('HoldsLog');
873 branchcode => $branchcode,
874 itemnumber => $itemnumber,
880 if ( defined( $suspend_until ) ) {
881 if ( $suspend_until ) {
882 $suspend_until = eval { dt_from_string( $suspend_until ) };
883 $hold->suspend_hold( $suspend_until );
885 # If the hold is suspended leave the hold suspended, but convert it to an indefinite hold.
886 # If the hold is not suspended, this does nothing.
887 $hold->set( { suspend_until => undef } )->store();
891 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
895 =head2 ModReserveFill
897 &ModReserveFill($reserve);
899 Fill a reserve. If I understand this correctly, this means that the
900 reserved book has been found and given to the patron who reserved it.
902 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
903 whose keys are fields from the reserves table in the Koha database.
909 my $reserve_id = $res->{'reserve_id'};
911 my $hold = Koha::Holds->find($reserve_id);
913 # get the priority on this record....
914 my $priority = $hold->priority;
916 # update the hold statuses, no need to store it though, we will be deleting it anyway
924 # FIXME Must call Koha::Hold->cancel ? => No, should call ->filled and add the correct log
925 Koha::Old::Hold->new( $hold->unblessed() )->store();
929 if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
930 my $reserve_fee = GetReserveFee( $hold->borrowernumber, $hold->biblionumber );
931 ChargeReserveFee( $hold->borrowernumber, $reserve_fee, $hold->biblio->title );
934 # now fix the priority on the others (if the priority wasn't
935 # already sorted!)....
936 unless ( $priority == 0 ) {
937 _FixPriority( { reserve_id => $reserve_id, biblionumber => $hold->biblionumber } );
941 =head2 ModReserveStatus
943 &ModReserveStatus($itemnumber, $newstatus);
945 Update the reserve status for the active (priority=0) reserve.
947 $itemnumber is the itemnumber the reserve is on
949 $newstatus is the new status.
953 sub ModReserveStatus {
955 #first : check if we have a reservation for this item .
956 my ($itemnumber, $newstatus) = @_;
957 my $dbh = C4::Context->dbh;
959 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
960 my $sth_set = $dbh->prepare($query);
961 $sth_set->execute( $newstatus, $itemnumber );
963 if ( C4::Context->preference("ReturnToShelvingCart") && $newstatus ) {
964 CartToShelf( $itemnumber );
968 =head2 ModReserveAffect
970 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend,$reserve_id);
972 This function affect an item and a status for a given reserve, either fetched directly
973 by record_id, or by borrowernumber and itemnumber or biblionumber. If only biblionumber
974 is given, only first reserve returned is affected, which is ok for anything but
977 if $transferToDo is not set, then the status is set to "Waiting" as well.
978 otherwise, a transfer is on the way, and the end of the transfer will
979 take care of the waiting status
983 sub ModReserveAffect {
984 my ( $itemnumber, $borrowernumber, $transferToDo, $reserve_id ) = @_;
985 my $dbh = C4::Context->dbh;
987 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
988 # attached to $itemnumber
989 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
990 $sth->execute($itemnumber);
991 my ($biblionumber) = $sth->fetchrow;
993 # get request - need to find out if item is already
994 # waiting in order to not send duplicate hold filled notifications
997 # Find hold by id if we have it
998 $hold = Koha::Holds->find( $reserve_id ) if $reserve_id;
999 # Find item level hold for this item if there is one
1000 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->next();
1001 # Find record level hold if there is no item level hold
1002 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, biblionumber => $biblionumber } )->next();
1004 return unless $hold;
1006 my $already_on_shelf = $hold->found && $hold->found eq 'W';
1008 $hold->itemnumber($itemnumber);
1009 $hold->set_waiting($transferToDo);
1011 _koha_notify_reserve( $hold->reserve_id )
1012 if ( !$transferToDo && !$already_on_shelf );
1014 _FixPriority( { biblionumber => $biblionumber } );
1016 if ( C4::Context->preference("ReturnToShelvingCart") ) {
1017 CartToShelf($itemnumber);
1023 =head2 ModReserveCancelAll
1025 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1027 function to cancel reserv,check other reserves, and transfer document if it's necessary
1031 sub ModReserveCancelAll {
1034 my ( $itemnumber, $borrowernumber ) = @_;
1036 #step 1 : cancel the reservation
1037 my $holds = Koha::Holds->search({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1038 return unless $holds->count;
1039 $holds->next->cancel;
1041 #step 2 launch the subroutine of the others reserves
1042 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1044 return ( $messages, $nextreservinfo );
1047 =head2 ModReserveMinusPriority
1049 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1051 Reduce the values of queued list
1055 sub ModReserveMinusPriority {
1056 my ( $itemnumber, $reserve_id ) = @_;
1058 #first step update the value of the first person on reserv
1059 my $dbh = C4::Context->dbh;
1062 SET priority = 0 , itemnumber = ?
1063 WHERE reserve_id = ?
1065 my $sth_upd = $dbh->prepare($query);
1066 $sth_upd->execute( $itemnumber, $reserve_id );
1067 # second step update all others reserves
1068 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1071 =head2 IsAvailableForItemLevelRequest
1073 my $is_available = IsAvailableForItemLevelRequest($item_record,$borrower_record);
1075 Checks whether a given item record is available for an
1076 item-level hold request. An item is available if
1078 * it is not lost AND
1079 * it is not damaged AND
1080 * it is not withdrawn AND
1081 * a waiting or in transit reserve is placed on
1082 * does not have a not for loan value > 0
1084 Need to check the issuingrules onshelfholds column,
1085 if this is set items on the shelf can be placed on hold
1087 Note that IsAvailableForItemLevelRequest() does not
1088 check if the staff operator is authorized to place
1089 a request on the item - in particular,
1090 this routine does not check IndependentBranches
1091 and canreservefromotherbranches.
1095 sub IsAvailableForItemLevelRequest {
1097 my $borrower = shift;
1099 my $dbh = C4::Context->dbh;
1100 # must check the notforloan setting of the itemtype
1101 # FIXME - a lot of places in the code do this
1102 # or something similar - need to be
1104 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
1105 my $item_object = Koha::Items->find( $item->{itemnumber } );
1106 my $itemtype = $item_object->effective_itemtype;
1107 my $notforloan_per_itemtype
1108 = $dbh->selectrow_array("SELECT notforloan FROM itemtypes WHERE itemtype = ?",
1112 $notforloan_per_itemtype ||
1113 $item->{itemlost} ||
1114 $item->{notforloan} > 0 ||
1115 $item->{withdrawn} ||
1116 ($item->{damaged} && !C4::Context->preference('AllowHoldsOnDamagedItems'));
1118 my $on_shelf_holds = Koha::IssuingRules->get_onshelfholds_policy( { item => $item_object, patron => $patron } );
1120 if ( $on_shelf_holds == 1 ) {
1122 } elsif ( $on_shelf_holds == 2 ) {
1124 Koha::Items->search( { biblionumber => $item->{biblionumber} } );
1126 my $any_available = 0;
1128 foreach my $i (@items) {
1130 my $circ_control_branch = C4::Circulation::_GetCircControlBranch( $i->unblessed(), $borrower );
1131 my $branchitemrule = C4::Circulation::GetBranchItemRule( $circ_control_branch, $i->itype );
1135 || $i->notforloan > 0
1138 || IsItemOnHoldAndFound( $i->id )
1140 && !C4::Context->preference('AllowHoldsOnDamagedItems') )
1141 || Koha::ItemTypes->find( $i->effective_itemtype() )->notforloan
1142 || $branchitemrule->{holdallowed} == 1 && $borrower->{branchcode} ne $i->homebranch;
1145 return $any_available ? 0 : 1;
1146 } else { # on_shelf_holds == 0 "If any unavailable" (the description is rather cryptic and could still be improved)
1147 return $item->{onloan} || IsItemOnHoldAndFound( $item->{itemnumber} );
1151 =head2 OnShelfHoldsAllowed
1153 OnShelfHoldsAllowed($itemtype,$borrowercategory,$branchcode);
1155 Checks issuingrules, using the borrowers categorycode, the itemtype, and branchcode to see if onshelf
1156 holds are allowed, returns true if so.
1160 sub OnShelfHoldsAllowed {
1161 my ($item, $borrower) = @_;
1163 my $itype = _get_itype($item);
1164 return _OnShelfHoldsAllowed($itype,$borrower->{categorycode},$item->{holdingbranch});
1171 if (C4::Context->preference('item-level_itypes')) {
1172 # We can't trust GetItem to honour the syspref, so safest to do it ourselves
1173 # When GetItem is fixed, we can remove this
1174 $itype = $item->{itype};
1177 # XXX This is a bit dodgy. It relies on biblio itemtype column having different name.
1178 # So if we already have a biblioitems join when calling this function,
1179 # we don't need to access the database again
1180 $itype = $item->{itemtype};
1183 my $dbh = C4::Context->dbh;
1184 my $query = "SELECT itemtype FROM biblioitems WHERE biblioitemnumber = ? ";
1185 my $sth = $dbh->prepare($query);
1186 $sth->execute($item->{biblioitemnumber});
1187 if (my $data = $sth->fetchrow_hashref()){
1188 $itype = $data->{itemtype};
1194 sub _OnShelfHoldsAllowed {
1195 my ($itype,$borrowercategory,$branchcode) = @_;
1197 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule({ categorycode => $borrowercategory, itemtype => $itype, branchcode => $branchcode });
1198 return $issuing_rule ? $issuing_rule->onshelfholds : undef;
1201 =head2 AlterPriority
1203 AlterPriority( $where, $reserve_id );
1205 This function changes a reserve's priority up, down, to the top, or to the bottom.
1206 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1211 my ( $where, $reserve_id ) = @_;
1213 my $hold = Koha::Holds->find( $reserve_id );
1214 return unless $hold;
1216 if ( $hold->cancellationdate ) {
1217 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (" . $hold->cancellationdate . ')';
1221 if ( $where eq 'up' || $where eq 'down' ) {
1223 my $priority = $hold->priority;
1224 $priority = $where eq 'up' ? $priority - 1 : $priority + 1;
1225 _FixPriority({ reserve_id => $reserve_id, rank => $priority })
1227 } elsif ( $where eq 'top' ) {
1229 _FixPriority({ reserve_id => $reserve_id, rank => '1' })
1231 } elsif ( $where eq 'bottom' ) {
1233 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1236 # FIXME Should return the new priority
1239 =head2 ToggleLowestPriority
1241 ToggleLowestPriority( $borrowernumber, $biblionumber );
1243 This function sets the lowestPriority field to true if is false, and false if it is true.
1247 sub ToggleLowestPriority {
1248 my ( $reserve_id ) = @_;
1250 my $dbh = C4::Context->dbh;
1252 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1253 $sth->execute( $reserve_id );
1255 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1258 =head2 ToggleSuspend
1260 ToggleSuspend( $reserve_id );
1262 This function sets the suspend field to true if is false, and false if it is true.
1263 If the reserve is currently suspended with a suspend_until date, that date will
1264 be cleared when it is unsuspended.
1269 my ( $reserve_id, $suspend_until ) = @_;
1271 $suspend_until = dt_from_string($suspend_until) if ($suspend_until);
1273 my $hold = Koha::Holds->find( $reserve_id );
1275 if ( $hold->is_suspended ) {
1278 $hold->suspend_hold( $suspend_until );
1285 borrowernumber => $borrowernumber,
1286 [ biblionumber => $biblionumber, ]
1287 [ suspend_until => $suspend_until, ]
1288 [ suspend => $suspend ]
1291 This function accepts a set of hash keys as its parameters.
1292 It requires either borrowernumber or biblionumber, or both.
1294 suspend_until is wholly optional.
1301 my $borrowernumber = $params{'borrowernumber'} || undef;
1302 my $biblionumber = $params{'biblionumber'} || undef;
1303 my $suspend_until = $params{'suspend_until'} || undef;
1304 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1306 $suspend_until = eval { dt_from_string($suspend_until) }
1307 if ( defined($suspend_until) );
1309 return unless ( $borrowernumber || $biblionumber );
1312 $params->{found} = undef;
1313 $params->{borrowernumber} = $borrowernumber if $borrowernumber;
1314 $params->{biblionumber} = $biblionumber if $biblionumber;
1316 my @holds = Koha::Holds->search($params);
1319 map { $_->suspend_hold($suspend_until) } @holds;
1322 map { $_->resume() } @holds;
1330 reserve_id => $reserve_id,
1332 [ignoreSetLowestRank => $ignoreSetLowestRank]
1337 _FixPriority({ biblionumber => $biblionumber});
1339 This routine adjusts the priority of a hold request and holds
1342 In the first form, where a reserve_id is passed, the priority of the
1343 hold is set to supplied rank, and other holds for that bib are adjusted
1344 accordingly. If the rank is "del", the hold is cancelled. If no rank
1345 is supplied, all of the holds on that bib have their priority adjusted
1346 as if the second form had been used.
1348 In the second form, where a biblionumber is passed, the holds on that
1349 bib (that are not captured) are sorted in order of increasing priority,
1350 then have reserves.priority set so that the first non-captured hold
1351 has its priority set to 1, the second non-captured hold has its priority
1352 set to 2, and so forth.
1354 In both cases, holds that have the lowestPriority flag on are have their
1355 priority adjusted to ensure that they remain at the end of the line.
1357 Note that the ignoreSetLowestRank parameter is meant to be used only
1358 when _FixPriority calls itself.
1363 my ( $params ) = @_;
1364 my $reserve_id = $params->{reserve_id};
1365 my $rank = $params->{rank} // '';
1366 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1367 my $biblionumber = $params->{biblionumber};
1369 my $dbh = C4::Context->dbh;
1372 if ( $reserve_id ) {
1373 $hold = Koha::Holds->find( $reserve_id );
1374 return unless $hold;
1377 unless ( $biblionumber ) { # FIXME This is a very weird API
1378 $biblionumber = $hold->biblionumber;
1381 if ( $rank eq "del" ) { # FIXME will crash if called without $hold
1384 elsif ( $rank eq "W" || $rank eq "0" ) {
1386 # make sure priority for waiting or in-transit items is 0
1390 WHERE reserve_id = ?
1391 AND found IN ('W', 'T')
1393 my $sth = $dbh->prepare($query);
1394 $sth->execute( $reserve_id );
1400 SELECT reserve_id, borrowernumber, reservedate
1402 WHERE biblionumber = ?
1403 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1404 ORDER BY priority ASC
1406 my $sth = $dbh->prepare($query);
1407 $sth->execute( $biblionumber );
1408 while ( my $line = $sth->fetchrow_hashref ) {
1409 push( @priority, $line );
1412 # To find the matching index
1414 my $key = -1; # to allow for 0 to be a valid result
1415 for ( $i = 0 ; $i < @priority ; $i++ ) {
1416 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1417 $key = $i; # save the index
1422 # if index exists in array then move it to new position
1423 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1424 my $new_rank = $rank -
1425 1; # $new_rank is what you want the new index to be in the array
1426 my $moving_item = splice( @priority, $key, 1 );
1427 splice( @priority, $new_rank, 0, $moving_item );
1430 # now fix the priority on those that are left....
1434 WHERE reserve_id = ?
1436 $sth = $dbh->prepare($query);
1437 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1440 $priority[$j]->{'reserve_id'}
1444 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1447 unless ( $ignoreSetLowestRank ) {
1448 while ( my $res = $sth->fetchrow_hashref() ) {
1450 reserve_id => $res->{'reserve_id'},
1452 ignoreSetLowestRank => 1
1458 =head2 _Findgroupreserve
1460 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead, $ignore_borrowers);
1462 Looks for a holds-queue based item-specific match first, then for a holds-queue title-level match, returning the
1463 first match found. If neither, then we look for non-holds-queue based holds.
1464 Lookahead is the number of days to look in advance.
1466 C<&_Findgroupreserve> returns :
1467 C<@results> is an array of references-to-hash whose keys are mostly
1468 fields from the reserves table of the Koha database, plus
1469 C<biblioitemnumber>.
1473 sub _Findgroupreserve {
1474 my ( $bibitem, $biblio, $itemnumber, $lookahead, $ignore_borrowers) = @_;
1475 my $dbh = C4::Context->dbh;
1477 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1478 # check for exact targeted match
1479 my $item_level_target_query = qq{
1480 SELECT reserves.biblionumber AS biblionumber,
1481 reserves.borrowernumber AS borrowernumber,
1482 reserves.reservedate AS reservedate,
1483 reserves.branchcode AS branchcode,
1484 reserves.cancellationdate AS cancellationdate,
1485 reserves.found AS found,
1486 reserves.reservenotes AS reservenotes,
1487 reserves.priority AS priority,
1488 reserves.timestamp AS timestamp,
1489 biblioitems.biblioitemnumber AS biblioitemnumber,
1490 reserves.itemnumber AS itemnumber,
1491 reserves.reserve_id AS reserve_id,
1492 reserves.itemtype AS itemtype
1494 JOIN biblioitems USING (biblionumber)
1495 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1498 AND item_level_request = 1
1500 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1504 my $sth = $dbh->prepare($item_level_target_query);
1505 $sth->execute($itemnumber, $lookahead||0);
1507 if ( my $data = $sth->fetchrow_hashref ) {
1508 push( @results, $data )
1509 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1511 return @results if @results;
1513 # check for title-level targeted match
1514 my $title_level_target_query = qq{
1515 SELECT reserves.biblionumber AS biblionumber,
1516 reserves.borrowernumber AS borrowernumber,
1517 reserves.reservedate AS reservedate,
1518 reserves.branchcode AS branchcode,
1519 reserves.cancellationdate AS cancellationdate,
1520 reserves.found AS found,
1521 reserves.reservenotes AS reservenotes,
1522 reserves.priority AS priority,
1523 reserves.timestamp AS timestamp,
1524 biblioitems.biblioitemnumber AS biblioitemnumber,
1525 reserves.itemnumber AS itemnumber,
1526 reserves.reserve_id AS reserve_id,
1527 reserves.itemtype AS itemtype
1529 JOIN biblioitems USING (biblionumber)
1530 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1533 AND item_level_request = 0
1534 AND hold_fill_targets.itemnumber = ?
1535 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1539 $sth = $dbh->prepare($title_level_target_query);
1540 $sth->execute($itemnumber, $lookahead||0);
1542 if ( my $data = $sth->fetchrow_hashref ) {
1543 push( @results, $data )
1544 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1546 return @results if @results;
1549 SELECT reserves.biblionumber AS biblionumber,
1550 reserves.borrowernumber AS borrowernumber,
1551 reserves.reservedate AS reservedate,
1552 reserves.waitingdate AS waitingdate,
1553 reserves.branchcode AS branchcode,
1554 reserves.cancellationdate AS cancellationdate,
1555 reserves.found AS found,
1556 reserves.reservenotes AS reservenotes,
1557 reserves.priority AS priority,
1558 reserves.timestamp AS timestamp,
1559 reserves.itemnumber AS itemnumber,
1560 reserves.reserve_id AS reserve_id,
1561 reserves.itemtype AS itemtype
1563 WHERE reserves.biblionumber = ?
1564 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1565 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1569 $sth = $dbh->prepare($query);
1570 $sth->execute( $biblio, $itemnumber, $lookahead||0);
1572 while ( my $data = $sth->fetchrow_hashref ) {
1573 push( @results, $data )
1574 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1579 =head2 _koha_notify_reserve
1581 _koha_notify_reserve( $hold->reserve_id );
1583 Sends a notification to the patron that their hold has been filled (through
1584 ModReserveAffect, _not_ ModReserveFill)
1586 The letter code for this notice may be found using the following query:
1588 select distinct letter_code
1589 from message_transports
1590 inner join message_attributes using (message_attribute_id)
1591 where message_name = 'Hold_Filled'
1593 This will probably sipmly be 'HOLD', but because it is defined in the database,
1594 it is subject to addition or change.
1596 The following tables are availalbe witin the notice:
1607 sub _koha_notify_reserve {
1608 my $reserve_id = shift;
1609 my $hold = Koha::Holds->find($reserve_id);
1610 my $borrowernumber = $hold->borrowernumber;
1612 my $patron = Koha::Patrons->find( $borrowernumber );
1614 # Try to get the borrower's email address
1615 my $to_address = $patron->notice_email_address;
1617 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
1618 borrowernumber => $borrowernumber,
1619 message_name => 'Hold_Filled'
1622 my $library = Koha::Libraries->find( $hold->branchcode )->unblessed;
1624 my $admin_email_address = $library->{branchemail} || C4::Context->preference('KohaAdminEmailAddress');
1626 my %letter_params = (
1627 module => 'reserves',
1628 branchcode => $hold->branchcode,
1629 lang => $patron->lang,
1631 'branches' => $library,
1632 'borrowers' => $patron->unblessed,
1633 'biblio' => $hold->biblionumber,
1634 'biblioitems' => $hold->biblionumber,
1635 'reserves' => $hold->unblessed,
1636 'items' => $hold->itemnumber,
1640 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.
1641 my $send_notification = sub {
1642 my ( $mtt, $letter_code ) = (@_);
1643 return unless defined $letter_code;
1644 $letter_params{letter_code} = $letter_code;
1645 $letter_params{message_transport_type} = $mtt;
1646 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
1648 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
1652 C4::Letters::EnqueueLetter( {
1654 borrowernumber => $borrowernumber,
1655 from_address => $admin_email_address,
1656 message_transport_type => $mtt,
1660 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
1662 ( $mtt eq 'email' and not $to_address ) # No email address
1663 or ( $mtt eq 'sms' and not $patron->smsalertnumber ) # No SMS number
1664 or ( $mtt eq 'phone' and C4::Context->preference('TalkingTechItivaPhoneNotification') ) # Notice is handled by TalkingTech_itiva_outbound.pl
1667 &$send_notification($mtt, $letter_code);
1668 $notification_sent++;
1670 #Making sure that a print notification is sent if no other transport types can be utilized.
1671 if (! $notification_sent) {
1672 &$send_notification('print', 'HOLD');
1677 =head2 _ShiftPriorityByDateAndPriority
1679 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
1681 This increments the priority of all reserves after the one
1682 with either the lowest date after C<$reservedate>
1683 or the lowest priority after C<$priority>.
1685 It effectively makes room for a new reserve to be inserted with a certain
1686 priority, which is returned.
1688 This is most useful when the reservedate can be set by the user. It allows
1689 the new reserve to be placed before other reserves that have a later
1690 reservedate. Since priority also is set by the form in reserves/request.pl
1691 the sub accounts for that too.
1695 sub _ShiftPriorityByDateAndPriority {
1696 my ( $biblio, $resdate, $new_priority ) = @_;
1698 my $dbh = C4::Context->dbh;
1699 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
1700 my $sth = $dbh->prepare( $query );
1701 $sth->execute( $biblio, $resdate, $new_priority );
1702 my $min_priority = $sth->fetchrow;
1703 # if no such matches are found, $new_priority remains as original value
1704 $new_priority = $min_priority if ( $min_priority );
1706 # Shift the priority up by one; works in conjunction with the next SQL statement
1707 $query = "UPDATE reserves
1708 SET priority = priority+1
1709 WHERE biblionumber = ?
1710 AND borrowernumber = ?
1713 my $sth_update = $dbh->prepare( $query );
1715 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1716 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1717 $sth = $dbh->prepare( $query );
1718 $sth->execute( $new_priority, $biblio );
1719 while ( my $row = $sth->fetchrow_hashref ) {
1720 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1723 return $new_priority; # so the caller knows what priority they wind up receiving
1728 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
1730 Use when checking out an item to handle reserves
1731 If $cancelreserve boolean is set to true, it will remove existing reserve
1736 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
1738 my $lookahead = C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1739 my ( $restype, $res, $all_reserves ) = CheckReserves( $itemnumber, undef, $lookahead );
1742 my $biblionumber = $res->{biblionumber};
1744 if ($res->{borrowernumber} == $borrowernumber) {
1745 ModReserveFill($res);
1749 # The item is reserved by someone else.
1750 # Find this item in the reserves
1753 foreach (@$all_reserves) {
1754 $_->{'borrowernumber'} == $borrowernumber or next;
1755 $_->{'biblionumber'} == $biblionumber or next;
1762 # The item is reserved by the current patron
1763 ModReserveFill($borr_res);
1766 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
1767 RevertWaitingStatus({ itemnumber => $itemnumber });
1769 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
1770 my $hold = Koha::Holds->find( $res->{reserve_id} );
1778 MergeHolds($dbh,$to_biblio, $from_biblio);
1780 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
1785 my ( $dbh, $to_biblio, $from_biblio ) = @_;
1786 my $sth = $dbh->prepare(
1787 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
1789 $sth->execute($from_biblio);
1790 if ( my $data = $sth->fetchrow_hashref() ) {
1792 # holds exist on old record, if not we don't need to do anything
1793 $sth = $dbh->prepare(
1794 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
1795 $sth->execute( $to_biblio, $from_biblio );
1798 # don't reorder those already waiting
1800 $sth = $dbh->prepare(
1801 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
1803 my $upd_sth = $dbh->prepare(
1804 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
1805 AND reservedate = ? AND (itemnumber = ? or itemnumber is NULL) "
1807 $sth->execute( $to_biblio, 'W', 'T' );
1809 while ( my $reserve = $sth->fetchrow_hashref() ) {
1811 $priority, $to_biblio,
1812 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
1813 $reserve->{'itemnumber'}
1820 =head2 RevertWaitingStatus
1822 RevertWaitingStatus({ itemnumber => $itemnumber });
1824 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
1826 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
1827 item level hold, even if it was only a bibliolevel hold to
1828 begin with. This is because we can no longer know if a hold
1829 was item-level or bib-level after a hold has been set to
1834 sub RevertWaitingStatus {
1835 my ( $params ) = @_;
1836 my $itemnumber = $params->{'itemnumber'};
1838 return unless ( $itemnumber );
1840 my $dbh = C4::Context->dbh;
1842 ## Get the waiting reserve we want to revert
1844 SELECT * FROM reserves
1845 WHERE itemnumber = ?
1846 AND found IS NOT NULL
1848 my $sth = $dbh->prepare( $query );
1849 $sth->execute( $itemnumber );
1850 my $reserve = $sth->fetchrow_hashref();
1852 ## Increment the priority of all other non-waiting
1853 ## reserves for this bib record
1857 priority = priority + 1
1863 $sth = $dbh->prepare( $query );
1864 $sth->execute( $reserve->{'biblionumber'} );
1866 ## Fix up the currently waiting reserve
1876 $sth = $dbh->prepare( $query );
1877 $sth->execute( $reserve->{'reserve_id'} );
1878 _FixPriority( { biblionumber => $reserve->{biblionumber} } );
1883 ReserveSlip($branchcode, $borrowernumber, $biblionumber)
1885 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
1887 The letter code will be HOLD_SLIP, and the following tables are
1888 available within the slip:
1900 my ($branch, $borrowernumber, $biblionumber) = @_;
1902 # return unless ( C4::Context->boolean_preference('printreserveslips') );
1903 my $patron = Koha::Patrons->find( $borrowernumber );
1905 my $hold = Koha::Holds->search({biblionumber => $biblionumber, borrowernumber => $borrowernumber })->next;
1906 return unless $hold;
1907 my $reserve = $hold->unblessed;
1909 return C4::Letters::GetPreparedLetter (
1910 module => 'circulation',
1911 letter_code => 'HOLD_SLIP',
1912 branchcode => $branch,
1913 lang => $patron->lang,
1915 'reserves' => $reserve,
1916 'branches' => $reserve->{branchcode},
1917 'borrowers' => $reserve->{borrowernumber},
1918 'biblio' => $reserve->{biblionumber},
1919 'biblioitems' => $reserve->{biblionumber},
1920 'items' => $reserve->{itemnumber},
1925 =head2 GetReservesControlBranch
1927 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
1929 Return the branchcode to be used to determine which reserves
1930 policy applies to a transaction.
1932 C<$item> is a hashref for an item. Only 'homebranch' is used.
1934 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
1938 sub GetReservesControlBranch {
1939 my ( $item, $borrower ) = @_;
1941 my $reserves_control = C4::Context->preference('ReservesControlBranch');
1944 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
1945 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
1951 =head2 CalculatePriority
1953 my $p = CalculatePriority($biblionumber, $resdate);
1955 Calculate priority for a new reserve on biblionumber, placing it at
1956 the end of the line of all holds whose start date falls before
1957 the current system time and that are neither on the hold shelf
1960 The reserve date parameter is optional; if it is supplied, the
1961 priority is based on the set of holds whose start date falls before
1962 the parameter value.
1964 After calculation of this priority, it is recommended to call
1965 _ShiftPriorityByDateAndPriority. Note that this is currently done in
1970 sub CalculatePriority {
1971 my ( $biblionumber, $resdate ) = @_;
1974 SELECT COUNT(*) FROM reserves
1975 WHERE biblionumber = ?
1977 AND (found IS NULL OR found = '')
1979 #skip found==W or found==T (waiting or transit holds)
1981 $sql.= ' AND ( reservedate <= ? )';
1984 $sql.= ' AND ( reservedate < NOW() )';
1986 my $dbh = C4::Context->dbh();
1987 my @row = $dbh->selectrow_array(
1990 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
1993 return @row ? $row[0]+1 : 1;
1996 =head2 IsItemOnHoldAndFound
1998 my $bool = IsItemFoundHold( $itemnumber );
2000 Returns true if the item is currently on hold
2001 and that hold has a non-null found status ( W, T, etc. )
2005 sub IsItemOnHoldAndFound {
2006 my ($itemnumber) = @_;
2008 my $rs = Koha::Database->new()->schema()->resultset('Reserve');
2010 my $found = $rs->count(
2012 itemnumber => $itemnumber,
2013 found => { '!=' => undef }
2020 =head2 GetMaxPatronHoldsForRecord
2022 my $holds_per_record = ReservesControlBranch( $borrowernumber, $biblionumber );
2024 For multiple holds on a given record for a given patron, the max
2025 number of record level holds that a patron can be placed is the highest
2026 value of the holds_per_record rule for each item if the record for that
2027 patron. This subroutine finds and returns the highest holds_per_record
2028 rule value for a given patron id and record id.
2032 sub GetMaxPatronHoldsForRecord {
2033 my ( $borrowernumber, $biblionumber ) = @_;
2035 my $patron = Koha::Patrons->find($borrowernumber);
2036 my @items = Koha::Items->search( { biblionumber => $biblionumber } );
2038 my $controlbranch = C4::Context->preference('ReservesControlBranch');
2040 my $categorycode = $patron->categorycode;
2042 $branchcode = $patron->branchcode if ( $controlbranch eq "PatronLibrary" );
2045 foreach my $item (@items) {
2046 my $itemtype = $item->effective_itemtype();
2048 $branchcode = $item->homebranch if ( $controlbranch eq "ItemHomeLibrary" );
2050 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2051 my $holds_per_record = $rule ? $rule->{holds_per_record} : 0;
2052 $max = $holds_per_record if $holds_per_record > $max;
2060 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2062 Returns the matching hold related issuingrule fields for a given
2063 patron category, itemtype, and library.
2068 my ( $categorycode, $itemtype, $branchcode ) = @_;
2070 my $dbh = C4::Context->dbh;
2072 my $sth = $dbh->prepare(
2074 SELECT categorycode, itemtype, branchcode, reservesallowed, holds_per_record
2076 WHERE (categorycode in (?,'*') )
2077 AND (itemtype IN (?,'*'))
2078 AND (branchcode IN (?,'*'))
2079 ORDER BY categorycode DESC,
2085 $sth->execute( $categorycode, $itemtype, $branchcode );
2087 return $sth->fetchrow_hashref();
2092 Koha Development Team <http://koha-community.org/>