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 );
258 my ($reserve_id) = @_;
260 my $dbh = C4::Context->dbh;
261 my $query = "SELECT * FROM reserves WHERE reserve_id = ?";
262 my $sth = $dbh->prepare( $query );
263 $sth->execute( $reserve_id );
264 my $res = $sth->fetchrow_hashref();
268 =head2 GetReservesFromBiblionumber
270 ($count, $title_reserves) = GetReservesFromBiblionumber($biblionumber);
272 This function gets the list of reservations for one C<$biblionumber>, returning a count
273 of the reserves and an arrayref pointing to the reserves for C<$biblionumber>.
277 sub GetReservesFromBiblionumber {
278 my ($biblionumber) = shift or return (0, []);
279 my ($all_dates) = shift;
280 my $dbh = C4::Context->dbh;
282 # Find the desired items in the reserves
286 timestamp AS rtimestamp,
300 WHERE biblionumber = ? ";
301 unless ( $all_dates ) {
302 $query .= "AND reservedate <= CURRENT_DATE()";
304 $query .= "ORDER BY priority";
305 my $sth = $dbh->prepare($query);
306 $sth->execute($biblionumber);
309 while ( my $data = $sth->fetchrow_hashref ) {
311 # FIXME - What is this doing? How do constraints work?
312 if ($data->{constrainttype} eq 'o') {
314 SELECT biblioitemnumber
315 FROM reserveconstraints
316 WHERE biblionumber = ?
317 AND borrowernumber = ?
320 my $csth = $dbh->prepare($query);
321 $csth->execute($data->{biblionumber}, $data->{borrowernumber}, $data->{reservedate});
323 while ( my $bibitemnos = $csth->fetchrow_array ) {
324 push( @bibitemno, $bibitemnos ); # FIXME: inefficient: use fetchall_arrayref
326 my $count = scalar @bibitemno;
328 # if we have two or more different specific itemtypes
329 # reserved by same person on same day
332 $bdata = GetBiblioItemData( $bibitemno[$i] ); # FIXME: This doesn't make sense.
333 $i++; # $i can increase each pass, but the next @bibitemno might be smaller?
336 # Look up the book we just found.
337 $bdata = GetBiblioItemData( $bibitemno[0] );
339 # Add the results of this latest search to the current
341 # FIXME - An 'each' would probably be more efficient.
342 foreach my $key ( keys %$bdata ) {
343 $data->{$key} = $bdata->{$key};
346 push @results, $data;
348 return ( $#results + 1, \@results );
351 =head2 GetReservesFromItemnumber
353 ( $reservedate, $borrowernumber, $branchcode, $reserve_id ) = GetReservesFromItemnumber($itemnumber);
355 TODO :: Description here
359 sub GetReservesFromItemnumber {
360 my ( $itemnumber, $all_dates ) = @_;
361 my $dbh = C4::Context->dbh;
363 SELECT reservedate,borrowernumber,branchcode,reserve_id
367 unless ( $all_dates ) {
368 $query .= " AND reservedate <= CURRENT_DATE()";
370 my $sth_res = $dbh->prepare($query);
371 $sth_res->execute($itemnumber);
372 my ( $reservedate, $borrowernumber, $branchcode, $reserve_id ) = $sth_res->fetchrow_array;
373 return ( $reservedate, $borrowernumber, $branchcode, $reserve_id );
376 =head2 GetReservesFromBorrowernumber
378 $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
384 sub GetReservesFromBorrowernumber {
385 my ( $borrowernumber, $status ) = @_;
386 my $dbh = C4::Context->dbh;
389 $sth = $dbh->prepare("
392 WHERE borrowernumber=?
396 $sth->execute($borrowernumber,$status);
398 $sth = $dbh->prepare("
401 WHERE borrowernumber=?
404 $sth->execute($borrowernumber);
406 my $data = $sth->fetchall_arrayref({});
409 #-------------------------------------------------------------------------------------
410 =head2 CanBookBeReserved
412 $error = &CanBookBeReserved($borrowernumber, $biblionumber)
416 sub CanBookBeReserved{
417 my ($borrowernumber, $biblionumber) = @_;
419 my $items = GetItemnumbersForBiblio($biblionumber);
420 #get items linked via host records
421 my @hostitems = get_hostitemnumbers_of($biblionumber);
423 push (@$items,@hostitems);
426 foreach my $item (@$items){
427 return 1 if CanItemBeReserved($borrowernumber, $item);
432 =head2 CanItemBeReserved
434 $error = &CanItemBeReserved($borrowernumber, $itemnumber)
436 This function return 1 if an item can be issued by this borrower.
440 sub CanItemBeReserved{
441 my ($borrowernumber, $itemnumber) = @_;
443 my $dbh = C4::Context->dbh;
444 my $allowedreserves = 0;
446 my $controlbranch = C4::Context->preference('ReservesControlBranch');
447 my $itype = C4::Context->preference('item-level_itypes') ? "itype" : "itemtype";
449 # we retrieve borrowers and items informations #
450 my $item = GetItem($itemnumber);
451 my $borrower = C4::Members::GetMember('borrowernumber'=>$borrowernumber);
453 # we retrieve user rights on this itemtype and branchcode
454 my $sth = $dbh->prepare("SELECT categorycode, itemtype, branchcode, reservesallowed
456 WHERE (categorycode in (?,'*') )
457 AND (itemtype IN (?,'*'))
458 AND (branchcode IN (?,'*'))
465 my $querycount ="SELECT
468 LEFT JOIN items USING (itemnumber)
469 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
470 LEFT JOIN borrowers USING (borrowernumber)
471 WHERE borrowernumber = ?
475 my $itemtype = $item->{$itype};
476 my $categorycode = $borrower->{categorycode};
478 my $branchfield = "reserves.branchcode";
480 if( $controlbranch eq "ItemHomeLibrary" ){
481 $branchfield = "items.homebranch";
482 $branchcode = $item->{homebranch};
483 }elsif( $controlbranch eq "PatronLibrary" ){
484 $branchfield = "borrowers.branchcode";
485 $branchcode = $borrower->{branchcode};
489 $sth->execute($categorycode, $itemtype, $branchcode);
490 if(my $rights = $sth->fetchrow_hashref()){
491 $itemtype = $rights->{itemtype};
492 $allowedreserves = $rights->{reservesallowed};
499 $querycount .= "AND $branchfield = ?";
501 $querycount .= " AND $itype = ?" if ($itemtype ne "*");
502 my $sthcount = $dbh->prepare($querycount);
504 if($itemtype eq "*"){
505 $sthcount->execute($borrowernumber, $branchcode);
507 $sthcount->execute($borrowernumber, $branchcode, $itemtype);
510 my $reservecount = "0";
511 if(my $rowcount = $sthcount->fetchrow_hashref()){
512 $reservecount = $rowcount->{count};
515 # we check if it's ok or not
516 if( $reservecount >= $allowedreserves ){
520 # If reservecount is ok, we check item branch if IndependentBranches is ON
521 # and canreservefromotherbranches is OFF
522 if ( C4::Context->preference('IndependentBranches')
523 and !C4::Context->preference('canreservefromotherbranches') )
525 my $itembranch = $item->{homebranch};
526 if ($itembranch ne $borrower->{branchcode}) {
533 #--------------------------------------------------------------------------------
534 =head2 GetReserveCount
536 $number = &GetReserveCount($borrowernumber);
538 this function returns the number of reservation for a borrower given on input arg.
542 sub GetReserveCount {
543 my ($borrowernumber) = @_;
545 my $dbh = C4::Context->dbh;
548 SELECT COUNT(*) AS counter
550 WHERE borrowernumber = ?
552 my $sth = $dbh->prepare($query);
553 $sth->execute($borrowernumber);
554 my $row = $sth->fetchrow_hashref;
555 return $row->{counter};
558 =head2 GetOtherReserves
560 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
562 Check queued list of this document and check if this document must be transfered
566 sub GetOtherReserves {
567 my ($itemnumber) = @_;
570 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
571 if ($checkreserves) {
572 my $iteminfo = GetItem($itemnumber);
573 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
574 $messages->{'transfert'} = $checkreserves->{'branchcode'};
575 #minus priorities of others reservs
576 ModReserveMinusPriority(
578 $checkreserves->{'reserve_id'},
581 #launch the subroutine dotransfer
582 C4::Items::ModItemTransfer(
584 $iteminfo->{'holdingbranch'},
585 $checkreserves->{'branchcode'}
590 #step 2b : case of a reservation on the same branch, set the waiting status
592 $messages->{'waiting'} = 1;
593 ModReserveMinusPriority(
595 $checkreserves->{'reserve_id'},
597 ModReserveStatus($itemnumber,'W');
600 $nextreservinfo = $checkreserves->{'borrowernumber'};
603 return ( $messages, $nextreservinfo );
608 $fee = GetReserveFee($borrowernumber,$biblionumber,$constraint,$biblionumber);
610 Calculate the fee for a reserve
615 my ($borrowernumber, $biblionumber, $constraint, $bibitems ) = @_;
618 my $dbh = C4::Context->dbh;
619 my $const = lc substr( $constraint, 0, 1 );
621 SELECT * FROM borrowers
622 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
623 WHERE borrowernumber = ?
625 my $sth = $dbh->prepare($query);
626 $sth->execute($borrowernumber);
627 my $data = $sth->fetchrow_hashref;
629 my $fee = $data->{'reservefee'};
630 my $cntitems = @- > $bibitems;
634 # check for items on issue
635 # first find biblioitem records
637 my $sth1 = $dbh->prepare(
638 "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber
639 WHERE (biblio.biblionumber = ?)"
641 $sth1->execute($biblionumber);
642 while ( my $data1 = $sth1->fetchrow_hashref ) {
643 if ( $const eq "a" ) {
644 push @biblioitems, $data1;
649 while ( $x < $cntitems ) {
650 if ( @$bibitems->{'biblioitemnumber'} ==
651 $data->{'biblioitemnumber'} )
657 if ( $const eq 'o' ) {
659 push @biblioitems, $data1;
664 push @biblioitems, $data1;
670 my $cntitemsfound = @biblioitems;
674 while ( $x < $cntitemsfound ) {
675 my $bitdata = $biblioitems[$x];
676 my $sth2 = $dbh->prepare(
678 WHERE biblioitemnumber = ?"
680 $sth2->execute( $bitdata->{'biblioitemnumber'} );
681 while ( my $itdata = $sth2->fetchrow_hashref ) {
682 my $sth3 = $dbh->prepare(
683 "SELECT * FROM issues
684 WHERE itemnumber = ?"
686 $sth3->execute( $itdata->{'itemnumber'} );
687 if ( my $isdata = $sth3->fetchrow_hashref ) {
695 if ( $allissued == 0 ) {
697 $dbh->prepare("SELECT * FROM reserves WHERE biblionumber = ?");
698 $rsth->execute($biblionumber);
699 if ( my $rdata = $rsth->fetchrow_hashref ) {
709 =head2 GetReservesToBranch
711 @transreserv = GetReservesToBranch( $frombranch );
713 Get reserve list for a given branch
717 sub GetReservesToBranch {
718 my ( $frombranch ) = @_;
719 my $dbh = C4::Context->dbh;
720 my $sth = $dbh->prepare(
721 "SELECT reserve_id,borrowernumber,reservedate,itemnumber,timestamp
726 $sth->execute( $frombranch );
729 while ( my $data = $sth->fetchrow_hashref ) {
730 $transreserv[$i] = $data;
733 return (@transreserv);
736 =head2 GetReservesForBranch
738 @transreserv = GetReservesForBranch($frombranch);
742 sub GetReservesForBranch {
743 my ($frombranch) = @_;
744 my $dbh = C4::Context->dbh;
747 SELECT reserve_id,borrowernumber,reservedate,itemnumber,waitingdate
752 $query .= " AND branchcode=? " if ( $frombranch );
753 $query .= "ORDER BY waitingdate" ;
755 my $sth = $dbh->prepare($query);
757 $sth->execute($frombranch);
764 while ( my $data = $sth->fetchrow_hashref ) {
765 $transreserv[$i] = $data;
768 return (@transreserv);
771 =head2 GetReserveStatus
773 $reservestatus = GetReserveStatus($itemnumber, $biblionumber);
775 Take an itemnumber or a biblionumber and return the status of the reserve places on it.
776 If several reserves exist, the reserve with the lower priority is given.
780 ## FIXME: I don't think this does what it thinks it does.
781 ## It only ever checks the first reserve result, even though
782 ## multiple reserves for that bib can have the itemnumber set
783 ## the sub is only used once in the codebase.
784 sub GetReserveStatus {
785 my ($itemnumber, $biblionumber) = @_;
787 my $dbh = C4::Context->dbh;
789 my ($sth, $found, $priority);
791 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
792 $sth->execute($itemnumber);
793 ($found, $priority) = $sth->fetchrow_array;
796 if ( $biblionumber and not defined $found and not defined $priority ) {
797 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE biblionumber = ? order by priority LIMIT 1");
798 $sth->execute($biblionumber);
799 ($found, $priority) = $sth->fetchrow_array;
803 return 'Waiting' if $found eq 'W' and $priority == 0;
804 return 'Finished' if $found eq 'F';
805 return 'Reserved' if $priority > 0;
808 #empty string here will remove need for checking undef, or less log lines
813 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber);
814 ($status, $reserve, $all_reserves) = &CheckReserves(undef, $barcode);
815 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
817 Find a book in the reserves.
819 C<$itemnumber> is the book's item number.
820 C<$lookahead> is the number of days to look in advance for future reserves.
822 As I understand it, C<&CheckReserves> looks for the given item in the
823 reserves. If it is found, that's a match, and C<$status> is set to
826 Otherwise, it finds the most important item in the reserves with the
827 same biblio number as this book (I'm not clear on this) and returns it
828 with C<$status> set to C<Reserved>.
830 C<&CheckReserves> returns a two-element list:
832 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
834 C<$reserve> is the reserve item that matched. It is a
835 reference-to-hash whose keys are mostly the fields of the reserves
836 table in the Koha database.
841 my ( $item, $barcode, $lookahead_days) = @_;
842 my $dbh = C4::Context->dbh;
845 if (C4::Context->preference('item-level_itypes')){
847 SELECT items.biblionumber,
848 items.biblioitemnumber,
849 itemtypes.notforloan,
850 items.notforloan AS itemnotforloan,
853 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
854 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
859 SELECT items.biblionumber,
860 items.biblioitemnumber,
861 itemtypes.notforloan,
862 items.notforloan AS itemnotforloan,
865 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
866 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
871 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
872 $sth->execute($item);
875 $sth = $dbh->prepare("$select WHERE barcode = ?");
876 $sth->execute($barcode);
878 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
879 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber ) = $sth->fetchrow_array;
881 return ( '' ) unless $itemnumber; # bail if we got nothing.
883 # if item is not for loan it cannot be reserved either.....
884 # execpt where items.notforloan < 0 : This indicates the item is holdable.
885 return ( '' ) if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
887 # Find this item in the reserves
888 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days);
890 # $priority and $highest are used to find the most important item
891 # in the list returned by &_Findgroupreserve. (The lower $priority,
892 # the more important the item.)
893 # $highest is the most important item we've seen so far.
895 if (scalar @reserves) {
896 my $priority = 10000000;
897 foreach my $res (@reserves) {
898 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
899 return ( "Waiting", $res, \@reserves ); # Found it
901 # See if this item is more important than what we've got so far
902 if ( $res->{'priority'} && $res->{'priority'} < $priority ) {
903 my $borrowerinfo=C4::Members::GetMember(borrowernumber => $res->{'borrowernumber'});
904 my $iteminfo=C4::Items::GetItem($itemnumber);
905 my $branch = GetReservesControlBranch( $iteminfo, $borrowerinfo );
906 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$iteminfo->{'itype'});
907 next if ($branchitemrule->{'holdallowed'} == 0);
908 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $borrowerinfo->{'branchcode'}));
909 $priority = $res->{'priority'};
916 # If we get this far, then no exact match was found.
917 # We return the most important (i.e. next) reservation.
919 $highest->{'itemnumber'} = $item;
920 return ( "Reserved", $highest, \@reserves );
926 =head2 CancelExpiredReserves
928 CancelExpiredReserves();
930 Cancels all reserves with an expiration date from before today.
934 sub CancelExpiredReserves {
936 # Cancel reserves that have passed their expiration date.
937 my $dbh = C4::Context->dbh;
938 my $sth = $dbh->prepare( "
939 SELECT * FROM reserves WHERE DATE(expirationdate) < DATE( CURDATE() )
940 AND expirationdate IS NOT NULL
945 while ( my $res = $sth->fetchrow_hashref() ) {
946 CancelReserve({ reserve_id => $res->{'reserve_id'} });
949 # Cancel reserves that have been waiting too long
950 if ( C4::Context->preference("ExpireReservesMaxPickUpDelay") ) {
951 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
952 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
954 my $query = "SELECT * FROM reserves WHERE TO_DAYS( NOW() ) - TO_DAYS( waitingdate ) > ? AND found = 'W' AND priority = 0";
955 $sth = $dbh->prepare( $query );
956 $sth->execute( $max_pickup_delay );
958 while (my $res = $sth->fetchrow_hashref ) {
960 manualinvoice($res->{'borrowernumber'}, $res->{'itemnumber'}, 'Hold waiting too long', 'F', $charge);
963 CancelReserve({ reserve_id => $res->{'reserve_id'} });
969 =head2 AutoUnsuspendReserves
971 AutoUnsuspendReserves();
973 Unsuspends all suspended reserves with a suspend_until date from before today.
977 sub AutoUnsuspendReserves {
979 my $dbh = C4::Context->dbh;
981 my $query = "UPDATE reserves SET suspend = 0, suspend_until = NULL WHERE DATE( suspend_until ) < DATE( CURDATE() )";
982 my $sth = $dbh->prepare( $query );
989 CancelReserve({ reserve_id => $reserve_id, [ biblionumber => $biblionumber, borrowernumber => $borrrowernumber, itemnumber => $itemnumber ] });
998 my $reserve_id = $params->{'reserve_id'};
999 $reserve_id = GetReserveId( $params ) unless ( $reserve_id );
1001 return unless ( $reserve_id );
1003 my $dbh = C4::Context->dbh;
1007 SET cancellationdate = now(),
1010 WHERE reserve_id = ?
1012 my $sth = $dbh->prepare($query);
1013 $sth->execute( $reserve_id );
1017 INSERT INTO old_reserves
1018 SELECT * FROM reserves
1019 WHERE reserve_id = ?
1021 $sth = $dbh->prepare($query);
1022 $sth->execute( $reserve_id );
1025 DELETE FROM reserves
1026 WHERE reserve_id = ?
1028 $sth = $dbh->prepare($query);
1029 $sth->execute( $reserve_id );
1031 # now fix the priority on the others....
1032 _FixPriority( $reserve_id );
1037 ModReserve({ rank => $rank,
1038 reserve_id => $reserve_id,
1039 branchcode => $branchcode
1040 [, itemnumber => $itemnumber ]
1041 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1044 Change a hold request's priority or cancel it.
1046 C<$rank> specifies the effect of the change. If C<$rank>
1047 is 'W' or 'n', nothing happens. This corresponds to leaving a
1048 request alone when changing its priority in the holds queue
1051 If C<$rank> is 'del', the hold request is cancelled.
1053 If C<$rank> is an integer greater than zero, the priority of
1054 the request is set to that value. Since priority != 0 means
1055 that the item is not waiting on the hold shelf, setting the
1056 priority to a non-zero value also sets the request's found
1057 status and waiting date to NULL.
1059 The optional C<$itemnumber> parameter is used only when
1060 C<$rank> is a non-zero integer; if supplied, the itemnumber
1061 of the hold request is set accordingly; if omitted, the itemnumber
1064 B<FIXME:> Note that the forgoing can have the effect of causing
1065 item-level hold requests to turn into title-level requests. This
1066 will be fixed once reserves has separate columns for requested
1067 itemnumber and supplying itemnumber.
1072 my ( $params ) = @_;
1074 my $rank = $params->{'rank'};
1075 my $reserve_id = $params->{'reserve_id'};
1076 my $branchcode = $params->{'branchcode'};
1077 my $itemnumber = $params->{'itemnumber'};
1078 my $suspend_until = $params->{'suspend_until'};
1079 my $borrowernumber = $params->{'borrowernumber'};
1080 my $biblionumber = $params->{'biblionumber'};
1082 return if $rank eq "W";
1083 return if $rank eq "n";
1085 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1086 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber }) unless ( $reserve_id );
1088 my $dbh = C4::Context->dbh;
1089 if ( $rank eq "del" ) {
1092 SET cancellationdate=now()
1093 WHERE reserve_id = ?
1095 my $sth = $dbh->prepare($query);
1096 $sth->execute( $reserve_id );
1099 INSERT INTO old_reserves
1102 WHERE reserve_id = ?
1104 $sth = $dbh->prepare($query);
1105 $sth->execute( $reserve_id );
1107 DELETE FROM reserves
1108 WHERE reserve_id = ?
1110 $sth = $dbh->prepare($query);
1111 $sth->execute( $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 );
1123 if ( defined( $suspend_until ) ) {
1124 if ( $suspend_until ) {
1125 $suspend_until = C4::Dates->new( $suspend_until )->output("iso");
1126 $dbh->do("UPDATE reserves SET suspend = 1, suspend_until = ? WHERE reserve_id = ?", undef, ( $suspend_until, $reserve_id ) );
1128 $dbh->do("UPDATE reserves SET suspend_until = NULL WHERE reserve_id = ?", undef, ( $reserve_id ) );
1132 _FixPriority( $reserve_id, $rank );
1136 =head2 ModReserveFill
1138 &ModReserveFill($reserve);
1140 Fill a reserve. If I understand this correctly, this means that the
1141 reserved book has been found and given to the patron who reserved it.
1143 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
1144 whose keys are fields from the reserves table in the Koha database.
1148 sub ModReserveFill {
1150 my $dbh = C4::Context->dbh;
1151 # fill in a reserve record....
1152 my $reserve_id = $res->{'reserve_id'};
1153 my $biblionumber = $res->{'biblionumber'};
1154 my $borrowernumber = $res->{'borrowernumber'};
1155 my $resdate = $res->{'reservedate'};
1157 # get the priority on this record....
1159 my $query = "SELECT priority
1161 WHERE biblionumber = ?
1162 AND borrowernumber = ?
1163 AND reservedate = ?";
1164 my $sth = $dbh->prepare($query);
1165 $sth->execute( $biblionumber, $borrowernumber, $resdate );
1166 ($priority) = $sth->fetchrow_array;
1169 # update the database...
1170 $query = "UPDATE reserves
1173 WHERE biblionumber = ?
1175 AND borrowernumber = ?
1177 $sth = $dbh->prepare($query);
1178 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1181 # move to old_reserves
1182 $query = "INSERT INTO old_reserves
1183 SELECT * FROM reserves
1184 WHERE biblionumber = ?
1186 AND borrowernumber = ?
1188 $sth = $dbh->prepare($query);
1189 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1190 $query = "DELETE FROM reserves
1191 WHERE biblionumber = ?
1193 AND borrowernumber = ?
1195 $sth = $dbh->prepare($query);
1196 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1198 # now fix the priority on the others (if the priority wasn't
1199 # already sorted!)....
1200 unless ( $priority == 0 ) {
1201 _FixPriority( $reserve_id );
1205 =head2 ModReserveStatus
1207 &ModReserveStatus($itemnumber, $newstatus);
1209 Update the reserve status for the active (priority=0) reserve.
1211 $itemnumber is the itemnumber the reserve is on
1213 $newstatus is the new status.
1217 sub ModReserveStatus {
1219 #first : check if we have a reservation for this item .
1220 my ($itemnumber, $newstatus) = @_;
1221 my $dbh = C4::Context->dbh;
1223 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1224 my $sth_set = $dbh->prepare($query);
1225 $sth_set->execute( $newstatus, $itemnumber );
1227 if ( C4::Context->preference("ReturnToShelvingCart") && $newstatus ) {
1228 CartToShelf( $itemnumber );
1232 =head2 ModReserveAffect
1234 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend);
1236 This function affect an item and a status for a given reserve
1237 The itemnumber parameter is used to find the biblionumber.
1238 with the biblionumber & the borrowernumber, we can affect the itemnumber
1239 to the correct reserve.
1241 if $transferToDo is not set, then the status is set to "Waiting" as well.
1242 otherwise, a transfer is on the way, and the end of the transfer will
1243 take care of the waiting status
1247 sub ModReserveAffect {
1248 my ( $itemnumber, $borrowernumber,$transferToDo ) = @_;
1249 my $dbh = C4::Context->dbh;
1251 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1252 # attached to $itemnumber
1253 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1254 $sth->execute($itemnumber);
1255 my ($biblionumber) = $sth->fetchrow;
1257 # get request - need to find out if item is already
1258 # waiting in order to not send duplicate hold filled notifications
1259 my $request = GetReserveInfo($borrowernumber, $biblionumber);
1260 my $already_on_shelf = ($request && $request->{found} eq 'W') ? 1 : 0;
1262 # If we affect a reserve that has to be transfered, don't set to Waiting
1264 if ($transferToDo) {
1270 WHERE borrowernumber = ?
1271 AND biblionumber = ?
1275 # affect the reserve to Waiting as well.
1280 waitingdate = NOW(),
1282 WHERE borrowernumber = ?
1283 AND biblionumber = ?
1286 $sth = $dbh->prepare($query);
1287 $sth->execute( $itemnumber, $borrowernumber,$biblionumber);
1288 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo && !$already_on_shelf );
1290 if ( C4::Context->preference("ReturnToShelvingCart") ) {
1291 CartToShelf( $itemnumber );
1297 =head2 ModReserveCancelAll
1299 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1301 function to cancel reserv,check other reserves, and transfer document if it's necessary
1305 sub ModReserveCancelAll {
1308 my ( $itemnumber, $borrowernumber ) = @_;
1310 #step 1 : cancel the reservation
1311 my $CancelReserve = CancelReserve({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1313 #step 2 launch the subroutine of the others reserves
1314 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1316 return ( $messages, $nextreservinfo );
1319 =head2 ModReserveMinusPriority
1321 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1323 Reduce the values of queued list
1327 sub ModReserveMinusPriority {
1328 my ( $itemnumber, $reserve_id ) = @_;
1330 #first step update the value of the first person on reserv
1331 my $dbh = C4::Context->dbh;
1334 SET priority = 0 , itemnumber = ?
1335 WHERE reserve_id = ?
1337 my $sth_upd = $dbh->prepare($query);
1338 $sth_upd->execute( $itemnumber, $reserve_id );
1339 # second step update all others reservs
1340 _FixPriority( $reserve_id, '0');
1343 =head2 GetReserveInfo
1345 &GetReserveInfo($reserve_id);
1347 Get item and borrower details for a current hold.
1348 Current implementation this query should have a single result.
1352 sub GetReserveInfo {
1353 my ( $reserve_id ) = @_;
1354 my $dbh = C4::Context->dbh;
1359 reserves.borrowernumber,
1360 reserves.biblionumber,
1361 reserves.branchcode,
1362 reserves.waitingdate,
1378 items.holdingbranch,
1379 items.itemcallnumber,
1385 LEFT JOIN items USING(itemnumber)
1386 LEFT JOIN borrowers USING(borrowernumber)
1387 LEFT JOIN biblio ON (reserves.biblionumber=biblio.biblionumber)
1388 WHERE reserves.reserve_id = ?";
1389 my $sth = $dbh->prepare($strsth);
1390 $sth->execute($reserve_id);
1392 my $data = $sth->fetchrow_hashref;
1396 =head2 IsAvailableForItemLevelRequest
1398 my $is_available = IsAvailableForItemLevelRequest($itemnumber);
1400 Checks whether a given item record is available for an
1401 item-level hold request. An item is available if
1403 * it is not lost AND
1404 * it is not damaged AND
1405 * it is not withdrawn AND
1406 * does not have a not for loan value > 0
1408 Whether or not the item is currently on loan is
1409 also checked - if the AllowOnShelfHolds system preference
1410 is ON, an item can be requested even if it is currently
1411 on loan to somebody else. If the system preference
1412 is OFF, an item that is currently checked out cannot
1413 be the target of an item-level hold request.
1415 Note that IsAvailableForItemLevelRequest() does not
1416 check if the staff operator is authorized to place
1417 a request on the item - in particular,
1418 this routine does not check IndependentBranches
1419 and canreservefromotherbranches.
1423 sub IsAvailableForItemLevelRequest {
1424 my $itemnumber = shift;
1426 my $item = GetItem($itemnumber);
1428 # must check the notforloan setting of the itemtype
1429 # FIXME - a lot of places in the code do this
1430 # or something similar - need to be
1432 my $dbh = C4::Context->dbh;
1433 my $notforloan_query;
1434 if (C4::Context->preference('item-level_itypes')) {
1435 $notforloan_query = "SELECT itemtypes.notforloan
1437 JOIN itemtypes ON (itemtypes.itemtype = items.itype)
1438 WHERE itemnumber = ?";
1440 $notforloan_query = "SELECT itemtypes.notforloan
1442 JOIN biblioitems USING (biblioitemnumber)
1443 JOIN itemtypes USING (itemtype)
1444 WHERE itemnumber = ?";
1446 my $sth = $dbh->prepare($notforloan_query);
1447 $sth->execute($itemnumber);
1448 my $notforloan_per_itemtype = 0;
1449 if (my ($notforloan) = $sth->fetchrow_array) {
1450 $notforloan_per_itemtype = 1 if $notforloan;
1453 my $available_per_item = 1;
1454 $available_per_item = 0 if $item->{itemlost} or
1455 ( $item->{notforloan} > 0 ) or
1456 ($item->{damaged} and not C4::Context->preference('AllowHoldsOnDamagedItems')) or
1457 $item->{withdrawn} or
1458 $notforloan_per_itemtype;
1461 if (C4::Context->preference('AllowOnShelfHolds')) {
1462 return $available_per_item;
1464 return ($available_per_item and ($item->{onloan} or GetReserveStatus($itemnumber) eq "Waiting"));
1468 =head2 AlterPriority
1470 AlterPriority( $where, $reserve_id );
1472 This function changes a reserve's priority up, down, to the top, or to the bottom.
1473 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1478 my ( $where, $reserve_id ) = @_;
1480 my $dbh = C4::Context->dbh;
1482 my $reserve = GetReserve( $reserve_id );
1484 if ( $reserve->{cancellationdate} ) {
1485 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (".$reserve->{cancellationdate}.')';
1489 if ( $where eq 'up' || $where eq 'down' ) {
1491 my $priority = $reserve->{'priority'};
1492 $priority = $where eq 'up' ? $priority - 1 : $priority + 1;
1493 _FixPriority( $reserve_id, $priority )
1495 } elsif ( $where eq 'top' ) {
1497 _FixPriority( $reserve_id, '1' )
1499 } elsif ( $where eq 'bottom' ) {
1501 _FixPriority( $reserve_id, '999999' )
1506 =head2 ToggleLowestPriority
1508 ToggleLowestPriority( $borrowernumber, $biblionumber );
1510 This function sets the lowestPriority field to true if is false, and false if it is true.
1514 sub ToggleLowestPriority {
1515 my ( $reserve_id ) = @_;
1517 my $dbh = C4::Context->dbh;
1519 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1520 $sth->execute( $reserve_id );
1523 _FixPriority( $reserve_id, '999999' );
1526 =head2 ToggleSuspend
1528 ToggleSuspend( $reserve_id );
1530 This function sets the suspend field to true if is false, and false if it is true.
1531 If the reserve is currently suspended with a suspend_until date, that date will
1532 be cleared when it is unsuspended.
1537 my ( $reserve_id, $suspend_until ) = @_;
1539 $suspend_until = output_pref( dt_from_string( $suspend_until ), 'iso' ) if ( $suspend_until );
1541 my $do_until = ( $suspend_until ) ? '?' : 'NULL';
1543 my $dbh = C4::Context->dbh;
1545 my $sth = $dbh->prepare(
1546 "UPDATE reserves SET suspend = NOT suspend,
1547 suspend_until = CASE WHEN suspend = 0 THEN NULL ELSE $do_until END
1548 WHERE reserve_id = ?
1552 push( @params, $suspend_until ) if ( $suspend_until );
1553 push( @params, $reserve_id );
1555 $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 &_FixPriority( $reserve_id, $rank, $ignoreSetLowestRank);
1620 Only used internally (so don't export it)
1621 Changed how this functions works #
1622 Now just gets an array of reserves in the rank order and updates them with
1623 the array index (+1 as array starts from 0)
1624 and if $rank is supplied will splice item from the array and splice it back in again
1625 in new priority rank
1630 my ( $reserve_id, $rank, $ignoreSetLowestRank ) = @_;
1631 my $dbh = C4::Context->dbh;
1633 my $res = GetReserve( $reserve_id );
1635 if ( $rank eq "del" ) {
1636 CancelReserve({ reserve_id => $reserve_id });
1638 elsif ( $rank eq "W" || $rank eq "0" ) {
1640 # make sure priority for waiting or in-transit items is 0
1644 WHERE reserve_id = ?
1645 AND found IN ('W', 'T')
1647 my $sth = $dbh->prepare($query);
1648 $sth->execute( $reserve_id );
1654 SELECT reserve_id, borrowernumber, reservedate, constrainttype
1656 WHERE biblionumber = ?
1657 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1658 ORDER BY priority ASC
1660 my $sth = $dbh->prepare($query);
1661 $sth->execute( $res->{'biblionumber'} );
1662 while ( my $line = $sth->fetchrow_hashref ) {
1663 push( @priority, $line );
1666 # To find the matching index
1668 my $key = -1; # to allow for 0 to be a valid result
1669 for ( $i = 0 ; $i < @priority ; $i++ ) {
1670 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1671 $key = $i; # save the index
1676 # if index exists in array then move it to new position
1677 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1678 my $new_rank = $rank -
1679 1; # $new_rank is what you want the new index to be in the array
1680 my $moving_item = splice( @priority, $key, 1 );
1681 splice( @priority, $new_rank, 0, $moving_item );
1684 # now fix the priority on those that are left....
1688 WHERE reserve_id = ?
1690 $sth = $dbh->prepare($query);
1691 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1694 $priority[$j]->{'reserve_id'}
1699 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1702 unless ( $ignoreSetLowestRank ) {
1703 while ( my $res = $sth->fetchrow_hashref() ) {
1704 _FixPriority( $res->{'reserve_id'}, '999999', 1 );
1709 =head2 _Findgroupreserve
1711 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead);
1713 Looks for an item-specific match first, then for a title-level match, returning the
1714 first match found. If neither, then we look for a 3rd kind of match based on
1715 reserve constraints.
1716 Lookahead is the number of days to look in advance.
1718 TODO: add more explanation about reserve constraints
1720 C<&_Findgroupreserve> returns :
1721 C<@results> is an array of references-to-hash whose keys are mostly
1722 fields from the reserves table of the Koha database, plus
1723 C<biblioitemnumber>.
1727 sub _Findgroupreserve {
1728 my ( $bibitem, $biblio, $itemnumber, $lookahead) = @_;
1729 my $dbh = C4::Context->dbh;
1731 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1732 # check for exact targetted match
1733 my $item_level_target_query = qq/
1734 SELECT reserves.biblionumber AS biblionumber,
1735 reserves.borrowernumber AS borrowernumber,
1736 reserves.reservedate AS reservedate,
1737 reserves.branchcode AS branchcode,
1738 reserves.cancellationdate AS cancellationdate,
1739 reserves.found AS found,
1740 reserves.reservenotes AS reservenotes,
1741 reserves.priority AS priority,
1742 reserves.timestamp AS timestamp,
1743 biblioitems.biblioitemnumber AS biblioitemnumber,
1744 reserves.itemnumber AS itemnumber,
1745 reserves.reserve_id AS reserve_id
1747 JOIN biblioitems USING (biblionumber)
1748 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1751 AND item_level_request = 1
1753 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1756 my $sth = $dbh->prepare($item_level_target_query);
1757 $sth->execute($itemnumber, $lookahead||0);
1759 if ( my $data = $sth->fetchrow_hashref ) {
1760 push( @results, $data );
1762 return @results if @results;
1764 # check for title-level targetted match
1765 my $title_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
1778 JOIN biblioitems USING (biblionumber)
1779 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1782 AND item_level_request = 0
1783 AND hold_fill_targets.itemnumber = ?
1784 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1787 $sth = $dbh->prepare($title_level_target_query);
1788 $sth->execute($itemnumber, $lookahead||0);
1790 if ( my $data = $sth->fetchrow_hashref ) {
1791 push( @results, $data );
1793 return @results if @results;
1796 SELECT reserves.biblionumber AS biblionumber,
1797 reserves.borrowernumber AS borrowernumber,
1798 reserves.reservedate AS reservedate,
1799 reserves.waitingdate AS waitingdate,
1800 reserves.branchcode AS branchcode,
1801 reserves.cancellationdate AS cancellationdate,
1802 reserves.found AS found,
1803 reserves.reservenotes AS reservenotes,
1804 reserves.priority AS priority,
1805 reserves.timestamp AS timestamp,
1806 reserveconstraints.biblioitemnumber AS biblioitemnumber,
1807 reserves.itemnumber AS itemnumber
1809 LEFT JOIN reserveconstraints ON reserves.biblionumber = reserveconstraints.biblionumber
1810 WHERE reserves.biblionumber = ?
1811 AND ( ( reserveconstraints.biblioitemnumber = ?
1812 AND reserves.borrowernumber = reserveconstraints.borrowernumber
1813 AND reserves.reservedate = reserveconstraints.reservedate )
1814 OR reserves.constrainttype='a' )
1815 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1816 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1819 $sth = $dbh->prepare($query);
1820 $sth->execute( $biblio, $bibitem, $itemnumber, $lookahead||0);
1822 while ( my $data = $sth->fetchrow_hashref ) {
1823 push( @results, $data );
1828 =head2 _koha_notify_reserve
1830 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber );
1832 Sends a notification to the patron that their hold has been filled (through
1833 ModReserveAffect, _not_ ModReserveFill)
1837 sub _koha_notify_reserve {
1838 my ($itemnumber, $borrowernumber, $biblionumber) = @_;
1840 my $dbh = C4::Context->dbh;
1841 my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
1843 # Try to get the borrower's email address
1844 my $to_address = C4::Members::GetNoticeEmailAddress($borrowernumber);
1849 if ( $to_address || $borrower->{'smsalertnumber'} ) {
1850 $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber, message_name => 'Hold_Filled' } );
1855 my $sth = $dbh->prepare("
1858 WHERE borrowernumber = ?
1859 AND biblionumber = ?
1861 $sth->execute( $borrowernumber, $biblionumber );
1862 my $reserve = $sth->fetchrow_hashref;
1863 my $branch_details = GetBranchDetail( $reserve->{'branchcode'} );
1865 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
1867 my %letter_params = (
1868 module => 'reserves',
1869 branchcode => $reserve->{branchcode},
1871 'branches' => $branch_details,
1872 'borrowers' => $borrower,
1873 'biblio' => $biblionumber,
1874 'reserves' => $reserve,
1875 'items', $reserve->{'itemnumber'},
1877 substitute => { today => C4::Dates->new()->output() },
1881 if ( $print_mode ) {
1882 $letter_params{ 'letter_code' } = 'HOLD_PRINT';
1883 my $letter = C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1885 C4::Letters::EnqueueLetter( {
1887 borrowernumber => $borrowernumber,
1888 message_transport_type => 'print',
1894 if ( $to_address && defined $messagingprefs->{transports}->{'email'} ) {
1895 $letter_params{ 'letter_code' } = $messagingprefs->{transports}->{'email'};
1896 my $letter = C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1898 C4::Letters::EnqueueLetter(
1899 { letter => $letter,
1900 borrowernumber => $borrowernumber,
1901 message_transport_type => 'email',
1902 from_address => $admin_email_address,
1907 if ( $borrower->{'smsalertnumber'} && defined $messagingprefs->{transports}->{'sms'} ) {
1908 $letter_params{ 'letter_code' } = $messagingprefs->{transports}->{'sms'};
1909 my $letter = C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1911 C4::Letters::EnqueueLetter(
1912 { letter => $letter,
1913 borrowernumber => $borrowernumber,
1914 message_transport_type => 'sms',
1920 =head2 _ShiftPriorityByDateAndPriority
1922 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
1924 This increments the priority of all reserves after the one
1925 with either the lowest date after C<$reservedate>
1926 or the lowest priority after C<$priority>.
1928 It effectively makes room for a new reserve to be inserted with a certain
1929 priority, which is returned.
1931 This is most useful when the reservedate can be set by the user. It allows
1932 the new reserve to be placed before other reserves that have a later
1933 reservedate. Since priority also is set by the form in reserves/request.pl
1934 the sub accounts for that too.
1938 sub _ShiftPriorityByDateAndPriority {
1939 my ( $biblio, $resdate, $new_priority ) = @_;
1941 my $dbh = C4::Context->dbh;
1942 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
1943 my $sth = $dbh->prepare( $query );
1944 $sth->execute( $biblio, $resdate, $new_priority );
1945 my $min_priority = $sth->fetchrow;
1946 # if no such matches are found, $new_priority remains as original value
1947 $new_priority = $min_priority if ( $min_priority );
1949 # Shift the priority up by one; works in conjunction with the next SQL statement
1950 $query = "UPDATE reserves
1951 SET priority = priority+1
1952 WHERE biblionumber = ?
1953 AND borrowernumber = ?
1956 my $sth_update = $dbh->prepare( $query );
1958 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1959 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1960 $sth = $dbh->prepare( $query );
1961 $sth->execute( $new_priority, $biblio );
1962 while ( my $row = $sth->fetchrow_hashref ) {
1963 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1966 return $new_priority; # so the caller knows what priority they wind up receiving
1971 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
1973 Use when checking out an item to handle reserves
1974 If $cancelreserve boolean is set to true, it will remove existing reserve
1979 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
1981 my ( $restype, $res, $all_reserves ) = CheckReserves( $itemnumber );
1984 my $biblionumber = $res->{biblionumber};
1985 my $biblioitemnumber = $res->{biblioitemnumber};
1987 if ($res->{borrowernumber} == $borrowernumber) {
1988 ModReserveFill($res);
1992 # The item is reserved by someone else.
1993 # Find this item in the reserves
1996 foreach (@$all_reserves) {
1997 $_->{'borrowernumber'} == $borrowernumber or next;
1998 $_->{'biblionumber'} == $biblionumber or next;
2005 # The item is reserved by the current patron
2006 ModReserveFill($borr_res);
2009 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2010 RevertWaitingStatus({ itemnumber => $itemnumber });
2012 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2014 biblionumber => $res->{'biblionumber'},
2015 itemnumber => $res->{'itemnumber'},
2016 borrowernumber => $res->{'borrowernumber'}
2024 MergeHolds($dbh,$to_biblio, $from_biblio);
2026 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2031 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2032 my $sth = $dbh->prepare(
2033 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2035 $sth->execute($from_biblio);
2036 if ( my $data = $sth->fetchrow_hashref() ) {
2038 # holds exist on old record, if not we don't need to do anything
2039 $sth = $dbh->prepare(
2040 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2041 $sth->execute( $to_biblio, $from_biblio );
2044 # don't reorder those already waiting
2046 $sth = $dbh->prepare(
2047 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
2049 my $upd_sth = $dbh->prepare(
2050 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2051 AND reservedate = ? AND constrainttype = ? AND (itemnumber = ? or itemnumber is NULL) "
2053 $sth->execute( $to_biblio, 'W', 'T' );
2055 while ( my $reserve = $sth->fetchrow_hashref() ) {
2057 $priority, $to_biblio,
2058 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2059 $reserve->{'constrainttype'}, $reserve->{'itemnumber'}
2066 =head2 RevertWaitingStatus
2068 $success = RevertWaitingStatus({ itemnumber => $itemnumber });
2070 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2072 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2073 item level hold, even if it was only a bibliolevel hold to
2074 begin with. This is because we can no longer know if a hold
2075 was item-level or bib-level after a hold has been set to
2080 sub RevertWaitingStatus {
2081 my ( $params ) = @_;
2082 my $itemnumber = $params->{'itemnumber'};
2084 return unless ( $itemnumber );
2086 my $dbh = C4::Context->dbh;
2088 ## Get the waiting reserve we want to revert
2090 SELECT * FROM reserves
2091 WHERE itemnumber = ?
2092 AND found IS NOT NULL
2094 my $sth = $dbh->prepare( $query );
2095 $sth->execute( $itemnumber );
2096 my $reserve = $sth->fetchrow_hashref();
2098 ## Increment the priority of all other non-waiting
2099 ## reserves for this bib record
2103 priority = priority + 1
2109 $sth = $dbh->prepare( $query );
2110 $sth->execute( $reserve->{'biblionumber'} );
2112 ## Fix up the currently waiting reserve
2122 $sth = $dbh->prepare( $query );
2123 return $sth->execute( $reserve->{'reserve_id'} );
2128 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber [, itemnumber => $itemnumber ] });
2130 Returnes the first reserve id that matches the given criteria
2135 my ( $params ) = @_;
2137 return unless ( ( $params->{'biblionumber'} || $params->{'itemnumber'} ) && $params->{'borrowernumber'} );
2139 my $dbh = C4::Context->dbh();
2141 my $sql = "SELECT reserve_id FROM reserves WHERE ";
2145 foreach my $key ( keys %$params ) {
2146 if ( defined( $params->{$key} ) ) {
2147 push( @limits, "$key = ?" );
2148 push( @params, $params->{$key} );
2152 $sql .= join( " AND ", @limits );
2154 my $sth = $dbh->prepare( $sql );
2155 $sth->execute( @params );
2156 my $row = $sth->fetchrow_hashref();
2158 return $row->{'reserve_id'};
2163 ReserveSlip($branchcode, $borrowernumber, $biblionumber)
2165 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2170 my ($branch, $borrowernumber, $biblionumber) = @_;
2172 # return unless ( C4::Context->boolean_preference('printreserveslips') );
2174 my $reserve_id = GetReserveId({
2175 biblionumber => $biblionumber,
2176 borrowernumber => $borrowernumber
2178 my $reserve = GetReserveInfo($reserve_id) or return;
2180 return C4::Letters::GetPreparedLetter (
2181 module => 'circulation',
2182 letter_code => 'RESERVESLIP',
2183 branchcode => $branch,
2185 'reserves' => $reserve,
2186 'branches' => $reserve->{branchcode},
2187 'borrowers' => $reserve->{borrowernumber},
2188 'biblio' => $reserve->{biblionumber},
2189 'items' => $reserve->{itemnumber},
2194 =head2 GetReservesControlBranch
2196 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2198 Return the branchcode to be used to determine which reserves
2199 policy applies to a transaction.
2201 C<$item> is a hashref for an item. Only 'homebranch' is used.
2203 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2207 sub GetReservesControlBranch {
2208 my ( $item, $borrower ) = @_;
2210 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2213 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2214 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2222 Koha Development Team <http://koha-community.org/>