2 # NOTE: This file uses standard 8-character tabs
6 # Copyright 2000-2002 Katipo Communications
7 # 2006 SAN Ouest Provence
8 # 2007 BibLibre Paul POULAIN
10 # This file is part of Koha.
12 # Koha is free software; you can redistribute it and/or modify it under the
13 # terms of the GNU General Public License as published by the Free Software
14 # Foundation; either version 2 of the License, or (at your option) any later
17 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
18 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License along with
22 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
23 # Suite 330, Boston, MA 02111-1307 USA
34 # for _koha_notify_reserve
35 use C4::Members::Messaging;
36 use C4::Members qw( GetMember );
38 use C4::Branch qw( GetBranchDetail );
39 use List::MoreUtils qw( firstidx );
41 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
43 my $library_name = C4::Context->preference("LibraryName");
47 C4::Reserves - Koha functions for dealing with reservation.
55 this modules provides somes functions to deal with reservations.
57 Reserves are stored in reserves table.
58 The following columns contains important values :
59 - priority >0 : then the reserve is at 1st stage, and not yet affected to any item.
60 =0 : then the reserve is being dealed
61 - found : NULL : means the patron requested the 1st available, and we haven't choosen the item
62 W(aiting) : the reserve has an itemnumber affected, and is on the way
63 F(inished) : the reserve has been completed, and is done
64 - itemnumber : empty : the reserve is still unaffected to an item
65 filled: the reserve is attached to an item
66 The complete workflow is :
67 ==== 1st use case ====
68 patron request a document, 1st available : P >0, F=NULL, I=NULL
69 a library having it run "transfertodo", and clic on the list
70 if there is no transfer to do, the reserve waiting
71 patron can pick it up P =0, F=W, I=filled
72 if there is a transfer to do, write in branchtransfer P =0, F=NULL, I=filled
73 The pickup library recieve the book, it check in P =0, F=W, I=filled
74 The patron borrow the book P =0, F=F, I=filled
76 ==== 2nd use case ====
77 patron requests a document, a given item,
78 If pickup is holding branch P =0, F=W, I=filled
79 If transfer needed, write in branchtransfer P =0, F=NULL, I=filled
80 The pickup library recieve the book, it checks it in P =0, F=W, I=filled
81 The patron borrow the book P =0, F=F, I=filled
90 # set the version for version checking
97 &GetReservesFromItemnumber
98 &GetReservesFromBiblionumber
99 &GetReservesFromBorrowernumber
100 &GetReservesForBranch
113 &ModReserveMinusPriority
118 &IsAvailableForItemLevelRequest
124 AddReserve($branch,$borrowernumber,$biblionumber,$constraint,$bibitems,$priority,$notes,$title,$checkitem,$found)
130 $branch, $borrowernumber, $biblionumber,
131 $constraint, $bibitems, $priority, $notes,
132 $title, $checkitem, $found
135 GetReserveFee($borrowernumber, $biblionumber, $constraint,
137 my $dbh = C4::Context->dbh;
138 my $const = lc substr( $constraint, 0, 1 );
139 my @datearr = localtime(time);
141 ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
144 # If the reserv had the waiting status, we had the value of the resdate
145 if ( $found eq 'W' ) {
146 $waitingdate = $resdate;
150 # updates take place here
152 my $nextacctno = &getnextacctno( $borrowernumber );
154 INSERT INTO accountlines
155 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
157 (?,?,now(),?,?,'Res',?)
159 my $usth = $dbh->prepare($query);
160 $usth->execute( $borrowernumber, $nextacctno, $fee,
161 "Reserve Charge - $title", $fee );
167 (borrowernumber,biblionumber,reservedate,branchcode,constrainttype,
168 priority,reservenotes,itemnumber,found,waitingdate)
173 my $sth = $dbh->prepare($query);
175 $borrowernumber, $biblionumber, $resdate, $branch,
176 $const, $priority, $notes, $checkitem,
181 ($const eq "o" || $const eq "e") or return; # FIXME: why not have a useful return value?
183 INSERT INTO reserveconstraints
184 (borrowernumber,biblionumber,reservedate,biblioitemnumber)
188 $sth = $dbh->prepare($query); # keep prepare outside the loop!
189 foreach (@$bibitems) {
190 $sth->execute($borrowernumber, $biblionumber, $resdate, $_);
192 return; # FIXME: why not have a useful return value?
195 =item GetReservesFromBiblionumber
197 @borrowerreserv=&GetReserves($biblionumber,$itemnumber,$borrowernumber);
199 this function get the list of reservation for an C<$biblionumber>, C<$itemnumber> or C<$borrowernumber>
201 Only 1 argument has to be passed.
205 sub GetReservesFromBiblionumber {
206 my ( $biblionumber, $itemnumber, $borrowernumber ) = @_;
207 my $dbh = C4::Context->dbh;
209 # Find the desired items in the reserves
212 timestamp AS rtimestamp,
222 WHERE biblionumber = ?
224 my $sth = $dbh->prepare($query);
225 $sth->execute($biblionumber);
228 while ( my $data = $sth->fetchrow_hashref ) {
230 # FIXME - What is this doing? How do constraints work?
231 ($data->{constrainttype} eq 'o') or next;
233 SELECT biblioitemnumber
234 FROM reserveconstraints
235 WHERE biblionumber = ?
236 AND borrowernumber = ?
239 my $csth = $dbh->prepare($query);
240 $csth->execute( $data->{biblionumber}, $data->{borrowernumber},
241 $data->{reservedate}, );
244 while ( my $bibitemnos = $csth->fetchrow_array ) {
245 push( @bibitemno, $bibitemnos ); # FIXME: inefficient: use fetchall_arrayref
247 my $count = scalar @bibitemno;
249 # if we have two or more different specific itemtypes
250 # reserved by same person on same day
253 $bdata = GetBiblioItemData( $bibitemno[$i] );
257 # Look up the book we just found.
258 $bdata = GetBiblioItemData( $bibitemno[0] );
260 # Add the results of this latest search to the current
262 # FIXME - An 'each' would probably be more efficient.
263 foreach my $key ( keys %$bdata ) {
264 $data->{$key} = $bdata->{$key};
266 push @results, $data;
268 return ( $#results + 1, \@results );
271 =item GetReservesFromItemnumber
273 ( $reservedate, $borrowernumber, $branchcode ) = GetReservesFromItemnumber($itemnumber);
275 TODO :: Description here
279 sub GetReservesFromItemnumber {
280 my ( $itemnumber ) = @_;
281 my $dbh = C4::Context->dbh;
283 SELECT reservedate,borrowernumber,branchcode
287 my $sth_res = $dbh->prepare($query);
288 $sth_res->execute($itemnumber);
289 my ( $reservedate, $borrowernumber,$branchcode ) = $sth_res->fetchrow_array;
290 return ( $reservedate, $borrowernumber, $branchcode );
293 =item GetReservesFromBorrowernumber
295 $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
301 sub GetReservesFromBorrowernumber {
302 my ( $borrowernumber, $status ) = @_;
303 my $dbh = C4::Context->dbh;
306 $sth = $dbh->prepare("
309 WHERE borrowernumber=?
313 $sth->execute($borrowernumber,$status);
315 $sth = $dbh->prepare("
318 WHERE borrowernumber=?
321 $sth->execute($borrowernumber);
323 my $data = $sth->fetchall_arrayref({});
326 #-------------------------------------------------------------------------------------
328 =item GetReserveCount
330 $number = &GetReserveCount($borrowernumber);
332 this function returns the number of reservation for a borrower given on input arg.
336 sub GetReserveCount {
337 my ($borrowernumber) = @_;
339 my $dbh = C4::Context->dbh;
342 SELECT COUNT(*) AS counter
344 WHERE borrowernumber = ?
346 my $sth = $dbh->prepare($query);
347 $sth->execute($borrowernumber);
348 my $row = $sth->fetchrow_hashref;
349 return $row->{counter};
352 =item GetOtherReserves
354 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
356 Check queued list of this document and check if this document must be transfered
360 sub GetOtherReserves {
361 my ($itemnumber) = @_;
364 my ( $restype, $checkreserves ) = CheckReserves($itemnumber);
365 if ($checkreserves and $restype ne "Waiting" ) {
366 my $iteminfo = GetItem($itemnumber);
367 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
368 $messages->{'transfert'} = $checkreserves->{'branchcode'};
369 #minus priorities of others reservs
370 ModReserveMinusPriority(
372 $checkreserves->{'borrowernumber'},
373 $iteminfo->{'biblionumber'}
376 #launch the subroutine dotransfer
377 C4::Circulation::ModItemTransfer(
379 $iteminfo->{'holdingbranch'},
380 $checkreserves->{'branchcode'}
385 #step 2b : case of a reservation on the same branch, set the waiting status
387 $messages->{'waiting'} = 1;
388 ModReserveMinusPriority(
390 $checkreserves->{'borrowernumber'},
391 $iteminfo->{'biblionumber'}
393 ModReserveStatus($itemnumber,'W');
396 $nextreservinfo = $checkreserves->{'borrowernumber'};
399 return ( $messages, $nextreservinfo );
404 $fee = GetReserveFee($borrowernumber,$biblionumber,$constraint,$biblionumber);
406 Calculate the fee for a reserve
411 my ($borrowernumber, $biblionumber, $constraint, $bibitems ) = @_;
414 my $dbh = C4::Context->dbh;
415 my $const = lc substr( $constraint, 0, 1 );
417 SELECT * FROM borrowers
418 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
419 WHERE borrowernumber = ?
421 my $sth = $dbh->prepare($query);
422 $sth->execute($borrowernumber);
423 my $data = $sth->fetchrow_hashref;
425 my $fee = $data->{'reservefee'};
426 my $cntitems = @- > $bibitems;
430 # check for items on issue
431 # first find biblioitem records
433 my $sth1 = $dbh->prepare(
434 "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber
435 WHERE (biblio.biblionumber = ?)"
437 $sth1->execute($biblionumber);
438 while ( my $data1 = $sth1->fetchrow_hashref ) {
439 if ( $const eq "a" ) {
440 push @biblioitems, $data1;
445 while ( $x < $cntitems ) {
446 if ( @$bibitems->{'biblioitemnumber'} ==
447 $data->{'biblioitemnumber'} )
453 if ( $const eq 'o' ) {
455 push @biblioitems, $data1;
460 push @biblioitems, $data1;
466 my $cntitemsfound = @biblioitems;
470 while ( $x < $cntitemsfound ) {
471 my $bitdata = $biblioitems[$x];
472 my $sth2 = $dbh->prepare(
474 WHERE biblioitemnumber = ?"
476 $sth2->execute( $bitdata->{'biblioitemnumber'} );
477 while ( my $itdata = $sth2->fetchrow_hashref ) {
478 my $sth3 = $dbh->prepare(
479 "SELECT * FROM issues
480 WHERE itemnumber = ?"
482 $sth3->execute( $itdata->{'itemnumber'} );
483 if ( my $isdata = $sth3->fetchrow_hashref ) {
491 if ( $allissued == 0 ) {
493 $dbh->prepare("SELECT * FROM reserves WHERE biblionumber = ?");
494 $rsth->execute($biblionumber);
495 if ( my $rdata = $rsth->fetchrow_hashref ) {
505 =item GetReservesToBranch
507 @transreserv = GetReservesToBranch( $frombranch );
509 Get reserve list for a given branch
513 sub GetReservesToBranch {
514 my ( $frombranch ) = @_;
515 my $dbh = C4::Context->dbh;
516 my $sth = $dbh->prepare(
517 "SELECT borrowernumber,reservedate,itemnumber,timestamp
522 $sth->execute( $frombranch );
525 while ( my $data = $sth->fetchrow_hashref ) {
526 $transreserv[$i] = $data;
529 return (@transreserv);
532 =item GetReservesForBranch
534 @transreserv = GetReservesForBranch($frombranch);
538 sub GetReservesForBranch {
539 my ($frombranch) = @_;
540 my $dbh = C4::Context->dbh;
541 my $query = "SELECT borrowernumber,reservedate,itemnumber,waitingdate
546 $query .= " AND branchcode=? ";
548 $query .= "ORDER BY waitingdate" ;
549 my $sth = $dbh->prepare($query);
551 $sth->execute($frombranch);
558 while ( my $data = $sth->fetchrow_hashref ) {
559 $transreserv[$i] = $data;
562 return (@transreserv);
567 ($status, $reserve) = &CheckReserves($itemnumber);
569 Find a book in the reserves.
571 C<$itemnumber> is the book's item number.
573 As I understand it, C<&CheckReserves> looks for the given item in the
574 reserves. If it is found, that's a match, and C<$status> is set to
577 Otherwise, it finds the most important item in the reserves with the
578 same biblio number as this book (I'm not clear on this) and returns it
579 with C<$status> set to C<Reserved>.
581 C<&CheckReserves> returns a two-element list:
583 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
585 C<$reserve> is the reserve item that matched. It is a
586 reference-to-hash whose keys are mostly the fields of the reserves
587 table in the Koha database.
592 my ( $item, $barcode ) = @_;
593 my $dbh = C4::Context->dbh;
596 my $qitem = $dbh->quote($item);
597 # Look up the item by itemnumber
599 SELECT items.biblionumber, items.biblioitemnumber, itemtypes.notforloan, items.notforloan AS itemnotforloan
601 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
602 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
603 WHERE itemnumber=$qitem
605 $sth = $dbh->prepare($query);
608 my $qbc = $dbh->quote($barcode);
609 # Look up the item by barcode
611 SELECT items.biblionumber, items.biblioitemnumber, itemtypes.notforloan, items.notforloan AS itemnotforloan
613 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
614 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
615 WHERE items.biblioitemnumber = biblioitems.biblioitemnumber
616 AND biblioitems.itemtype = itemtypes.itemtype
619 $sth = $dbh->prepare($query);
621 # FIXME - This function uses $item later on. Ought to set it here.
624 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item ) = $sth->fetchrow_array;
626 # if item is not for loan it cannot be reserved either.....
627 # execption to notforloan is where items.notforloan < 0 : This indicates the item is holdable.
628 return ( 0, 0 ) if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
630 # get the reserves...
631 # Find this item in the reserves
632 my @reserves = _Findgroupreserve( $bibitem, $biblio, $item );
633 my $count = scalar @reserves;
635 # $priority and $highest are used to find the most important item
636 # in the list returned by &_Findgroupreserve. (The lower $priority,
637 # the more important the item.)
638 # $highest is the most important item we've seen so far.
639 my $priority = 10000000;
642 foreach my $res (@reserves) {
643 # FIXME - $item might be undefined or empty: the caller
644 # might be searching by barcode.
645 if ( $res->{'itemnumber'} == $item && $res->{'priority'} == 0) {
647 return ( "Waiting", $res );
650 # See if this item is more important than what we've got
652 if ( $res->{'priority'} != 0 && $res->{'priority'} < $priority )
654 $priority = $res->{'priority'};
661 # If we get this far, then no exact match was found. Print the
662 # most important item on the list. I think this tells us who's
663 # next in line to get this book.
664 if ($highest) { # FIXME - $highest might be undefined
665 $highest->{'itemnumber'} = $item;
666 return ( "Reserved", $highest );
675 &CancelReserve($biblionumber, $itemnumber, $borrowernumber);
679 Use either C<$biblionumber> or C<$itemnumber> to specify the item to
680 cancel, but not both: if both are given, C<&CancelReserve> does
683 C<$borrowernumber> is the borrower number of the patron on whose
684 behalf the book was reserved.
686 If C<$biblionumber> was given, C<&CancelReserve> also adjusts the
687 priorities of the other people who are waiting on the book.
692 my ( $biblio, $item, $borr ) = @_;
693 my $dbh = C4::Context->dbh;
694 if ( $item and $borr ) {
695 # removing a waiting reserve record....
696 # update the database...
699 SET cancellationdate = now(),
703 AND borrowernumber = ?
705 my $sth = $dbh->prepare($query);
706 $sth->execute( $item, $borr );
709 INSERT INTO old_reserves
710 SELECT * FROM reserves
712 AND borrowernumber = ?
714 $sth = $dbh->prepare($query);
715 $sth->execute( $item, $borr );
719 AND borrowernumber = ?
721 $sth = $dbh->prepare($query);
722 $sth->execute( $item, $borr );
725 # removing a reserve record....
726 # get the prioritiy on this record....
729 SELECT priority FROM reserves
730 WHERE biblionumber = ?
731 AND borrowernumber = ?
732 AND cancellationdate IS NULL
733 AND itemnumber IS NULL
735 my $sth = $dbh->prepare($query);
736 $sth->execute( $biblio, $borr );
737 ($priority) = $sth->fetchrow_array;
741 SET cancellationdate = now(),
744 WHERE biblionumber = ?
745 AND borrowernumber = ?
748 # update the database, removing the record...
749 $sth = $dbh->prepare($query);
750 $sth->execute( $biblio, $borr );
754 INSERT INTO old_reserves
755 SELECT * FROM reserves
756 WHERE biblionumber = ?
757 AND borrowernumber = ?
759 $sth = $dbh->prepare($query);
760 $sth->execute( $biblio, $borr );
764 WHERE biblionumber = ?
765 AND borrowernumber = ?
767 $sth = $dbh->prepare($query);
768 $sth->execute( $biblio, $borr );
770 # now fix the priority on the others....
771 _FixPriority( $priority, $biblio );
779 ModReserve($rank, $biblio, $borrower, $branch[, $itemnumber])
783 Change a hold request's priority or cancel it.
785 C<$rank> specifies the effect of the change. If C<$rank>
786 is 'W' or 'n', nothing happens. This corresponds to leaving a
787 request alone when changing its priority in the holds queue
790 If C<$rank> is 'del', the hold request is cancelled.
792 If C<$rank> is an integer greater than zero, the priority of
793 the request is set to that value. Since priority != 0 means
794 that the item is not waiting on the hold shelf, setting the
795 priority to a non-zero value also sets the request's found
796 status and waiting date to NULL.
798 The optional C<$itemnumber> parameter is used only when
799 C<$rank> is a non-zero integer; if supplied, the itemnumber
800 of the hold request is set accordingly; if omitted, the itemnumber
803 FIXME: Note that the forgoing can have the effect of causing
804 item-level hold requests to turn into title-level requests. This
805 will be fixed once reserves has separate columns for requested
806 itemnumber and supplying itemnumber.
811 #subroutine to update a reserve
812 my ( $rank, $biblio, $borrower, $branch , $itemnumber) = @_;
813 return if $rank eq "W";
814 return if $rank eq "n";
815 my $dbh = C4::Context->dbh;
816 if ( $rank eq "del" ) {
819 SET cancellationdate=now()
820 WHERE biblionumber = ?
821 AND borrowernumber = ?
823 my $sth = $dbh->prepare($query);
824 $sth->execute( $biblio, $borrower );
827 INSERT INTO old_reserves
830 WHERE biblionumber = ?
831 AND borrowernumber = ?
833 $sth = $dbh->prepare($query);
834 $sth->execute( $biblio, $borrower );
837 WHERE biblionumber = ?
838 AND borrowernumber = ?
840 $sth = $dbh->prepare($query);
841 $sth->execute( $biblio, $borrower );
844 elsif ($rank =~ /^\d+/ and $rank > 0) {
846 UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL, waitingdate = NULL
847 WHERE biblionumber = ?
848 AND borrowernumber = ?
850 my $sth = $dbh->prepare($query);
851 $sth->execute( $rank, $branch,$itemnumber, $biblio, $borrower);
853 _FixPriority( $biblio, $borrower, $rank);
859 &ModReserveFill($reserve);
861 Fill a reserve. If I understand this correctly, this means that the
862 reserved book has been found and given to the patron who reserved it.
864 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
865 whose keys are fields from the reserves table in the Koha database.
871 my $dbh = C4::Context->dbh;
872 # fill in a reserve record....
873 my $biblionumber = $res->{'biblionumber'};
874 my $borrowernumber = $res->{'borrowernumber'};
875 my $resdate = $res->{'reservedate'};
877 # get the priority on this record....
879 my $query = "SELECT priority
881 WHERE biblionumber = ?
882 AND borrowernumber = ?
883 AND reservedate = ?";
884 my $sth = $dbh->prepare($query);
885 $sth->execute( $biblionumber, $borrowernumber, $resdate );
886 ($priority) = $sth->fetchrow_array;
889 # update the database...
890 $query = "UPDATE reserves
893 WHERE biblionumber = ?
895 AND borrowernumber = ?
897 $sth = $dbh->prepare($query);
898 $sth->execute( $biblionumber, $resdate, $borrowernumber );
901 # move to old_reserves
902 $query = "INSERT INTO old_reserves
903 SELECT * FROM reserves
904 WHERE biblionumber = ?
906 AND borrowernumber = ?
908 $sth = $dbh->prepare($query);
909 $sth->execute( $biblionumber, $resdate, $borrowernumber );
910 $query = "DELETE FROM reserves
911 WHERE biblionumber = ?
913 AND borrowernumber = ?
915 $sth = $dbh->prepare($query);
916 $sth->execute( $biblionumber, $resdate, $borrowernumber );
918 # now fix the priority on the others (if the priority wasn't
919 # already sorted!)....
920 unless ( $priority == 0 ) {
921 _FixPriority( $priority, $biblionumber );
925 =item ModReserveStatus
927 &ModReserveStatus($itemnumber, $newstatus);
929 Update the reserve status for the active (priority=0) reserve.
931 $itemnumber is the itemnumber the reserve is on
933 $newstatus is the new status.
937 sub ModReserveStatus {
939 #first : check if we have a reservation for this item .
940 my ($itemnumber, $newstatus) = @_;
941 my $dbh = C4::Context->dbh;
942 my $query = " UPDATE reserves
943 SET found=?,waitingdate = now()
948 my $sth_set = $dbh->prepare($query);
949 $sth_set->execute( $newstatus, $itemnumber );
952 =item ModReserveAffect
954 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend);
956 This function affect an item and a status for a given reserve
957 The itemnumber parameter is used to find the biblionumber.
958 with the biblionumber & the borrowernumber, we can affect the itemnumber
959 to the correct reserve.
961 if $transferToDo is not set, then the status is set to "Waiting" as well.
962 otherwise, a transfer is on the way, and the end of the transfer will
963 take care of the waiting status
966 sub ModReserveAffect {
967 my ( $itemnumber, $borrowernumber,$transferToDo ) = @_;
968 my $dbh = C4::Context->dbh;
970 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
971 # attached to $itemnumber
972 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
973 $sth->execute($itemnumber);
974 my ($biblionumber) = $sth->fetchrow;
975 # If we affect a reserve that has to be transfered, don't set to Waiting
982 WHERE borrowernumber = ?
987 # affect the reserve to Waiting as well.
994 WHERE borrowernumber = ?
998 $sth = $dbh->prepare($query);
999 $sth->execute( $itemnumber, $borrowernumber,$biblionumber);
1000 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo );
1005 =item ModReserveCancelAll
1007 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1009 function to cancel reserv,check other reserves, and transfer document if it's necessary
1013 sub ModReserveCancelAll {
1016 my ( $itemnumber, $borrowernumber ) = @_;
1018 #step 1 : cancel the reservation
1019 my $CancelReserve = CancelReserve( undef, $itemnumber, $borrowernumber );
1021 #step 2 launch the subroutine of the others reserves
1022 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1024 return ( $messages, $nextreservinfo );
1027 =item ModReserveMinusPriority
1029 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1031 Reduce the values of queuded list
1035 sub ModReserveMinusPriority {
1036 my ( $itemnumber, $borrowernumber, $biblionumber ) = @_;
1038 #first step update the value of the first person on reserv
1039 my $dbh = C4::Context->dbh;
1042 SET priority = 0 , itemnumber = ?
1043 WHERE borrowernumber=?
1046 my $sth_upd = $dbh->prepare($query);
1047 $sth_upd->execute( $itemnumber, $borrowernumber, $biblionumber );
1048 # second step update all others reservs
1049 _FixPriority($biblionumber, $borrowernumber, '0');
1052 =item GetReserveInfo
1054 &GetReserveInfo($borrowernumber,$biblionumber);
1056 Get item and borrower details for a current hold.
1057 Current implementation this query should have a single result.
1060 sub GetReserveInfo {
1061 my ( $borrowernumber, $biblionumber ) = @_;
1062 my $dbh = C4::Context->dbh;
1063 my $strsth="SELECT reservedate, reservenotes, reserves.borrowernumber,
1064 reserves.biblionumber, reserves.branchcode,
1065 notificationdate, reminderdate, priority, found,
1066 firstname, surname, phone,
1067 email, address, address2,
1068 cardnumber, city, zipcode,
1069 biblio.title, biblio.author,
1070 items.holdingbranch, items.itemcallnumber, items.itemnumber,
1072 FROM reserves left join items
1073 ON items.itemnumber=reserves.itemnumber ,
1076 reserves.borrowernumber=? &&
1077 reserves.biblionumber=? &&
1078 reserves.borrowernumber=borrowers.borrowernumber &&
1079 reserves.biblionumber=biblio.biblionumber ";
1080 my $sth = $dbh->prepare($strsth);
1081 $sth->execute($borrowernumber,$biblionumber);
1083 my $data = $sth->fetchrow_hashref;
1088 =item IsAvailableForItemLevelRequest
1092 my $is_available = IsAvailableForItemLevelRequest($itemnumber);
1096 Checks whether a given item record is available for an
1097 item-level hold request. An item is available if
1099 * it is not lost AND
1100 * it is not damaged AND
1101 * it is not withdrawn AND
1102 * does not have a not for loan value > 0
1104 Whether or not the item is currently on loan is
1105 also checked - if the AllowOnShelfHolds system preference
1106 is ON, an item can be requested even if it is currently
1107 on loan to somebody else. If the system preference
1108 is OFF, an item that is currently checked out cannot
1109 be the target of an item-level hold request.
1111 Note that IsAvailableForItemLevelRequest() does not
1112 check if the staff operator is authorized to place
1113 a request on the item - in particular,
1114 this routine does not check IndependantBranches
1115 and canreservefromotherbranches.
1119 sub IsAvailableForItemLevelRequest {
1120 my $itemnumber = shift;
1122 my $item = GetItem($itemnumber);
1124 # must check the notforloan setting of the itemtype
1125 # FIXME - a lot of places in the code do this
1126 # or something similar - need to be
1128 my $dbh = C4::Context->dbh;
1129 my $notforloan_query;
1130 if (C4::Context->preference('item-level_itypes')) {
1131 $notforloan_query = "SELECT itemtypes.notforloan
1133 JOIN itemtypes ON (itemtypes.itemtype = items.itype)
1134 WHERE itemnumber = ?";
1136 $notforloan_query = "SELECT itemtypes.notforloan
1138 JOIN biblioitems USING (biblioitemnumber)
1139 JOIN itemtypes USING (itemtype)
1140 WHERE itemnumber = ?";
1142 my $sth = $dbh->prepare($notforloan_query);
1143 $sth->execute($itemnumber);
1144 my $notforloan_per_itemtype = 0;
1145 if (my ($notforloan) = $sth->fetchrow_array) {
1146 $notforloan_per_itemtype = 1 if $notforloan;
1149 my $available_per_item = 1;
1150 $available_per_item = 0 if $item->{itemlost} or
1151 ( $item->{notforloan} > 0 ) or
1152 ($item->{damaged} and not C4::Context->preference('AllowHoldsOnDamagedItems')) or
1153 $item->{wthdrawn} or
1154 $notforloan_per_itemtype;
1157 if (C4::Context->preference('AllowOnShelfHolds')) {
1158 return $available_per_item;
1160 return ($available_per_item and $item->{onloan});
1166 &_FixPriority($biblio,$borrowernumber,$rank);
1168 Only used internally (so don't export it)
1169 Changed how this functions works #
1170 Now just gets an array of reserves in the rank order and updates them with
1171 the array index (+1 as array starts from 0)
1172 and if $rank is supplied will splice item from the array and splice it back in again
1173 in new priority rank
1178 my ( $biblio, $borrowernumber, $rank ) = @_;
1179 my $dbh = C4::Context->dbh;
1180 if ( $rank eq "del" ) {
1181 CancelReserve( $biblio, undef, $borrowernumber );
1183 if ( $rank eq "W" || $rank eq "0" ) {
1185 # make sure priority for waiting items is 0
1189 WHERE biblionumber = ?
1190 AND borrowernumber = ?
1193 my $sth = $dbh->prepare($query);
1194 $sth->execute( $biblio, $borrowernumber );
1200 # FIXME adding a new security in returned elements for changing priority,
1201 # now, we don't care anymore any reservations with itemnumber linked (suppose a waiting reserve)
1202 # This is wrong a waiting reserve has W set
1203 # The assumption that having an itemnumber set means waiting is wrong and should be corrected any place it occurs
1205 SELECT borrowernumber, reservedate, constrainttype
1207 WHERE biblionumber = ?
1208 AND ((found <> 'W') or found is NULL)
1209 ORDER BY priority ASC
1211 my $sth = $dbh->prepare($query);
1212 $sth->execute($biblio);
1213 while ( my $line = $sth->fetchrow_hashref ) {
1214 push( @reservedates, $line );
1215 push( @priority, $line );
1218 # To find the matching index
1220 my $key = -1; # to allow for 0 to be a valid result
1221 for ( $i = 0 ; $i < @priority ; $i++ ) {
1222 if ( $borrowernumber == $priority[$i]->{'borrowernumber'} ) {
1223 $key = $i; # save the index
1228 # if index exists in array then move it to new position
1229 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1230 my $new_rank = $rank -
1231 1; # $new_rank is what you want the new index to be in the array
1232 my $moving_item = splice( @priority, $key, 1 );
1233 splice( @priority, $new_rank, 0, $moving_item );
1236 # now fix the priority on those that are left....
1240 WHERE biblionumber = ?
1241 AND borrowernumber = ?
1245 $sth = $dbh->prepare($query);
1246 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1249 $priority[$j]->{'borrowernumber'},
1250 $priority[$j]->{'reservedate'}
1256 =item _Findgroupreserve
1258 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber);
1261 I don't know what this does, because I don't understand how reserve
1262 constraints work. I think the idea is that you reserve a particular
1263 biblio, and the constraint allows you to restrict it to a given
1264 biblioitem (e.g., if you want to borrow the audio book edition of "The
1265 Prophet", rather than the first available publication).
1267 C<&_Findgroupreserve> returns :
1268 C<@results> is an array of references-to-hash whose keys are mostly
1269 fields from the reserves table of the Koha database, plus
1270 C<biblioitemnumber>.
1274 sub _Findgroupreserve {
1275 my ( $bibitem, $biblio, $itemnumber ) = @_;
1276 my $dbh = C4::Context->dbh;
1278 # check for exact targetted match
1279 my $item_level_target_query = qq/
1280 SELECT reserves.biblionumber AS biblionumber,
1281 reserves.borrowernumber AS borrowernumber,
1282 reserves.reservedate AS reservedate,
1283 reserves.branchcode AS branchcode,
1284 reserves.cancellationdate AS cancellationdate,
1285 reserves.found AS found,
1286 reserves.reservenotes AS reservenotes,
1287 reserves.priority AS priority,
1288 reserves.timestamp AS timestamp,
1289 biblioitems.biblioitemnumber AS biblioitemnumber,
1290 reserves.itemnumber AS itemnumber
1292 JOIN biblioitems USING (biblionumber)
1293 JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
1296 AND item_level_request = 1
1299 my $sth = $dbh->prepare($item_level_target_query);
1300 $sth->execute($itemnumber);
1302 if ( my $data = $sth->fetchrow_hashref ) {
1303 push( @results, $data );
1305 return @results if @results;
1307 # check for title-level targetted match
1308 my $title_level_target_query = qq/
1309 SELECT reserves.biblionumber AS biblionumber,
1310 reserves.borrowernumber AS borrowernumber,
1311 reserves.reservedate AS reservedate,
1312 reserves.branchcode AS branchcode,
1313 reserves.cancellationdate AS cancellationdate,
1314 reserves.found AS found,
1315 reserves.reservenotes AS reservenotes,
1316 reserves.priority AS priority,
1317 reserves.timestamp AS timestamp,
1318 biblioitems.biblioitemnumber AS biblioitemnumber,
1319 reserves.itemnumber AS itemnumber
1321 JOIN biblioitems USING (biblionumber)
1322 JOIN hold_fill_targets USING (biblionumber, borrowernumber)
1325 AND item_level_request = 0
1326 AND hold_fill_targets.itemnumber = ?
1328 $sth = $dbh->prepare($title_level_target_query);
1329 $sth->execute($itemnumber);
1331 if ( my $data = $sth->fetchrow_hashref ) {
1332 push( @results, $data );
1334 return @results if @results;
1337 SELECT reserves.biblionumber AS biblionumber,
1338 reserves.borrowernumber AS borrowernumber,
1339 reserves.reservedate AS reservedate,
1340 reserves.branchcode AS branchcode,
1341 reserves.cancellationdate AS cancellationdate,
1342 reserves.found AS found,
1343 reserves.reservenotes AS reservenotes,
1344 reserves.priority AS priority,
1345 reserves.timestamp AS timestamp,
1346 reserveconstraints.biblioitemnumber AS biblioitemnumber,
1347 reserves.itemnumber AS itemnumber
1349 LEFT JOIN reserveconstraints ON reserves.biblionumber = reserveconstraints.biblionumber
1350 WHERE reserves.biblionumber = ?
1351 AND ( ( reserveconstraints.biblioitemnumber = ?
1352 AND reserves.borrowernumber = reserveconstraints.borrowernumber
1353 AND reserves.reservedate =reserveconstraints.reservedate )
1354 OR reserves.constrainttype='a' )
1355 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1357 $sth = $dbh->prepare($query);
1358 $sth->execute( $biblio, $bibitem, $itemnumber );
1360 while ( my $data = $sth->fetchrow_hashref ) {
1361 push( @results, $data );
1366 =item _koha_notify_reserve
1370 _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber );
1374 Sends a notification to the patron that their hold has been filled (through
1375 ModReserveAffect, _not_ ModReserveFill)
1379 sub _koha_notify_reserve {
1380 my ($itemnumber, $borrowernumber, $biblionumber) = @_;
1382 my $dbh = C4::Context->dbh;
1383 my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber, message_name => 'Hold Filled' } );
1385 return if ( !defined( $messagingprefs->{'letter_code'} ) );
1387 my $sth = $dbh->prepare("
1390 WHERE borrowernumber = ?
1391 AND biblionumber = ?
1393 $sth->execute( $borrowernumber, $biblionumber );
1394 my $reserve = $sth->fetchrow_hashref;
1395 my $branch_details = GetBranchDetail( $reserve->{'branchcode'} );
1397 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
1399 my $letter = getletter( 'reserves', $messagingprefs->{'letter_code'} );
1401 C4::Letters::parseletter( $letter, 'branches', $reserve->{'branchcode'} );
1402 C4::Letters::parseletter( $letter, 'borrowers', $reserve->{'borrowernumber'} );
1403 C4::Letters::parseletter( $letter, 'biblio', $reserve->{'biblionumber'} );
1404 C4::Letters::parseletter( $letter, 'reserves', $reserve->{'borrowernumber'}, $reserve->{'biblionumber'} );
1406 if ( $reserve->{'itemnumber'} ) {
1407 C4::Letters::parseletter( $letter, 'items', $reserve->{'itemnumber'} );
1409 $letter->{'content'} =~ s/<<[a-z0-9_]+\.[a-z0-9]+>>//g; #remove any stragglers
1411 if ( -1 != firstidx { $_ eq 'email' } @{$messagingprefs->{transports}} ) {
1412 # aka, 'email' in ->{'transports'}
1413 C4::Letters::EnqueueLetter(
1414 { letter => $letter,
1415 borrowernumber => $borrowernumber,
1416 message_transport_type => 'email',
1417 from_address => $admin_email_address,
1422 if ( -1 != firstidx { $_ eq 'sms' } @{$messagingprefs->{transports}} ) {
1423 C4::Letters::EnqueueLetter(
1424 { letter => $letter,
1425 borrowernumber => $borrowernumber,
1426 message_transport_type => 'sms',
1436 Koha Developement team <info@koha.org>