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 );
42 use List::MoreUtils qw( firstidx );
44 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
48 C4::Reserves - Koha functions for dealing with reservation.
56 This modules provides somes functions to deal with reservations.
58 Reserves are stored in reserves table.
59 The following columns contains important values :
60 - priority >0 : then the reserve is at 1st stage, and not yet affected to any item.
61 =0 : then the reserve is being dealed
62 - found : NULL : means the patron requested the 1st available, and we haven't choosen the item
63 T(ransit) : the reserve is linked to an item but is in transit to the pickup branch
64 W(aiting) : the reserve is linked to an item, is at the pickup branch, and is waiting on the hold shelf
65 F(inished) : the reserve has been completed, and is done
66 - itemnumber : empty : the reserve is still unaffected to an item
67 filled: the reserve is attached to an item
68 The complete workflow is :
69 ==== 1st use case ====
70 patron request a document, 1st available : P >0, F=NULL, I=NULL
71 a library having it run "transfertodo", and clic on the list
72 if there is no transfer to do, the reserve waiting
73 patron can pick it up P =0, F=W, I=filled
74 if there is a transfer to do, write in branchtransfer P =0, F=T, I=filled
75 The pickup library recieve the book, it check in P =0, F=W, I=filled
76 The patron borrow the book P =0, F=F, I=filled
78 ==== 2nd use case ====
79 patron requests a document, a given item,
80 If pickup is holding branch P =0, F=W, I=filled
81 If transfer needed, write in branchtransfer P =0, F=T, I=filled
82 The pickup library receive the book, it checks it in P =0, F=W, I=filled
83 The patron borrow the book P =0, F=F, I=filled
90 # set the version for version checking
91 $VERSION = 3.07.00.049;
98 &GetReservesFromItemnumber
99 &GetReservesFromBiblionumber
100 &GetReservesFromBorrowernumber
101 &GetReservesForBranch
115 &ModReserveMinusPriority
122 &CancelExpiredReserves
124 &AutoUnsuspendReserves
126 &IsAvailableForItemLevelRequest
129 &ToggleLowestPriority
135 &GetReservesControlBranch
137 @EXPORT_OK = qw( MergeHolds );
142 AddReserve($branch,$borrowernumber,$biblionumber,$constraint,$bibitems,$priority,$resdate,$expdate,$notes,$title,$checkitem,$found)
148 $branch, $borrowernumber, $biblionumber,
149 $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
150 $title, $checkitem, $found
153 GetReserveFee($borrowernumber, $biblionumber, $constraint,
155 my $dbh = C4::Context->dbh;
156 my $const = lc substr( $constraint, 0, 1 );
157 $resdate = format_date_in_iso( $resdate ) if ( $resdate );
158 $resdate = C4::Dates->today( 'iso' ) unless ( $resdate );
160 $expdate = format_date_in_iso( $expdate );
162 undef $expdate; # make reserves.expirationdate default to null rather than '0000-00-00'
164 if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
165 # Make room in reserves for this before those of a later reserve date
166 $priority = _ShiftPriorityByDateAndPriority( $biblionumber, $resdate, $priority );
170 # If the reserv had the waiting status, we had the value of the resdate
171 if ( $found eq 'W' ) {
172 $waitingdate = $resdate;
176 # updates take place here
178 my $nextacctno = &getnextacctno( $borrowernumber );
180 INSERT INTO accountlines
181 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
183 (?,?,now(),?,?,'Res',?)
185 my $usth = $dbh->prepare($query);
186 $usth->execute( $borrowernumber, $nextacctno, $fee,
187 "Reserve Charge - $title", $fee );
193 (borrowernumber,biblionumber,reservedate,branchcode,constrainttype,
194 priority,reservenotes,itemnumber,found,waitingdate,expirationdate)
199 my $sth = $dbh->prepare($query);
201 $borrowernumber, $biblionumber, $resdate, $branch,
202 $const, $priority, $notes, $checkitem,
203 $found, $waitingdate, $expdate
206 # Send e-mail to librarian if syspref is active
207 if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
208 my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
209 my $branch_details = C4::Branch::GetBranchDetail($borrower->{branchcode});
210 if ( my $letter = C4::Letters::GetPreparedLetter (
211 module => 'reserves',
212 letter_code => 'HOLDPLACED',
213 branchcode => $branch,
215 'branches' => $branch_details,
216 'borrowers' => $borrower,
217 'biblio' => $biblionumber,
218 'items' => $checkitem,
222 my $admin_email_address =$branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
224 C4::Letters::EnqueueLetter(
226 borrowernumber => $borrowernumber,
227 message_transport_type => 'email',
228 from_address => $admin_email_address,
229 to_address => $admin_email_address,
236 ($const eq "o" || $const eq "e") or return; # FIXME: why not have a useful return value?
238 INSERT INTO reserveconstraints
239 (borrowernumber,biblionumber,reservedate,biblioitemnumber)
243 $sth = $dbh->prepare($query); # keep prepare outside the loop!
244 foreach (@$bibitems) {
245 $sth->execute($borrowernumber, $biblionumber, $resdate, $_);
248 return; # FIXME: why not have a useful return value?
253 $res = GetReserve( $reserve_id );
255 Return the current reserve.
260 my ($reserve_id) = @_;
262 my $dbh = C4::Context->dbh;
263 my $query = "SELECT * FROM reserves WHERE reserve_id = ?";
264 my $sth = $dbh->prepare( $query );
265 $sth->execute( $reserve_id );
266 return $sth->fetchrow_hashref();
269 =head2 GetReservesFromBiblionumber
271 my $reserves = GetReservesFromBiblionumber({
272 biblionumber => $biblionumber,
273 [ itemnumber => $itemnumber, ]
277 This function gets the list of reservations for one C<$biblionumber>,
278 returning an arrayref pointing to the reserves for C<$biblionumber>.
280 By default, only reserves whose start date falls before the current
281 time are returned. To return all reserves, including future ones,
282 the C<all_dates> parameter can be included and set to a true value.
284 If the C<itemnumber> parameter is supplied, reserves must be targeted
285 to that item or not targeted to any item at all; otherwise, they
286 are excluded from the list.
290 sub GetReservesFromBiblionumber {
292 my $biblionumber = $params->{biblionumber} or return [];
293 my $itemnumber = $params->{itemnumber};
294 my $all_dates = $params->{all_dates} // 0;
295 my $dbh = C4::Context->dbh;
297 # Find the desired items in the reserves
302 timestamp AS rtimestamp,
316 WHERE biblionumber = ? ";
317 push( @params, $biblionumber );
318 unless ( $all_dates ) {
319 $query .= " AND reservedate <= CAST(NOW() AS DATE) ";
322 $query .= " AND ( itemnumber IS NULL OR itemnumber = ? )";
323 push( @params, $itemnumber );
325 $query .= "ORDER BY priority";
326 my $sth = $dbh->prepare($query);
327 $sth->execute( @params );
330 while ( my $data = $sth->fetchrow_hashref ) {
332 # FIXME - What is this doing? How do constraints work?
333 if ($data->{constrainttype} eq 'o') {
335 SELECT biblioitemnumber
336 FROM reserveconstraints
337 WHERE biblionumber = ?
338 AND borrowernumber = ?
341 my $csth = $dbh->prepare($query);
342 $csth->execute($data->{biblionumber}, $data->{borrowernumber}, $data->{reservedate});
344 while ( my $bibitemnos = $csth->fetchrow_array ) {
345 push( @bibitemno, $bibitemnos ); # FIXME: inefficient: use fetchall_arrayref
347 my $count = scalar @bibitemno;
349 # if we have two or more different specific itemtypes
350 # reserved by same person on same day
353 $bdata = GetBiblioItemData( $bibitemno[$i] ); # FIXME: This doesn't make sense.
354 $i++; # $i can increase each pass, but the next @bibitemno might be smaller?
357 # Look up the book we just found.
358 $bdata = GetBiblioItemData( $bibitemno[0] );
360 # Add the results of this latest search to the current
362 # FIXME - An 'each' would probably be more efficient.
363 foreach my $key ( keys %$bdata ) {
364 $data->{$key} = $bdata->{$key};
367 push @results, $data;
372 =head2 GetReservesFromItemnumber
374 ( $reservedate, $borrowernumber, $branchcode, $reserve_id, $waitingdate ) = GetReservesFromItemnumber($itemnumber);
376 Get the first reserve for a specific item number (based on priority). Returns the abovementioned values for that reserve.
378 The routine does not look at future reserves (read: item level holds), but DOES include future waits (a confirmed future hold).
382 sub GetReservesFromItemnumber {
383 my ( $itemnumber ) = @_;
384 my $dbh = C4::Context->dbh;
386 SELECT reservedate,borrowernumber,branchcode,reserve_id,waitingdate
388 WHERE itemnumber=? AND ( reservedate <= CAST(now() AS date) OR
389 waitingdate IS NOT NULL )
392 my $sth_res = $dbh->prepare($query);
393 $sth_res->execute($itemnumber);
394 my ( $reservedate, $borrowernumber,$branchcode, $reserve_id, $wait ) = $sth_res->fetchrow_array;
395 return ( $reservedate, $borrowernumber, $branchcode, $reserve_id, $wait );
398 =head2 GetReservesFromBorrowernumber
400 $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
406 sub GetReservesFromBorrowernumber {
407 my ( $borrowernumber, $status ) = @_;
408 my $dbh = C4::Context->dbh;
411 $sth = $dbh->prepare("
414 WHERE borrowernumber=?
418 $sth->execute($borrowernumber,$status);
420 $sth = $dbh->prepare("
423 WHERE borrowernumber=?
426 $sth->execute($borrowernumber);
428 my $data = $sth->fetchall_arrayref({});
431 #-------------------------------------------------------------------------------------
432 =head2 CanBookBeReserved
434 $error = &CanBookBeReserved($borrowernumber, $biblionumber)
438 sub CanBookBeReserved{
439 my ($borrowernumber, $biblionumber) = @_;
441 my $items = GetItemnumbersForBiblio($biblionumber);
442 #get items linked via host records
443 my @hostitems = get_hostitemnumbers_of($biblionumber);
445 push (@$items,@hostitems);
448 foreach my $item (@$items){
449 return 1 if CanItemBeReserved($borrowernumber, $item);
454 =head2 CanItemBeReserved
456 $error = &CanItemBeReserved($borrowernumber, $itemnumber)
458 This function return 1 if an item can be issued by this borrower.
462 sub CanItemBeReserved{
463 my ($borrowernumber, $itemnumber) = @_;
465 my $dbh = C4::Context->dbh;
466 my $allowedreserves = 0;
468 my $controlbranch = C4::Context->preference('ReservesControlBranch');
469 my $itype = C4::Context->preference('item-level_itypes') ? "itype" : "itemtype";
471 # we retrieve borrowers and items informations #
472 my $item = GetItem($itemnumber);
473 my $borrower = C4::Members::GetMember('borrowernumber'=>$borrowernumber);
475 # we retrieve user rights on this itemtype and branchcode
476 my $sth = $dbh->prepare("SELECT categorycode, itemtype, branchcode, reservesallowed
478 WHERE (categorycode in (?,'*') )
479 AND (itemtype IN (?,'*'))
480 AND (branchcode IN (?,'*'))
487 my $querycount ="SELECT
490 LEFT JOIN items USING (itemnumber)
491 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
492 LEFT JOIN borrowers USING (borrowernumber)
493 WHERE borrowernumber = ?
497 my $itemtype = $item->{$itype};
498 my $categorycode = $borrower->{categorycode};
500 my $branchfield = "reserves.branchcode";
502 if( $controlbranch eq "ItemHomeLibrary" ){
503 $branchfield = "items.homebranch";
504 $branchcode = $item->{homebranch};
505 }elsif( $controlbranch eq "PatronLibrary" ){
506 $branchfield = "borrowers.branchcode";
507 $branchcode = $borrower->{branchcode};
511 $sth->execute($categorycode, $itemtype, $branchcode);
512 if(my $rights = $sth->fetchrow_hashref()){
513 $itemtype = $rights->{itemtype};
514 $allowedreserves = $rights->{reservesallowed};
521 $querycount .= "AND $branchfield = ?";
523 $querycount .= " AND $itype = ?" if ($itemtype ne "*");
524 my $sthcount = $dbh->prepare($querycount);
526 if($itemtype eq "*"){
527 $sthcount->execute($borrowernumber, $branchcode);
529 $sthcount->execute($borrowernumber, $branchcode, $itemtype);
532 my $reservecount = "0";
533 if(my $rowcount = $sthcount->fetchrow_hashref()){
534 $reservecount = $rowcount->{count};
537 # we check if it's ok or not
538 if( $reservecount >= $allowedreserves ){
542 # If reservecount is ok, we check item branch if IndependentBranches is ON
543 # and canreservefromotherbranches is OFF
544 if ( C4::Context->preference('IndependentBranches')
545 and !C4::Context->preference('canreservefromotherbranches') )
547 my $itembranch = $item->{homebranch};
548 if ($itembranch ne $borrower->{branchcode}) {
555 #--------------------------------------------------------------------------------
556 =head2 GetReserveCount
558 $number = &GetReserveCount($borrowernumber);
560 this function returns the number of reservation for a borrower given on input arg.
564 sub GetReserveCount {
565 my ($borrowernumber) = @_;
567 my $dbh = C4::Context->dbh;
570 SELECT COUNT(*) AS counter
572 WHERE borrowernumber = ?
574 my $sth = $dbh->prepare($query);
575 $sth->execute($borrowernumber);
576 my $row = $sth->fetchrow_hashref;
577 return $row->{counter};
580 =head2 GetOtherReserves
582 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
584 Check queued list of this document and check if this document must be transfered
588 sub GetOtherReserves {
589 my ($itemnumber) = @_;
592 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
593 if ($checkreserves) {
594 my $iteminfo = GetItem($itemnumber);
595 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
596 $messages->{'transfert'} = $checkreserves->{'branchcode'};
597 #minus priorities of others reservs
598 ModReserveMinusPriority(
600 $checkreserves->{'reserve_id'},
603 #launch the subroutine dotransfer
604 C4::Items::ModItemTransfer(
606 $iteminfo->{'holdingbranch'},
607 $checkreserves->{'branchcode'}
612 #step 2b : case of a reservation on the same branch, set the waiting status
614 $messages->{'waiting'} = 1;
615 ModReserveMinusPriority(
617 $checkreserves->{'reserve_id'},
619 ModReserveStatus($itemnumber,'W');
622 $nextreservinfo = $checkreserves->{'borrowernumber'};
625 return ( $messages, $nextreservinfo );
630 $fee = GetReserveFee($borrowernumber,$biblionumber,$constraint,$biblionumber);
632 Calculate the fee for a reserve
637 my ($borrowernumber, $biblionumber, $constraint, $bibitems ) = @_;
640 my $dbh = C4::Context->dbh;
641 my $const = lc substr( $constraint, 0, 1 );
643 SELECT * FROM borrowers
644 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
645 WHERE borrowernumber = ?
647 my $sth = $dbh->prepare($query);
648 $sth->execute($borrowernumber);
649 my $data = $sth->fetchrow_hashref;
650 my $fee = $data->{'reservefee'};
651 my $cntitems = @- > $bibitems;
655 # check for items on issue
656 # first find biblioitem records
658 my $sth1 = $dbh->prepare(
659 "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber
660 WHERE (biblio.biblionumber = ?)"
662 $sth1->execute($biblionumber);
663 while ( my $data1 = $sth1->fetchrow_hashref ) {
664 if ( $const eq "a" ) {
665 push @biblioitems, $data1;
670 while ( $x < $cntitems ) {
671 if ( @$bibitems->{'biblioitemnumber'} ==
672 $data->{'biblioitemnumber'} )
678 if ( $const eq 'o' ) {
680 push @biblioitems, $data1;
685 push @biblioitems, $data1;
690 my $cntitemsfound = @biblioitems;
694 while ( $x < $cntitemsfound ) {
695 my $bitdata = $biblioitems[$x];
696 my $sth2 = $dbh->prepare(
698 WHERE biblioitemnumber = ?"
700 $sth2->execute( $bitdata->{'biblioitemnumber'} );
701 while ( my $itdata = $sth2->fetchrow_hashref ) {
702 my $sth3 = $dbh->prepare(
703 "SELECT * FROM issues
704 WHERE itemnumber = ?"
706 $sth3->execute( $itdata->{'itemnumber'} );
707 if ( my $isdata = $sth3->fetchrow_hashref ) {
715 if ( $allissued == 0 ) {
717 $dbh->prepare("SELECT * FROM reserves WHERE biblionumber = ?");
718 $rsth->execute($biblionumber);
719 if ( my $rdata = $rsth->fetchrow_hashref ) {
729 =head2 GetReservesToBranch
731 @transreserv = GetReservesToBranch( $frombranch );
733 Get reserve list for a given branch
737 sub GetReservesToBranch {
738 my ( $frombranch ) = @_;
739 my $dbh = C4::Context->dbh;
740 my $sth = $dbh->prepare(
741 "SELECT reserve_id,borrowernumber,reservedate,itemnumber,timestamp
746 $sth->execute( $frombranch );
749 while ( my $data = $sth->fetchrow_hashref ) {
750 $transreserv[$i] = $data;
753 return (@transreserv);
756 =head2 GetReservesForBranch
758 @transreserv = GetReservesForBranch($frombranch);
762 sub GetReservesForBranch {
763 my ($frombranch) = @_;
764 my $dbh = C4::Context->dbh;
767 SELECT reserve_id,borrowernumber,reservedate,itemnumber,waitingdate
772 $query .= " AND branchcode=? " if ( $frombranch );
773 $query .= "ORDER BY waitingdate" ;
775 my $sth = $dbh->prepare($query);
777 $sth->execute($frombranch);
784 while ( my $data = $sth->fetchrow_hashref ) {
785 $transreserv[$i] = $data;
788 return (@transreserv);
791 =head2 GetReserveStatus
793 $reservestatus = GetReserveStatus($itemnumber, $biblionumber);
795 Take an itemnumber or a biblionumber and return the status of the reserve places on it.
796 If several reserves exist, the reserve with the lower priority is given.
800 ## FIXME: I don't think this does what it thinks it does.
801 ## It only ever checks the first reserve result, even though
802 ## multiple reserves for that bib can have the itemnumber set
803 ## the sub is only used once in the codebase.
804 sub GetReserveStatus {
805 my ($itemnumber, $biblionumber) = @_;
807 my $dbh = C4::Context->dbh;
809 my ($sth, $found, $priority);
811 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
812 $sth->execute($itemnumber);
813 ($found, $priority) = $sth->fetchrow_array;
816 if ( $biblionumber and not defined $found and not defined $priority ) {
817 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE biblionumber = ? order by priority LIMIT 1");
818 $sth->execute($biblionumber);
819 ($found, $priority) = $sth->fetchrow_array;
823 return 'Waiting' if $found eq 'W' and $priority == 0;
824 return 'Finished' if $found eq 'F';
827 return 'Reserved' if $priority > 0;
829 return ''; # empty string here will remove need for checking undef, or less log lines
834 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber);
835 ($status, $reserve, $all_reserves) = &CheckReserves(undef, $barcode);
836 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
838 Find a book in the reserves.
840 C<$itemnumber> is the book's item number.
841 C<$lookahead> is the number of days to look in advance for future reserves.
843 As I understand it, C<&CheckReserves> looks for the given item in the
844 reserves. If it is found, that's a match, and C<$status> is set to
847 Otherwise, it finds the most important item in the reserves with the
848 same biblio number as this book (I'm not clear on this) and returns it
849 with C<$status> set to C<Reserved>.
851 C<&CheckReserves> returns a two-element list:
853 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
855 C<$reserve> is the reserve item that matched. It is a
856 reference-to-hash whose keys are mostly the fields of the reserves
857 table in the Koha database.
862 my ( $item, $barcode, $lookahead_days) = @_;
863 my $dbh = C4::Context->dbh;
866 if (C4::Context->preference('item-level_itypes')){
868 SELECT items.biblionumber,
869 items.biblioitemnumber,
870 itemtypes.notforloan,
871 items.notforloan AS itemnotforloan,
874 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
875 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
880 SELECT items.biblionumber,
881 items.biblioitemnumber,
882 itemtypes.notforloan,
883 items.notforloan AS itemnotforloan,
886 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
887 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
892 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
893 $sth->execute($item);
896 $sth = $dbh->prepare("$select WHERE barcode = ?");
897 $sth->execute($barcode);
899 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
900 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber ) = $sth->fetchrow_array;
902 return ( '' ) unless $itemnumber; # bail if we got nothing.
904 # if item is not for loan it cannot be reserved either.....
905 # execpt where items.notforloan < 0 : This indicates the item is holdable.
906 return ( '' ) if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
908 # Find this item in the reserves
909 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days);
911 # $priority and $highest are used to find the most important item
912 # in the list returned by &_Findgroupreserve. (The lower $priority,
913 # the more important the item.)
914 # $highest is the most important item we've seen so far.
916 if (scalar @reserves) {
917 my $priority = 10000000;
918 foreach my $res (@reserves) {
919 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
920 return ( "Waiting", $res, \@reserves ); # Found it
922 # See if this item is more important than what we've got so far
923 if ( $res->{'priority'} && $res->{'priority'} < $priority ) {
924 my $borrowerinfo=C4::Members::GetMember(borrowernumber => $res->{'borrowernumber'});
925 my $iteminfo=C4::Items::GetItem($itemnumber);
926 my $branch = GetReservesControlBranch( $iteminfo, $borrowerinfo );
927 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$iteminfo->{'itype'});
928 next if ($branchitemrule->{'holdallowed'} == 0);
929 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $borrowerinfo->{'branchcode'}));
930 $priority = $res->{'priority'};
937 # If we get this far, then no exact match was found.
938 # We return the most important (i.e. next) reservation.
940 $highest->{'itemnumber'} = $item;
941 return ( "Reserved", $highest, \@reserves );
947 =head2 CancelExpiredReserves
949 CancelExpiredReserves();
951 Cancels all reserves with an expiration date from before today.
955 sub CancelExpiredReserves {
957 # Cancel reserves that have passed their expiration date.
958 my $dbh = C4::Context->dbh;
959 my $sth = $dbh->prepare( "
960 SELECT * FROM reserves WHERE DATE(expirationdate) < DATE( CURDATE() )
961 AND expirationdate IS NOT NULL
966 while ( my $res = $sth->fetchrow_hashref() ) {
967 CancelReserve({ reserve_id => $res->{'reserve_id'} });
970 # Cancel reserves that have been waiting too long
971 if ( C4::Context->preference("ExpireReservesMaxPickUpDelay") ) {
972 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
973 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
975 my $query = "SELECT * FROM reserves WHERE TO_DAYS( NOW() ) - TO_DAYS( waitingdate ) > ? AND found = 'W' AND priority = 0";
976 $sth = $dbh->prepare( $query );
977 $sth->execute( $max_pickup_delay );
979 while (my $res = $sth->fetchrow_hashref ) {
981 manualinvoice($res->{'borrowernumber'}, $res->{'itemnumber'}, 'Hold waiting too long', 'F', $charge);
984 CancelReserve({ reserve_id => $res->{'reserve_id'} });
990 =head2 AutoUnsuspendReserves
992 AutoUnsuspendReserves();
994 Unsuspends all suspended reserves with a suspend_until date from before today.
998 sub AutoUnsuspendReserves {
1000 my $dbh = C4::Context->dbh;
1002 my $query = "UPDATE reserves SET suspend = 0, suspend_until = NULL WHERE DATE( suspend_until ) < DATE( CURDATE() )";
1003 my $sth = $dbh->prepare( $query );
1008 =head2 CancelReserve
1010 CancelReserve({ reserve_id => $reserve_id, [ biblionumber => $biblionumber, borrowernumber => $borrrowernumber, itemnumber => $itemnumber ] });
1017 my ( $params ) = @_;
1019 my $reserve_id = $params->{'reserve_id'};
1020 $reserve_id = GetReserveId( $params ) unless ( $reserve_id );
1022 return unless ( $reserve_id );
1024 my $dbh = C4::Context->dbh;
1026 my $reserve = GetReserve( $reserve_id );
1030 SET cancellationdate = now(),
1033 WHERE reserve_id = ?
1035 my $sth = $dbh->prepare($query);
1036 $sth->execute( $reserve_id );
1039 INSERT INTO old_reserves
1040 SELECT * FROM reserves
1041 WHERE reserve_id = ?
1043 $sth = $dbh->prepare($query);
1044 $sth->execute( $reserve_id );
1047 DELETE FROM reserves
1048 WHERE reserve_id = ?
1050 $sth = $dbh->prepare($query);
1051 $sth->execute( $reserve_id );
1053 # now fix the priority on the others....
1054 _FixPriority({ biblionumber => $reserve->{biblionumber} });
1059 ModReserve({ rank => $rank,
1060 reserve_id => $reserve_id,
1061 branchcode => $branchcode
1062 [, itemnumber => $itemnumber ]
1063 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1066 Change a hold request's priority or cancel it.
1068 C<$rank> specifies the effect of the change. If C<$rank>
1069 is 'W' or 'n', nothing happens. This corresponds to leaving a
1070 request alone when changing its priority in the holds queue
1073 If C<$rank> is 'del', the hold request is cancelled.
1075 If C<$rank> is an integer greater than zero, the priority of
1076 the request is set to that value. Since priority != 0 means
1077 that the item is not waiting on the hold shelf, setting the
1078 priority to a non-zero value also sets the request's found
1079 status and waiting date to NULL.
1081 The optional C<$itemnumber> parameter is used only when
1082 C<$rank> is a non-zero integer; if supplied, the itemnumber
1083 of the hold request is set accordingly; if omitted, the itemnumber
1086 B<FIXME:> Note that the forgoing can have the effect of causing
1087 item-level hold requests to turn into title-level requests. This
1088 will be fixed once reserves has separate columns for requested
1089 itemnumber and supplying itemnumber.
1094 my ( $params ) = @_;
1096 my $rank = $params->{'rank'};
1097 my $reserve_id = $params->{'reserve_id'};
1098 my $branchcode = $params->{'branchcode'};
1099 my $itemnumber = $params->{'itemnumber'};
1100 my $suspend_until = $params->{'suspend_until'};
1101 my $borrowernumber = $params->{'borrowernumber'};
1102 my $biblionumber = $params->{'biblionumber'};
1104 return if $rank eq "W";
1105 return if $rank eq "n";
1107 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1108 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber }) unless ( $reserve_id );
1110 my $dbh = C4::Context->dbh;
1111 if ( $rank eq "del" ) {
1112 CancelReserve({ reserve_id => $reserve_id });
1114 elsif ($rank =~ /^\d+/ and $rank > 0) {
1116 UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL, waitingdate = NULL
1117 WHERE reserve_id = ?
1119 my $sth = $dbh->prepare($query);
1120 $sth->execute( $rank, $branchcode, $itemnumber, $reserve_id );
1122 if ( defined( $suspend_until ) ) {
1123 if ( $suspend_until ) {
1124 $suspend_until = C4::Dates->new( $suspend_until )->output("iso");
1125 $dbh->do("UPDATE reserves SET suspend = 1, suspend_until = ? WHERE reserve_id = ?", undef, ( $suspend_until, $reserve_id ) );
1127 $dbh->do("UPDATE reserves SET suspend_until = NULL WHERE reserve_id = ?", undef, ( $reserve_id ) );
1131 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
1135 =head2 ModReserveFill
1137 &ModReserveFill($reserve);
1139 Fill a reserve. If I understand this correctly, this means that the
1140 reserved book has been found and given to the patron who reserved it.
1142 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
1143 whose keys are fields from the reserves table in the Koha database.
1147 sub ModReserveFill {
1149 my $dbh = C4::Context->dbh;
1150 # fill in a reserve record....
1151 my $reserve_id = $res->{'reserve_id'};
1152 my $biblionumber = $res->{'biblionumber'};
1153 my $borrowernumber = $res->{'borrowernumber'};
1154 my $resdate = $res->{'reservedate'};
1156 # get the priority on this record....
1158 my $query = "SELECT priority
1160 WHERE biblionumber = ?
1161 AND borrowernumber = ?
1162 AND reservedate = ?";
1163 my $sth = $dbh->prepare($query);
1164 $sth->execute( $biblionumber, $borrowernumber, $resdate );
1165 ($priority) = $sth->fetchrow_array;
1167 # update the database...
1168 $query = "UPDATE reserves
1171 WHERE biblionumber = ?
1173 AND borrowernumber = ?
1175 $sth = $dbh->prepare($query);
1176 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1178 # move to old_reserves
1179 $query = "INSERT INTO old_reserves
1180 SELECT * FROM reserves
1181 WHERE biblionumber = ?
1183 AND borrowernumber = ?
1185 $sth = $dbh->prepare($query);
1186 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1187 $query = "DELETE FROM reserves
1188 WHERE biblionumber = ?
1190 AND borrowernumber = ?
1192 $sth = $dbh->prepare($query);
1193 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1195 # now fix the priority on the others (if the priority wasn't
1196 # already sorted!)....
1197 unless ( $priority == 0 ) {
1198 _FixPriority({ reserve_id => $reserve_id });
1202 =head2 ModReserveStatus
1204 &ModReserveStatus($itemnumber, $newstatus);
1206 Update the reserve status for the active (priority=0) reserve.
1208 $itemnumber is the itemnumber the reserve is on
1210 $newstatus is the new status.
1214 sub ModReserveStatus {
1216 #first : check if we have a reservation for this item .
1217 my ($itemnumber, $newstatus) = @_;
1218 my $dbh = C4::Context->dbh;
1220 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1221 my $sth_set = $dbh->prepare($query);
1222 $sth_set->execute( $newstatus, $itemnumber );
1224 if ( C4::Context->preference("ReturnToShelvingCart") && $newstatus ) {
1225 CartToShelf( $itemnumber );
1229 =head2 ModReserveAffect
1231 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend);
1233 This function affect an item and a status for a given reserve
1234 The itemnumber parameter is used to find the biblionumber.
1235 with the biblionumber & the borrowernumber, we can affect the itemnumber
1236 to the correct reserve.
1238 if $transferToDo is not set, then the status is set to "Waiting" as well.
1239 otherwise, a transfer is on the way, and the end of the transfer will
1240 take care of the waiting status
1244 sub ModReserveAffect {
1245 my ( $itemnumber, $borrowernumber,$transferToDo ) = @_;
1246 my $dbh = C4::Context->dbh;
1248 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1249 # attached to $itemnumber
1250 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1251 $sth->execute($itemnumber);
1252 my ($biblionumber) = $sth->fetchrow;
1254 # get request - need to find out if item is already
1255 # waiting in order to not send duplicate hold filled notifications
1256 my $reserve_id = GetReserveId({
1257 borrowernumber => $borrowernumber,
1258 biblionumber => $biblionumber,
1260 return unless defined $reserve_id;
1261 my $request = GetReserveInfo($reserve_id);
1262 my $already_on_shelf = ($request && $request->{found} eq 'W') ? 1 : 0;
1264 # If we affect a reserve that has to be transfered, don't set to Waiting
1266 if ($transferToDo) {
1272 WHERE borrowernumber = ?
1273 AND biblionumber = ?
1277 # affect the reserve to Waiting as well.
1282 waitingdate = NOW(),
1284 WHERE borrowernumber = ?
1285 AND biblionumber = ?
1288 $sth = $dbh->prepare($query);
1289 $sth->execute( $itemnumber, $borrowernumber,$biblionumber);
1290 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo && !$already_on_shelf );
1292 if ( C4::Context->preference("ReturnToShelvingCart") ) {
1293 CartToShelf( $itemnumber );
1299 =head2 ModReserveCancelAll
1301 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1303 function to cancel reserv,check other reserves, and transfer document if it's necessary
1307 sub ModReserveCancelAll {
1310 my ( $itemnumber, $borrowernumber ) = @_;
1312 #step 1 : cancel the reservation
1313 my $CancelReserve = CancelReserve({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1315 #step 2 launch the subroutine of the others reserves
1316 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1318 return ( $messages, $nextreservinfo );
1321 =head2 ModReserveMinusPriority
1323 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1325 Reduce the values of queued list
1329 sub ModReserveMinusPriority {
1330 my ( $itemnumber, $reserve_id ) = @_;
1332 #first step update the value of the first person on reserv
1333 my $dbh = C4::Context->dbh;
1336 SET priority = 0 , itemnumber = ?
1337 WHERE reserve_id = ?
1339 my $sth_upd = $dbh->prepare($query);
1340 $sth_upd->execute( $itemnumber, $reserve_id );
1341 # second step update all others reserves
1342 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1345 =head2 GetReserveInfo
1347 &GetReserveInfo($reserve_id);
1349 Get item and borrower details for a current hold.
1350 Current implementation this query should have a single result.
1354 sub GetReserveInfo {
1355 my ( $reserve_id ) = @_;
1356 my $dbh = C4::Context->dbh;
1361 reserves.borrowernumber,
1362 reserves.biblionumber,
1363 reserves.branchcode,
1364 reserves.waitingdate,
1380 items.holdingbranch,
1381 items.itemcallnumber,
1387 LEFT JOIN items USING(itemnumber)
1388 LEFT JOIN borrowers USING(borrowernumber)
1389 LEFT JOIN biblio ON (reserves.biblionumber=biblio.biblionumber)
1390 WHERE reserves.reserve_id = ?";
1391 my $sth = $dbh->prepare($strsth);
1392 $sth->execute($reserve_id);
1394 my $data = $sth->fetchrow_hashref;
1398 =head2 IsAvailableForItemLevelRequest
1400 my $is_available = IsAvailableForItemLevelRequest($itemnumber);
1402 Checks whether a given item record is available for an
1403 item-level hold request. An item is available if
1405 * it is not lost AND
1406 * it is not damaged AND
1407 * it is not withdrawn AND
1408 * does not have a not for loan value > 0
1410 Whether or not the item is currently on loan is
1411 also checked - if the AllowOnShelfHolds system preference
1412 is ON, an item can be requested even if it is currently
1413 on loan to somebody else. If the system preference
1414 is OFF, an item that is currently checked out cannot
1415 be the target of an item-level hold request.
1417 Note that IsAvailableForItemLevelRequest() does not
1418 check if the staff operator is authorized to place
1419 a request on the item - in particular,
1420 this routine does not check IndependentBranches
1421 and canreservefromotherbranches.
1425 sub IsAvailableForItemLevelRequest {
1426 my $itemnumber = shift;
1428 my $item = GetItem($itemnumber);
1430 # must check the notforloan setting of the itemtype
1431 # FIXME - a lot of places in the code do this
1432 # or something similar - need to be
1434 my $dbh = C4::Context->dbh;
1435 my $notforloan_query;
1436 if (C4::Context->preference('item-level_itypes')) {
1437 $notforloan_query = "SELECT itemtypes.notforloan
1439 JOIN itemtypes ON (itemtypes.itemtype = items.itype)
1440 WHERE itemnumber = ?";
1442 $notforloan_query = "SELECT itemtypes.notforloan
1444 JOIN biblioitems USING (biblioitemnumber)
1445 JOIN itemtypes USING (itemtype)
1446 WHERE itemnumber = ?";
1448 my $sth = $dbh->prepare($notforloan_query);
1449 $sth->execute($itemnumber);
1450 my $notforloan_per_itemtype = 0;
1451 if (my ($notforloan) = $sth->fetchrow_array) {
1452 $notforloan_per_itemtype = 1 if $notforloan;
1455 my $available_per_item = 1;
1456 $available_per_item = 0 if $item->{itemlost} or
1457 ( $item->{notforloan} > 0 ) or
1458 ($item->{damaged} and not C4::Context->preference('AllowHoldsOnDamagedItems')) or
1459 $item->{withdrawn} or
1460 $notforloan_per_itemtype;
1463 if (C4::Context->preference('AllowOnShelfHolds')) {
1464 return $available_per_item;
1466 return ($available_per_item and ($item->{onloan} or GetReserveStatus($itemnumber) eq "Waiting"));
1470 =head2 AlterPriority
1472 AlterPriority( $where, $reserve_id );
1474 This function changes a reserve's priority up, down, to the top, or to the bottom.
1475 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1480 my ( $where, $reserve_id ) = @_;
1482 my $dbh = C4::Context->dbh;
1484 my $reserve = GetReserve( $reserve_id );
1486 if ( $reserve->{cancellationdate} ) {
1487 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (".$reserve->{cancellationdate}.')';
1491 if ( $where eq 'up' || $where eq 'down' ) {
1493 my $priority = $reserve->{'priority'};
1494 $priority = $where eq 'up' ? $priority - 1 : $priority + 1;
1495 _FixPriority({ reserve_id => $reserve_id, rank => $priority })
1497 } elsif ( $where eq 'top' ) {
1499 _FixPriority({ reserve_id => $reserve_id, rank => '1' })
1501 } elsif ( $where eq 'bottom' ) {
1503 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1508 =head2 ToggleLowestPriority
1510 ToggleLowestPriority( $borrowernumber, $biblionumber );
1512 This function sets the lowestPriority field to true if is false, and false if it is true.
1516 sub ToggleLowestPriority {
1517 my ( $reserve_id ) = @_;
1519 my $dbh = C4::Context->dbh;
1521 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1522 $sth->execute( $reserve_id );
1524 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1527 =head2 ToggleSuspend
1529 ToggleSuspend( $reserve_id );
1531 This function sets the suspend field to true if is false, and false if it is true.
1532 If the reserve is currently suspended with a suspend_until date, that date will
1533 be cleared when it is unsuspended.
1538 my ( $reserve_id, $suspend_until ) = @_;
1540 $suspend_until = output_pref({ dt => dt_from_string( $suspend_until ), dateformat => 'iso' }) if ( $suspend_until );
1542 my $do_until = ( $suspend_until ) ? '?' : 'NULL';
1544 my $dbh = C4::Context->dbh;
1546 my $sth = $dbh->prepare(
1547 "UPDATE reserves SET suspend = NOT suspend,
1548 suspend_until = CASE WHEN suspend = 0 THEN NULL ELSE $do_until END
1549 WHERE reserve_id = ?
1553 push( @params, $suspend_until ) if ( $suspend_until );
1554 push( @params, $reserve_id );
1556 $sth->execute( @params );
1562 borrowernumber => $borrowernumber,
1563 [ biblionumber => $biblionumber, ]
1564 [ suspend_until => $suspend_until, ]
1565 [ suspend => $suspend ]
1568 This function accepts a set of hash keys as its parameters.
1569 It requires either borrowernumber or biblionumber, or both.
1571 suspend_until is wholly optional.
1578 my $borrowernumber = $params{'borrowernumber'} || undef;
1579 my $biblionumber = $params{'biblionumber'} || undef;
1580 my $suspend_until = $params{'suspend_until'} || undef;
1581 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1583 $suspend_until = C4::Dates->new( $suspend_until )->output("iso") if ( defined( $suspend_until ) );
1585 return unless ( $borrowernumber || $biblionumber );
1587 my ( $query, $sth, $dbh, @query_params );
1589 $query = "UPDATE reserves SET suspend = ? ";
1590 push( @query_params, $suspend );
1592 $query .= ", suspend_until = NULL ";
1593 } elsif ( $suspend_until ) {
1594 $query .= ", suspend_until = ? ";
1595 push( @query_params, $suspend_until );
1597 $query .= " WHERE ";
1598 if ( $borrowernumber ) {
1599 $query .= " borrowernumber = ? ";
1600 push( @query_params, $borrowernumber );
1602 $query .= " AND " if ( $borrowernumber && $biblionumber );
1603 if ( $biblionumber ) {
1604 $query .= " biblionumber = ? ";
1605 push( @query_params, $biblionumber );
1607 $query .= " AND found IS NULL ";
1609 $dbh = C4::Context->dbh;
1610 $sth = $dbh->prepare( $query );
1611 $sth->execute( @query_params );
1618 reserve_id => $reserve_id,
1620 [ignoreSetLowestRank => $ignoreSetLowestRank]
1625 _FixPriority({ biblionumber => $biblionumber});
1627 This routine adjusts the priority of a hold request and holds
1630 In the first form, where a reserve_id is passed, the priority of the
1631 hold is set to supplied rank, and other holds for that bib are adjusted
1632 accordingly. If the rank is "del", the hold is cancelled. If no rank
1633 is supplied, all of the holds on that bib have their priority adjusted
1634 as if the second form had been used.
1636 In the second form, where a biblionumber is passed, the holds on that
1637 bib (that are not captured) are sorted in order of increasing priority,
1638 then have reserves.priority set so that the first non-captured hold
1639 has its priority set to 1, the second non-captured hold has its priority
1640 set to 2, and so forth.
1642 In both cases, holds that have the lowestPriority flag on are have their
1643 priority adjusted to ensure that they remain at the end of the line.
1645 Note that the ignoreSetLowestRank parameter is meant to be used only
1646 when _FixPriority calls itself.
1651 my ( $params ) = @_;
1652 my $reserve_id = $params->{reserve_id};
1653 my $rank = $params->{rank} // '';
1654 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1655 my $biblionumber = $params->{biblionumber};
1657 my $dbh = C4::Context->dbh;
1659 unless ( $biblionumber ) {
1660 my $res = GetReserve( $reserve_id );
1661 $biblionumber = $res->{biblionumber};
1664 if ( $rank eq "del" ) {
1665 CancelReserve({ reserve_id => $reserve_id });
1667 elsif ( $rank eq "W" || $rank eq "0" ) {
1669 # make sure priority for waiting or in-transit items is 0
1673 WHERE reserve_id = ?
1674 AND found IN ('W', 'T')
1676 my $sth = $dbh->prepare($query);
1677 $sth->execute( $reserve_id );
1683 SELECT reserve_id, borrowernumber, reservedate, constrainttype
1685 WHERE biblionumber = ?
1686 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1687 ORDER BY priority ASC
1689 my $sth = $dbh->prepare($query);
1690 $sth->execute( $biblionumber );
1691 while ( my $line = $sth->fetchrow_hashref ) {
1692 push( @priority, $line );
1695 # To find the matching index
1697 my $key = -1; # to allow for 0 to be a valid result
1698 for ( $i = 0 ; $i < @priority ; $i++ ) {
1699 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1700 $key = $i; # save the index
1705 # if index exists in array then move it to new position
1706 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1707 my $new_rank = $rank -
1708 1; # $new_rank is what you want the new index to be in the array
1709 my $moving_item = splice( @priority, $key, 1 );
1710 splice( @priority, $new_rank, 0, $moving_item );
1713 # now fix the priority on those that are left....
1717 WHERE reserve_id = ?
1719 $sth = $dbh->prepare($query);
1720 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1723 $priority[$j]->{'reserve_id'}
1727 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1730 unless ( $ignoreSetLowestRank ) {
1731 while ( my $res = $sth->fetchrow_hashref() ) {
1733 reserve_id => $res->{'reserve_id'},
1735 ignoreSetLowestRank => 1
1741 =head2 _Findgroupreserve
1743 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead);
1745 Looks for an item-specific match first, then for a title-level match, returning the
1746 first match found. If neither, then we look for a 3rd kind of match based on
1747 reserve constraints.
1748 Lookahead is the number of days to look in advance.
1750 TODO: add more explanation about reserve constraints
1752 C<&_Findgroupreserve> returns :
1753 C<@results> is an array of references-to-hash whose keys are mostly
1754 fields from the reserves table of the Koha database, plus
1755 C<biblioitemnumber>.
1759 sub _Findgroupreserve {
1760 my ( $bibitem, $biblio, $itemnumber, $lookahead) = @_;
1761 my $dbh = C4::Context->dbh;
1763 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1764 # check for exact targetted match
1765 my $item_level_target_query = qq/
1766 SELECT reserves.biblionumber AS biblionumber,
1767 reserves.borrowernumber AS borrowernumber,
1768 reserves.reservedate AS reservedate,
1769 reserves.branchcode AS branchcode,
1770 reserves.cancellationdate AS cancellationdate,
1771 reserves.found AS found,
1772 reserves.reservenotes AS reservenotes,
1773 reserves.priority AS priority,
1774 reserves.timestamp AS timestamp,
1775 biblioitems.biblioitemnumber AS biblioitemnumber,
1776 reserves.itemnumber AS itemnumber,
1777 reserves.reserve_id AS reserve_id
1779 JOIN biblioitems USING (biblionumber)
1780 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1783 AND item_level_request = 1
1785 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1788 my $sth = $dbh->prepare($item_level_target_query);
1789 $sth->execute($itemnumber, $lookahead||0);
1791 if ( my $data = $sth->fetchrow_hashref ) {
1792 push( @results, $data );
1794 return @results if @results;
1796 # check for title-level targetted match
1797 my $title_level_target_query = qq/
1798 SELECT reserves.biblionumber AS biblionumber,
1799 reserves.borrowernumber AS borrowernumber,
1800 reserves.reservedate AS reservedate,
1801 reserves.branchcode AS branchcode,
1802 reserves.cancellationdate AS cancellationdate,
1803 reserves.found AS found,
1804 reserves.reservenotes AS reservenotes,
1805 reserves.priority AS priority,
1806 reserves.timestamp AS timestamp,
1807 biblioitems.biblioitemnumber AS biblioitemnumber,
1808 reserves.itemnumber AS itemnumber
1810 JOIN biblioitems USING (biblionumber)
1811 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1814 AND item_level_request = 0
1815 AND hold_fill_targets.itemnumber = ?
1816 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1819 $sth = $dbh->prepare($title_level_target_query);
1820 $sth->execute($itemnumber, $lookahead||0);
1822 if ( my $data = $sth->fetchrow_hashref ) {
1823 push( @results, $data );
1825 return @results if @results;
1828 SELECT reserves.biblionumber AS biblionumber,
1829 reserves.borrowernumber AS borrowernumber,
1830 reserves.reservedate AS reservedate,
1831 reserves.waitingdate AS waitingdate,
1832 reserves.branchcode AS branchcode,
1833 reserves.cancellationdate AS cancellationdate,
1834 reserves.found AS found,
1835 reserves.reservenotes AS reservenotes,
1836 reserves.priority AS priority,
1837 reserves.timestamp AS timestamp,
1838 reserveconstraints.biblioitemnumber AS biblioitemnumber,
1839 reserves.itemnumber AS itemnumber
1841 LEFT JOIN reserveconstraints ON reserves.biblionumber = reserveconstraints.biblionumber
1842 WHERE reserves.biblionumber = ?
1843 AND ( ( reserveconstraints.biblioitemnumber = ?
1844 AND reserves.borrowernumber = reserveconstraints.borrowernumber
1845 AND reserves.reservedate = reserveconstraints.reservedate )
1846 OR reserves.constrainttype='a' )
1847 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1848 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1851 $sth = $dbh->prepare($query);
1852 $sth->execute( $biblio, $bibitem, $itemnumber, $lookahead||0);
1854 while ( my $data = $sth->fetchrow_hashref ) {
1855 push( @results, $data );
1860 =head2 _koha_notify_reserve
1862 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber );
1864 Sends a notification to the patron that their hold has been filled (through
1865 ModReserveAffect, _not_ ModReserveFill)
1869 sub _koha_notify_reserve {
1870 my ($itemnumber, $borrowernumber, $biblionumber) = @_;
1872 my $dbh = C4::Context->dbh;
1873 my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
1875 # Try to get the borrower's email address
1876 my $to_address = C4::Members::GetNoticeEmailAddress($borrowernumber);
1881 if ( $to_address || $borrower->{'smsalertnumber'} ) {
1882 $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber, message_name => 'Hold_Filled' } );
1887 my $sth = $dbh->prepare("
1890 WHERE borrowernumber = ?
1891 AND biblionumber = ?
1893 $sth->execute( $borrowernumber, $biblionumber );
1894 my $reserve = $sth->fetchrow_hashref;
1895 my $branch_details = GetBranchDetail( $reserve->{'branchcode'} );
1897 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
1899 my %letter_params = (
1900 module => 'reserves',
1901 branchcode => $reserve->{branchcode},
1903 'branches' => $branch_details,
1904 'borrowers' => $borrower,
1905 'biblio' => $biblionumber,
1906 'reserves' => $reserve,
1907 'items', $reserve->{'itemnumber'},
1909 substitute => { today => C4::Dates->new()->output() },
1913 if ( $print_mode ) {
1914 $letter_params{ 'letter_code' } = 'HOLD_PRINT';
1915 my $letter = C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1917 C4::Letters::EnqueueLetter( {
1919 borrowernumber => $borrowernumber,
1920 message_transport_type => 'print',
1926 if ( $to_address && defined $messagingprefs->{transports}->{'email'} ) {
1927 $letter_params{ 'letter_code' } = $messagingprefs->{transports}->{'email'};
1928 my $letter = C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1930 C4::Letters::EnqueueLetter(
1931 { letter => $letter,
1932 borrowernumber => $borrowernumber,
1933 message_transport_type => 'email',
1934 from_address => $admin_email_address,
1939 if ( $borrower->{'smsalertnumber'} && defined $messagingprefs->{transports}->{'sms'} ) {
1940 $letter_params{ 'letter_code' } = $messagingprefs->{transports}->{'sms'};
1941 my $letter = C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1943 C4::Letters::EnqueueLetter(
1944 { letter => $letter,
1945 borrowernumber => $borrowernumber,
1946 message_transport_type => 'sms',
1952 =head2 _ShiftPriorityByDateAndPriority
1954 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
1956 This increments the priority of all reserves after the one
1957 with either the lowest date after C<$reservedate>
1958 or the lowest priority after C<$priority>.
1960 It effectively makes room for a new reserve to be inserted with a certain
1961 priority, which is returned.
1963 This is most useful when the reservedate can be set by the user. It allows
1964 the new reserve to be placed before other reserves that have a later
1965 reservedate. Since priority also is set by the form in reserves/request.pl
1966 the sub accounts for that too.
1970 sub _ShiftPriorityByDateAndPriority {
1971 my ( $biblio, $resdate, $new_priority ) = @_;
1973 my $dbh = C4::Context->dbh;
1974 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
1975 my $sth = $dbh->prepare( $query );
1976 $sth->execute( $biblio, $resdate, $new_priority );
1977 my $min_priority = $sth->fetchrow;
1978 # if no such matches are found, $new_priority remains as original value
1979 $new_priority = $min_priority if ( $min_priority );
1981 # Shift the priority up by one; works in conjunction with the next SQL statement
1982 $query = "UPDATE reserves
1983 SET priority = priority+1
1984 WHERE biblionumber = ?
1985 AND borrowernumber = ?
1988 my $sth_update = $dbh->prepare( $query );
1990 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1991 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1992 $sth = $dbh->prepare( $query );
1993 $sth->execute( $new_priority, $biblio );
1994 while ( my $row = $sth->fetchrow_hashref ) {
1995 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1998 return $new_priority; # so the caller knows what priority they wind up receiving
2003 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
2005 Use when checking out an item to handle reserves
2006 If $cancelreserve boolean is set to true, it will remove existing reserve
2011 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
2013 my ( $restype, $res, $all_reserves ) = CheckReserves( $itemnumber );
2016 my $biblionumber = $res->{biblionumber};
2017 my $biblioitemnumber = $res->{biblioitemnumber};
2019 if ($res->{borrowernumber} == $borrowernumber) {
2020 ModReserveFill($res);
2024 # The item is reserved by someone else.
2025 # Find this item in the reserves
2028 foreach (@$all_reserves) {
2029 $_->{'borrowernumber'} == $borrowernumber or next;
2030 $_->{'biblionumber'} == $biblionumber or next;
2037 # The item is reserved by the current patron
2038 ModReserveFill($borr_res);
2041 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2042 RevertWaitingStatus({ itemnumber => $itemnumber });
2044 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2046 biblionumber => $res->{'biblionumber'},
2047 itemnumber => $res->{'itemnumber'},
2048 borrowernumber => $res->{'borrowernumber'}
2056 MergeHolds($dbh,$to_biblio, $from_biblio);
2058 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2063 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2064 my $sth = $dbh->prepare(
2065 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2067 $sth->execute($from_biblio);
2068 if ( my $data = $sth->fetchrow_hashref() ) {
2070 # holds exist on old record, if not we don't need to do anything
2071 $sth = $dbh->prepare(
2072 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2073 $sth->execute( $to_biblio, $from_biblio );
2076 # don't reorder those already waiting
2078 $sth = $dbh->prepare(
2079 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
2081 my $upd_sth = $dbh->prepare(
2082 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2083 AND reservedate = ? AND constrainttype = ? AND (itemnumber = ? or itemnumber is NULL) "
2085 $sth->execute( $to_biblio, 'W', 'T' );
2087 while ( my $reserve = $sth->fetchrow_hashref() ) {
2089 $priority, $to_biblio,
2090 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2091 $reserve->{'constrainttype'}, $reserve->{'itemnumber'}
2098 =head2 RevertWaitingStatus
2100 $success = RevertWaitingStatus({ itemnumber => $itemnumber });
2102 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2104 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2105 item level hold, even if it was only a bibliolevel hold to
2106 begin with. This is because we can no longer know if a hold
2107 was item-level or bib-level after a hold has been set to
2112 sub RevertWaitingStatus {
2113 my ( $params ) = @_;
2114 my $itemnumber = $params->{'itemnumber'};
2116 return unless ( $itemnumber );
2118 my $dbh = C4::Context->dbh;
2120 ## Get the waiting reserve we want to revert
2122 SELECT * FROM reserves
2123 WHERE itemnumber = ?
2124 AND found IS NOT NULL
2126 my $sth = $dbh->prepare( $query );
2127 $sth->execute( $itemnumber );
2128 my $reserve = $sth->fetchrow_hashref();
2130 ## Increment the priority of all other non-waiting
2131 ## reserves for this bib record
2135 priority = priority + 1
2141 $sth = $dbh->prepare( $query );
2142 $sth->execute( $reserve->{'biblionumber'} );
2144 ## Fix up the currently waiting reserve
2154 $sth = $dbh->prepare( $query );
2155 return $sth->execute( $reserve->{'reserve_id'} );
2160 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber [, itemnumber => $itemnumber ] });
2162 Returnes the first reserve id that matches the given criteria
2167 my ( $params ) = @_;
2169 return unless ( ( $params->{'biblionumber'} || $params->{'itemnumber'} ) && $params->{'borrowernumber'} );
2171 my $dbh = C4::Context->dbh();
2173 my $sql = "SELECT reserve_id FROM reserves WHERE ";
2177 foreach my $key ( keys %$params ) {
2178 if ( defined( $params->{$key} ) ) {
2179 push( @limits, "$key = ?" );
2180 push( @params, $params->{$key} );
2184 $sql .= join( " AND ", @limits );
2186 my $sth = $dbh->prepare( $sql );
2187 $sth->execute( @params );
2188 my $row = $sth->fetchrow_hashref();
2190 return $row->{'reserve_id'};
2195 ReserveSlip($branchcode, $borrowernumber, $biblionumber)
2197 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2202 my ($branch, $borrowernumber, $biblionumber) = @_;
2204 # return unless ( C4::Context->boolean_preference('printreserveslips') );
2206 my $reserve_id = GetReserveId({
2207 biblionumber => $biblionumber,
2208 borrowernumber => $borrowernumber
2210 my $reserve = GetReserveInfo($reserve_id) or return;
2212 return C4::Letters::GetPreparedLetter (
2213 module => 'circulation',
2214 letter_code => 'RESERVESLIP',
2215 branchcode => $branch,
2217 'reserves' => $reserve,
2218 'branches' => $reserve->{branchcode},
2219 'borrowers' => $reserve->{borrowernumber},
2220 'biblio' => $reserve->{biblionumber},
2221 'items' => $reserve->{itemnumber},
2226 =head2 GetReservesControlBranch
2228 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2230 Return the branchcode to be used to determine which reserves
2231 policy applies to a transaction.
2233 C<$item> is a hashref for an item. Only 'homebranch' is used.
2235 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2239 sub GetReservesControlBranch {
2240 my ( $item, $borrower ) = @_;
2242 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2245 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2246 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2254 Koha Development Team <http://koha-community.org/>