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 under the
11 # terms of the GNU General Public License as published by the Free Software
12 # Foundation; either version 2 of the License, or (at your option) any later
15 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
16 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License along
20 # with Koha; if not, write to the Free Software Foundation, Inc.,
21 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #use warnings; FIXME - Bug 2505
33 # for _koha_notify_reserve
34 use C4::Members::Messaging;
37 use C4::Branch qw( GetBranchDetail );
38 use C4::Dates qw( format_date_in_iso );
44 use List::MoreUtils qw( firstidx );
46 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
50 C4::Reserves - Koha functions for dealing with reservation.
58 This modules provides somes functions to deal with reservations.
60 Reserves are stored in reserves table.
61 The following columns contains important values :
62 - priority >0 : then the reserve is at 1st stage, and not yet affected to any item.
63 =0 : then the reserve is being dealed
64 - found : NULL : means the patron requested the 1st available, and we haven't choosen the item
65 T(ransit) : the reserve is linked to an item but is in transit to the pickup branch
66 W(aiting) : the reserve is linked to an item, is at the pickup branch, and is waiting on the hold shelf
67 F(inished) : the reserve has been completed, and is done
68 - itemnumber : empty : the reserve is still unaffected to an item
69 filled: the reserve is attached to an item
70 The complete workflow is :
71 ==== 1st use case ====
72 patron request a document, 1st available : P >0, F=NULL, I=NULL
73 a library having it run "transfertodo", and clic on the list
74 if there is no transfer to do, the reserve waiting
75 patron can pick it up P =0, F=W, I=filled
76 if there is a transfer to do, write in branchtransfer P =0, F=T, I=filled
77 The pickup library recieve the book, it check in P =0, F=W, I=filled
78 The patron borrow the book P =0, F=F, I=filled
80 ==== 2nd use case ====
81 patron requests a document, a given item,
82 If pickup is holding branch P =0, F=W, I=filled
83 If transfer needed, write in branchtransfer P =0, F=T, I=filled
84 The pickup library receive the book, it checks it in P =0, F=W, I=filled
85 The patron borrow the book P =0, F=F, I=filled
92 # set the version for version checking
93 $VERSION = 3.07.00.049;
100 &GetReservesFromItemnumber
101 &GetReservesFromBiblionumber
102 &GetReservesFromBorrowernumber
103 &GetReservesForBranch
117 &ModReserveMinusPriority
123 &CanReserveBeCanceledFromOpac
125 &CancelExpiredReserves
127 &AutoUnsuspendReserves
129 &IsAvailableForItemLevelRequest
132 &ToggleLowestPriority
138 &GetReservesControlBranch
140 @EXPORT_OK = qw( MergeHolds );
145 AddReserve($branch,$borrowernumber,$biblionumber,$constraint,$bibitems,$priority,$resdate,$expdate,$notes,$title,$checkitem,$found)
151 $branch, $borrowernumber, $biblionumber,
152 $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
153 $title, $checkitem, $found
156 GetReserveFee($borrowernumber, $biblionumber, $constraint,
158 my $dbh = C4::Context->dbh;
159 my $const = lc substr( $constraint, 0, 1 );
160 $resdate = format_date_in_iso( $resdate ) if ( $resdate );
161 $resdate = C4::Dates->today( 'iso' ) unless ( $resdate );
163 $expdate = format_date_in_iso( $expdate );
165 undef $expdate; # make reserves.expirationdate default to null rather than '0000-00-00'
167 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
168 # Make room in reserves for this before those of a later reserve date
169 $priority = _ShiftPriorityByDateAndPriority( $biblionumber, $resdate, $priority );
173 # If the reserv had the waiting status, we had the value of the resdate
174 if ( $found eq 'W' ) {
175 $waitingdate = $resdate;
179 # updates take place here
181 my $nextacctno = &getnextacctno( $borrowernumber );
183 INSERT INTO accountlines
184 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
186 (?,?,now(),?,?,'Res',?)
188 my $usth = $dbh->prepare($query);
189 $usth->execute( $borrowernumber, $nextacctno, $fee,
190 "Reserve Charge - $title", $fee );
196 (borrowernumber,biblionumber,reservedate,branchcode,constrainttype,
197 priority,reservenotes,itemnumber,found,waitingdate,expirationdate)
202 my $sth = $dbh->prepare($query);
204 $borrowernumber, $biblionumber, $resdate, $branch,
205 $const, $priority, $notes, $checkitem,
206 $found, $waitingdate, $expdate
209 # Send e-mail to librarian if syspref is active
210 if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
211 my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
212 my $branch_details = C4::Branch::GetBranchDetail($borrower->{branchcode});
213 if ( my $letter = C4::Letters::GetPreparedLetter (
214 module => 'reserves',
215 letter_code => 'HOLDPLACED',
216 branchcode => $branch,
218 'branches' => $branch_details,
219 'borrowers' => $borrower,
220 'biblio' => $biblionumber,
221 'items' => $checkitem,
225 my $admin_email_address =$branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
227 C4::Letters::EnqueueLetter(
229 borrowernumber => $borrowernumber,
230 message_transport_type => 'email',
231 from_address => $admin_email_address,
232 to_address => $admin_email_address,
239 ($const eq "o" || $const eq "e") or return; # FIXME: why not have a useful return value?
241 INSERT INTO reserveconstraints
242 (borrowernumber,biblionumber,reservedate,biblioitemnumber)
246 $sth = $dbh->prepare($query); # keep prepare outside the loop!
247 foreach (@$bibitems) {
248 $sth->execute($borrowernumber, $biblionumber, $resdate, $_);
251 return; # FIXME: why not have a useful return value?
256 $res = GetReserve( $reserve_id );
258 Return the current reserve.
263 my ($reserve_id) = @_;
265 my $dbh = C4::Context->dbh;
266 my $query = "SELECT * FROM reserves WHERE reserve_id = ?";
267 my $sth = $dbh->prepare( $query );
268 $sth->execute( $reserve_id );
269 return $sth->fetchrow_hashref();
272 =head2 GetReservesFromBiblionumber
274 my $reserves = GetReservesFromBiblionumber({
275 biblionumber => $biblionumber,
276 [ itemnumber => $itemnumber, ]
280 This function gets the list of reservations for one C<$biblionumber>,
281 returning an arrayref pointing to the reserves for C<$biblionumber>.
283 By default, only reserves whose start date falls before the current
284 time are returned. To return all reserves, including future ones,
285 the C<all_dates> parameter can be included and set to a true value.
287 If the C<itemnumber> parameter is supplied, reserves must be targeted
288 to that item or not targeted to any item at all; otherwise, they
289 are excluded from the list.
293 sub GetReservesFromBiblionumber {
295 my $biblionumber = $params->{biblionumber} or return [];
296 my $itemnumber = $params->{itemnumber};
297 my $all_dates = $params->{all_dates} // 0;
298 my $dbh = C4::Context->dbh;
300 # Find the desired items in the reserves
305 timestamp AS rtimestamp,
319 WHERE biblionumber = ? ";
320 push( @params, $biblionumber );
321 unless ( $all_dates ) {
322 $query .= " AND reservedate <= CAST(NOW() AS DATE) ";
325 $query .= " AND ( itemnumber IS NULL OR itemnumber = ? )";
326 push( @params, $itemnumber );
328 $query .= "ORDER BY priority";
329 my $sth = $dbh->prepare($query);
330 $sth->execute( @params );
333 while ( my $data = $sth->fetchrow_hashref ) {
335 # FIXME - What is this doing? How do constraints work?
336 if ($data->{constrainttype} eq 'o') {
338 SELECT biblioitemnumber
339 FROM reserveconstraints
340 WHERE biblionumber = ?
341 AND borrowernumber = ?
344 my $csth = $dbh->prepare($query);
345 $csth->execute($data->{biblionumber}, $data->{borrowernumber}, $data->{reservedate});
347 while ( my $bibitemnos = $csth->fetchrow_array ) {
348 push( @bibitemno, $bibitemnos ); # FIXME: inefficient: use fetchall_arrayref
350 my $count = scalar @bibitemno;
352 # if we have two or more different specific itemtypes
353 # reserved by same person on same day
356 $bdata = GetBiblioItemData( $bibitemno[$i] ); # FIXME: This doesn't make sense.
357 $i++; # $i can increase each pass, but the next @bibitemno might be smaller?
360 # Look up the book we just found.
361 $bdata = GetBiblioItemData( $bibitemno[0] );
363 # Add the results of this latest search to the current
365 # FIXME - An 'each' would probably be more efficient.
366 foreach my $key ( keys %$bdata ) {
367 $data->{$key} = $bdata->{$key};
370 push @results, $data;
375 =head2 GetReservesFromItemnumber
377 ( $reservedate, $borrowernumber, $branchcode, $reserve_id, $waitingdate ) = GetReservesFromItemnumber($itemnumber);
379 Get the first reserve for a specific item number (based on priority). Returns the abovementioned values for that reserve.
381 The routine does not look at future reserves (read: item level holds), but DOES include future waits (a confirmed future hold).
385 sub GetReservesFromItemnumber {
386 my ($itemnumber) = @_;
388 my $schema = Koha::Database->new()->schema();
390 my $r = $schema->resultset('Reserve')->search(
392 itemnumber => $itemnumber,
395 reservedate => \'<= CAST( NOW() AS DATE )',
396 waitingdate => { '!=', undef }
400 order_by => 'priority',
408 $r->get_column('borrowernumber'),
409 $r->get_column('branchcode'),
415 =head2 GetReservesFromBorrowernumber
417 $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
423 sub GetReservesFromBorrowernumber {
424 my ( $borrowernumber, $status ) = @_;
425 my $dbh = C4::Context->dbh;
428 $sth = $dbh->prepare("
431 WHERE borrowernumber=?
435 $sth->execute($borrowernumber,$status);
437 $sth = $dbh->prepare("
440 WHERE borrowernumber=?
443 $sth->execute($borrowernumber);
445 my $data = $sth->fetchall_arrayref({});
448 #-------------------------------------------------------------------------------------
449 =head2 CanBookBeReserved
451 $error = &CanBookBeReserved($borrowernumber, $biblionumber)
455 sub CanBookBeReserved{
456 my ($borrowernumber, $biblionumber) = @_;
458 my $items = GetItemnumbersForBiblio($biblionumber);
459 #get items linked via host records
460 my @hostitems = get_hostitemnumbers_of($biblionumber);
462 push (@$items,@hostitems);
465 foreach my $item (@$items){
466 return 1 if CanItemBeReserved($borrowernumber, $item);
471 =head2 CanItemBeReserved
473 $error = &CanItemBeReserved($borrowernumber, $itemnumber)
475 This function return 1 if an item can be issued by this borrower.
479 sub CanItemBeReserved{
480 my ($borrowernumber, $itemnumber) = @_;
482 my $dbh = C4::Context->dbh;
483 my $ruleitemtype; # itemtype of the matching issuing rule
484 my $allowedreserves = 0;
486 # we retrieve borrowers and items informations #
487 # item->{itype} will come for biblioitems if necessery
488 my $item = GetItem($itemnumber);
490 # If an item is damaged and we don't allow holds on damaged items, we can stop right here
491 return 0 if ( $item->{damaged} && !C4::Context->preference('AllowHoldsOnDamagedItems') );
493 my $borrower = C4::Members::GetMember('borrowernumber'=>$borrowernumber);
495 my $controlbranch = C4::Context->preference('ReservesControlBranch');
496 my $itemtypefield = C4::Context->preference('item-level_itypes') ? "itype" : "itemtype";
498 # we retrieve user rights on this itemtype and branchcode
499 my $sth = $dbh->prepare("SELECT categorycode, itemtype, branchcode, reservesallowed
501 WHERE (categorycode in (?,'*') )
502 AND (itemtype IN (?,'*'))
503 AND (branchcode IN (?,'*'))
510 my $querycount ="SELECT
513 LEFT JOIN items USING (itemnumber)
514 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
515 LEFT JOIN borrowers USING (borrowernumber)
516 WHERE borrowernumber = ?
521 my $branchfield = "reserves.branchcode";
523 if( $controlbranch eq "ItemHomeLibrary" ){
524 $branchfield = "items.homebranch";
525 $branchcode = $item->{homebranch};
526 }elsif( $controlbranch eq "PatronLibrary" ){
527 $branchfield = "borrowers.branchcode";
528 $branchcode = $borrower->{branchcode};
532 $sth->execute($borrower->{'categorycode'}, $item->{'itype'}, $branchcode);
533 if(my $rights = $sth->fetchrow_hashref()){
534 $ruleitemtype = $rights->{itemtype};
535 $allowedreserves = $rights->{reservesallowed};
542 $querycount .= "AND $branchfield = ?";
544 $querycount .= " AND $itemtypefield = ?" if ($ruleitemtype ne "*");
545 my $sthcount = $dbh->prepare($querycount);
547 if($ruleitemtype eq "*"){
548 $sthcount->execute($borrowernumber, $branchcode);
550 $sthcount->execute($borrowernumber, $branchcode, $ruleitemtype);
553 my $reservecount = "0";
554 if(my $rowcount = $sthcount->fetchrow_hashref()){
555 $reservecount = $rowcount->{count};
558 # we check if it's ok or not
559 if( $reservecount >= $allowedreserves ){
563 # If reservecount is ok, we check item branch if IndependentBranches is ON
564 # and canreservefromotherbranches is OFF
565 if ( C4::Context->preference('IndependentBranches')
566 and !C4::Context->preference('canreservefromotherbranches') )
568 my $itembranch = $item->{homebranch};
569 if ($itembranch ne $borrower->{branchcode}) {
577 =head2 CanReserveBeCanceledFromOpac
579 $number = CanReserveBeCanceledFromOpac($reserve_id, $borrowernumber);
581 returns 1 if reserve can be cancelled by user from OPAC.
582 First check if reserve belongs to user, next checks if reserve is not in
583 transfer or waiting status
587 sub CanReserveBeCanceledFromOpac {
588 my ($reserve_id, $borrowernumber) = @_;
590 return unless $reserve_id and $borrowernumber;
591 my $reserve = GetReserve($reserve_id);
593 return 0 unless $reserve->{borrowernumber} == $borrowernumber;
594 return 0 if ( $reserve->{found} eq 'W' ) or ( $reserve->{found} eq 'T' );
600 #--------------------------------------------------------------------------------
601 =head2 GetReserveCount
603 $number = &GetReserveCount($borrowernumber);
605 this function returns the number of reservation for a borrower given on input arg.
609 sub GetReserveCount {
610 my ($borrowernumber) = @_;
612 my $dbh = C4::Context->dbh;
615 SELECT COUNT(*) AS counter
617 WHERE borrowernumber = ?
619 my $sth = $dbh->prepare($query);
620 $sth->execute($borrowernumber);
621 my $row = $sth->fetchrow_hashref;
622 return $row->{counter};
625 =head2 GetOtherReserves
627 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
629 Check queued list of this document and check if this document must be transfered
633 sub GetOtherReserves {
634 my ($itemnumber) = @_;
637 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
638 if ($checkreserves) {
639 my $iteminfo = GetItem($itemnumber);
640 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
641 $messages->{'transfert'} = $checkreserves->{'branchcode'};
642 #minus priorities of others reservs
643 ModReserveMinusPriority(
645 $checkreserves->{'reserve_id'},
648 #launch the subroutine dotransfer
649 C4::Items::ModItemTransfer(
651 $iteminfo->{'holdingbranch'},
652 $checkreserves->{'branchcode'}
657 #step 2b : case of a reservation on the same branch, set the waiting status
659 $messages->{'waiting'} = 1;
660 ModReserveMinusPriority(
662 $checkreserves->{'reserve_id'},
664 ModReserveStatus($itemnumber,'W');
667 $nextreservinfo = $checkreserves->{'borrowernumber'};
670 return ( $messages, $nextreservinfo );
675 $fee = GetReserveFee($borrowernumber,$biblionumber,$constraint,$biblionumber);
677 Calculate the fee for a reserve
682 my ($borrowernumber, $biblionumber, $constraint, $bibitems ) = @_;
685 my $dbh = C4::Context->dbh;
686 my $const = lc substr( $constraint, 0, 1 );
688 SELECT * FROM borrowers
689 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
690 WHERE borrowernumber = ?
692 my $sth = $dbh->prepare($query);
693 $sth->execute($borrowernumber);
694 my $data = $sth->fetchrow_hashref;
695 my $fee = $data->{'reservefee'};
696 my $cntitems = @- > $bibitems;
700 # check for items on issue
701 # first find biblioitem records
703 my $sth1 = $dbh->prepare(
704 "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber
705 WHERE (biblio.biblionumber = ?)"
707 $sth1->execute($biblionumber);
708 while ( my $data1 = $sth1->fetchrow_hashref ) {
709 if ( $const eq "a" ) {
710 push @biblioitems, $data1;
715 while ( $x < $cntitems ) {
716 if ( @$bibitems->{'biblioitemnumber'} ==
717 $data->{'biblioitemnumber'} )
723 if ( $const eq 'o' ) {
725 push @biblioitems, $data1;
730 push @biblioitems, $data1;
735 my $cntitemsfound = @biblioitems;
739 while ( $x < $cntitemsfound ) {
740 my $bitdata = $biblioitems[$x];
741 my $sth2 = $dbh->prepare(
743 WHERE biblioitemnumber = ?"
745 $sth2->execute( $bitdata->{'biblioitemnumber'} );
746 while ( my $itdata = $sth2->fetchrow_hashref ) {
747 my $sth3 = $dbh->prepare(
748 "SELECT * FROM issues
749 WHERE itemnumber = ?"
751 $sth3->execute( $itdata->{'itemnumber'} );
752 if ( my $isdata = $sth3->fetchrow_hashref ) {
760 if ( $allissued == 0 ) {
762 $dbh->prepare("SELECT * FROM reserves WHERE biblionumber = ?");
763 $rsth->execute($biblionumber);
764 if ( my $rdata = $rsth->fetchrow_hashref ) {
774 =head2 GetReservesToBranch
776 @transreserv = GetReservesToBranch( $frombranch );
778 Get reserve list for a given branch
782 sub GetReservesToBranch {
783 my ( $frombranch ) = @_;
784 my $dbh = C4::Context->dbh;
785 my $sth = $dbh->prepare(
786 "SELECT reserve_id,borrowernumber,reservedate,itemnumber,timestamp
791 $sth->execute( $frombranch );
794 while ( my $data = $sth->fetchrow_hashref ) {
795 $transreserv[$i] = $data;
798 return (@transreserv);
801 =head2 GetReservesForBranch
803 @transreserv = GetReservesForBranch($frombranch);
807 sub GetReservesForBranch {
808 my ($frombranch) = @_;
809 my $dbh = C4::Context->dbh;
812 SELECT reserve_id,borrowernumber,reservedate,itemnumber,waitingdate
817 $query .= " AND branchcode=? " if ( $frombranch );
818 $query .= "ORDER BY waitingdate" ;
820 my $sth = $dbh->prepare($query);
822 $sth->execute($frombranch);
829 while ( my $data = $sth->fetchrow_hashref ) {
830 $transreserv[$i] = $data;
833 return (@transreserv);
836 =head2 GetReserveStatus
838 $reservestatus = GetReserveStatus($itemnumber, $biblionumber);
840 Take an itemnumber or a biblionumber and return the status of the reserve places on it.
841 If several reserves exist, the reserve with the lower priority is given.
845 ## FIXME: I don't think this does what it thinks it does.
846 ## It only ever checks the first reserve result, even though
847 ## multiple reserves for that bib can have the itemnumber set
848 ## the sub is only used once in the codebase.
849 sub GetReserveStatus {
850 my ($itemnumber, $biblionumber) = @_;
852 my $dbh = C4::Context->dbh;
854 my ($sth, $found, $priority);
856 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
857 $sth->execute($itemnumber);
858 ($found, $priority) = $sth->fetchrow_array;
861 if ( $biblionumber and not defined $found and not defined $priority ) {
862 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE biblionumber = ? order by priority LIMIT 1");
863 $sth->execute($biblionumber);
864 ($found, $priority) = $sth->fetchrow_array;
868 return 'Waiting' if $found eq 'W' and $priority == 0;
869 return 'Finished' if $found eq 'F';
872 return 'Reserved' if $priority > 0;
874 return ''; # empty string here will remove need for checking undef, or less log lines
879 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber);
880 ($status, $reserve, $all_reserves) = &CheckReserves(undef, $barcode);
881 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
883 Find a book in the reserves.
885 C<$itemnumber> is the book's item number.
886 C<$lookahead> is the number of days to look in advance for future reserves.
888 As I understand it, C<&CheckReserves> looks for the given item in the
889 reserves. If it is found, that's a match, and C<$status> is set to
892 Otherwise, it finds the most important item in the reserves with the
893 same biblio number as this book (I'm not clear on this) and returns it
894 with C<$status> set to C<Reserved>.
896 C<&CheckReserves> returns a two-element list:
898 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
900 C<$reserve> is the reserve item that matched. It is a
901 reference-to-hash whose keys are mostly the fields of the reserves
902 table in the Koha database.
907 my ( $item, $barcode, $lookahead_days) = @_;
908 my $dbh = C4::Context->dbh;
911 if (C4::Context->preference('item-level_itypes')){
913 SELECT items.biblionumber,
914 items.biblioitemnumber,
915 itemtypes.notforloan,
916 items.notforloan AS itemnotforloan,
922 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
923 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
928 SELECT items.biblionumber,
929 items.biblioitemnumber,
930 itemtypes.notforloan,
931 items.notforloan AS itemnotforloan,
937 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
938 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
943 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
944 $sth->execute($item);
947 $sth = $dbh->prepare("$select WHERE barcode = ?");
948 $sth->execute($barcode);
950 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
951 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber, $damaged, $item_homebranch, $item_holdingbranch ) = $sth->fetchrow_array;
953 return if ( $damaged && !C4::Context->preference('AllowHoldsOnDamagedItems') );
955 return unless $itemnumber; # bail if we got nothing.
957 # if item is not for loan it cannot be reserved either.....
958 # except where items.notforloan < 0 : This indicates the item is holdable.
959 return if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
961 # Find this item in the reserves
962 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days);
964 # $priority and $highest are used to find the most important item
965 # in the list returned by &_Findgroupreserve. (The lower $priority,
966 # the more important the item.)
967 # $highest is the most important item we've seen so far.
969 if (scalar @reserves) {
970 my $LocalHoldsPriority = C4::Context->preference('LocalHoldsPriority');
971 my $LocalHoldsPriorityPatronControl = C4::Context->preference('LocalHoldsPriorityPatronControl');
972 my $LocalHoldsPriorityItemControl = C4::Context->preference('LocalHoldsPriorityItemControl');
974 my $priority = 10000000;
975 foreach my $res (@reserves) {
976 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
977 return ( "Waiting", $res, \@reserves ); # Found it
979 # Lazy fetch for borrower and item. We only need to know about the patron and item
980 # each and every time if we are using LocalHoldsPriority. This is a great place to
981 # leverage the inherent lazy fetching of DBIx::Class.
985 my $local_hold_match;
986 if ($LocalHoldsPriority) {
987 $borrowerinfo = C4::Members::GetMember( borrowernumber => $res->{'borrowernumber'} );
988 $iteminfo = C4::Items::GetItem($itemnumber);
990 my $local_holds_priority_item_branchcode =
991 $iteminfo->{$LocalHoldsPriorityItemControl};
992 my $local_holds_priority_patron_branchcode =
993 ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
995 : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
996 ? $borrowerinfo->{branchcode}
999 $local_holds_priority_item_branchcode eq
1000 $local_holds_priority_patron_branchcode;
1003 # See if this item is more important than what we've got so far
1004 if ( ( $res->{'priority'} && $res->{'priority'} < $priority ) || $local_hold_match ) {
1005 $borrowerinfo ||= C4::Members::GetMember( borrowernumber => $res->{'borrowernumber'} );
1006 $iteminfo ||= C4::Items::GetItem($itemnumber);
1007 my $branch = GetReservesControlBranch( $iteminfo, $borrowerinfo );
1008 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$iteminfo->{'itype'});
1009 next if ($branchitemrule->{'holdallowed'} == 0);
1010 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $borrowerinfo->{'branchcode'}));
1011 $priority = $res->{'priority'};
1013 last if $local_hold_match;
1019 # If we get this far, then no exact match was found.
1020 # We return the most important (i.e. next) reservation.
1022 $highest->{'itemnumber'} = $item;
1023 return ( "Reserved", $highest, \@reserves );
1029 =head2 CancelExpiredReserves
1031 CancelExpiredReserves();
1033 Cancels all reserves with an expiration date from before today.
1037 sub CancelExpiredReserves {
1039 # Cancel reserves that have passed their expiration date.
1040 my $dbh = C4::Context->dbh;
1041 my $sth = $dbh->prepare( "
1042 SELECT * FROM reserves WHERE DATE(expirationdate) < DATE( CURDATE() )
1043 AND expirationdate IS NOT NULL
1048 while ( my $res = $sth->fetchrow_hashref() ) {
1049 CancelReserve({ reserve_id => $res->{'reserve_id'} });
1052 # Cancel reserves that have been waiting too long
1053 if ( C4::Context->preference("ExpireReservesMaxPickUpDelay") ) {
1054 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
1055 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
1056 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
1058 my $today = dt_from_string();
1060 my $query = "SELECT * FROM reserves WHERE TO_DAYS( NOW() ) - TO_DAYS( waitingdate ) > ? AND found = 'W' AND priority = 0";
1061 $sth = $dbh->prepare( $query );
1062 $sth->execute( $max_pickup_delay );
1064 while ( my $res = $sth->fetchrow_hashref ) {
1066 unless ( $cancel_on_holidays ) {
1067 my $calendar = Koha::Calendar->new( branchcode => $res->{'branchcode'} );
1068 my $is_holiday = $calendar->is_holiday( $today );
1070 if ( $is_holiday ) {
1077 manualinvoice($res->{'borrowernumber'}, $res->{'itemnumber'}, 'Hold waiting too long', 'F', $charge);
1080 CancelReserve({ reserve_id => $res->{'reserve_id'} });
1087 =head2 AutoUnsuspendReserves
1089 AutoUnsuspendReserves();
1091 Unsuspends all suspended reserves with a suspend_until date from before today.
1095 sub AutoUnsuspendReserves {
1097 my $dbh = C4::Context->dbh;
1099 my $query = "UPDATE reserves SET suspend = 0, suspend_until = NULL WHERE DATE( suspend_until ) < DATE( CURDATE() )";
1100 my $sth = $dbh->prepare( $query );
1105 =head2 CancelReserve
1107 CancelReserve({ reserve_id => $reserve_id, [ biblionumber => $biblionumber, borrowernumber => $borrrowernumber, itemnumber => $itemnumber ] });
1114 my ( $params ) = @_;
1116 my $reserve_id = $params->{'reserve_id'};
1117 $reserve_id = GetReserveId( $params ) unless ( $reserve_id );
1119 return unless ( $reserve_id );
1121 my $dbh = C4::Context->dbh;
1123 my $reserve = GetReserve( $reserve_id );
1127 SET cancellationdate = now(),
1130 WHERE reserve_id = ?
1132 my $sth = $dbh->prepare($query);
1133 $sth->execute( $reserve_id );
1136 INSERT INTO old_reserves
1137 SELECT * FROM reserves
1138 WHERE reserve_id = ?
1140 $sth = $dbh->prepare($query);
1141 $sth->execute( $reserve_id );
1144 DELETE FROM reserves
1145 WHERE reserve_id = ?
1147 $sth = $dbh->prepare($query);
1148 $sth->execute( $reserve_id );
1150 # now fix the priority on the others....
1151 _FixPriority({ biblionumber => $reserve->{biblionumber} });
1159 ModReserve({ rank => $rank,
1160 reserve_id => $reserve_id,
1161 branchcode => $branchcode
1162 [, itemnumber => $itemnumber ]
1163 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1166 Change a hold request's priority or cancel it.
1168 C<$rank> specifies the effect of the change. If C<$rank>
1169 is 'W' or 'n', nothing happens. This corresponds to leaving a
1170 request alone when changing its priority in the holds queue
1173 If C<$rank> is 'del', the hold request is cancelled.
1175 If C<$rank> is an integer greater than zero, the priority of
1176 the request is set to that value. Since priority != 0 means
1177 that the item is not waiting on the hold shelf, setting the
1178 priority to a non-zero value also sets the request's found
1179 status and waiting date to NULL.
1181 The optional C<$itemnumber> parameter is used only when
1182 C<$rank> is a non-zero integer; if supplied, the itemnumber
1183 of the hold request is set accordingly; if omitted, the itemnumber
1186 B<FIXME:> Note that the forgoing can have the effect of causing
1187 item-level hold requests to turn into title-level requests. This
1188 will be fixed once reserves has separate columns for requested
1189 itemnumber and supplying itemnumber.
1194 my ( $params ) = @_;
1196 my $rank = $params->{'rank'};
1197 my $reserve_id = $params->{'reserve_id'};
1198 my $branchcode = $params->{'branchcode'};
1199 my $itemnumber = $params->{'itemnumber'};
1200 my $suspend_until = $params->{'suspend_until'};
1201 my $borrowernumber = $params->{'borrowernumber'};
1202 my $biblionumber = $params->{'biblionumber'};
1204 return if $rank eq "W";
1205 return if $rank eq "n";
1207 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1208 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber }) unless ( $reserve_id );
1210 my $dbh = C4::Context->dbh;
1211 if ( $rank eq "del" ) {
1212 CancelReserve({ reserve_id => $reserve_id });
1214 elsif ($rank =~ /^\d+/ and $rank > 0) {
1216 UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL, waitingdate = NULL
1217 WHERE reserve_id = ?
1219 my $sth = $dbh->prepare($query);
1220 $sth->execute( $rank, $branchcode, $itemnumber, $reserve_id );
1222 if ( defined( $suspend_until ) ) {
1223 if ( $suspend_until ) {
1224 $suspend_until = C4::Dates->new( $suspend_until )->output("iso");
1225 $dbh->do("UPDATE reserves SET suspend = 1, suspend_until = ? WHERE reserve_id = ?", undef, ( $suspend_until, $reserve_id ) );
1227 $dbh->do("UPDATE reserves SET suspend_until = NULL WHERE reserve_id = ?", undef, ( $reserve_id ) );
1231 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
1235 =head2 ModReserveFill
1237 &ModReserveFill($reserve);
1239 Fill a reserve. If I understand this correctly, this means that the
1240 reserved book has been found and given to the patron who reserved it.
1242 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
1243 whose keys are fields from the reserves table in the Koha database.
1247 sub ModReserveFill {
1249 my $dbh = C4::Context->dbh;
1250 # fill in a reserve record....
1251 my $reserve_id = $res->{'reserve_id'};
1252 my $biblionumber = $res->{'biblionumber'};
1253 my $borrowernumber = $res->{'borrowernumber'};
1254 my $resdate = $res->{'reservedate'};
1256 # get the priority on this record....
1258 my $query = "SELECT priority
1260 WHERE biblionumber = ?
1261 AND borrowernumber = ?
1262 AND reservedate = ?";
1263 my $sth = $dbh->prepare($query);
1264 $sth->execute( $biblionumber, $borrowernumber, $resdate );
1265 ($priority) = $sth->fetchrow_array;
1267 # update the database...
1268 $query = "UPDATE reserves
1271 WHERE biblionumber = ?
1273 AND borrowernumber = ?
1275 $sth = $dbh->prepare($query);
1276 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1278 # move to old_reserves
1279 $query = "INSERT INTO old_reserves
1280 SELECT * FROM reserves
1281 WHERE biblionumber = ?
1283 AND borrowernumber = ?
1285 $sth = $dbh->prepare($query);
1286 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1287 $query = "DELETE FROM reserves
1288 WHERE biblionumber = ?
1290 AND borrowernumber = ?
1292 $sth = $dbh->prepare($query);
1293 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1295 # now fix the priority on the others (if the priority wasn't
1296 # already sorted!)....
1297 unless ( $priority == 0 ) {
1298 _FixPriority({ reserve_id => $reserve_id });
1302 =head2 ModReserveStatus
1304 &ModReserveStatus($itemnumber, $newstatus);
1306 Update the reserve status for the active (priority=0) reserve.
1308 $itemnumber is the itemnumber the reserve is on
1310 $newstatus is the new status.
1314 sub ModReserveStatus {
1316 #first : check if we have a reservation for this item .
1317 my ($itemnumber, $newstatus) = @_;
1318 my $dbh = C4::Context->dbh;
1320 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1321 my $sth_set = $dbh->prepare($query);
1322 $sth_set->execute( $newstatus, $itemnumber );
1324 if ( C4::Context->preference("ReturnToShelvingCart") && $newstatus ) {
1325 CartToShelf( $itemnumber );
1329 =head2 ModReserveAffect
1331 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend);
1333 This function affect an item and a status for a given reserve
1334 The itemnumber parameter is used to find the biblionumber.
1335 with the biblionumber & the borrowernumber, we can affect the itemnumber
1336 to the correct reserve.
1338 if $transferToDo is not set, then the status is set to "Waiting" as well.
1339 otherwise, a transfer is on the way, and the end of the transfer will
1340 take care of the waiting status
1344 sub ModReserveAffect {
1345 my ( $itemnumber, $borrowernumber,$transferToDo ) = @_;
1346 my $dbh = C4::Context->dbh;
1348 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1349 # attached to $itemnumber
1350 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1351 $sth->execute($itemnumber);
1352 my ($biblionumber) = $sth->fetchrow;
1354 # get request - need to find out if item is already
1355 # waiting in order to not send duplicate hold filled notifications
1356 my $reserve_id = GetReserveId({
1357 borrowernumber => $borrowernumber,
1358 biblionumber => $biblionumber,
1360 return unless defined $reserve_id;
1361 my $request = GetReserveInfo($reserve_id);
1362 my $already_on_shelf = ($request && $request->{found} eq 'W') ? 1 : 0;
1364 # If we affect a reserve that has to be transfered, don't set to Waiting
1366 if ($transferToDo) {
1372 WHERE borrowernumber = ?
1373 AND biblionumber = ?
1377 # affect the reserve to Waiting as well.
1382 waitingdate = NOW(),
1384 WHERE borrowernumber = ?
1385 AND biblionumber = ?
1388 $sth = $dbh->prepare($query);
1389 $sth->execute( $itemnumber, $borrowernumber,$biblionumber);
1390 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo && !$already_on_shelf );
1391 _FixPriority( { biblionumber => $biblionumber } );
1392 if ( C4::Context->preference("ReturnToShelvingCart") ) {
1393 CartToShelf( $itemnumber );
1399 =head2 ModReserveCancelAll
1401 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1403 function to cancel reserv,check other reserves, and transfer document if it's necessary
1407 sub ModReserveCancelAll {
1410 my ( $itemnumber, $borrowernumber ) = @_;
1412 #step 1 : cancel the reservation
1413 my $CancelReserve = CancelReserve({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1415 #step 2 launch the subroutine of the others reserves
1416 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1418 return ( $messages, $nextreservinfo );
1421 =head2 ModReserveMinusPriority
1423 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1425 Reduce the values of queued list
1429 sub ModReserveMinusPriority {
1430 my ( $itemnumber, $reserve_id ) = @_;
1432 #first step update the value of the first person on reserv
1433 my $dbh = C4::Context->dbh;
1436 SET priority = 0 , itemnumber = ?
1437 WHERE reserve_id = ?
1439 my $sth_upd = $dbh->prepare($query);
1440 $sth_upd->execute( $itemnumber, $reserve_id );
1441 # second step update all others reserves
1442 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1445 =head2 GetReserveInfo
1447 &GetReserveInfo($reserve_id);
1449 Get item and borrower details for a current hold.
1450 Current implementation this query should have a single result.
1454 sub GetReserveInfo {
1455 my ( $reserve_id ) = @_;
1456 my $dbh = C4::Context->dbh;
1461 reserves.borrowernumber,
1462 reserves.biblionumber,
1463 reserves.branchcode,
1464 reserves.waitingdate,
1480 items.holdingbranch,
1481 items.itemcallnumber,
1487 LEFT JOIN items USING(itemnumber)
1488 LEFT JOIN borrowers USING(borrowernumber)
1489 LEFT JOIN biblio ON (reserves.biblionumber=biblio.biblionumber)
1490 WHERE reserves.reserve_id = ?";
1491 my $sth = $dbh->prepare($strsth);
1492 $sth->execute($reserve_id);
1494 my $data = $sth->fetchrow_hashref;
1498 =head2 IsAvailableForItemLevelRequest
1500 my $is_available = IsAvailableForItemLevelRequest($itemnumber);
1502 Checks whether a given item record is available for an
1503 item-level hold request. An item is available if
1505 * it is not lost AND
1506 * it is not damaged AND
1507 * it is not withdrawn AND
1508 * does not have a not for loan value > 0
1510 Whether or not the item is currently on loan is
1511 also checked - if the AllowOnShelfHolds system preference
1512 is ON, an item can be requested even if it is currently
1513 on loan to somebody else. If the system preference
1514 is OFF, an item that is currently checked out cannot
1515 be the target of an item-level hold request.
1517 Note that IsAvailableForItemLevelRequest() does not
1518 check if the staff operator is authorized to place
1519 a request on the item - in particular,
1520 this routine does not check IndependentBranches
1521 and canreservefromotherbranches.
1525 sub IsAvailableForItemLevelRequest {
1526 my $itemnumber = shift;
1528 my $item = GetItem($itemnumber);
1530 # must check the notforloan setting of the itemtype
1531 # FIXME - a lot of places in the code do this
1532 # or something similar - need to be
1534 my $dbh = C4::Context->dbh;
1535 my $notforloan_query;
1536 if (C4::Context->preference('item-level_itypes')) {
1537 $notforloan_query = "SELECT itemtypes.notforloan
1539 JOIN itemtypes ON (itemtypes.itemtype = items.itype)
1540 WHERE itemnumber = ?";
1542 $notforloan_query = "SELECT itemtypes.notforloan
1544 JOIN biblioitems USING (biblioitemnumber)
1545 JOIN itemtypes USING (itemtype)
1546 WHERE itemnumber = ?";
1548 my $sth = $dbh->prepare($notforloan_query);
1549 $sth->execute($itemnumber);
1550 my $notforloan_per_itemtype = 0;
1551 if (my ($notforloan) = $sth->fetchrow_array) {
1552 $notforloan_per_itemtype = 1 if $notforloan;
1555 my $available_per_item = 1;
1556 $available_per_item = 0 if $item->{itemlost} or
1557 ( $item->{notforloan} > 0 ) or
1558 ($item->{damaged} and not C4::Context->preference('AllowHoldsOnDamagedItems')) or
1559 $item->{withdrawn} or
1560 $notforloan_per_itemtype;
1563 if (C4::Context->preference('AllowOnShelfHolds')) {
1564 return $available_per_item;
1566 return ($available_per_item and ($item->{onloan} or GetReserveStatus($itemnumber) eq "Waiting"));
1570 =head2 AlterPriority
1572 AlterPriority( $where, $reserve_id );
1574 This function changes a reserve's priority up, down, to the top, or to the bottom.
1575 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1580 my ( $where, $reserve_id ) = @_;
1582 my $dbh = C4::Context->dbh;
1584 my $reserve = GetReserve( $reserve_id );
1586 if ( $reserve->{cancellationdate} ) {
1587 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (".$reserve->{cancellationdate}.')';
1591 if ( $where eq 'up' || $where eq 'down' ) {
1593 my $priority = $reserve->{'priority'};
1594 $priority = $where eq 'up' ? $priority - 1 : $priority + 1;
1595 _FixPriority({ reserve_id => $reserve_id, rank => $priority })
1597 } elsif ( $where eq 'top' ) {
1599 _FixPriority({ reserve_id => $reserve_id, rank => '1' })
1601 } elsif ( $where eq 'bottom' ) {
1603 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1608 =head2 ToggleLowestPriority
1610 ToggleLowestPriority( $borrowernumber, $biblionumber );
1612 This function sets the lowestPriority field to true if is false, and false if it is true.
1616 sub ToggleLowestPriority {
1617 my ( $reserve_id ) = @_;
1619 my $dbh = C4::Context->dbh;
1621 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1622 $sth->execute( $reserve_id );
1624 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1627 =head2 ToggleSuspend
1629 ToggleSuspend( $reserve_id );
1631 This function sets the suspend field to true if is false, and false if it is true.
1632 If the reserve is currently suspended with a suspend_until date, that date will
1633 be cleared when it is unsuspended.
1638 my ( $reserve_id, $suspend_until ) = @_;
1640 $suspend_until = output_pref(
1642 dt => dt_from_string($suspend_until),
1643 dateformat => 'iso',
1646 ) if ($suspend_until);
1648 my $do_until = ( $suspend_until ) ? '?' : 'NULL';
1650 my $dbh = C4::Context->dbh;
1652 my $sth = $dbh->prepare(
1653 "UPDATE reserves SET suspend = NOT suspend,
1654 suspend_until = CASE WHEN suspend = 0 THEN NULL ELSE $do_until END
1655 WHERE reserve_id = ?
1659 push( @params, $suspend_until ) if ( $suspend_until );
1660 push( @params, $reserve_id );
1662 $sth->execute( @params );
1668 borrowernumber => $borrowernumber,
1669 [ biblionumber => $biblionumber, ]
1670 [ suspend_until => $suspend_until, ]
1671 [ suspend => $suspend ]
1674 This function accepts a set of hash keys as its parameters.
1675 It requires either borrowernumber or biblionumber, or both.
1677 suspend_until is wholly optional.
1684 my $borrowernumber = $params{'borrowernumber'} || undef;
1685 my $biblionumber = $params{'biblionumber'} || undef;
1686 my $suspend_until = $params{'suspend_until'} || undef;
1687 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1689 $suspend_until = C4::Dates->new( $suspend_until )->output("iso") if ( defined( $suspend_until ) );
1691 return unless ( $borrowernumber || $biblionumber );
1693 my ( $query, $sth, $dbh, @query_params );
1695 $query = "UPDATE reserves SET suspend = ? ";
1696 push( @query_params, $suspend );
1698 $query .= ", suspend_until = NULL ";
1699 } elsif ( $suspend_until ) {
1700 $query .= ", suspend_until = ? ";
1701 push( @query_params, $suspend_until );
1703 $query .= " WHERE ";
1704 if ( $borrowernumber ) {
1705 $query .= " borrowernumber = ? ";
1706 push( @query_params, $borrowernumber );
1708 $query .= " AND " if ( $borrowernumber && $biblionumber );
1709 if ( $biblionumber ) {
1710 $query .= " biblionumber = ? ";
1711 push( @query_params, $biblionumber );
1713 $query .= " AND found IS NULL ";
1715 $dbh = C4::Context->dbh;
1716 $sth = $dbh->prepare( $query );
1717 $sth->execute( @query_params );
1724 reserve_id => $reserve_id,
1726 [ignoreSetLowestRank => $ignoreSetLowestRank]
1731 _FixPriority({ biblionumber => $biblionumber});
1733 This routine adjusts the priority of a hold request and holds
1736 In the first form, where a reserve_id is passed, the priority of the
1737 hold is set to supplied rank, and other holds for that bib are adjusted
1738 accordingly. If the rank is "del", the hold is cancelled. If no rank
1739 is supplied, all of the holds on that bib have their priority adjusted
1740 as if the second form had been used.
1742 In the second form, where a biblionumber is passed, the holds on that
1743 bib (that are not captured) are sorted in order of increasing priority,
1744 then have reserves.priority set so that the first non-captured hold
1745 has its priority set to 1, the second non-captured hold has its priority
1746 set to 2, and so forth.
1748 In both cases, holds that have the lowestPriority flag on are have their
1749 priority adjusted to ensure that they remain at the end of the line.
1751 Note that the ignoreSetLowestRank parameter is meant to be used only
1752 when _FixPriority calls itself.
1757 my ( $params ) = @_;
1758 my $reserve_id = $params->{reserve_id};
1759 my $rank = $params->{rank} // '';
1760 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1761 my $biblionumber = $params->{biblionumber};
1763 my $dbh = C4::Context->dbh;
1765 unless ( $biblionumber ) {
1766 my $res = GetReserve( $reserve_id );
1767 $biblionumber = $res->{biblionumber};
1770 if ( $rank eq "del" ) {
1771 CancelReserve({ reserve_id => $reserve_id });
1773 elsif ( $rank eq "W" || $rank eq "0" ) {
1775 # make sure priority for waiting or in-transit items is 0
1779 WHERE reserve_id = ?
1780 AND found IN ('W', 'T')
1782 my $sth = $dbh->prepare($query);
1783 $sth->execute( $reserve_id );
1789 SELECT reserve_id, borrowernumber, reservedate, constrainttype
1791 WHERE biblionumber = ?
1792 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1793 ORDER BY priority ASC
1795 my $sth = $dbh->prepare($query);
1796 $sth->execute( $biblionumber );
1797 while ( my $line = $sth->fetchrow_hashref ) {
1798 push( @priority, $line );
1801 # To find the matching index
1803 my $key = -1; # to allow for 0 to be a valid result
1804 for ( $i = 0 ; $i < @priority ; $i++ ) {
1805 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1806 $key = $i; # save the index
1811 # if index exists in array then move it to new position
1812 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1813 my $new_rank = $rank -
1814 1; # $new_rank is what you want the new index to be in the array
1815 my $moving_item = splice( @priority, $key, 1 );
1816 splice( @priority, $new_rank, 0, $moving_item );
1819 # now fix the priority on those that are left....
1823 WHERE reserve_id = ?
1825 $sth = $dbh->prepare($query);
1826 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1829 $priority[$j]->{'reserve_id'}
1833 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1836 unless ( $ignoreSetLowestRank ) {
1837 while ( my $res = $sth->fetchrow_hashref() ) {
1839 reserve_id => $res->{'reserve_id'},
1841 ignoreSetLowestRank => 1
1847 =head2 _Findgroupreserve
1849 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead);
1851 Looks for an item-specific match first, then for a title-level match, returning the
1852 first match found. If neither, then we look for a 3rd kind of match based on
1853 reserve constraints.
1854 Lookahead is the number of days to look in advance.
1856 TODO: add more explanation about reserve constraints
1858 C<&_Findgroupreserve> returns :
1859 C<@results> is an array of references-to-hash whose keys are mostly
1860 fields from the reserves table of the Koha database, plus
1861 C<biblioitemnumber>.
1865 sub _Findgroupreserve {
1866 my ( $bibitem, $biblio, $itemnumber, $lookahead) = @_;
1867 my $dbh = C4::Context->dbh;
1869 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1870 # check for exact targetted match
1871 my $item_level_target_query = qq/
1872 SELECT reserves.biblionumber AS biblionumber,
1873 reserves.borrowernumber AS borrowernumber,
1874 reserves.reservedate AS reservedate,
1875 reserves.branchcode AS branchcode,
1876 reserves.cancellationdate AS cancellationdate,
1877 reserves.found AS found,
1878 reserves.reservenotes AS reservenotes,
1879 reserves.priority AS priority,
1880 reserves.timestamp AS timestamp,
1881 biblioitems.biblioitemnumber AS biblioitemnumber,
1882 reserves.itemnumber AS itemnumber,
1883 reserves.reserve_id AS reserve_id
1885 JOIN biblioitems USING (biblionumber)
1886 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1889 AND item_level_request = 1
1891 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1894 my $sth = $dbh->prepare($item_level_target_query);
1895 $sth->execute($itemnumber, $lookahead||0);
1897 if ( my $data = $sth->fetchrow_hashref ) {
1898 push( @results, $data );
1900 return @results if @results;
1902 # check for title-level targetted match
1903 my $title_level_target_query = qq/
1904 SELECT reserves.biblionumber AS biblionumber,
1905 reserves.borrowernumber AS borrowernumber,
1906 reserves.reservedate AS reservedate,
1907 reserves.branchcode AS branchcode,
1908 reserves.cancellationdate AS cancellationdate,
1909 reserves.found AS found,
1910 reserves.reservenotes AS reservenotes,
1911 reserves.priority AS priority,
1912 reserves.timestamp AS timestamp,
1913 biblioitems.biblioitemnumber AS biblioitemnumber,
1914 reserves.itemnumber AS itemnumber,
1915 reserves.reserve_id AS reserve_id
1917 JOIN biblioitems USING (biblionumber)
1918 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1921 AND item_level_request = 0
1922 AND hold_fill_targets.itemnumber = ?
1923 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1926 $sth = $dbh->prepare($title_level_target_query);
1927 $sth->execute($itemnumber, $lookahead||0);
1929 if ( my $data = $sth->fetchrow_hashref ) {
1930 push( @results, $data );
1932 return @results if @results;
1935 SELECT reserves.biblionumber AS biblionumber,
1936 reserves.borrowernumber AS borrowernumber,
1937 reserves.reservedate AS reservedate,
1938 reserves.waitingdate AS waitingdate,
1939 reserves.branchcode AS branchcode,
1940 reserves.cancellationdate AS cancellationdate,
1941 reserves.found AS found,
1942 reserves.reservenotes AS reservenotes,
1943 reserves.priority AS priority,
1944 reserves.timestamp AS timestamp,
1945 reserveconstraints.biblioitemnumber AS biblioitemnumber,
1946 reserves.itemnumber AS itemnumber,
1947 reserves.reserve_id AS reserve_id
1949 LEFT JOIN reserveconstraints ON reserves.biblionumber = reserveconstraints.biblionumber
1950 WHERE reserves.biblionumber = ?
1951 AND ( ( reserveconstraints.biblioitemnumber = ?
1952 AND reserves.borrowernumber = reserveconstraints.borrowernumber
1953 AND reserves.reservedate = reserveconstraints.reservedate )
1954 OR reserves.constrainttype='a' )
1955 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1956 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1959 $sth = $dbh->prepare($query);
1960 $sth->execute( $biblio, $bibitem, $itemnumber, $lookahead||0);
1962 while ( my $data = $sth->fetchrow_hashref ) {
1963 push( @results, $data );
1968 =head2 _koha_notify_reserve
1970 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber );
1972 Sends a notification to the patron that their hold has been filled (through
1973 ModReserveAffect, _not_ ModReserveFill)
1977 sub _koha_notify_reserve {
1978 my ($itemnumber, $borrowernumber, $biblionumber) = @_;
1980 my $dbh = C4::Context->dbh;
1981 my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
1983 # Try to get the borrower's email address
1984 my $to_address = C4::Members::GetNoticeEmailAddress($borrowernumber);
1986 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( {
1987 borrowernumber => $borrowernumber,
1988 message_name => 'Hold_Filled'
1991 my $sth = $dbh->prepare("
1994 WHERE borrowernumber = ?
1995 AND biblionumber = ?
1997 $sth->execute( $borrowernumber, $biblionumber );
1998 my $reserve = $sth->fetchrow_hashref;
1999 my $branch_details = GetBranchDetail( $reserve->{'branchcode'} );
2001 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
2003 my %letter_params = (
2004 module => 'reserves',
2005 branchcode => $reserve->{branchcode},
2007 'branches' => $branch_details,
2008 'borrowers' => $borrower,
2009 'biblio' => $biblionumber,
2010 'reserves' => $reserve,
2011 'items', $reserve->{'itemnumber'},
2013 substitute => { today => C4::Dates->new()->output() },
2016 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.
2017 my $send_notification = sub {
2018 my ( $mtt, $letter_code ) = (@_);
2019 return unless defined $letter_code;
2020 $letter_params{letter_code} = $letter_code;
2021 $letter_params{message_transport_type} = $mtt;
2022 my $letter = C4::Letters::GetPreparedLetter ( %letter_params );
2024 warn "Could not find a letter called '$letter_params{'letter_code'}' for $mtt in the 'reserves' module";
2028 C4::Letters::EnqueueLetter( {
2030 borrowernumber => $borrowernumber,
2031 from_address => $admin_email_address,
2032 message_transport_type => $mtt,
2036 while ( my ( $mtt, $letter_code ) = each %{ $messagingprefs->{transports} } ) {
2037 if ( ($mtt eq 'email' and not $to_address) or ($mtt eq 'sms' and not $borrower->{smsalertnumber}) ) {
2038 # email or sms is requested but not exist
2041 &$send_notification($mtt, $letter_code);
2042 $notification_sent++;
2044 #Making sure that a print notification is sent if no other transport types can be utilized.
2045 if (! $notification_sent) {
2046 &$send_notification('print', 'HOLD');
2051 =head2 _ShiftPriorityByDateAndPriority
2053 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
2055 This increments the priority of all reserves after the one
2056 with either the lowest date after C<$reservedate>
2057 or the lowest priority after C<$priority>.
2059 It effectively makes room for a new reserve to be inserted with a certain
2060 priority, which is returned.
2062 This is most useful when the reservedate can be set by the user. It allows
2063 the new reserve to be placed before other reserves that have a later
2064 reservedate. Since priority also is set by the form in reserves/request.pl
2065 the sub accounts for that too.
2069 sub _ShiftPriorityByDateAndPriority {
2070 my ( $biblio, $resdate, $new_priority ) = @_;
2072 my $dbh = C4::Context->dbh;
2073 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
2074 my $sth = $dbh->prepare( $query );
2075 $sth->execute( $biblio, $resdate, $new_priority );
2076 my $min_priority = $sth->fetchrow;
2077 # if no such matches are found, $new_priority remains as original value
2078 $new_priority = $min_priority if ( $min_priority );
2080 # Shift the priority up by one; works in conjunction with the next SQL statement
2081 $query = "UPDATE reserves
2082 SET priority = priority+1
2083 WHERE biblionumber = ?
2084 AND borrowernumber = ?
2087 my $sth_update = $dbh->prepare( $query );
2089 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
2090 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
2091 $sth = $dbh->prepare( $query );
2092 $sth->execute( $new_priority, $biblio );
2093 while ( my $row = $sth->fetchrow_hashref ) {
2094 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
2097 return $new_priority; # so the caller knows what priority they wind up receiving
2102 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
2104 Use when checking out an item to handle reserves
2105 If $cancelreserve boolean is set to true, it will remove existing reserve
2110 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
2112 my ( $restype, $res, $all_reserves ) = CheckReserves( $itemnumber );
2115 my $biblionumber = $res->{biblionumber};
2116 my $biblioitemnumber = $res->{biblioitemnumber};
2118 if ($res->{borrowernumber} == $borrowernumber) {
2119 ModReserveFill($res);
2123 # The item is reserved by someone else.
2124 # Find this item in the reserves
2127 foreach (@$all_reserves) {
2128 $_->{'borrowernumber'} == $borrowernumber or next;
2129 $_->{'biblionumber'} == $biblionumber or next;
2136 # The item is reserved by the current patron
2137 ModReserveFill($borr_res);
2140 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2141 RevertWaitingStatus({ itemnumber => $itemnumber });
2143 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2145 biblionumber => $res->{'biblionumber'},
2146 itemnumber => $res->{'itemnumber'},
2147 borrowernumber => $res->{'borrowernumber'}
2155 MergeHolds($dbh,$to_biblio, $from_biblio);
2157 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2162 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2163 my $sth = $dbh->prepare(
2164 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2166 $sth->execute($from_biblio);
2167 if ( my $data = $sth->fetchrow_hashref() ) {
2169 # holds exist on old record, if not we don't need to do anything
2170 $sth = $dbh->prepare(
2171 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2172 $sth->execute( $to_biblio, $from_biblio );
2175 # don't reorder those already waiting
2177 $sth = $dbh->prepare(
2178 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
2180 my $upd_sth = $dbh->prepare(
2181 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2182 AND reservedate = ? AND constrainttype = ? AND (itemnumber = ? or itemnumber is NULL) "
2184 $sth->execute( $to_biblio, 'W', 'T' );
2186 while ( my $reserve = $sth->fetchrow_hashref() ) {
2188 $priority, $to_biblio,
2189 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2190 $reserve->{'constrainttype'}, $reserve->{'itemnumber'}
2197 =head2 RevertWaitingStatus
2199 RevertWaitingStatus({ itemnumber => $itemnumber });
2201 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2203 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2204 item level hold, even if it was only a bibliolevel hold to
2205 begin with. This is because we can no longer know if a hold
2206 was item-level or bib-level after a hold has been set to
2211 sub RevertWaitingStatus {
2212 my ( $params ) = @_;
2213 my $itemnumber = $params->{'itemnumber'};
2215 return unless ( $itemnumber );
2217 my $dbh = C4::Context->dbh;
2219 ## Get the waiting reserve we want to revert
2221 SELECT * FROM reserves
2222 WHERE itemnumber = ?
2223 AND found IS NOT NULL
2225 my $sth = $dbh->prepare( $query );
2226 $sth->execute( $itemnumber );
2227 my $reserve = $sth->fetchrow_hashref();
2229 ## Increment the priority of all other non-waiting
2230 ## reserves for this bib record
2234 priority = priority + 1
2240 $sth = $dbh->prepare( $query );
2241 $sth->execute( $reserve->{'biblionumber'} );
2243 ## Fix up the currently waiting reserve
2253 $sth = $dbh->prepare( $query );
2254 $sth->execute( $reserve->{'reserve_id'} );
2255 _FixPriority( { biblionumber => $reserve->{biblionumber} } );
2260 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber [, itemnumber => $itemnumber ] });
2262 Returnes the first reserve id that matches the given criteria
2267 my ( $params ) = @_;
2269 return unless ( ( $params->{'biblionumber'} || $params->{'itemnumber'} ) && $params->{'borrowernumber'} );
2271 my $dbh = C4::Context->dbh();
2273 my $sql = "SELECT reserve_id FROM reserves WHERE ";
2277 foreach my $key ( keys %$params ) {
2278 if ( defined( $params->{$key} ) ) {
2279 push( @limits, "$key = ?" );
2280 push( @params, $params->{$key} );
2284 $sql .= join( " AND ", @limits );
2286 my $sth = $dbh->prepare( $sql );
2287 $sth->execute( @params );
2288 my $row = $sth->fetchrow_hashref();
2290 return $row->{'reserve_id'};
2295 ReserveSlip($branchcode, $borrowernumber, $biblionumber)
2297 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2302 my ($branch, $borrowernumber, $biblionumber) = @_;
2304 # return unless ( C4::Context->boolean_preference('printreserveslips') );
2306 my $reserve_id = GetReserveId({
2307 biblionumber => $biblionumber,
2308 borrowernumber => $borrowernumber
2310 my $reserve = GetReserveInfo($reserve_id) or return;
2312 return C4::Letters::GetPreparedLetter (
2313 module => 'circulation',
2314 letter_code => 'RESERVESLIP',
2315 branchcode => $branch,
2317 'reserves' => $reserve,
2318 'branches' => $reserve->{branchcode},
2319 'borrowers' => $reserve->{borrowernumber},
2320 'biblio' => $reserve->{biblionumber},
2321 'items' => $reserve->{itemnumber},
2326 =head2 GetReservesControlBranch
2328 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2330 Return the branchcode to be used to determine which reserves
2331 policy applies to a transaction.
2333 C<$item> is a hashref for an item. Only 'homebranch' is used.
2335 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2339 sub GetReservesControlBranch {
2340 my ( $item, $borrower ) = @_;
2342 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2345 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2346 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2352 =head2 CalculatePriority
2354 my $p = CalculatePriority($biblionumber, $resdate);
2356 Calculate priority for a new reserve on biblionumber, placing it at
2357 the end of the line of all holds whose start date falls before
2358 the current system time and that are neither on the hold shelf
2361 The reserve date parameter is optional; if it is supplied, the
2362 priority is based on the set of holds whose start date falls before
2363 the parameter value.
2365 After calculation of this priority, it is recommended to call
2366 _ShiftPriorityByDateAndPriority. Note that this is currently done in
2371 sub CalculatePriority {
2372 my ( $biblionumber, $resdate ) = @_;
2375 SELECT COUNT(*) FROM reserves
2376 WHERE biblionumber = ?
2378 AND (found IS NULL OR found = '')
2380 #skip found==W or found==T (waiting or transit holds)
2382 $sql.= ' AND ( reservedate <= ? )';
2385 $sql.= ' AND ( reservedate < NOW() )';
2387 my $dbh = C4::Context->dbh();
2388 my @row = $dbh->selectrow_array(
2391 $resdate ? ($biblionumber, $resdate) : ($biblionumber)
2394 return @row ? $row[0]+1 : 1;
2399 Koha Development Team <http://koha-community.org/>