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 or the old 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 ($count, $title_reserves) = GetReservesFromBiblionumber($biblionumber);
273 This function gets the list of reservations for one C<$biblionumber>, returning a count
274 of the reserves and an arrayref pointing to the reserves for C<$biblionumber>.
278 sub GetReservesFromBiblionumber {
279 my ($biblionumber) = shift or return (0, []);
280 my ($all_dates) = shift;
281 my ($itemnumber) = shift;
282 my $dbh = C4::Context->dbh;
284 # Find the desired items in the reserves
289 timestamp AS rtimestamp,
303 WHERE biblionumber = ? ";
304 push( @params, $biblionumber );
305 unless ( $all_dates ) {
306 $query .= " AND reservedate <= CAST(NOW() AS DATE) ";
309 $query .= " AND ( itemnumber IS NULL OR itemnumber = ? )";
310 push( @params, $itemnumber );
312 $query .= "ORDER BY priority";
313 my $sth = $dbh->prepare($query);
314 $sth->execute( @params );
317 while ( my $data = $sth->fetchrow_hashref ) {
319 # FIXME - What is this doing? How do constraints work?
320 if ($data->{constrainttype} eq 'o') {
322 SELECT biblioitemnumber
323 FROM reserveconstraints
324 WHERE biblionumber = ?
325 AND borrowernumber = ?
328 my $csth = $dbh->prepare($query);
329 $csth->execute($data->{biblionumber}, $data->{borrowernumber}, $data->{reservedate});
331 while ( my $bibitemnos = $csth->fetchrow_array ) {
332 push( @bibitemno, $bibitemnos ); # FIXME: inefficient: use fetchall_arrayref
334 my $count = scalar @bibitemno;
336 # if we have two or more different specific itemtypes
337 # reserved by same person on same day
340 $bdata = GetBiblioItemData( $bibitemno[$i] ); # FIXME: This doesn't make sense.
341 $i++; # $i can increase each pass, but the next @bibitemno might be smaller?
344 # Look up the book we just found.
345 $bdata = GetBiblioItemData( $bibitemno[0] );
347 # Add the results of this latest search to the current
349 # FIXME - An 'each' would probably be more efficient.
350 foreach my $key ( keys %$bdata ) {
351 $data->{$key} = $bdata->{$key};
354 push @results, $data;
356 return ( $#results + 1, \@results );
359 =head2 GetReservesFromItemnumber
361 ( $reservedate, $borrowernumber, $branchcode, $reserve_id ) = GetReservesFromItemnumber($itemnumber);
363 TODO :: Description here
367 sub GetReservesFromItemnumber {
368 my ( $itemnumber, $all_dates ) = @_;
369 my $dbh = C4::Context->dbh;
371 SELECT reservedate,borrowernumber,branchcode,reserve_id
375 unless ( $all_dates ) {
376 $query .= " AND reservedate <= CURRENT_DATE()";
378 my $sth_res = $dbh->prepare($query);
379 $sth_res->execute($itemnumber);
380 my ( $reservedate, $borrowernumber, $branchcode, $reserve_id ) = $sth_res->fetchrow_array;
381 return ( $reservedate, $borrowernumber, $branchcode, $reserve_id );
384 =head2 GetReservesFromBorrowernumber
386 $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
392 sub GetReservesFromBorrowernumber {
393 my ( $borrowernumber, $status ) = @_;
394 my $dbh = C4::Context->dbh;
397 $sth = $dbh->prepare("
400 WHERE borrowernumber=?
404 $sth->execute($borrowernumber,$status);
406 $sth = $dbh->prepare("
409 WHERE borrowernumber=?
412 $sth->execute($borrowernumber);
414 my $data = $sth->fetchall_arrayref({});
417 #-------------------------------------------------------------------------------------
418 =head2 CanBookBeReserved
420 $error = &CanBookBeReserved($borrowernumber, $biblionumber)
424 sub CanBookBeReserved{
425 my ($borrowernumber, $biblionumber) = @_;
427 my $items = GetItemnumbersForBiblio($biblionumber);
428 #get items linked via host records
429 my @hostitems = get_hostitemnumbers_of($biblionumber);
431 push (@$items,@hostitems);
434 foreach my $item (@$items){
435 return 1 if CanItemBeReserved($borrowernumber, $item);
440 =head2 CanItemBeReserved
442 $error = &CanItemBeReserved($borrowernumber, $itemnumber)
444 This function return 1 if an item can be issued by this borrower.
448 sub CanItemBeReserved{
449 my ($borrowernumber, $itemnumber) = @_;
451 my $dbh = C4::Context->dbh;
452 my $allowedreserves = 0;
454 my $controlbranch = C4::Context->preference('ReservesControlBranch');
455 my $itype = C4::Context->preference('item-level_itypes') ? "itype" : "itemtype";
457 # we retrieve borrowers and items informations #
458 my $item = GetItem($itemnumber);
459 my $borrower = C4::Members::GetMember('borrowernumber'=>$borrowernumber);
461 # we retrieve user rights on this itemtype and branchcode
462 my $sth = $dbh->prepare("SELECT categorycode, itemtype, branchcode, reservesallowed
464 WHERE (categorycode in (?,'*') )
465 AND (itemtype IN (?,'*'))
466 AND (branchcode IN (?,'*'))
473 my $querycount ="SELECT
476 LEFT JOIN items USING (itemnumber)
477 LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
478 LEFT JOIN borrowers USING (borrowernumber)
479 WHERE borrowernumber = ?
483 my $itemtype = $item->{$itype};
484 my $categorycode = $borrower->{categorycode};
486 my $branchfield = "reserves.branchcode";
488 if( $controlbranch eq "ItemHomeLibrary" ){
489 $branchfield = "items.homebranch";
490 $branchcode = $item->{homebranch};
491 }elsif( $controlbranch eq "PatronLibrary" ){
492 $branchfield = "borrowers.branchcode";
493 $branchcode = $borrower->{branchcode};
497 $sth->execute($categorycode, $itemtype, $branchcode);
498 if(my $rights = $sth->fetchrow_hashref()){
499 $itemtype = $rights->{itemtype};
500 $allowedreserves = $rights->{reservesallowed};
507 $querycount .= "AND $branchfield = ?";
509 $querycount .= " AND $itype = ?" if ($itemtype ne "*");
510 my $sthcount = $dbh->prepare($querycount);
512 if($itemtype eq "*"){
513 $sthcount->execute($borrowernumber, $branchcode);
515 $sthcount->execute($borrowernumber, $branchcode, $itemtype);
518 my $reservecount = "0";
519 if(my $rowcount = $sthcount->fetchrow_hashref()){
520 $reservecount = $rowcount->{count};
523 # we check if it's ok or not
524 if( $reservecount >= $allowedreserves ){
528 # If reservecount is ok, we check item branch if IndependentBranches is ON
529 # and canreservefromotherbranches is OFF
530 if ( C4::Context->preference('IndependentBranches')
531 and !C4::Context->preference('canreservefromotherbranches') )
533 my $itembranch = $item->{homebranch};
534 if ($itembranch ne $borrower->{branchcode}) {
541 #--------------------------------------------------------------------------------
542 =head2 GetReserveCount
544 $number = &GetReserveCount($borrowernumber);
546 this function returns the number of reservation for a borrower given on input arg.
550 sub GetReserveCount {
551 my ($borrowernumber) = @_;
553 my $dbh = C4::Context->dbh;
556 SELECT COUNT(*) AS counter
558 WHERE borrowernumber = ?
560 my $sth = $dbh->prepare($query);
561 $sth->execute($borrowernumber);
562 my $row = $sth->fetchrow_hashref;
563 return $row->{counter};
566 =head2 GetOtherReserves
568 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
570 Check queued list of this document and check if this document must be transfered
574 sub GetOtherReserves {
575 my ($itemnumber) = @_;
578 my ( undef, $checkreserves, undef ) = CheckReserves($itemnumber);
579 if ($checkreserves) {
580 my $iteminfo = GetItem($itemnumber);
581 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
582 $messages->{'transfert'} = $checkreserves->{'branchcode'};
583 #minus priorities of others reservs
584 ModReserveMinusPriority(
586 $checkreserves->{'reserve_id'},
589 #launch the subroutine dotransfer
590 C4::Items::ModItemTransfer(
592 $iteminfo->{'holdingbranch'},
593 $checkreserves->{'branchcode'}
598 #step 2b : case of a reservation on the same branch, set the waiting status
600 $messages->{'waiting'} = 1;
601 ModReserveMinusPriority(
603 $checkreserves->{'reserve_id'},
605 ModReserveStatus($itemnumber,'W');
608 $nextreservinfo = $checkreserves->{'borrowernumber'};
611 return ( $messages, $nextreservinfo );
616 $fee = GetReserveFee($borrowernumber,$biblionumber,$constraint,$biblionumber);
618 Calculate the fee for a reserve
623 my ($borrowernumber, $biblionumber, $constraint, $bibitems ) = @_;
626 my $dbh = C4::Context->dbh;
627 my $const = lc substr( $constraint, 0, 1 );
629 SELECT * FROM borrowers
630 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
631 WHERE borrowernumber = ?
633 my $sth = $dbh->prepare($query);
634 $sth->execute($borrowernumber);
635 my $data = $sth->fetchrow_hashref;
636 my $fee = $data->{'reservefee'};
637 my $cntitems = @- > $bibitems;
641 # check for items on issue
642 # first find biblioitem records
644 my $sth1 = $dbh->prepare(
645 "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber
646 WHERE (biblio.biblionumber = ?)"
648 $sth1->execute($biblionumber);
649 while ( my $data1 = $sth1->fetchrow_hashref ) {
650 if ( $const eq "a" ) {
651 push @biblioitems, $data1;
656 while ( $x < $cntitems ) {
657 if ( @$bibitems->{'biblioitemnumber'} ==
658 $data->{'biblioitemnumber'} )
664 if ( $const eq 'o' ) {
666 push @biblioitems, $data1;
671 push @biblioitems, $data1;
676 my $cntitemsfound = @biblioitems;
680 while ( $x < $cntitemsfound ) {
681 my $bitdata = $biblioitems[$x];
682 my $sth2 = $dbh->prepare(
684 WHERE biblioitemnumber = ?"
686 $sth2->execute( $bitdata->{'biblioitemnumber'} );
687 while ( my $itdata = $sth2->fetchrow_hashref ) {
688 my $sth3 = $dbh->prepare(
689 "SELECT * FROM issues
690 WHERE itemnumber = ?"
692 $sth3->execute( $itdata->{'itemnumber'} );
693 if ( my $isdata = $sth3->fetchrow_hashref ) {
701 if ( $allissued == 0 ) {
703 $dbh->prepare("SELECT * FROM reserves WHERE biblionumber = ?");
704 $rsth->execute($biblionumber);
705 if ( my $rdata = $rsth->fetchrow_hashref ) {
715 =head2 GetReservesToBranch
717 @transreserv = GetReservesToBranch( $frombranch );
719 Get reserve list for a given branch
723 sub GetReservesToBranch {
724 my ( $frombranch ) = @_;
725 my $dbh = C4::Context->dbh;
726 my $sth = $dbh->prepare(
727 "SELECT reserve_id,borrowernumber,reservedate,itemnumber,timestamp
732 $sth->execute( $frombranch );
735 while ( my $data = $sth->fetchrow_hashref ) {
736 $transreserv[$i] = $data;
739 return (@transreserv);
742 =head2 GetReservesForBranch
744 @transreserv = GetReservesForBranch($frombranch);
748 sub GetReservesForBranch {
749 my ($frombranch) = @_;
750 my $dbh = C4::Context->dbh;
753 SELECT reserve_id,borrowernumber,reservedate,itemnumber,waitingdate
758 $query .= " AND branchcode=? " if ( $frombranch );
759 $query .= "ORDER BY waitingdate" ;
761 my $sth = $dbh->prepare($query);
763 $sth->execute($frombranch);
770 while ( my $data = $sth->fetchrow_hashref ) {
771 $transreserv[$i] = $data;
774 return (@transreserv);
777 =head2 GetReserveStatus
779 $reservestatus = GetReserveStatus($itemnumber, $biblionumber);
781 Take an itemnumber or a biblionumber and return the status of the reserve places on it.
782 If several reserves exist, the reserve with the lower priority is given.
786 ## FIXME: I don't think this does what it thinks it does.
787 ## It only ever checks the first reserve result, even though
788 ## multiple reserves for that bib can have the itemnumber set
789 ## the sub is only used once in the codebase.
790 sub GetReserveStatus {
791 my ($itemnumber, $biblionumber) = @_;
793 my $dbh = C4::Context->dbh;
795 my ($sth, $found, $priority);
797 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE itemnumber = ? order by priority LIMIT 1");
798 $sth->execute($itemnumber);
799 ($found, $priority) = $sth->fetchrow_array;
802 if ( $biblionumber and not defined $found and not defined $priority ) {
803 $sth = $dbh->prepare("SELECT found, priority FROM reserves WHERE biblionumber = ? order by priority LIMIT 1");
804 $sth->execute($biblionumber);
805 ($found, $priority) = $sth->fetchrow_array;
809 return 'Waiting' if $found eq 'W' and $priority == 0;
810 return 'Finished' if $found eq 'F';
813 return 'Reserved' if $priority > 0;
815 return ''; # empty string here will remove need for checking undef, or less log lines
820 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber);
821 ($status, $reserve, $all_reserves) = &CheckReserves(undef, $barcode);
822 ($status, $reserve, $all_reserves) = &CheckReserves($itemnumber,undef,$lookahead);
824 Find a book in the reserves.
826 C<$itemnumber> is the book's item number.
827 C<$lookahead> is the number of days to look in advance for future reserves.
829 As I understand it, C<&CheckReserves> looks for the given item in the
830 reserves. If it is found, that's a match, and C<$status> is set to
833 Otherwise, it finds the most important item in the reserves with the
834 same biblio number as this book (I'm not clear on this) and returns it
835 with C<$status> set to C<Reserved>.
837 C<&CheckReserves> returns a two-element list:
839 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
841 C<$reserve> is the reserve item that matched. It is a
842 reference-to-hash whose keys are mostly the fields of the reserves
843 table in the Koha database.
848 my ( $item, $barcode, $lookahead_days) = @_;
849 my $dbh = C4::Context->dbh;
852 if (C4::Context->preference('item-level_itypes')){
854 SELECT items.biblionumber,
855 items.biblioitemnumber,
856 itemtypes.notforloan,
857 items.notforloan AS itemnotforloan,
860 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
861 LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype
866 SELECT items.biblionumber,
867 items.biblioitemnumber,
868 itemtypes.notforloan,
869 items.notforloan AS itemnotforloan,
872 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
873 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
878 $sth = $dbh->prepare("$select WHERE itemnumber = ?");
879 $sth->execute($item);
882 $sth = $dbh->prepare("$select WHERE barcode = ?");
883 $sth->execute($barcode);
885 # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
886 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber ) = $sth->fetchrow_array;
888 return ( '' ) unless $itemnumber; # bail if we got nothing.
890 # if item is not for loan it cannot be reserved either.....
891 # execpt where items.notforloan < 0 : This indicates the item is holdable.
892 return ( '' ) if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
894 # Find this item in the reserves
895 my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber, $lookahead_days);
897 # $priority and $highest are used to find the most important item
898 # in the list returned by &_Findgroupreserve. (The lower $priority,
899 # the more important the item.)
900 # $highest is the most important item we've seen so far.
902 if (scalar @reserves) {
903 my $priority = 10000000;
904 foreach my $res (@reserves) {
905 if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
906 return ( "Waiting", $res, \@reserves ); # Found it
908 # See if this item is more important than what we've got so far
909 if ( $res->{'priority'} && $res->{'priority'} < $priority ) {
910 my $borrowerinfo=C4::Members::GetMember(borrowernumber => $res->{'borrowernumber'});
911 my $iteminfo=C4::Items::GetItem($itemnumber);
912 my $branch = GetReservesControlBranch( $iteminfo, $borrowerinfo );
913 my $branchitemrule = C4::Circulation::GetBranchItemRule($branch,$iteminfo->{'itype'});
914 next if ($branchitemrule->{'holdallowed'} == 0);
915 next if (($branchitemrule->{'holdallowed'} == 1) && ($branch ne $borrowerinfo->{'branchcode'}));
916 $priority = $res->{'priority'};
923 # If we get this far, then no exact match was found.
924 # We return the most important (i.e. next) reservation.
926 $highest->{'itemnumber'} = $item;
927 return ( "Reserved", $highest, \@reserves );
933 =head2 CancelExpiredReserves
935 CancelExpiredReserves();
937 Cancels all reserves with an expiration date from before today.
941 sub CancelExpiredReserves {
943 # Cancel reserves that have passed their expiration date.
944 my $dbh = C4::Context->dbh;
945 my $sth = $dbh->prepare( "
946 SELECT * FROM reserves WHERE DATE(expirationdate) < DATE( CURDATE() )
947 AND expirationdate IS NOT NULL
952 while ( my $res = $sth->fetchrow_hashref() ) {
953 CancelReserve({ reserve_id => $res->{'reserve_id'} });
956 # Cancel reserves that have been waiting too long
957 if ( C4::Context->preference("ExpireReservesMaxPickUpDelay") ) {
958 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
959 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
961 my $query = "SELECT * FROM reserves WHERE TO_DAYS( NOW() ) - TO_DAYS( waitingdate ) > ? AND found = 'W' AND priority = 0";
962 $sth = $dbh->prepare( $query );
963 $sth->execute( $max_pickup_delay );
965 while (my $res = $sth->fetchrow_hashref ) {
967 manualinvoice($res->{'borrowernumber'}, $res->{'itemnumber'}, 'Hold waiting too long', 'F', $charge);
970 CancelReserve({ reserve_id => $res->{'reserve_id'} });
976 =head2 AutoUnsuspendReserves
978 AutoUnsuspendReserves();
980 Unsuspends all suspended reserves with a suspend_until date from before today.
984 sub AutoUnsuspendReserves {
986 my $dbh = C4::Context->dbh;
988 my $query = "UPDATE reserves SET suspend = 0, suspend_until = NULL WHERE DATE( suspend_until ) < DATE( CURDATE() )";
989 my $sth = $dbh->prepare( $query );
996 CancelReserve({ reserve_id => $reserve_id, [ biblionumber => $biblionumber, borrowernumber => $borrrowernumber, itemnumber => $itemnumber ] });
1003 my ( $params ) = @_;
1005 my $reserve_id = $params->{'reserve_id'};
1006 $reserve_id = GetReserveId( $params ) unless ( $reserve_id );
1008 return unless ( $reserve_id );
1010 my $dbh = C4::Context->dbh;
1012 my $reserve = GetReserve( $reserve_id );
1016 SET cancellationdate = now(),
1019 WHERE reserve_id = ?
1021 my $sth = $dbh->prepare($query);
1022 $sth->execute( $reserve_id );
1025 INSERT INTO old_reserves
1026 SELECT * FROM reserves
1027 WHERE reserve_id = ?
1029 $sth = $dbh->prepare($query);
1030 $sth->execute( $reserve_id );
1033 DELETE FROM reserves
1034 WHERE reserve_id = ?
1036 $sth = $dbh->prepare($query);
1037 $sth->execute( $reserve_id );
1039 # now fix the priority on the others....
1041 reserve_id => $reserve_id,
1042 biblionumber => $reserve->{biblionumber},
1048 ModReserve({ rank => $rank,
1049 reserve_id => $reserve_id,
1050 branchcode => $branchcode
1051 [, itemnumber => $itemnumber ]
1052 [, biblionumber => $biblionumber, $borrowernumber => $borrowernumber ]
1055 Change a hold request's priority or cancel it.
1057 C<$rank> specifies the effect of the change. If C<$rank>
1058 is 'W' or 'n', nothing happens. This corresponds to leaving a
1059 request alone when changing its priority in the holds queue
1062 If C<$rank> is 'del', the hold request is cancelled.
1064 If C<$rank> is an integer greater than zero, the priority of
1065 the request is set to that value. Since priority != 0 means
1066 that the item is not waiting on the hold shelf, setting the
1067 priority to a non-zero value also sets the request's found
1068 status and waiting date to NULL.
1070 The optional C<$itemnumber> parameter is used only when
1071 C<$rank> is a non-zero integer; if supplied, the itemnumber
1072 of the hold request is set accordingly; if omitted, the itemnumber
1075 B<FIXME:> Note that the forgoing can have the effect of causing
1076 item-level hold requests to turn into title-level requests. This
1077 will be fixed once reserves has separate columns for requested
1078 itemnumber and supplying itemnumber.
1083 my ( $params ) = @_;
1085 my $rank = $params->{'rank'};
1086 my $reserve_id = $params->{'reserve_id'};
1087 my $branchcode = $params->{'branchcode'};
1088 my $itemnumber = $params->{'itemnumber'};
1089 my $suspend_until = $params->{'suspend_until'};
1090 my $borrowernumber = $params->{'borrowernumber'};
1091 my $biblionumber = $params->{'biblionumber'};
1093 return if $rank eq "W";
1094 return if $rank eq "n";
1096 return unless ( $reserve_id || ( $borrowernumber && ( $biblionumber || $itemnumber ) ) );
1097 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber, itemnumber => $itemnumber }) unless ( $reserve_id );
1099 my $dbh = C4::Context->dbh;
1100 if ( $rank eq "del" ) {
1101 CancelReserve({ reserve_id => $reserve_id });
1103 elsif ($rank =~ /^\d+/ and $rank > 0) {
1105 UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL, waitingdate = NULL
1106 WHERE reserve_id = ?
1108 my $sth = $dbh->prepare($query);
1109 $sth->execute( $rank, $branchcode, $itemnumber, $reserve_id );
1111 if ( defined( $suspend_until ) ) {
1112 if ( $suspend_until ) {
1113 $suspend_until = C4::Dates->new( $suspend_until )->output("iso");
1114 $dbh->do("UPDATE reserves SET suspend = 1, suspend_until = ? WHERE reserve_id = ?", undef, ( $suspend_until, $reserve_id ) );
1116 $dbh->do("UPDATE reserves SET suspend_until = NULL WHERE reserve_id = ?", undef, ( $reserve_id ) );
1120 _FixPriority({ reserve_id => $reserve_id, rank =>$rank });
1124 =head2 ModReserveFill
1126 &ModReserveFill($reserve);
1128 Fill a reserve. If I understand this correctly, this means that the
1129 reserved book has been found and given to the patron who reserved it.
1131 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
1132 whose keys are fields from the reserves table in the Koha database.
1136 sub ModReserveFill {
1138 my $dbh = C4::Context->dbh;
1139 # fill in a reserve record....
1140 my $reserve_id = $res->{'reserve_id'};
1141 my $biblionumber = $res->{'biblionumber'};
1142 my $borrowernumber = $res->{'borrowernumber'};
1143 my $resdate = $res->{'reservedate'};
1145 # get the priority on this record....
1147 my $query = "SELECT priority
1149 WHERE biblionumber = ?
1150 AND borrowernumber = ?
1151 AND reservedate = ?";
1152 my $sth = $dbh->prepare($query);
1153 $sth->execute( $biblionumber, $borrowernumber, $resdate );
1154 ($priority) = $sth->fetchrow_array;
1156 # update the database...
1157 $query = "UPDATE reserves
1160 WHERE biblionumber = ?
1162 AND borrowernumber = ?
1164 $sth = $dbh->prepare($query);
1165 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1167 # move to old_reserves
1168 $query = "INSERT INTO old_reserves
1169 SELECT * FROM reserves
1170 WHERE biblionumber = ?
1172 AND borrowernumber = ?
1174 $sth = $dbh->prepare($query);
1175 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1176 $query = "DELETE FROM reserves
1177 WHERE biblionumber = ?
1179 AND borrowernumber = ?
1181 $sth = $dbh->prepare($query);
1182 $sth->execute( $biblionumber, $resdate, $borrowernumber );
1184 # now fix the priority on the others (if the priority wasn't
1185 # already sorted!)....
1186 unless ( $priority == 0 ) {
1187 _FixPriority({ reserve_id => $reserve_id });
1191 =head2 ModReserveStatus
1193 &ModReserveStatus($itemnumber, $newstatus);
1195 Update the reserve status for the active (priority=0) reserve.
1197 $itemnumber is the itemnumber the reserve is on
1199 $newstatus is the new status.
1203 sub ModReserveStatus {
1205 #first : check if we have a reservation for this item .
1206 my ($itemnumber, $newstatus) = @_;
1207 my $dbh = C4::Context->dbh;
1209 my $query = "UPDATE reserves SET found = ?, waitingdate = NOW() WHERE itemnumber = ? AND found IS NULL AND priority = 0";
1210 my $sth_set = $dbh->prepare($query);
1211 $sth_set->execute( $newstatus, $itemnumber );
1213 if ( C4::Context->preference("ReturnToShelvingCart") && $newstatus ) {
1214 CartToShelf( $itemnumber );
1218 =head2 ModReserveAffect
1220 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend);
1222 This function affect an item and a status for a given reserve
1223 The itemnumber parameter is used to find the biblionumber.
1224 with the biblionumber & the borrowernumber, we can affect the itemnumber
1225 to the correct reserve.
1227 if $transferToDo is not set, then the status is set to "Waiting" as well.
1228 otherwise, a transfer is on the way, and the end of the transfer will
1229 take care of the waiting status
1233 sub ModReserveAffect {
1234 my ( $itemnumber, $borrowernumber,$transferToDo ) = @_;
1235 my $dbh = C4::Context->dbh;
1237 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
1238 # attached to $itemnumber
1239 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
1240 $sth->execute($itemnumber);
1241 my ($biblionumber) = $sth->fetchrow;
1243 # get request - need to find out if item is already
1244 # waiting in order to not send duplicate hold filled notifications
1245 my $reserve_id = GetReserveId({
1246 borrowernumber => $borrowernumber,
1247 biblionumber => $biblionumber,
1249 return unless defined $reserve_id;
1250 my $request = GetReserveInfo($reserve_id);
1251 my $already_on_shelf = ($request && $request->{found} eq 'W') ? 1 : 0;
1253 # If we affect a reserve that has to be transfered, don't set to Waiting
1255 if ($transferToDo) {
1261 WHERE borrowernumber = ?
1262 AND biblionumber = ?
1266 # affect the reserve to Waiting as well.
1271 waitingdate = NOW(),
1273 WHERE borrowernumber = ?
1274 AND biblionumber = ?
1277 $sth = $dbh->prepare($query);
1278 $sth->execute( $itemnumber, $borrowernumber,$biblionumber);
1279 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo && !$already_on_shelf );
1281 if ( C4::Context->preference("ReturnToShelvingCart") ) {
1282 CartToShelf( $itemnumber );
1288 =head2 ModReserveCancelAll
1290 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1292 function to cancel reserv,check other reserves, and transfer document if it's necessary
1296 sub ModReserveCancelAll {
1299 my ( $itemnumber, $borrowernumber ) = @_;
1301 #step 1 : cancel the reservation
1302 my $CancelReserve = CancelReserve({ itemnumber => $itemnumber, borrowernumber => $borrowernumber });
1304 #step 2 launch the subroutine of the others reserves
1305 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1307 return ( $messages, $nextreservinfo );
1310 =head2 ModReserveMinusPriority
1312 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1314 Reduce the values of queued list
1318 sub ModReserveMinusPriority {
1319 my ( $itemnumber, $reserve_id ) = @_;
1321 #first step update the value of the first person on reserv
1322 my $dbh = C4::Context->dbh;
1325 SET priority = 0 , itemnumber = ?
1326 WHERE reserve_id = ?
1328 my $sth_upd = $dbh->prepare($query);
1329 $sth_upd->execute( $itemnumber, $reserve_id );
1330 # second step update all others reservs
1331 _FixPriority({ reserve_id => $reserve_id, rank => '0' });
1334 =head2 GetReserveInfo
1336 &GetReserveInfo($reserve_id);
1338 Get item and borrower details for a current hold.
1339 Current implementation this query should have a single result.
1343 sub GetReserveInfo {
1344 my ( $reserve_id ) = @_;
1345 my $dbh = C4::Context->dbh;
1350 reserves.borrowernumber,
1351 reserves.biblionumber,
1352 reserves.branchcode,
1353 reserves.waitingdate,
1369 items.holdingbranch,
1370 items.itemcallnumber,
1376 LEFT JOIN items USING(itemnumber)
1377 LEFT JOIN borrowers USING(borrowernumber)
1378 LEFT JOIN biblio ON (reserves.biblionumber=biblio.biblionumber)
1379 WHERE reserves.reserve_id = ?";
1380 my $sth = $dbh->prepare($strsth);
1381 $sth->execute($reserve_id);
1383 my $data = $sth->fetchrow_hashref;
1387 =head2 IsAvailableForItemLevelRequest
1389 my $is_available = IsAvailableForItemLevelRequest($itemnumber);
1391 Checks whether a given item record is available for an
1392 item-level hold request. An item is available if
1394 * it is not lost AND
1395 * it is not damaged AND
1396 * it is not withdrawn AND
1397 * does not have a not for loan value > 0
1399 Whether or not the item is currently on loan is
1400 also checked - if the AllowOnShelfHolds system preference
1401 is ON, an item can be requested even if it is currently
1402 on loan to somebody else. If the system preference
1403 is OFF, an item that is currently checked out cannot
1404 be the target of an item-level hold request.
1406 Note that IsAvailableForItemLevelRequest() does not
1407 check if the staff operator is authorized to place
1408 a request on the item - in particular,
1409 this routine does not check IndependentBranches
1410 and canreservefromotherbranches.
1414 sub IsAvailableForItemLevelRequest {
1415 my $itemnumber = shift;
1417 my $item = GetItem($itemnumber);
1419 # must check the notforloan setting of the itemtype
1420 # FIXME - a lot of places in the code do this
1421 # or something similar - need to be
1423 my $dbh = C4::Context->dbh;
1424 my $notforloan_query;
1425 if (C4::Context->preference('item-level_itypes')) {
1426 $notforloan_query = "SELECT itemtypes.notforloan
1428 JOIN itemtypes ON (itemtypes.itemtype = items.itype)
1429 WHERE itemnumber = ?";
1431 $notforloan_query = "SELECT itemtypes.notforloan
1433 JOIN biblioitems USING (biblioitemnumber)
1434 JOIN itemtypes USING (itemtype)
1435 WHERE itemnumber = ?";
1437 my $sth = $dbh->prepare($notforloan_query);
1438 $sth->execute($itemnumber);
1439 my $notforloan_per_itemtype = 0;
1440 if (my ($notforloan) = $sth->fetchrow_array) {
1441 $notforloan_per_itemtype = 1 if $notforloan;
1444 my $available_per_item = 1;
1445 $available_per_item = 0 if $item->{itemlost} or
1446 ( $item->{notforloan} > 0 ) or
1447 ($item->{damaged} and not C4::Context->preference('AllowHoldsOnDamagedItems')) or
1448 $item->{withdrawn} or
1449 $notforloan_per_itemtype;
1452 if (C4::Context->preference('AllowOnShelfHolds')) {
1453 return $available_per_item;
1455 return ($available_per_item and ($item->{onloan} or GetReserveStatus($itemnumber) eq "Waiting"));
1459 =head2 AlterPriority
1461 AlterPriority( $where, $reserve_id );
1463 This function changes a reserve's priority up, down, to the top, or to the bottom.
1464 Input: $where is 'up', 'down', 'top' or 'bottom'. Biblionumber, Date reserve was placed
1469 my ( $where, $reserve_id ) = @_;
1471 my $dbh = C4::Context->dbh;
1473 my $reserve = GetReserve( $reserve_id );
1475 if ( $reserve->{cancellationdate} ) {
1476 warn "I cannot alter the priority for reserve_id $reserve_id, the reserve has been cancelled (".$reserve->{cancellationdate}.')';
1480 if ( $where eq 'up' || $where eq 'down' ) {
1482 my $priority = $reserve->{'priority'};
1483 $priority = $where eq 'up' ? $priority - 1 : $priority + 1;
1484 _FixPriority({ reserve_id => $reserve_id, rank => $priority })
1486 } elsif ( $where eq 'top' ) {
1488 _FixPriority({ reserve_id => $reserve_id, rank => '1' })
1490 } elsif ( $where eq 'bottom' ) {
1492 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1497 =head2 ToggleLowestPriority
1499 ToggleLowestPriority( $borrowernumber, $biblionumber );
1501 This function sets the lowestPriority field to true if is false, and false if it is true.
1505 sub ToggleLowestPriority {
1506 my ( $reserve_id ) = @_;
1508 my $dbh = C4::Context->dbh;
1510 my $sth = $dbh->prepare( "UPDATE reserves SET lowestPriority = NOT lowestPriority WHERE reserve_id = ?");
1511 $sth->execute( $reserve_id );
1513 _FixPriority({ reserve_id => $reserve_id, rank => '999999' });
1516 =head2 ToggleSuspend
1518 ToggleSuspend( $reserve_id );
1520 This function sets the suspend field to true if is false, and false if it is true.
1521 If the reserve is currently suspended with a suspend_until date, that date will
1522 be cleared when it is unsuspended.
1527 my ( $reserve_id, $suspend_until ) = @_;
1529 $suspend_until = output_pref({ dt => dt_from_string( $suspend_until ), dateformat => 'iso' }) if ( $suspend_until );
1531 my $do_until = ( $suspend_until ) ? '?' : 'NULL';
1533 my $dbh = C4::Context->dbh;
1535 my $sth = $dbh->prepare(
1536 "UPDATE reserves SET suspend = NOT suspend,
1537 suspend_until = CASE WHEN suspend = 0 THEN NULL ELSE $do_until END
1538 WHERE reserve_id = ?
1542 push( @params, $suspend_until ) if ( $suspend_until );
1543 push( @params, $reserve_id );
1545 $sth->execute( @params );
1551 borrowernumber => $borrowernumber,
1552 [ biblionumber => $biblionumber, ]
1553 [ suspend_until => $suspend_until, ]
1554 [ suspend => $suspend ]
1557 This function accepts a set of hash keys as its parameters.
1558 It requires either borrowernumber or biblionumber, or both.
1560 suspend_until is wholly optional.
1567 my $borrowernumber = $params{'borrowernumber'} || undef;
1568 my $biblionumber = $params{'biblionumber'} || undef;
1569 my $suspend_until = $params{'suspend_until'} || undef;
1570 my $suspend = defined( $params{'suspend'} ) ? $params{'suspend'} : 1;
1572 $suspend_until = C4::Dates->new( $suspend_until )->output("iso") if ( defined( $suspend_until ) );
1574 return unless ( $borrowernumber || $biblionumber );
1576 my ( $query, $sth, $dbh, @query_params );
1578 $query = "UPDATE reserves SET suspend = ? ";
1579 push( @query_params, $suspend );
1581 $query .= ", suspend_until = NULL ";
1582 } elsif ( $suspend_until ) {
1583 $query .= ", suspend_until = ? ";
1584 push( @query_params, $suspend_until );
1586 $query .= " WHERE ";
1587 if ( $borrowernumber ) {
1588 $query .= " borrowernumber = ? ";
1589 push( @query_params, $borrowernumber );
1591 $query .= " AND " if ( $borrowernumber && $biblionumber );
1592 if ( $biblionumber ) {
1593 $query .= " biblionumber = ? ";
1594 push( @query_params, $biblionumber );
1596 $query .= " AND found IS NULL ";
1598 $dbh = C4::Context->dbh;
1599 $sth = $dbh->prepare( $query );
1600 $sth->execute( @query_params );
1606 &_FixPriority({ reserve_id => $reserve_id, rank => $rank, ignoreSetLowestRank => $ignoreSetLowestRank });
1608 Only used internally (so don't export it)
1609 Changed how this functions works #
1610 Now just gets an array of reserves in the rank order and updates them with
1611 the array index (+1 as array starts from 0)
1612 and if $rank is supplied will splice item from the array and splice it back in again
1613 in new priority rank
1618 my ( $params ) = @_;
1619 my $reserve_id = $params->{reserve_id};
1620 my $rank = $params->{rank};
1621 my $ignoreSetLowestRank = $params->{ignoreSetLowestRank};
1622 my $biblionumber = $params->{biblionumber};
1624 my $dbh = C4::Context->dbh;
1626 unless ( $biblionumber ) {
1627 my $res = GetReserve( $reserve_id );
1628 $biblionumber = $res->{biblionumber};
1631 if ( $rank eq "del" ) {
1632 CancelReserve({ reserve_id => $reserve_id });
1634 elsif ( $rank eq "W" || $rank eq "0" ) {
1636 # make sure priority for waiting or in-transit items is 0
1640 WHERE reserve_id = ?
1641 AND found IN ('W', 'T')
1643 my $sth = $dbh->prepare($query);
1644 $sth->execute( $reserve_id );
1650 SELECT reserve_id, borrowernumber, reservedate, constrainttype
1652 WHERE biblionumber = ?
1653 AND ((found <> 'W' AND found <> 'T') OR found IS NULL)
1654 ORDER BY priority ASC
1656 my $sth = $dbh->prepare($query);
1657 $sth->execute( $biblionumber );
1658 while ( my $line = $sth->fetchrow_hashref ) {
1659 push( @priority, $line );
1662 # To find the matching index
1664 my $key = -1; # to allow for 0 to be a valid result
1665 for ( $i = 0 ; $i < @priority ; $i++ ) {
1666 if ( $reserve_id == $priority[$i]->{'reserve_id'} ) {
1667 $key = $i; # save the index
1672 # if index exists in array then move it to new position
1673 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1674 my $new_rank = $rank -
1675 1; # $new_rank is what you want the new index to be in the array
1676 my $moving_item = splice( @priority, $key, 1 );
1677 splice( @priority, $new_rank, 0, $moving_item );
1680 # now fix the priority on those that are left....
1684 WHERE reserve_id = ?
1686 $sth = $dbh->prepare($query);
1687 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1690 $priority[$j]->{'reserve_id'}
1694 $sth = $dbh->prepare( "SELECT reserve_id FROM reserves WHERE lowestPriority = 1 ORDER BY priority" );
1697 unless ( $ignoreSetLowestRank ) {
1698 while ( my $res = $sth->fetchrow_hashref() ) {
1700 reserve_id => $res->{'reserve_id'},
1702 ignoreSetLowestRank => 1
1708 =head2 _Findgroupreserve
1710 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber, $lookahead);
1712 Looks for an item-specific match first, then for a title-level match, returning the
1713 first match found. If neither, then we look for a 3rd kind of match based on
1714 reserve constraints.
1715 Lookahead is the number of days to look in advance.
1717 TODO: add more explanation about reserve constraints
1719 C<&_Findgroupreserve> returns :
1720 C<@results> is an array of references-to-hash whose keys are mostly
1721 fields from the reserves table of the Koha database, plus
1722 C<biblioitemnumber>.
1726 sub _Findgroupreserve {
1727 my ( $bibitem, $biblio, $itemnumber, $lookahead) = @_;
1728 my $dbh = C4::Context->dbh;
1730 # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
1731 # check for exact targetted match
1732 my $item_level_target_query = qq/
1733 SELECT reserves.biblionumber AS biblionumber,
1734 reserves.borrowernumber AS borrowernumber,
1735 reserves.reservedate AS reservedate,
1736 reserves.branchcode AS branchcode,
1737 reserves.cancellationdate AS cancellationdate,
1738 reserves.found AS found,
1739 reserves.reservenotes AS reservenotes,
1740 reserves.priority AS priority,
1741 reserves.timestamp AS timestamp,
1742 biblioitems.biblioitemnumber AS biblioitemnumber,
1743 reserves.itemnumber AS itemnumber,
1744 reserves.reserve_id AS reserve_id
1746 JOIN biblioitems USING (biblionumber)
1747 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1750 AND item_level_request = 1
1752 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1755 my $sth = $dbh->prepare($item_level_target_query);
1756 $sth->execute($itemnumber, $lookahead||0);
1758 if ( my $data = $sth->fetchrow_hashref ) {
1759 push( @results, $data );
1761 return @results if @results;
1763 # check for title-level targetted match
1764 my $title_level_target_query = qq/
1765 SELECT reserves.biblionumber AS biblionumber,
1766 reserves.borrowernumber AS borrowernumber,
1767 reserves.reservedate AS reservedate,
1768 reserves.branchcode AS branchcode,
1769 reserves.cancellationdate AS cancellationdate,
1770 reserves.found AS found,
1771 reserves.reservenotes AS reservenotes,
1772 reserves.priority AS priority,
1773 reserves.timestamp AS timestamp,
1774 biblioitems.biblioitemnumber AS biblioitemnumber,
1775 reserves.itemnumber AS itemnumber
1777 JOIN biblioitems USING (biblionumber)
1778 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1781 AND item_level_request = 0
1782 AND hold_fill_targets.itemnumber = ?
1783 AND reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1786 $sth = $dbh->prepare($title_level_target_query);
1787 $sth->execute($itemnumber, $lookahead||0);
1789 if ( my $data = $sth->fetchrow_hashref ) {
1790 push( @results, $data );
1792 return @results if @results;
1795 SELECT reserves.biblionumber AS biblionumber,
1796 reserves.borrowernumber AS borrowernumber,
1797 reserves.reservedate AS reservedate,
1798 reserves.waitingdate AS waitingdate,
1799 reserves.branchcode AS branchcode,
1800 reserves.cancellationdate AS cancellationdate,
1801 reserves.found AS found,
1802 reserves.reservenotes AS reservenotes,
1803 reserves.priority AS priority,
1804 reserves.timestamp AS timestamp,
1805 reserveconstraints.biblioitemnumber AS biblioitemnumber,
1806 reserves.itemnumber AS itemnumber
1808 LEFT JOIN reserveconstraints ON reserves.biblionumber = reserveconstraints.biblionumber
1809 WHERE reserves.biblionumber = ?
1810 AND ( ( reserveconstraints.biblioitemnumber = ?
1811 AND reserves.borrowernumber = reserveconstraints.borrowernumber
1812 AND reserves.reservedate = reserveconstraints.reservedate )
1813 OR reserves.constrainttype='a' )
1814 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1815 AND reserves.reservedate <= DATE_ADD(NOW(),INTERVAL ? DAY)
1818 $sth = $dbh->prepare($query);
1819 $sth->execute( $biblio, $bibitem, $itemnumber, $lookahead||0);
1821 while ( my $data = $sth->fetchrow_hashref ) {
1822 push( @results, $data );
1827 =head2 _koha_notify_reserve
1829 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber );
1831 Sends a notification to the patron that their hold has been filled (through
1832 ModReserveAffect, _not_ ModReserveFill)
1836 sub _koha_notify_reserve {
1837 my ($itemnumber, $borrowernumber, $biblionumber) = @_;
1839 my $dbh = C4::Context->dbh;
1840 my $borrower = C4::Members::GetMember(borrowernumber => $borrowernumber);
1842 # Try to get the borrower's email address
1843 my $to_address = C4::Members::GetNoticeEmailAddress($borrowernumber);
1848 if ( $to_address || $borrower->{'smsalertnumber'} ) {
1849 $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber, message_name => 'Hold_Filled' } );
1854 my $sth = $dbh->prepare("
1857 WHERE borrowernumber = ?
1858 AND biblionumber = ?
1860 $sth->execute( $borrowernumber, $biblionumber );
1861 my $reserve = $sth->fetchrow_hashref;
1862 my $branch_details = GetBranchDetail( $reserve->{'branchcode'} );
1864 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
1866 my %letter_params = (
1867 module => 'reserves',
1868 branchcode => $reserve->{branchcode},
1870 'branches' => $branch_details,
1871 'borrowers' => $borrower,
1872 'biblio' => $biblionumber,
1873 'reserves' => $reserve,
1874 'items', $reserve->{'itemnumber'},
1876 substitute => { today => C4::Dates->new()->output() },
1880 if ( $print_mode ) {
1881 $letter_params{ 'letter_code' } = 'HOLD_PRINT';
1882 my $letter = C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1884 C4::Letters::EnqueueLetter( {
1886 borrowernumber => $borrowernumber,
1887 message_transport_type => 'print',
1893 if ( $to_address && defined $messagingprefs->{transports}->{'email'} ) {
1894 $letter_params{ 'letter_code' } = $messagingprefs->{transports}->{'email'};
1895 my $letter = C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1897 C4::Letters::EnqueueLetter(
1898 { letter => $letter,
1899 borrowernumber => $borrowernumber,
1900 message_transport_type => 'email',
1901 from_address => $admin_email_address,
1906 if ( $borrower->{'smsalertnumber'} && defined $messagingprefs->{transports}->{'sms'} ) {
1907 $letter_params{ 'letter_code' } = $messagingprefs->{transports}->{'sms'};
1908 my $letter = C4::Letters::GetPreparedLetter ( %letter_params ) or die "Could not find a letter called '$letter_params{'letter_code'}' in the 'reserves' module";
1910 C4::Letters::EnqueueLetter(
1911 { letter => $letter,
1912 borrowernumber => $borrowernumber,
1913 message_transport_type => 'sms',
1919 =head2 _ShiftPriorityByDateAndPriority
1921 $new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
1923 This increments the priority of all reserves after the one
1924 with either the lowest date after C<$reservedate>
1925 or the lowest priority after C<$priority>.
1927 It effectively makes room for a new reserve to be inserted with a certain
1928 priority, which is returned.
1930 This is most useful when the reservedate can be set by the user. It allows
1931 the new reserve to be placed before other reserves that have a later
1932 reservedate. Since priority also is set by the form in reserves/request.pl
1933 the sub accounts for that too.
1937 sub _ShiftPriorityByDateAndPriority {
1938 my ( $biblio, $resdate, $new_priority ) = @_;
1940 my $dbh = C4::Context->dbh;
1941 my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC LIMIT 1";
1942 my $sth = $dbh->prepare( $query );
1943 $sth->execute( $biblio, $resdate, $new_priority );
1944 my $min_priority = $sth->fetchrow;
1945 # if no such matches are found, $new_priority remains as original value
1946 $new_priority = $min_priority if ( $min_priority );
1948 # Shift the priority up by one; works in conjunction with the next SQL statement
1949 $query = "UPDATE reserves
1950 SET priority = priority+1
1951 WHERE biblionumber = ?
1952 AND borrowernumber = ?
1955 my $sth_update = $dbh->prepare( $query );
1957 # Select all reserves for the biblio with priority greater than $new_priority, and order greatest to least
1958 $query = "SELECT borrowernumber, reservedate FROM reserves WHERE priority >= ? AND biblionumber = ? ORDER BY priority DESC";
1959 $sth = $dbh->prepare( $query );
1960 $sth->execute( $new_priority, $biblio );
1961 while ( my $row = $sth->fetchrow_hashref ) {
1962 $sth_update->execute( $biblio, $row->{borrowernumber}, $row->{reservedate} );
1965 return $new_priority; # so the caller knows what priority they wind up receiving
1970 MoveReserve( $itemnumber, $borrowernumber, $cancelreserve )
1972 Use when checking out an item to handle reserves
1973 If $cancelreserve boolean is set to true, it will remove existing reserve
1978 my ( $itemnumber, $borrowernumber, $cancelreserve ) = @_;
1980 my ( $restype, $res, $all_reserves ) = CheckReserves( $itemnumber );
1983 my $biblionumber = $res->{biblionumber};
1984 my $biblioitemnumber = $res->{biblioitemnumber};
1986 if ($res->{borrowernumber} == $borrowernumber) {
1987 ModReserveFill($res);
1991 # The item is reserved by someone else.
1992 # Find this item in the reserves
1995 foreach (@$all_reserves) {
1996 $_->{'borrowernumber'} == $borrowernumber or next;
1997 $_->{'biblionumber'} == $biblionumber or next;
2004 # The item is reserved by the current patron
2005 ModReserveFill($borr_res);
2008 if ( $cancelreserve eq 'revert' ) { ## Revert waiting reserve to priority 1
2009 RevertWaitingStatus({ itemnumber => $itemnumber });
2011 elsif ( $cancelreserve eq 'cancel' || $cancelreserve ) { # cancel reserves on this item
2013 biblionumber => $res->{'biblionumber'},
2014 itemnumber => $res->{'itemnumber'},
2015 borrowernumber => $res->{'borrowernumber'}
2023 MergeHolds($dbh,$to_biblio, $from_biblio);
2025 This shifts the holds from C<$from_biblio> to C<$to_biblio> and reorders them by the date they were placed
2030 my ( $dbh, $to_biblio, $from_biblio ) = @_;
2031 my $sth = $dbh->prepare(
2032 "SELECT count(*) as reserve_count FROM reserves WHERE biblionumber = ?"
2034 $sth->execute($from_biblio);
2035 if ( my $data = $sth->fetchrow_hashref() ) {
2037 # holds exist on old record, if not we don't need to do anything
2038 $sth = $dbh->prepare(
2039 "UPDATE reserves SET biblionumber = ? WHERE biblionumber = ?");
2040 $sth->execute( $to_biblio, $from_biblio );
2043 # don't reorder those already waiting
2045 $sth = $dbh->prepare(
2046 "SELECT * FROM reserves WHERE biblionumber = ? AND (found <> ? AND found <> ? OR found is NULL) ORDER BY reservedate ASC"
2048 my $upd_sth = $dbh->prepare(
2049 "UPDATE reserves SET priority = ? WHERE biblionumber = ? AND borrowernumber = ?
2050 AND reservedate = ? AND constrainttype = ? AND (itemnumber = ? or itemnumber is NULL) "
2052 $sth->execute( $to_biblio, 'W', 'T' );
2054 while ( my $reserve = $sth->fetchrow_hashref() ) {
2056 $priority, $to_biblio,
2057 $reserve->{'borrowernumber'}, $reserve->{'reservedate'},
2058 $reserve->{'constrainttype'}, $reserve->{'itemnumber'}
2065 =head2 RevertWaitingStatus
2067 $success = RevertWaitingStatus({ itemnumber => $itemnumber });
2069 Reverts a 'waiting' hold back to a regular hold with a priority of 1.
2071 Caveat: Any waiting hold fixed with RevertWaitingStatus will be an
2072 item level hold, even if it was only a bibliolevel hold to
2073 begin with. This is because we can no longer know if a hold
2074 was item-level or bib-level after a hold has been set to
2079 sub RevertWaitingStatus {
2080 my ( $params ) = @_;
2081 my $itemnumber = $params->{'itemnumber'};
2083 return unless ( $itemnumber );
2085 my $dbh = C4::Context->dbh;
2087 ## Get the waiting reserve we want to revert
2089 SELECT * FROM reserves
2090 WHERE itemnumber = ?
2091 AND found IS NOT NULL
2093 my $sth = $dbh->prepare( $query );
2094 $sth->execute( $itemnumber );
2095 my $reserve = $sth->fetchrow_hashref();
2097 ## Increment the priority of all other non-waiting
2098 ## reserves for this bib record
2102 priority = priority + 1
2108 $sth = $dbh->prepare( $query );
2109 $sth->execute( $reserve->{'biblionumber'} );
2111 ## Fix up the currently waiting reserve
2121 $sth = $dbh->prepare( $query );
2122 return $sth->execute( $reserve->{'reserve_id'} );
2127 $reserve_id = GetReserveId({ biblionumber => $biblionumber, borrowernumber => $borrowernumber [, itemnumber => $itemnumber ] });
2129 Returnes the first reserve id that matches the given criteria
2134 my ( $params ) = @_;
2136 return unless ( ( $params->{'biblionumber'} || $params->{'itemnumber'} ) && $params->{'borrowernumber'} );
2138 my $dbh = C4::Context->dbh();
2140 my $sql = "SELECT reserve_id FROM reserves WHERE ";
2144 foreach my $key ( keys %$params ) {
2145 if ( defined( $params->{$key} ) ) {
2146 push( @limits, "$key = ?" );
2147 push( @params, $params->{$key} );
2151 $sql .= join( " AND ", @limits );
2153 my $sth = $dbh->prepare( $sql );
2154 $sth->execute( @params );
2155 my $row = $sth->fetchrow_hashref();
2157 return $row->{'reserve_id'};
2162 ReserveSlip($branchcode, $borrowernumber, $biblionumber)
2164 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
2169 my ($branch, $borrowernumber, $biblionumber) = @_;
2171 # return unless ( C4::Context->boolean_preference('printreserveslips') );
2173 my $reserve_id = GetReserveId({
2174 biblionumber => $biblionumber,
2175 borrowernumber => $borrowernumber
2177 my $reserve = GetReserveInfo($reserve_id) or return;
2179 return C4::Letters::GetPreparedLetter (
2180 module => 'circulation',
2181 letter_code => 'RESERVESLIP',
2182 branchcode => $branch,
2184 'reserves' => $reserve,
2185 'branches' => $reserve->{branchcode},
2186 'borrowers' => $reserve->{borrowernumber},
2187 'biblio' => $reserve->{biblionumber},
2188 'items' => $reserve->{itemnumber},
2193 =head2 GetReservesControlBranch
2195 my $reserves_control_branch = GetReservesControlBranch($item, $borrower);
2197 Return the branchcode to be used to determine which reserves
2198 policy applies to a transaction.
2200 C<$item> is a hashref for an item. Only 'homebranch' is used.
2202 C<$borrower> is a hashref to borrower. Only 'branchcode' is used.
2206 sub GetReservesControlBranch {
2207 my ( $item, $borrower ) = @_;
2209 my $reserves_control = C4::Context->preference('ReservesControlBranch');
2212 ( $reserves_control eq 'ItemHomeLibrary' ) ? $item->{'homebranch'}
2213 : ( $reserves_control eq 'PatronLibrary' ) ? $borrower->{'branchcode'}
2221 Koha Development Team <http://koha-community.org/>