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;
46 use Koha::IssuingRules;
51 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
107 &GetReservesForBranch
120 &ModReserveMinusPriority
126 &CanReserveBeCanceledFromOpac
128 &CancelExpiredReserves
130 &AutoUnsuspendReserves
132 &IsAvailableForItemLevelRequest
134 &OPACItemHoldsAllowed
137 &ToggleLowestPriority
143 &GetReservesControlBranch
147 GetMaxPatronHoldsForRecord
149 @EXPORT_OK = qw( MergeHolds );
154 AddReserve($branch,$borrowernumber,$biblionumber,$bibitems,$priority,$resdate,$expdate,$notes,$title,$checkitem,$found)
156 Adds reserve and generates HOLDPLACED message.
158 The following tables are available witin the HOLDPLACED message:
171 $branch, $borrowernumber, $biblionumber, $bibitems,
172 $priority, $resdate, $expdate, $notes,
173 $title, $checkitem, $found, $itemtype
176 $resdate = output_pref( { str => dt_from_string( $resdate ), dateonly => 1, dateformat => 'iso' })
177 or output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
179 $expdate = output_pref({ str => $expdate, dateonly => 1, dateformat => 'iso' });
181 if ( C4::Context->preference('AllowHoldDateInFuture') ) {
183 # Make room in reserves for this before those of a later reserve date
184 $priority = _ShiftPriorityByDateAndPriority( $biblionumber, $resdate, $priority );
189 # If the reserv had the waiting status, we had the value of the resdate
190 if ( $found eq 'W' ) {
191 $waitingdate = $resdate;
194 # Don't add itemtype limit if specific item is selected
195 $itemtype = undef if $checkitem;
197 # updates take place here
198 my $hold = Koha::Hold->new(
200 borrowernumber => $borrowernumber,
201 biblionumber => $biblionumber,
202 reservedate => $resdate,
203 branchcode => $branch,
204 priority => $priority,
205 reservenotes => $notes,
206 itemnumber => $checkitem,
208 waitingdate => $waitingdate,
209 expirationdate => $expdate,
210 itemtype => $itemtype,
214 logaction( 'HOLDS', 'CREATE', $hold->id, Dumper($hold->unblessed) )
215 if C4::Context->preference('HoldsLog');
217 my $reserve_id = $hold->id();
219 # add a reserve fee if needed
220 if ( C4::Context->preference('HoldFeeMode') ne 'any_time_is_collected' ) {
221 my $reserve_fee = GetReserveFee( $borrowernumber, $biblionumber );
222 ChargeReserveFee( $borrowernumber, $reserve_fee, $title );
225 _FixPriority({ biblionumber => $biblionumber});
227 # Send e-mail to librarian if syspref is active
228 if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
229 my $patron = Koha::Patrons->find( $borrowernumber );
230 my $library = $patron->library;
231 if ( my $letter = C4::Letters::GetPreparedLetter (
232 module => 'reserves',
233 letter_code => 'HOLDPLACED',
234 branchcode => $branch,
235 lang => $patron->lang,
237 'branches' => $library->unblessed,
238 'borrowers' => $patron->unblessed,
239 'biblio' => $biblionumber,
240 'biblioitems' => $biblionumber,
241 'items' => $checkitem,
242 'reserves' => $hold->unblessed,
246 my $admin_email_address = $library->branchemail || C4::Context->preference('KohaAdminEmailAddress');
248 C4::Letters::EnqueueLetter(
250 borrowernumber => $borrowernumber,
251 message_transport_type => 'email',
252 from_address => $admin_email_address,
253 to_address => $admin_email_address,
264 $res = GetReserve( $reserve_id );
266 Return the current reserve.
271 my ($reserve_id) = @_;
273 my $dbh = C4::Context->dbh;
275 my $query = "SELECT * FROM reserves WHERE reserve_id = ?";
276 my $sth = $dbh->prepare( $query );
277 $sth->execute( $reserve_id );
278 return $sth->fetchrow_hashref();
281 =head2 CanBookBeReserved
283 $canReserve = &CanBookBeReserved($borrowernumber, $biblionumber)
284 if ($canReserve eq 'OK') { #We can reserve this Item! }
286 See CanItemBeReserved() for possible return values.
290 sub CanBookBeReserved{
291 my ($borrowernumber, $biblionumber) = @_;
293 my $items = GetItemnumbersForBiblio($biblionumber);
294 #get items linked via host records
295 my @hostitems = get_hostitemnumbers_of($biblionumber);
297 push (@$items,@hostitems);
301 foreach my $item (@$items) {
302 $canReserve = CanItemBeReserved( $borrowernumber, $item );
303 return 'OK' if $canReserve eq 'OK';
308 =head2 CanItemBeReserved
310 $canReserve = &CanItemBeReserved($borrowernumber, $itemnumber)
311 if ($canReserve eq 'OK') { #We can reserve this Item! }
313 @RETURNS OK, if the Item can be reserved.
314 ageRestricted, if the Item is age restricted for this borrower.
315 damaged, if the Item is damaged.
316 cannotReserveFromOtherBranches, if syspref 'canreservefromotherbranches' is OK.
317 tooManyReserves, if the borrower has exceeded his maximum reserve amount.
318 notReservable, if holds on this item are not allowed
322 sub CanItemBeReserved {
323 my ( $borrowernumber, $itemnumber ) = @_;
325 my $dbh = C4::Context->dbh;
326 my $ruleitemtype; # itemtype of the matching issuing rule
327 my $allowedreserves = 0; # Total number of holds allowed across all records
328 my $holds_per_record = 1; # Total number of holds allowed for this one given record
330 # we retrieve borrowers and items informations #
331 # item->{itype} will come for biblioitems if necessery
332 my $item = GetItem($itemnumber);
333 my $biblioData = C4::Biblio::GetBiblioData( $item->{biblionumber} );
334 my $patron = Koha::Patrons->find( $borrowernumber );
335 my $borrower = $patron->unblessed;
337 # If an item is damaged and we don't allow holds on damaged items, we can stop right here
339 if ( $item->{damaged}
340 && !C4::Context->preference('AllowHoldsOnDamagedItems') );
342 # Check for the age restriction
343 my ( $ageRestriction, $daysToAgeRestriction ) =
344 C4::Circulation::GetAgeRestriction( $biblioData->{agerestriction}, $borrower );
345 return 'ageRestricted' if $daysToAgeRestriction && $daysToAgeRestriction > 0;
347 # Check that the patron doesn't have an item level hold on this item already
348 return 'itemAlreadyOnHold'
349 if Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->count();
351 my $controlbranch = C4::Context->preference('ReservesControlBranch');
354 SELECT count(*) AS count
356 LEFT JOIN items USING (itemnumber)
357 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
358 LEFT JOIN borrowers USING (borrowernumber)
359 WHERE borrowernumber = ?
363 my $branchfield = "reserves.branchcode";
365 if ( $controlbranch eq "ItemHomeLibrary" ) {
366 $branchfield = "items.homebranch";
367 $branchcode = $item->{homebranch};
369 elsif ( $controlbranch eq "PatronLibrary" ) {
370 $branchfield = "borrowers.branchcode";
371 $branchcode = $borrower->{branchcode};
375 if ( my $rights = GetHoldRule( $borrower->{'categorycode'}, $item->{'itype'}, $branchcode ) ) {
376 $ruleitemtype = $rights->{itemtype};
377 $allowedreserves = $rights->{reservesallowed};
378 $holds_per_record = $rights->{holds_per_record};
384 $item = Koha::Items->find( $itemnumber );
385 my $holds = Koha::Holds->search(
387 borrowernumber => $borrowernumber,
388 biblionumber => $item->biblionumber,
389 found => undef, # Found holds don't count against a patron's holds limit
392 if ( $holds->count() >= $holds_per_record ) {
393 return "tooManyHoldsForThisRecord";
398 $querycount .= "AND $branchfield = ?";
400 # If using item-level itypes, fall back to the record
401 # level itemtype if the hold has no associated item
403 C4::Context->preference('item-level_itypes')
404 ? " AND COALESCE( items.itype, biblioitems.itemtype ) = ?"
405 : " AND biblioitems.itemtype = ?"
406 if ( $ruleitemtype ne "*" );
408 my $sthcount = $dbh->prepare($querycount);
410 if ( $ruleitemtype eq "*" ) {
411 $sthcount->execute( $borrowernumber, $branchcode );
414 $sthcount->execute( $borrowernumber, $branchcode, $ruleitemtype );
417 my $reservecount = "0";
418 if ( my $rowcount = $sthcount->fetchrow_hashref() ) {
419 $reservecount = $rowcount->{count};
422 # we check if it's ok or not
423 if ( $reservecount >= $allowedreserves ) {
424 return 'tooManyReserves';
427 my $circ_control_branch =
428 C4::Circulation::_GetCircControlBranch( $item->unblessed(), $borrower );
430 C4::Circulation::GetBranchItemRule( $circ_control_branch, $item->itype );
432 if ( $branchitemrule->{holdallowed} == 0 ) {
433 return 'notReservable';
436 if ( $branchitemrule->{holdallowed} == 1
437 && $borrower->{branchcode} ne $item->homebranch )
439 return 'cannotReserveFromOtherBranches';
442 # If reservecount is ok, we check item branch if IndependentBranches is ON
443 # and canreservefromotherbranches is OFF
444 if ( C4::Context->preference('IndependentBranches')
445 and !C4::Context->preference('canreservefromotherbranches') )
447 my $itembranch = $item->homebranch;
448 if ( $itembranch ne $borrower->{branchcode} ) {
449 return 'cannotReserveFromOtherBranches';
456 =head2 CanReserveBeCanceledFromOpac
458 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
460 returns 1 if reserve can be cancelled by user from OPAC.
461 First check if reserve belongs to user, next checks if reserve is not in
462 transfer or waiting status
466 sub CanReserveBeCanceledFromOpac {
467 my ($reserve_id, $borrowernumber) = @_;
469 return unless $reserve_id and $borrowernumber;
470 my $reserve = GetReserve($reserve_id);
472 return 0 unless $reserve->{borrowernumber} == $borrowernumber;
473 return 0 if ( $reserve->{found} eq 'W' ) or ( $reserve->{found} eq 'T' );
479 =head2 GetReserveCount
481 $number = &GetReserveCount($borrowernumber);
483 this function returns the number of reservation for a borrower given on input arg.
487 sub GetReserveCount {
488 my ($borrowernumber) = @_;
490 my $dbh = C4::Context->dbh;
493 SELECT COUNT(*) AS counter
495 WHERE borrowernumber = ?
497 my $sth = $dbh->prepare($query);
498 $sth->execute($borrowernumber);
499 my $row = $sth->fetchrow_hashref;
500 return $row->{counter};
503 =head2 GetOtherReserves
505 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
507 Check queued list of this document and check if this document must be transferred
511 sub GetOtherReserves {
512 my ($itemnumber) = @_;
515 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
516 if ($checkreserves) {
517 my $iteminfo = GetItem($itemnumber);
518 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
519 $messages->{'transfert'} = $checkreserves->{'branchcode'};
520 #minus priorities of others reservs
521 ModReserveMinusPriority(
523 $checkreserves->{'reserve_id'},
526 #launch the subroutine dotransfer
527 C4::Items::ModItemTransfer(
529 $iteminfo->{'holdingbranch'},
530 $checkreserves->{'branchcode'}
535 #step 2b : case of a reservation on the same branch, set the waiting status
537 $messages->{'waiting'} = 1;
538 ModReserveMinusPriority(
540 $checkreserves->{'reserve_id'},
542 ModReserveStatus($itemnumber,'W');
545 $nextreservinfo = $checkreserves->{'borrowernumber'};
548 return ( $messages, $nextreservinfo );
551 =head2 ChargeReserveFee
553 $fee = ChargeReserveFee( $borrowernumber, $fee, $title );
555 Charge the fee for a reserve (if $fee > 0)
559 sub ChargeReserveFee {
560 my ( $borrowernumber, $fee, $title ) = @_;
561 return if !$fee || $fee==0; # the last test is needed to include 0.00
563 INSERT INTO accountlines ( borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding ) VALUES (?, ?, NOW(), ?, ?, 'Res', ?)
565 my $dbh = C4::Context->dbh;
566 my $nextacctno = &getnextacctno( $borrowernumber );
567 $dbh->do( $accquery, undef, ( $borrowernumber, $nextacctno, $fee, "Reserve Charge - $title", $fee ) );
572 $fee = GetReserveFee( $borrowernumber, $biblionumber );
574 Calculate the fee for a reserve (if applicable).
579 my ( $borrowernumber, $biblionumber ) = @_;
581 SELECT reservefee FROM borrowers LEFT JOIN categories ON borrowers.categorycode = categories.categorycode WHERE borrowernumber = ?
584 SELECT COUNT(*) FROM items
585 LEFT JOIN issues USING (itemnumber)
586 WHERE items.biblionumber=? AND issues.issue_id IS NULL
589 SELECT COUNT(*) FROM reserves WHERE biblionumber=? AND borrowernumber<>?
592 my $dbh = C4::Context->dbh;
593 my ( $fee ) = $dbh->selectrow_array( $borquery, undef, ($borrowernumber) );
594 my $hold_fee_mode = C4::Context->preference('HoldFeeMode') || 'not_always';
595 if( $fee and $fee > 0 and $hold_fee_mode eq 'not_always' ) {
596 # This is a reconstruction of the old code:
597 # Compare number of items with items issued, and optionally check holds
598 # If not all items are issued and there are no holds: charge no fee
599 # NOTE: Lost, damaged, not-for-loan, etc. are just ignored here
600 my ( $notissued, $reserved );
601 ( $notissued ) = $dbh->selectrow_array( $issue_qry, undef,
604 ( $reserved ) = $dbh->selectrow_array( $holds_qry, undef,
605 ( $biblionumber, $borrowernumber ) );
606 $fee = 0 if $reserved == 0;
612 =head2 GetReservesToBranch
614 @transreserv = GetReservesToBranch( $frombranch );
616 Get reserve list for a given branch
620 sub GetReservesToBranch {
621 my ( $frombranch ) = @_;
622 my $dbh = C4::Context->dbh;
623 my $sth = $dbh->prepare(
624 "SELECT reserve_id,borrowernumber,reservedate,itemnumber,timestamp
629 $sth->execute( $frombranch );
632 while ( my $data = $sth->fetchrow_hashref ) {
633 $transreserv[$i] = $data;
636 return (@transreserv);
639 =head2 GetReservesForBranch
641 @transreserv = GetReservesForBranch($frombranch);
645 sub GetReservesForBranch {
646 my ($frombranch) = @_;
647 my $dbh = C4::Context->dbh;
650 SELECT reserve_id,borrowernumber,reservedate,itemnumber,waitingdate, expirationdate
655 $query .= " AND branchcode=? " if ( $frombranch );
656 $query .= "ORDER BY waitingdate" ;
658 my $sth = $dbh->prepare($query);
660 $sth->execute($frombranch);
667 while ( my $data = $sth->fetchrow_hashref ) {
668 $transreserv[$i] = $data;
671 return (@transreserv);
674 =head2 GetReserveStatus
676 $reservestatus = GetReserveStatus($itemnumber);
678 Takes an itemnumber and returns the status of the reserve placed on it.
679 If several reserves exist, the reserve with the lower priority is given.
683 ## FIXME: I don't think this does what it thinks it does.
684 ## It only ever checks the first reserve result, even though
685 ## multiple reserves for that bib can have the itemnumber set
686 ## the sub is only used once in the codebase.
687 sub GetReserveStatus {
688 my ($itemnumber) = @_;
690 my $dbh = C4::Context->dbh;
692 my ($sth, $found, $priority);
694 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
695 $sth->execute($itemnumber);
696 ($found, $priority) = $sth->fetchrow_array;
700 return 'Waiting' if $found eq 'W' and $priority == 0;
701 return 'Finished' if $found eq 'F';
704 return 'Reserved' if $priority > 0;
706 return ''; # empty string here will remove need for checking undef, or less log lines
711 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber);
712 ($status, $reserve, $all_reserves) = &CheckReserves(undef, $barcode);
713 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
715 Find a book in the reserves.
717 C<$itemnumber> is the book's item number.
718 C<$lookahead> is the number of days to look in advance for future reserves.
720 As I understand it, C<&CheckReserves> looks for the given item in the
721 reserves. If it is found, that's a match, and C<$status> is set to
724 Otherwise, it finds the most important item in the reserves with the
725 same biblio number as this book (I'm not clear on this) and returns it
726 with C<$status> set to C<Reserved>.
728 C<&CheckReserves> returns a two-element list:
730 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
732 C<$reserve> is the reserve item that matched. It is a
733 reference-to-hash whose keys are mostly the fields of the reserves
734 table in the Koha database.
739 my ( $item, $barcode, $lookahead_days, $ignore_borrowers) = @_;
740 my $dbh = C4::Context->dbh;
743 if (C4::Context->preference('item-level_itypes')){
745 SELECT items.biblionumber,
746 items.biblioitemnumber,
747 itemtypes.notforloan,
748 items.notforloan AS itemnotforloan,
754 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
755 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
760 SELECT items.biblionumber,
761 items.biblioitemnumber,
762 itemtypes.notforloan,
763 items.notforloan AS itemnotforloan,
769 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
770 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
775 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
776 $sth->execute($item);
779 $sth = $dbh->prepare("$select WHERE barcode = ?");
780 $sth->execute($barcode);
782 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
783 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber, $damaged, $item_homebranch, $item_holdingbranch ) = $sth->fetchrow_array;
785 return if ( $damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
787 return unless $itemnumber; # bail if we got nothing.
789 # if item is not for loan it cannot be reserved either.....
790 # except where items.notforloan < 0 : This indicates the item is holdable.
791 return if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
793 # Find this item in the reserves
794 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days, $ignore_borrowers);
796 # $priority and $highest are used to find the most important item
797 # in the list returned by &_Findgroupreserve. (The lower $priority,
798 # the more important the item.)
799 # $highest is the most important item we've seen so far.
801 if (scalar @reserves) {
802 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
803 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
804 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
806 my $priority = 10000000;
807 foreach my $res (@reserves) {
808 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
809 return ( "Waiting", $res, \@reserves ); # Found it
813 my $local_hold_match;
815 if ($LocalHoldsPriority) {
816 $patron = Koha::Patrons->find( $res->{borrowernumber} );
817 $iteminfo = C4::Items::GetItem($itemnumber);
819 my $local_holds_priority_item_branchcode =
820 $iteminfo->{$LocalHoldsPriorityItemControl};
821 my $local_holds_priority_patron_branchcode =
822 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
824 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
825 ? $patron->branchcode
828 $local_holds_priority_item_branchcode eq
829 $local_holds_priority_patron_branchcode;
832 # See if this item is more important than what we've got so far
833 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
834 $iteminfo ||= C4::Items::GetItem($itemnumber);
835 next if $res->{itemtype} && $res->{itemtype} ne _get_itype( $iteminfo );
836 $patron ||= Koha::Patrons->find( $res->{borrowernumber} );
837 my $branch = GetReservesControlBranch( $iteminfo, $patron->unblessed );
838 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$iteminfo->{'itype'});
839 next if ($branchitemrule->{'holdallowed'} == 0);
840 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $patron->branchcode));
841 next if ( ($branchitemrule->{hold_fulfillment_policy} ne 'any') && ($res->{branchcode} ne $iteminfo->{ $branchitemrule->{hold_fulfillment_policy} }) );
842 $priority = $res->{'priority'};
844 last if $local_hold_match;
850 # If we get this far, then no exact match was found.
851 # We return the most important (i.e. next) reservation.
853 $highest->{'itemnumber'} = $item;
854 return ( "Reserved", $highest, \@reserves );
860 =head2 CancelExpiredReserves
862 CancelExpiredReserves();
864 Cancels all reserves with an expiration date from before today.
868 sub CancelExpiredReserves {
870 my $today = dt_from_string();
871 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
873 my $dbh = C4::Context->dbh;
874 my $sth = $dbh->prepare( "
875 SELECT * FROM reserves WHERE DATE(expirationdate) < DATE( CURDATE() )
876 AND expirationdate IS NOT NULL
880 while ( my $res = $sth->fetchrow_hashref() ) {
881 my $calendar = Koha::Calendar->new( branchcode => $res->{'branchcode'} );
882 my $cancel_params = { reserve_id => $res->{'reserve_id'} };
884 next if !$cancel_on_holidays && $calendar->is_holiday( $today );
886 if ( $res->{found} eq 'W' ) {
887 $cancel_params->{charge_cancel_fee} = 1;
890 CancelReserve($cancel_params);
894 =head2 AutoUnsuspendReserves
896 AutoUnsuspendReserves();
898 Unsuspends all suspended reserves with a suspend_until date from before today.
902 sub AutoUnsuspendReserves {
903 my $today = dt_from_string();
905 my @holds = Koha::Holds->search( { suspend_until => { '<' => $today->ymd() } } );
907 map { $_->suspend(0)->suspend_until(undef)->store() } @holds;
912 CancelReserve({ reserve_id => $reserve_id, [ biblionumber => $biblionumber, borrowernumber => $borrrowernumber, itemnumber => $itemnumber, ] [ charge_cancel_fee => 1 ] });
914 Cancels a reserve. If C<charge_cancel_fee> is passed and the C<ExpireReservesMaxPickUpDelayCharge> syspref is set, charge that fee to the patron's account.
921 my $reserve_id = $params->{'reserve_id'};
922 # Filter out only the desired keys; this will insert undefined values for elements missing in
923 # \%params, but GetReserveId filters them out anyway.
924 $reserve_id = GetReserveId( { biblionumber => $params->{'biblionumber'}, borrowernumber => $params->{'borrowernumber'}, itemnumber => $params->{'itemnumber'} } ) unless ( $reserve_id );
926 return unless ( $reserve_id );
928 my $dbh = C4::Context->dbh;
930 my $reserve = GetReserve( $reserve_id );
933 my $hold = Koha::Holds->find( $reserve_id );
934 logaction( 'HOLDS', 'CANCEL', $hold->reserve_id, Dumper($hold->unblessed) )
935 if C4::Context->preference('HoldsLog');
939 SET cancellationdate = now(),
943 my $sth = $dbh->prepare($query);
944 $sth->execute( $reserve_id );
947 INSERT INTO old_reserves
948 SELECT * FROM reserves
951 $sth = $dbh->prepare($query);
952 $sth->execute( $reserve_id );
958 $sth = $dbh->prepare($query);
959 $sth->execute( $reserve_id );
961 # now fix the priority on the others....
962 _FixPriority({ biblionumber => $reserve->{biblionumber} });
964 # and, if desired, charge a cancel fee
965 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
966 if ( $charge && $params->{'charge_cancel_fee'} ) {
967 manualinvoice($reserve->{'borrowernumber'}, $reserve->{'itemnumber'}, '', 'HE', $charge);
976 ModReserve({ rank => $rank,
977 reserve_id => $reserve_id,
978 branchcode => $branchcode
979 [, itemnumber => $itemnumber ]
980 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
983 Change a hold request's priority or cancel it.
985 C<$rank> specifies the effect of the change. If C<$rank>
986 is 'W' or 'n', nothing happens. This corresponds to leaving a
987 request alone when changing its priority in the holds queue
990 If C<$rank> is 'del', the hold request is cancelled.
992 If C<$rank> is an integer greater than zero, the priority of
993 the request is set to that value. Since priority != 0 means
994 that the item is not waiting on the hold shelf, setting the
995 priority to a non-zero value also sets the request's found
996 status and waiting date to NULL.
998 The optional C<$itemnumber> parameter is used only when
999 C<$rank> is a non-zero integer; if supplied, the itemnumber
1000 of the hold request is set accordingly; if omitted, the itemnumber
1003 B<FIXME:> Note that the forgoing can have the effect of causing
1004 item-level hold requests to turn into title-level requests. This
1005 will be fixed once reserves has separate columns for requested
1006 itemnumber and supplying itemnumber.
1011 my ( $params ) = @_;
1013 my $rank = $params->{'rank'};
1014 my $reserve_id = $params->{'reserve_id'};
1015 my $branchcode = $params->{'branchcode'};
1016 my $itemnumber = $params->{'itemnumber'};
1017 my $suspend_until = $params->{'suspend_until'};
1018 my $borrowernumber = $params->{'borrowernumber'};
1019 my $biblionumber = $params->{'biblionumber'};
1021 return if $rank eq "W";
1022 return if $rank eq "n";
1024 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1025 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber }) unless ( $reserve_id );
1027 if ( $rank eq "del" ) {
1028 CancelReserve({ reserve_id => $reserve_id });
1030 elsif ($rank =~ /^\d+/ and $rank > 0) {
1031 my $hold = Koha::Holds->find($reserve_id);
1032 logaction( 'HOLDS', 'MODIFY', $hold->reserve_id, Dumper($hold->unblessed) )
1033 if C4::Context->preference('HoldsLog');
1038 branchcode => $branchcode,
1039 itemnumber => $itemnumber,
1041 waitingdate => undef
1045 if ( defined( $suspend_until ) ) {
1046 if ( $suspend_until ) {
1047 $suspend_until = eval { dt_from_string( $suspend_until ) };
1048 $hold->suspend_hold( $suspend_until );
1050 # If the hold is suspended leave the hold suspended, but convert it to an indefinite hold.
1051 # If the hold is not suspended, this does nothing.
1052 $hold->set( { suspend_until => undef } )->store();
1056 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
1060 =head2 ModReserveFill
1062 &ModReserveFill($reserve);
1064 Fill a reserve. If I understand this correctly, this means that the
1065 reserved book has been found and given to the patron who reserved it.
1067 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
1068 whose keys are fields from the reserves table in the Koha database.
1072 sub ModReserveFill {
1074 my $reserve_id = $res->{'reserve_id'};
1076 my $hold = Koha::Holds->find($reserve_id);
1078 # get the priority on this record....
1079 my $priority = $hold->priority;
1081 # update the hold statuses, no need to store it though, we will be deleting it anyway
1089 Koha::Old::Hold->new( $hold->unblessed() )->store();
1093 if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
1094 my $reserve_fee = GetReserveFee( $hold->borrowernumber, $hold->biblionumber );
1095 ChargeReserveFee( $hold->borrowernumber, $reserve_fee, $hold->biblio->title );
1098 # now fix the priority on the others (if the priority wasn't
1099 # already sorted!)....
1100 unless ( $priority == 0 ) {
1101 _FixPriority( { reserve_id => $reserve_id, biblionumber => $hold->biblionumber } );
1105 =head2 ModReserveStatus
1107 &ModReserveStatus($itemnumber, $newstatus);
1109 Update the reserve status for the active (priority=0) reserve.
1111 $itemnumber is the itemnumber the reserve is on
1113 $newstatus is the new status.
1117 sub ModReserveStatus {
1119 #first : check if we have a reservation for this item .
1120 my ($itemnumber, $newstatus) = @_;
1121 my $dbh = C4::Context->dbh;
1123 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1124 my $sth_set = $dbh->prepare($query);
1125 $sth_set->execute( $newstatus, $itemnumber );
1127 if ( C4::Context->preference("ReturnToShelvingCart") && $newstatus ) {
1128 CartToShelf( $itemnumber );
1132 =head2 ModReserveAffect
1134 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend,$reserve_id);
1136 This function affect an item and a status for a given reserve, either fetched directly
1137 by record_id, or by borrowernumber and itemnumber or biblionumber. If only biblionumber
1138 is given, only first reserve returned is affected, which is ok for anything but
1141 if $transferToDo is not set, then the status is set to "Waiting" as well.
1142 otherwise, a transfer is on the way, and the end of the transfer will
1143 take care of the waiting status
1147 sub ModReserveAffect {
1148 my ( $itemnumber, $borrowernumber, $transferToDo, $reserve_id ) = @_;
1149 my $dbh = C4::Context->dbh;
1151 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1152 # attached to $itemnumber
1153 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1154 $sth->execute($itemnumber);
1155 my ($biblionumber) = $sth->fetchrow;
1157 # get request - need to find out if item is already
1158 # waiting in order to not send duplicate hold filled notifications
1161 # Find hold by id if we have it
1162 $hold = Koha::Holds->find( $reserve_id ) if $reserve_id;
1163 # Find item level hold for this item if there is one
1164 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, itemnumber => $itemnumber } )->next();
1165 # Find record level hold if there is no item level hold
1166 $hold ||= Koha::Holds->search( { borrowernumber => $borrowernumber, biblionumber => $biblionumber } )->next();
1168 return unless $hold;
1170 my $already_on_shelf = $hold->found && $hold->found eq 'W';
1172 $hold->itemnumber($itemnumber);
1173 $hold->set_waiting($transferToDo);
1175 _koha_notify_reserve( $hold->reserve_id )
1176 if ( !$transferToDo && !$already_on_shelf );
1178 _FixPriority( { biblionumber => $biblionumber } );
1180 if ( C4::Context->preference("ReturnToShelvingCart") ) {
1181 CartToShelf($itemnumber);
1187 =head2 ModReserveCancelAll
1189 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1191 function to cancel reserv,check other reserves, and transfer document if it's necessary
1195 sub ModReserveCancelAll {
1198 my ( $itemnumber, $borrowernumber ) = @_;
1200 #step 1 : cancel the reservation
1201 my $CancelReserve = CancelReserve({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1203 #step 2 launch the subroutine of the others reserves
1204 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1206 return ( $messages, $nextreservinfo );
1209 =head2 ModReserveMinusPriority
1211 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1213 Reduce the values of queued list
1217 sub ModReserveMinusPriority {
1218 my ( $itemnumber, $reserve_id ) = @_;
1220 #first step update the value of the first person on reserv
1221 my $dbh = C4::Context->dbh;
1224 SET priority = 0 , itemnumber = ?
1225 WHERE reserve_id = ?
1227 my $sth_upd = $dbh->prepare($query);
1228 $sth_upd->execute( $itemnumber, $reserve_id );
1229 # second step update all others reserves
1230 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1233 =head2 GetReserveInfo
1235 &GetReserveInfo($reserve_id);
1237 Get item and borrower details for a current hold.
1238 Current implementation this query should have a single result.
1242 sub GetReserveInfo {
1243 my ( $reserve_id ) = @_;
1244 my $dbh = C4::Context->dbh;
1249 reserves.borrowernumber,
1250 reserves.biblionumber,
1251 reserves.branchcode,
1252 reserves.waitingdate,
1268 items.holdingbranch,
1269 items.itemcallnumber,
1275 LEFT JOIN items USING(itemnumber)
1276 LEFT JOIN borrowers USING(borrowernumber)
1277 LEFT JOIN biblio ON (reserves.biblionumber=biblio.biblionumber)
1278 WHERE reserves.reserve_id = ?";
1279 my $sth = $dbh->prepare($strsth);
1280 $sth->execute($reserve_id);
1282 my $data = $sth->fetchrow_hashref;
1286 =head2 IsAvailableForItemLevelRequest
1288 my $is_available = IsAvailableForItemLevelRequest($item_record,$borrower_record);
1290 Checks whether a given item record is available for an
1291 item-level hold request. An item is available if
1293 * it is not lost AND
1294 * it is not damaged AND
1295 * it is not withdrawn AND
1296 * does not have a not for loan value > 0
1298 Need to check the issuingrules onshelfholds column,
1299 if this is set items on the shelf can be placed on hold
1301 Note that IsAvailableForItemLevelRequest() does not
1302 check if the staff operator is authorized to place
1303 a request on the item - in particular,
1304 this routine does not check IndependentBranches
1305 and canreservefromotherbranches.
1309 sub IsAvailableForItemLevelRequest {
1311 my $borrower = shift;
1313 my $dbh = C4::Context->dbh;
1314 # must check the notforloan setting of the itemtype
1315 # FIXME - a lot of places in the code do this
1316 # or something similar - need to be
1318 my $itype = _get_itype($item);
1319 my $notforloan_per_itemtype
1320 = $dbh->selectrow_array("SELECT notforloan FROM itemtypes WHERE itemtype = ?",
1324 $notforloan_per_itemtype ||
1325 $item->{itemlost} ||
1326 $item->{notforloan} > 0 ||
1327 $item->{withdrawn} ||
1328 ($item->{damaged} && !C4::Context->preference('AllowHoldsOnDamagedItems'));
1330 my $on_shelf_holds = _OnShelfHoldsAllowed($itype,$borrower->{categorycode},$item->{holdingbranch});
1332 if ( $on_shelf_holds == 1 ) {
1334 } elsif ( $on_shelf_holds == 2 ) {
1336 Koha::Items->search( { biblionumber => $item->{biblionumber} } );
1338 my $any_available = 0;
1340 foreach my $i (@items) {
1343 || $i->notforloan > 0
1346 || IsItemOnHoldAndFound( $i->id )
1348 && !C4::Context->preference('AllowHoldsOnDamagedItems') )
1349 || Koha::ItemTypes->find( $i->effective_itemtype() )->notforloan;
1352 return $any_available ? 0 : 1;
1355 return $item->{onloan} || GetReserveStatus($item->{itemnumber}) eq "Waiting";
1358 =head2 OnShelfHoldsAllowed
1360 OnShelfHoldsAllowed($itemtype,$borrowercategory,$branchcode);
1362 Checks issuingrules, using the borrowers categorycode, the itemtype, and branchcode to see if onshelf
1363 holds are allowed, returns true if so.
1367 sub OnShelfHoldsAllowed {
1368 my ($item, $borrower) = @_;
1370 my $itype = _get_itype($item);
1371 return _OnShelfHoldsAllowed($itype,$borrower->{categorycode},$item->{holdingbranch});
1378 if (C4::Context->preference('item-level_itypes')) {
1379 # We can't trust GetItem to honour the syspref, so safest to do it ourselves
1380 # When GetItem is fixed, we can remove this
1381 $itype = $item->{itype};
1384 # XXX This is a bit dodgy. It relies on biblio itemtype column having different name.
1385 # So if we already have a biblioitems join when calling this function,
1386 # we don't need to access the database again
1387 $itype = $item->{itemtype};
1390 my $dbh = C4::Context->dbh;
1391 my $query = "SELECT itemtype FROM biblioitems WHERE biblioitemnumber = ? ";
1392 my $sth = $dbh->prepare($query);
1393 $sth->execute($item->{biblioitemnumber});
1394 if (my $data = $sth->fetchrow_hashref()){
1395 $itype = $data->{itemtype};
1401 sub _OnShelfHoldsAllowed {
1402 my ($itype,$borrowercategory,$branchcode) = @_;
1404 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule({ categorycode => $borrowercategory, itemtype => $itype, branchcode => $branchcode });
1405 return $issuing_rule ? $issuing_rule->onshelfholds : undef;
1408 =head2 AlterPriority
1410 AlterPriority( $where, $reserve_id );
1412 This function changes a reserve's priority up, down, to the top, or to the bottom.
1413 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1418 my ( $where, $reserve_id ) = @_;
1420 my $reserve = GetReserve( $reserve_id );
1422 if ( $reserve->{cancellationdate} ) {
1423 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (".$reserve->{cancellationdate}.')';
1427 if ( $where eq 'up' || $where eq 'down' ) {
1429 my $priority = $reserve->{'priority'};
1430 $priority = $where eq 'up' ? $priority - 1 : $priority + 1;
1431 _FixPriority({ reserve_id => $reserve_id, rank => $priority })
1433 } elsif ( $where eq 'top' ) {
1435 _FixPriority({ reserve_id => $reserve_id, rank => '1' })
1437 } elsif ( $where eq 'bottom' ) {
1439 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1444 =head2 ToggleLowestPriority
1446 ToggleLowestPriority( $borrowernumber, $biblionumber );
1448 This function sets the lowestPriority field to true if is false, and false if it is true.
1452 sub ToggleLowestPriority {
1453 my ( $reserve_id ) = @_;
1455 my $dbh = C4::Context->dbh;
1457 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1458 $sth->execute( $reserve_id );
1460 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1463 =head2 ToggleSuspend
1465 ToggleSuspend( $reserve_id );
1467 This function sets the suspend field to true if is false, and false if it is true.
1468 If the reserve is currently suspended with a suspend_until date, that date will
1469 be cleared when it is unsuspended.
1474 my ( $reserve_id, $suspend_until ) = @_;
1476 $suspend_until = dt_from_string($suspend_until) if ($suspend_until);
1478 my $hold = Koha::Holds->find( $reserve_id );
1480 if ( $hold->is_suspended ) {
1483 $hold->suspend_hold( $suspend_until );
1490 borrowernumber => $borrowernumber,
1491 [ biblionumber => $biblionumber, ]
1492 [ suspend_until => $suspend_until, ]
1493 [ suspend => $suspend ]
1496 This function accepts a set of hash keys as its parameters.
1497 It requires either borrowernumber or biblionumber, or both.
1499 suspend_until is wholly optional.
1506 my $borrowernumber = $params{'borrowernumber'} || undef;
1507 my $biblionumber = $params{'biblionumber'} || undef;
1508 my $suspend_until = $params{'suspend_until'} || undef;
1509 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1511 $suspend_until = eval { dt_from_string($suspend_until) }
1512 if ( defined($suspend_until) );
1514 return unless ( $borrowernumber || $biblionumber );
1517 $params->{found} = undef;
1518 $params->{borrowernumber} = $borrowernumber if $borrowernumber;
1519 $params->{biblionumber} = $biblionumber if $biblionumber;
1521 my @holds = Koha::Holds->search($params);
1524 map { $_->suspend_hold($suspend_until) } @holds;
1527 map { $_->resume() } @holds;
1535 reserve_id => $reserve_id,
1537 [ignoreSetLowestRank => $ignoreSetLowestRank]
1542 _FixPriority({ biblionumber => $biblionumber});
1544 This routine adjusts the priority of a hold request and holds
1547 In the first form, where a reserve_id is passed, the priority of the
1548 hold is set to supplied rank, and other holds for that bib are adjusted
1549 accordingly. If the rank is "del", the hold is cancelled. If no rank
1550 is supplied, all of the holds on that bib have their priority adjusted
1551 as if the second form had been used.
1553 In the second form, where a biblionumber is passed, the holds on that
1554 bib (that are not captured) are sorted in order of increasing priority,
1555 then have reserves.priority set so that the first non-captured hold
1556 has its priority set to 1, the second non-captured hold has its priority
1557 set to 2, and so forth.
1559 In both cases, holds that have the lowestPriority flag on are have their
1560 priority adjusted to ensure that they remain at the end of the line.
1562 Note that the ignoreSetLowestRank parameter is meant to be used only
1563 when _FixPriority calls itself.
1568 my ( $params ) = @_;
1569 my $reserve_id = $params->{reserve_id};
1570 my $rank = $params->{rank} // '';
1571 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1572 my $biblionumber = $params->{biblionumber};
1574 my $dbh = C4::Context->dbh;
1576 unless ( $biblionumber ) {
1577 my $res = GetReserve( $reserve_id );
1578 $biblionumber = $res->{biblionumber};
1581 if ( $rank eq "del" ) {
1582 CancelReserve({ reserve_id => $reserve_id });
1584 elsif ( $rank eq "W" || $rank eq "0" ) {
1586 # make sure priority for waiting or in-transit items is 0
1590 WHERE reserve_id = ?
1591 AND found IN ('W', 'T')
1593 my $sth = $dbh->prepare($query);
1594 $sth->execute( $reserve_id );
1600 SELECT reserve_id, borrowernumber, reservedate
1602 WHERE biblionumber = ?
1603 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1604 ORDER BY priority ASC
1606 my $sth = $dbh->prepare($query);
1607 $sth->execute( $biblionumber );
1608 while ( my $line = $sth->fetchrow_hashref ) {
1609 push( @priority, $line );
1612 # To find the matching index
1614 my $key = -1; # to allow for 0 to be a valid result
1615 for ( $i = 0 ; $i < @priority ; $i++ ) {
1616 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1617 $key = $i; # save the index
1622 # if index exists in array then move it to new position
1623 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1624 my $new_rank = $rank -
1625 1; # $new_rank is what you want the new index to be in the array
1626 my $moving_item = splice( @priority, $key, 1 );
1627 splice( @priority, $new_rank, 0, $moving_item );
1630 # now fix the priority on those that are left....
1634 WHERE reserve_id = ?
1636 $sth = $dbh->prepare($query);
1637 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1640 $priority[$j]->{'reserve_id'}
1644 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1647 unless ( $ignoreSetLowestRank ) {
1648 while ( my $res = $sth->fetchrow_hashref() ) {
1650 reserve_id => $res->{'reserve_id'},
1652 ignoreSetLowestRank => 1
1658 =head2 _Findgroupreserve
1660 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead, $ignore_borrowers);
1662 Looks for a holds-queue based item-specific match first, then for a holds-queue title-level match, returning the
1663 first match found. If neither, then we look for non-holds-queue based holds.
1664 Lookahead is the number of days to look in advance.
1666 C<&_Findgroupreserve> returns :
1667 C<@results> is an array of references-to-hash whose keys are mostly
1668 fields from the reserves table of the Koha database, plus
1669 C<biblioitemnumber>.
1673 sub _Findgroupreserve {
1674 my ( $bibitem, $biblio, $itemnumber, $lookahead, $ignore_borrowers) = @_;
1675 my $dbh = C4::Context->dbh;
1677 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1678 # check for exact targeted match
1679 my $item_level_target_query = qq{
1680 SELECT reserves.biblionumber AS biblionumber,
1681 reserves.borrowernumber AS borrowernumber,
1682 reserves.reservedate AS reservedate,
1683 reserves.branchcode AS branchcode,
1684 reserves.cancellationdate AS cancellationdate,
1685 reserves.found AS found,
1686 reserves.reservenotes AS reservenotes,
1687 reserves.priority AS priority,
1688 reserves.timestamp AS timestamp,
1689 biblioitems.biblioitemnumber AS biblioitemnumber,
1690 reserves.itemnumber AS itemnumber,
1691 reserves.reserve_id AS reserve_id,
1692 reserves.itemtype AS itemtype
1694 JOIN biblioitems USING (biblionumber)
1695 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1698 AND item_level_request = 1
1700 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1704 my $sth = $dbh->prepare($item_level_target_query);
1705 $sth->execute($itemnumber, $lookahead||0);
1707 if ( my $data = $sth->fetchrow_hashref ) {
1708 push( @results, $data )
1709 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1711 return @results if @results;
1713 # check for title-level targeted match
1714 my $title_level_target_query = qq{
1715 SELECT reserves.biblionumber AS biblionumber,
1716 reserves.borrowernumber AS borrowernumber,
1717 reserves.reservedate AS reservedate,
1718 reserves.branchcode AS branchcode,
1719 reserves.cancellationdate AS cancellationdate,
1720 reserves.found AS found,
1721 reserves.reservenotes AS reservenotes,
1722 reserves.priority AS priority,
1723 reserves.timestamp AS timestamp,
1724 biblioitems.biblioitemnumber AS biblioitemnumber,
1725 reserves.itemnumber AS itemnumber,
1726 reserves.reserve_id AS reserve_id,
1727 reserves.itemtype AS itemtype
1729 JOIN biblioitems USING (biblionumber)
1730 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1733 AND item_level_request = 0
1734 AND hold_fill_targets.itemnumber = ?
1735 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1739 $sth = $dbh->prepare($title_level_target_query);
1740 $sth->execute($itemnumber, $lookahead||0);
1742 if ( my $data = $sth->fetchrow_hashref ) {
1743 push( @results, $data )
1744 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1746 return @results if @results;
1749 SELECT reserves.biblionumber AS biblionumber,
1750 reserves.borrowernumber AS borrowernumber,
1751 reserves.reservedate AS reservedate,
1752 reserves.waitingdate AS waitingdate,
1753 reserves.branchcode AS branchcode,
1754 reserves.cancellationdate AS cancellationdate,
1755 reserves.found AS found,
1756 reserves.reservenotes AS reservenotes,
1757 reserves.priority AS priority,
1758 reserves.timestamp AS timestamp,
1759 reserves.itemnumber AS itemnumber,
1760 reserves.reserve_id AS reserve_id,
1761 reserves.itemtype AS itemtype
1763 WHERE reserves.biblionumber = ?
1764 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1765 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1769 $sth = $dbh->prepare($query);
1770 $sth->execute( $biblio, $itemnumber, $lookahead||0);
1772 while ( my $data = $sth->fetchrow_hashref ) {
1773 push( @results, $data )
1774 unless any{ $data->{borrowernumber} eq $_ } @$ignore_borrowers ;
1779 =head2 _koha_notify_reserve
1781 _koha_notify_reserve( $hold->reserve_id );
1783 Sends a notification to the patron that their hold has been filled (through
1784 ModReserveAffect, _not_ ModReserveFill)
1786 The letter code for this notice may be found using the following query:
1788 select distinct letter_code
1789 from message_transports
1790 inner join message_attributes using (message_attribute_id)
1791 where message_name = 'Hold_Filled'
1793 This will probably sipmly be 'HOLD', but because it is defined in the database,
1794 it is subject to addition or change.
1796 The following tables are availalbe witin the notice:
1807 sub _koha_notify_reserve {
1808 my $reserve_id = shift;
1809 my $hold = Koha::Holds->find($reserve_id);
1810 my $borrowernumber = $hold->borrowernumber;
1812 my $patron = Koha::Patrons->find( $borrowernumber );
1814 # Try to get the borrower's email address
1815 my $to_address = C4::Members::GetNoticeEmailAddress($borrowernumber);
1817 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
1818 borrowernumber => $borrowernumber,
1819 message_name => 'Hold_Filled'
1822 my $library = Koha::Libraries->find( $hold->branchcode )->unblessed;
1824 my $admin_email_address = $library->{branchemail} || C4::Context->preference('KohaAdminEmailAddress');
1826 my %letter_params = (
1827 module => 'reserves',
1828 branchcode => $hold->branchcode,
1829 lang => $patron->lang,
1831 'branches' => $library,
1832 'borrowers' => $patron->unblessed,
1833 'biblio' => $hold->biblionumber,
1834 'biblioitems' => $hold->biblionumber,
1835 'reserves' => $hold->unblessed,
1836 'items' => $hold->itemnumber,
1840 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.
1841 my $send_notification = sub {
1842 my ( $mtt, $letter_code ) = (@_);
1843 return unless defined $letter_code;
1844 $letter_params{letter_code} = $letter_code;
1845 $letter_params{message_transport_type} = $mtt;
1846 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
1848 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
1852 C4::Letters::EnqueueLetter( {
1854 borrowernumber => $borrowernumber,
1855 from_address => $admin_email_address,
1856 message_transport_type => $mtt,
1860 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
1862 ( $mtt eq 'email' and not $to_address ) # No email address
1863 or ( $mtt eq 'sms' and not $patron->smsalertnumber ) # No SMS number
1864 or ( $mtt eq 'phone' and C4::Context->preference('TalkingTechItivaPhoneNotification') ) # Notice is handled by TalkingTech_itiva_outbound.pl
1867 &$send_notification($mtt, $letter_code);
1868 $notification_sent++;
1870 #Making sure that a print notification is sent if no other transport types can be utilized.
1871 if (! $notification_sent) {
1872 &$send_notification('print', 'HOLD');
1877 =head2 _ShiftPriorityByDateAndPriority
1879 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
1881 This increments the priority of all reserves after the one
1882 with either the lowest date after C<$reservedate>
1883 or the lowest priority after C<$priority>.
1885 It effectively makes room for a new reserve to be inserted with a certain
1886 priority, which is returned.
1888 This is most useful when the reservedate can be set by the user. It allows
1889 the new reserve to be placed before other reserves that have a later
1890 reservedate. Since priority also is set by the form in reserves/request.pl
1891 the sub accounts for that too.
1895 sub _ShiftPriorityByDateAndPriority {
1896 my ( $biblio, $resdate, $new_priority ) = @_;
1898 my $dbh = C4::Context->dbh;
1899 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
1900 my $sth = $dbh->prepare( $query );
1901 $sth->execute( $biblio, $resdate, $new_priority );
1902 my $min_priority = $sth->fetchrow;
1903 # if no such matches are found, $new_priority remains as original value
1904 $new_priority = $min_priority if ( $min_priority );
1906 # Shift the priority up by one; works in conjunction with the next SQL statement
1907 $query = "UPDATE reserves
1908 SET priority = priority+1
1909 WHERE biblionumber = ?
1910 AND borrowernumber = ?
1913 my $sth_update = $dbh->prepare( $query );
1915 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1916 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1917 $sth = $dbh->prepare( $query );
1918 $sth->execute( $new_priority, $biblio );
1919 while ( my $row = $sth->fetchrow_hashref ) {
1920 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1923 return $new_priority; # so the caller knows what priority they wind up receiving
1926 =head2 OPACItemHoldsAllowed
1928 OPACItemHoldsAllowed($item_record,$borrower_record);
1930 Checks issuingrules, using the borrowers categorycode, the itemtype, and branchcode to see
1931 if specific item holds are allowed, returns true if so.
1935 sub OPACItemHoldsAllowed {
1936 my ($item,$borrower) = @_;
1938 my $branchcode = $item->{homebranch} or die "No homebranch";
1940 my $dbh = C4::Context->dbh;
1941 if (C4::Context->preference('item-level_itypes')) {
1942 # We can't trust GetItem to honour the syspref, so safest to do it ourselves
1943 # When GetItem is fixed, we can remove this
1944 $itype = $item->{itype};
1947 my $query = "SELECT itemtype FROM biblioitems WHERE biblioitemnumber = ? ";
1948 my $sth = $dbh->prepare($query);
1949 $sth->execute($item->{biblioitemnumber});
1950 if (my $data = $sth->fetchrow_hashref()){
1951 $itype = $data->{itemtype};
1955 my $query = "SELECT opacitemholds,categorycode,itemtype,branchcode FROM issuingrules WHERE
1956 (issuingrules.categorycode = ? OR issuingrules.categorycode = '*')
1958 (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
1960 (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')
1962 issuingrules.categorycode desc,
1963 issuingrules.itemtype desc,
1964 issuingrules.branchcode desc
1966 my $sth = $dbh->prepare($query);
1967 $sth->execute($borrower->{categorycode},$itype,$branchcode);
1968 my $data = $sth->fetchrow_hashref;
1969 my $opacitemholds = uc substr ($data->{opacitemholds}, 0, 1);
1970 return '' if $opacitemholds eq 'N';
1971 return $opacitemholds;
1976 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
1978 Use when checking out an item to handle reserves
1979 If $cancelreserve boolean is set to true, it will remove existing reserve
1984 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
1986 my $lookahead = C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1987 my ( $restype, $res, $all_reserves ) = CheckReserves( $itemnumber, undef, $lookahead );
1990 my $biblionumber = $res->{biblionumber};
1992 if ($res->{borrowernumber} == $borrowernumber) {
1993 ModReserveFill($res);
1997 # The item is reserved by someone else.
1998 # Find this item in the reserves
2001 foreach (@$all_reserves) {
2002 $_->{'borrowernumber'} == $borrowernumber or next;
2003 $_->{'biblionumber'} == $biblionumber or next;
2010 # The item is reserved by the current patron
2011 ModReserveFill($borr_res);
2014 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2015 RevertWaitingStatus({ itemnumber => $itemnumber });
2017 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2018 CancelReserve( { reserve_id => $res->{'reserve_id'} } );
2025 MergeHolds($dbh,$to_biblio, $from_biblio);
2027 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2032 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2033 my $sth = $dbh->prepare(
2034 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2036 $sth->execute($from_biblio);
2037 if ( my $data = $sth->fetchrow_hashref() ) {
2039 # holds exist on old record, if not we don't need to do anything
2040 $sth = $dbh->prepare(
2041 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2042 $sth->execute( $to_biblio, $from_biblio );
2045 # don't reorder those already waiting
2047 $sth = $dbh->prepare(
2048 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
2050 my $upd_sth = $dbh->prepare(
2051 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2052 AND reservedate = ? AND (itemnumber = ? or itemnumber is NULL) "
2054 $sth->execute( $to_biblio, 'W', 'T' );
2056 while ( my $reserve = $sth->fetchrow_hashref() ) {
2058 $priority, $to_biblio,
2059 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2060 $reserve->{'itemnumber'}
2067 =head2 RevertWaitingStatus
2069 RevertWaitingStatus({ itemnumber => $itemnumber });
2071 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2073 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2074 item level hold, even if it was only a bibliolevel hold to
2075 begin with. This is because we can no longer know if a hold
2076 was item-level or bib-level after a hold has been set to
2081 sub RevertWaitingStatus {
2082 my ( $params ) = @_;
2083 my $itemnumber = $params->{'itemnumber'};
2085 return unless ( $itemnumber );
2087 my $dbh = C4::Context->dbh;
2089 ## Get the waiting reserve we want to revert
2091 SELECT * FROM reserves
2092 WHERE itemnumber = ?
2093 AND found IS NOT NULL
2095 my $sth = $dbh->prepare( $query );
2096 $sth->execute( $itemnumber );
2097 my $reserve = $sth->fetchrow_hashref();
2099 ## Increment the priority of all other non-waiting
2100 ## reserves for this bib record
2104 priority = priority + 1
2110 $sth = $dbh->prepare( $query );
2111 $sth->execute( $reserve->{'biblionumber'} );
2113 ## Fix up the currently waiting reserve
2123 $sth = $dbh->prepare( $query );
2124 $sth->execute( $reserve->{'reserve_id'} );
2125 _FixPriority( { biblionumber => $reserve->{biblionumber} } );
2130 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber [, itemnumber => $itemnumber ] });
2132 Returnes the first reserve id that matches the given criteria
2137 my ( $params ) = @_;
2139 return unless ( ( $params->{'biblionumber'} || $params->{'itemnumber'} ) && $params->{'borrowernumber'} );
2141 foreach my $key ( keys %$params ) {
2142 delete $params->{$key} unless defined( $params->{$key} );
2145 my $hold = Koha::Holds->search( $params )->next();
2147 return unless $hold;
2154 ReserveSlip($branchcode, $borrowernumber, $biblionumber)
2156 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2158 The letter code will be HOLD_SLIP, and the following tables are
2159 available within the slip:
2171 my ($branch, $borrowernumber, $biblionumber) = @_;
2173 # return unless ( C4::Context->boolean_preference('printreserveslips') );
2174 my $patron = Koha::Patrons->find( $borrowernumber );
2176 my $reserve_id = GetReserveId({
2177 biblionumber => $biblionumber,
2178 borrowernumber => $borrowernumber
2180 my $reserve = GetReserveInfo($reserve_id) or return;
2182 return C4::Letters::GetPreparedLetter (
2183 module => 'circulation',
2184 letter_code => 'HOLD_SLIP',
2185 branchcode => $branch,
2186 lang => $patron->lang,
2188 'reserves' => $reserve,
2189 'branches' => $reserve->{branchcode},
2190 'borrowers' => $reserve->{borrowernumber},
2191 'biblio' => $reserve->{biblionumber},
2192 'biblioitems' => $reserve->{biblionumber},
2193 'items' => $reserve->{itemnumber},
2198 =head2 GetReservesControlBranch
2200 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2202 Return the branchcode to be used to determine which reserves
2203 policy applies to a transaction.
2205 C<$item> is a hashref for an item. Only 'homebranch' is used.
2207 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2211 sub GetReservesControlBranch {
2212 my ( $item, $borrower ) = @_;
2214 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2217 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2218 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2224 =head2 CalculatePriority
2226 my $p = CalculatePriority($biblionumber, $resdate);
2228 Calculate priority for a new reserve on biblionumber, placing it at
2229 the end of the line of all holds whose start date falls before
2230 the current system time and that are neither on the hold shelf
2233 The reserve date parameter is optional; if it is supplied, the
2234 priority is based on the set of holds whose start date falls before
2235 the parameter value.
2237 After calculation of this priority, it is recommended to call
2238 _ShiftPriorityByDateAndPriority. Note that this is currently done in
2243 sub CalculatePriority {
2244 my ( $biblionumber, $resdate ) = @_;
2247 SELECT COUNT(*) FROM reserves
2248 WHERE biblionumber = ?
2250 AND (found IS NULL OR found = '')
2252 #skip found==W or found==T (waiting or transit holds)
2254 $sql.= ' AND ( reservedate <= ? )';
2257 $sql.= ' AND ( reservedate < NOW() )';
2259 my $dbh = C4::Context->dbh();
2260 my @row = $dbh->selectrow_array(
2263 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
2266 return @row ? $row[0]+1 : 1;
2269 =head2 IsItemOnHoldAndFound
2271 my $bool = IsItemFoundHold( $itemnumber );
2273 Returns true if the item is currently on hold
2274 and that hold has a non-null found status ( W, T, etc. )
2278 sub IsItemOnHoldAndFound {
2279 my ($itemnumber) = @_;
2281 my $rs = Koha::Database->new()->schema()->resultset('Reserve');
2283 my $found = $rs->count(
2285 itemnumber => $itemnumber,
2286 found => { '!=' => undef }
2293 =head2 GetMaxPatronHoldsForRecord
2295 my $holds_per_record = ReservesControlBranch( $borrowernumber, $biblionumber );
2297 For multiple holds on a given record for a given patron, the max
2298 number of record level holds that a patron can be placed is the highest
2299 value of the holds_per_record rule for each item if the record for that
2300 patron. This subroutine finds and returns the highest holds_per_record
2301 rule value for a given patron id and record id.
2305 sub GetMaxPatronHoldsForRecord {
2306 my ( $borrowernumber, $biblionumber ) = @_;
2308 my $patron = Koha::Patrons->find($borrowernumber);
2309 my @items = Koha::Items->search( { biblionumber => $biblionumber } );
2311 my $controlbranch = C4::Context->preference('ReservesControlBranch');
2313 my $categorycode = $patron->categorycode;
2315 $branchcode = $patron->branchcode if ( $controlbranch eq "PatronLibrary" );
2318 foreach my $item (@items) {
2319 my $itemtype = $item->effective_itemtype();
2321 $branchcode = $item->homebranch if ( $controlbranch eq "ItemHomeLibrary" );
2323 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2324 my $holds_per_record = $rule ? $rule->{holds_per_record} : 0;
2325 $max = $holds_per_record if $holds_per_record > $max;
2333 my $rule = GetHoldRule( $categorycode, $itemtype, $branchcode );
2335 Returns the matching hold related issuingrule fields for a given
2336 patron category, itemtype, and library.
2341 my ( $categorycode, $itemtype, $branchcode ) = @_;
2343 my $dbh = C4::Context->dbh;
2345 my $sth = $dbh->prepare(
2347 SELECT categorycode, itemtype, branchcode, reservesallowed, holds_per_record
2349 WHERE (categorycode in (?,'*') )
2350 AND (itemtype IN (?,'*'))
2351 AND (branchcode IN (?,'*'))
2352 ORDER BY categorycode DESC,
2358 $sth->execute( $categorycode, $itemtype, $branchcode );
2360 return $sth->fetchrow_hashref();
2365 Koha Development Team <http://koha-community.org/>