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 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
36 my $library_name = C4::Context->preference("LibraryName");
40 C4::Reserves - Koha functions for dealing with reservation.
48 this modules provides somes functions to deal with reservations.
50 Reserves are stored in reserves table.
51 The following columns contains important values :
52 - priority >0 : then the reserve is at 1st stage, and not yet affected to any item.
53 =0 : then the reserve is being dealed
54 - found : NULL : means the patron requested the 1st available, and we haven't choosen the item
55 W(aiting) : the reserve has an itemnumber affected, and is on the way
56 F(inished) : the reserve has been completed, and is done
57 - itemnumber : empty : the reserve is still unaffected to an item
58 filled: the reserve is attached to an item
59 The complete workflow is :
60 ==== 1st use case ====
61 patron request a document, 1st available : P >0, F=NULL, I=NULL
62 a library having it run "transfertodo", and clic on the list
63 if there is no transfer to do, the reserve waiting
64 patron can pick it up P =0, F=W, I=filled
65 if there is a transfer to do, write in branchtransfer P =0, F=NULL, I=filled
66 The pickup library recieve the book, it check in P =0, F=W, I=filled
67 The patron borrow the book P =0, F=F, I=filled
69 ==== 2nd use case ====
70 patron requests a document, a given item,
71 If pickup is holding branch P =0, F=W, I=filled
72 If transfer needed, write in branchtransfer P =0, F=NULL, I=filled
73 The pickup library recieve the book, it checks it in P =0, F=W, I=filled
74 The patron borrow the book P =0, F=F, I=filled
83 # set the version for version checking
90 &GetReservesFromItemnumber
91 &GetReservesFromBiblionumber
92 &GetReservesFromBorrowernumber
106 &ModReserveMinusPriority
111 &IsAvailableForItemLevelRequest
117 AddReserve($branch,$borrowernumber,$biblionumber,$constraint,$bibitems,$priority,$notes,$title,$checkitem,$found)
123 $branch, $borrowernumber, $biblionumber,
124 $constraint, $bibitems, $priority, $notes,
125 $title, $checkitem, $found
128 GetReserveFee($borrowernumber, $biblionumber, $constraint,
130 my $dbh = C4::Context->dbh;
131 my $const = lc substr( $constraint, 0, 1 );
132 my @datearr = localtime(time);
134 ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
137 # If the reserv had the waiting status, we had the value of the resdate
138 if ( $found eq 'W' ) {
139 $waitingdate = $resdate;
143 # updates take place here
145 my $nextacctno = &getnextacctno( $borrowernumber );
147 INSERT INTO accountlines
148 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
150 (?,?,now(),?,?,'Res',?)
152 my $usth = $dbh->prepare($query);
153 $usth->execute( $borrowernumber, $nextacctno, $fee,
154 "Reserve Charge - $title", $fee );
160 (borrowernumber,biblionumber,reservedate,branchcode,constrainttype,
161 priority,reservenotes,itemnumber,found,waitingdate)
166 my $sth = $dbh->prepare($query);
168 $borrowernumber, $biblionumber, $resdate, $branch,
169 $const, $priority, $notes, $checkitem,
174 ($const eq "o" || $const eq "e") or return; # FIXME: why not have a useful return value?
176 INSERT INTO reserveconstraints
177 (borrowernumber,biblionumber,reservedate,biblioitemnumber)
181 $sth = $dbh->prepare($query); # keep prepare outside the loop!
182 foreach (@$bibitems) {
183 $sth->execute($borrowernumber, $biblionumber, $resdate, $_);
185 return; # FIXME: why not have a useful return value?
188 =item GetReservesFromBiblionumber
190 @borrowerreserv=&GetReserves($biblionumber,$itemnumber,$borrowernumber);
192 this function get the list of reservation for an C<$biblionumber>, C<$itemnumber> or C<$borrowernumber>
194 Only 1 argument has to be passed.
198 sub GetReservesFromBiblionumber {
199 my ( $biblionumber, $itemnumber, $borrowernumber ) = @_;
200 my $dbh = C4::Context->dbh;
202 # Find the desired items in the reserves
205 timestamp AS rtimestamp,
215 WHERE biblionumber = ?
217 my $sth = $dbh->prepare($query);
218 $sth->execute($biblionumber);
221 while ( my $data = $sth->fetchrow_hashref ) {
223 # FIXME - What is this doing? How do constraints work?
224 if ($data->{constrainttype} eq 'o') {
226 SELECT biblioitemnumber
227 FROM reserveconstraints
228 WHERE biblionumber = ?
229 AND borrowernumber = ?
232 my $csth = $dbh->prepare($query);
233 $csth->execute( $data->{biblionumber}, $data->{borrowernumber},
234 $data->{reservedate}, );
237 while ( my $bibitemnos = $csth->fetchrow_array ) {
238 push( @bibitemno, $bibitemnos ); # FIXME: inefficient: use fetchall_arrayref
240 my $count = scalar @bibitemno;
242 # if we have two or more different specific itemtypes
243 # reserved by same person on same day
246 $bdata = GetBiblioItemData( $bibitemno[$i] );
250 # Look up the book we just found.
251 $bdata = GetBiblioItemData( $bibitemno[0] );
253 # Add the results of this latest search to the current
255 # FIXME - An 'each' would probably be more efficient.
256 foreach my $key ( keys %$bdata ) {
257 $data->{$key} = $bdata->{$key};
260 push @results, $data;
262 return ( $#results + 1, \@results );
265 =item GetReservesFromItemnumber
267 ( $reservedate, $borrowernumber, $branchcode ) = GetReservesFromItemnumber($itemnumber);
269 TODO :: Description here
273 sub GetReservesFromItemnumber {
274 my ( $itemnumber ) = @_;
275 my $dbh = C4::Context->dbh;
277 SELECT reservedate,borrowernumber,branchcode
281 my $sth_res = $dbh->prepare($query);
282 $sth_res->execute($itemnumber);
283 my ( $reservedate, $borrowernumber,$branchcode ) = $sth_res->fetchrow_array;
284 return ( $reservedate, $borrowernumber, $branchcode );
287 =item GetReservesFromBorrowernumber
289 $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
295 sub GetReservesFromBorrowernumber {
296 my ( $borrowernumber, $status ) = @_;
297 my $dbh = C4::Context->dbh;
300 $sth = $dbh->prepare("
303 WHERE borrowernumber=?
307 $sth->execute($borrowernumber,$status);
309 $sth = $dbh->prepare("
312 WHERE borrowernumber=?
315 $sth->execute($borrowernumber);
317 my $data = $sth->fetchall_arrayref({});
320 #-------------------------------------------------------------------------------------
322 =item GetReserveCount
324 $number = &GetReserveCount($borrowernumber);
326 this function returns the number of reservation for a borrower given on input arg.
330 sub GetReserveCount {
331 my ($borrowernumber) = @_;
333 my $dbh = C4::Context->dbh;
336 SELECT COUNT(*) AS counter
338 WHERE borrowernumber = ?
340 my $sth = $dbh->prepare($query);
341 $sth->execute($borrowernumber);
342 my $row = $sth->fetchrow_hashref;
343 return $row->{counter};
346 =item GetOtherReserves
348 ($messages,$nextreservinfo)=$GetOtherReserves(itemnumber);
350 Check queued list of this document and check if this document must be transfered
354 sub GetOtherReserves {
355 my ($itemnumber) = @_;
358 my ( $restype, $checkreserves ) = CheckReserves($itemnumber);
359 if ($checkreserves) {
360 my $iteminfo = GetItem($itemnumber);
361 if ( $iteminfo->{'holdingbranch'} ne $checkreserves->{'branchcode'} ) {
362 $messages->{'transfert'} = $checkreserves->{'branchcode'};
363 #minus priorities of others reservs
364 ModReserveMinusPriority(
366 $checkreserves->{'borrowernumber'},
367 $iteminfo->{'biblionumber'}
370 #launch the subroutine dotransfer
371 C4::Items::ModItemTransfer(
373 $iteminfo->{'holdingbranch'},
374 $checkreserves->{'branchcode'}
379 #step 2b : case of a reservation on the same branch, set the waiting status
381 $messages->{'waiting'} = 1;
382 ModReserveMinusPriority(
384 $checkreserves->{'borrowernumber'},
385 $iteminfo->{'biblionumber'}
387 ModReserveStatus($itemnumber,'W');
390 $nextreservinfo = $checkreserves->{'borrowernumber'};
393 return ( $messages, $nextreservinfo );
398 $fee = GetReserveFee($borrowernumber,$biblionumber,$constraint,$biblionumber);
400 Calculate the fee for a reserve
405 my ($borrowernumber, $biblionumber, $constraint, $bibitems ) = @_;
408 my $dbh = C4::Context->dbh;
409 my $const = lc substr( $constraint, 0, 1 );
411 SELECT * FROM borrowers
412 LEFT JOIN categories ON borrowers.categorycode = categories.categorycode
413 WHERE borrowernumber = ?
415 my $sth = $dbh->prepare($query);
416 $sth->execute($borrowernumber);
417 my $data = $sth->fetchrow_hashref;
419 my $fee = $data->{'reservefee'};
420 my $cntitems = @- > $bibitems;
424 # check for items on issue
425 # first find biblioitem records
427 my $sth1 = $dbh->prepare(
428 "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber
429 WHERE (biblio.biblionumber = ?)"
431 $sth1->execute($biblionumber);
432 while ( my $data1 = $sth1->fetchrow_hashref ) {
433 if ( $const eq "a" ) {
434 push @biblioitems, $data1;
439 while ( $x < $cntitems ) {
440 if ( @$bibitems->{'biblioitemnumber'} ==
441 $data->{'biblioitemnumber'} )
447 if ( $const eq 'o' ) {
449 push @biblioitems, $data1;
454 push @biblioitems, $data1;
460 my $cntitemsfound = @biblioitems;
464 while ( $x < $cntitemsfound ) {
465 my $bitdata = $biblioitems[$x];
466 my $sth2 = $dbh->prepare(
468 WHERE biblioitemnumber = ?"
470 $sth2->execute( $bitdata->{'biblioitemnumber'} );
471 while ( my $itdata = $sth2->fetchrow_hashref ) {
472 my $sth3 = $dbh->prepare(
473 "SELECT * FROM issues
474 WHERE itemnumber = ?"
476 $sth3->execute( $itdata->{'itemnumber'} );
477 if ( my $isdata = $sth3->fetchrow_hashref ) {
485 if ( $allissued == 0 ) {
487 $dbh->prepare("SELECT * FROM reserves WHERE biblionumber = ?");
488 $rsth->execute($biblionumber);
489 if ( my $rdata = $rsth->fetchrow_hashref ) {
499 =item GetReservesToBranch
501 @transreserv = GetReservesToBranch( $frombranch );
503 Get reserve list for a given branch
507 sub GetReservesToBranch {
508 my ( $frombranch ) = @_;
509 my $dbh = C4::Context->dbh;
510 my $sth = $dbh->prepare(
511 "SELECT borrowernumber,reservedate,itemnumber,timestamp
516 $sth->execute( $frombranch );
519 while ( my $data = $sth->fetchrow_hashref ) {
520 $transreserv[$i] = $data;
523 return (@transreserv);
526 =item GetReservesForBranch
528 @transreserv = GetReservesForBranch($frombranch);
532 sub GetReservesForBranch {
533 my ($frombranch) = @_;
534 my $dbh = C4::Context->dbh;
535 my $query = "SELECT borrowernumber,reservedate,itemnumber,waitingdate
540 $query .= " AND branchcode=? ";
542 $query .= "ORDER BY waitingdate" ;
543 my $sth = $dbh->prepare($query);
545 $sth->execute($frombranch);
552 while ( my $data = $sth->fetchrow_hashref ) {
553 $transreserv[$i] = $data;
556 return (@transreserv);
561 ($status, $reserve) = &CheckReserves($itemnumber);
563 Find a book in the reserves.
565 C<$itemnumber> is the book's item number.
567 As I understand it, C<&CheckReserves> looks for the given item in the
568 reserves. If it is found, that's a match, and C<$status> is set to
571 Otherwise, it finds the most important item in the reserves with the
572 same biblio number as this book (I'm not clear on this) and returns it
573 with C<$status> set to C<Reserved>.
575 C<&CheckReserves> returns a two-element list:
577 C<$status> is either C<Waiting>, C<Reserved> (see above), or 0.
579 C<$reserve> is the reserve item that matched. It is a
580 reference-to-hash whose keys are mostly the fields of the reserves
581 table in the Koha database.
586 my ( $item, $barcode ) = @_;
587 my $dbh = C4::Context->dbh;
590 my $qitem = $dbh->quote($item);
591 # Look up the item by itemnumber
593 SELECT items.biblionumber, items.biblioitemnumber, itemtypes.notforloan, items.notforloan AS itemnotforloan
595 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
596 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
597 WHERE itemnumber=$qitem
599 $sth = $dbh->prepare($query);
602 my $qbc = $dbh->quote($barcode);
603 # Look up the item by barcode
605 SELECT items.biblionumber, items.biblioitemnumber, itemtypes.notforloan, items.notforloan AS itemnotforloan
607 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
608 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
609 WHERE items.biblioitemnumber = biblioitems.biblioitemnumber
610 AND biblioitems.itemtype = itemtypes.itemtype
613 $sth = $dbh->prepare($query);
615 # FIXME - This function uses $item later on. Ought to set it here.
618 my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item ) = $sth->fetchrow_array;
620 # if item is not for loan it cannot be reserved either.....
621 # execption to notforloan is where items.notforloan < 0 : This indicates the item is holdable.
622 return ( 0, 0 ) if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype;
624 # get the reserves...
625 # Find this item in the reserves
626 my @reserves = _Findgroupreserve( $bibitem, $biblio, $item );
627 my $count = scalar @reserves;
629 # $priority and $highest are used to find the most important item
630 # in the list returned by &_Findgroupreserve. (The lower $priority,
631 # the more important the item.)
632 # $highest is the most important item we've seen so far.
633 my $priority = 10000000;
636 foreach my $res (@reserves) {
637 # FIXME - $item might be undefined or empty: the caller
638 # might be searching by barcode.
639 if ( $res->{'itemnumber'} == $item && $res->{'priority'} == 0) {
641 return ( "Waiting", $res );
644 # See if this item is more important than what we've got
646 if ( $res->{'priority'} != 0 && $res->{'priority'} < $priority )
648 $priority = $res->{'priority'};
655 # If we get this far, then no exact match was found. Print the
656 # most important item on the list. I think this tells us who's
657 # next in line to get this book.
658 if ($highest) { # FIXME - $highest might be undefined
659 $highest->{'itemnumber'} = $item;
660 return ( "Reserved", $highest );
669 &CancelReserve($biblionumber, $itemnumber, $borrowernumber);
673 Use either C<$biblionumber> or C<$itemnumber> to specify the item to
674 cancel, but not both: if both are given, C<&CancelReserve> does
677 C<$borrowernumber> is the borrower number of the patron on whose
678 behalf the book was reserved.
680 If C<$biblionumber> was given, C<&CancelReserve> also adjusts the
681 priorities of the other people who are waiting on the book.
686 my ( $biblio, $item, $borr ) = @_;
687 my $dbh = C4::Context->dbh;
688 if ( $item and $borr ) {
689 # removing a waiting reserve record....
690 # update the database...
693 SET cancellationdate = now(),
697 AND borrowernumber = ?
699 my $sth = $dbh->prepare($query);
700 $sth->execute( $item, $borr );
703 INSERT INTO old_reserves
704 SELECT * FROM reserves
706 AND borrowernumber = ?
708 $sth = $dbh->prepare($query);
709 $sth->execute( $item, $borr );
713 AND borrowernumber = ?
715 $sth = $dbh->prepare($query);
716 $sth->execute( $item, $borr );
719 # removing a reserve record....
720 # get the prioritiy on this record....
723 SELECT priority FROM reserves
724 WHERE biblionumber = ?
725 AND borrowernumber = ?
726 AND cancellationdate IS NULL
727 AND itemnumber IS NULL
729 my $sth = $dbh->prepare($query);
730 $sth->execute( $biblio, $borr );
731 ($priority) = $sth->fetchrow_array;
735 SET cancellationdate = now(),
738 WHERE biblionumber = ?
739 AND borrowernumber = ?
742 # update the database, removing the record...
743 $sth = $dbh->prepare($query);
744 $sth->execute( $biblio, $borr );
748 INSERT INTO old_reserves
749 SELECT * FROM reserves
750 WHERE biblionumber = ?
751 AND borrowernumber = ?
753 $sth = $dbh->prepare($query);
754 $sth->execute( $biblio, $borr );
758 WHERE biblionumber = ?
759 AND borrowernumber = ?
761 $sth = $dbh->prepare($query);
762 $sth->execute( $biblio, $borr );
764 # now fix the priority on the others....
765 _FixPriority( $priority, $biblio );
773 ModReserve($rank, $biblio, $borrower, $branch[, $itemnumber])
777 Change a hold request's priority or cancel it.
779 C<$rank> specifies the effect of the change. If C<$rank>
780 is 'W' or 'n', nothing happens. This corresponds to leaving a
781 request alone when changing its priority in the holds queue
784 If C<$rank> is 'del', the hold request is cancelled.
786 If C<$rank> is an integer greater than zero, the priority of
787 the request is set to that value. Since priority != 0 means
788 that the item is not waiting on the hold shelf, setting the
789 priority to a non-zero value also sets the request's found
790 status and waiting date to NULL.
792 The optional C<$itemnumber> parameter is used only when
793 C<$rank> is a non-zero integer; if supplied, the itemnumber
794 of the hold request is set accordingly; if omitted, the itemnumber
797 FIXME: Note that the forgoing can have the effect of causing
798 item-level hold requests to turn into title-level requests. This
799 will be fixed once reserves has separate columns for requested
800 itemnumber and supplying itemnumber.
805 #subroutine to update a reserve
806 my ( $rank, $biblio, $borrower, $branch , $itemnumber) = @_;
807 return if $rank eq "W";
808 return if $rank eq "n";
809 my $dbh = C4::Context->dbh;
810 if ( $rank eq "del" ) {
813 SET cancellationdate=now()
814 WHERE biblionumber = ?
815 AND borrowernumber = ?
817 my $sth = $dbh->prepare($query);
818 $sth->execute( $biblio, $borrower );
821 INSERT INTO old_reserves
824 WHERE biblionumber = ?
825 AND borrowernumber = ?
827 $sth = $dbh->prepare($query);
828 $sth->execute( $biblio, $borrower );
831 WHERE biblionumber = ?
832 AND borrowernumber = ?
834 $sth = $dbh->prepare($query);
835 $sth->execute( $biblio, $borrower );
838 elsif ($rank =~ /^\d+/ and $rank > 0) {
840 UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL, waitingdate = NULL
841 WHERE biblionumber = ?
842 AND borrowernumber = ?
844 my $sth = $dbh->prepare($query);
845 $sth->execute( $rank, $branch,$itemnumber, $biblio, $borrower);
847 _FixPriority( $biblio, $borrower, $rank);
853 &ModReserveFill($reserve);
855 Fill a reserve. If I understand this correctly, this means that the
856 reserved book has been found and given to the patron who reserved it.
858 C<$reserve> specifies the reserve to fill. It is a reference-to-hash
859 whose keys are fields from the reserves table in the Koha database.
865 my $dbh = C4::Context->dbh;
866 # fill in a reserve record....
867 my $biblionumber = $res->{'biblionumber'};
868 my $borrowernumber = $res->{'borrowernumber'};
869 my $resdate = $res->{'reservedate'};
871 # get the priority on this record....
873 my $query = "SELECT priority
875 WHERE biblionumber = ?
876 AND borrowernumber = ?
877 AND reservedate = ?";
878 my $sth = $dbh->prepare($query);
879 $sth->execute( $biblionumber, $borrowernumber, $resdate );
880 ($priority) = $sth->fetchrow_array;
883 # update the database...
884 $query = "UPDATE reserves
887 WHERE biblionumber = ?
889 AND borrowernumber = ?
891 $sth = $dbh->prepare($query);
892 $sth->execute( $biblionumber, $resdate, $borrowernumber );
895 # move to old_reserves
896 $query = "INSERT INTO old_reserves
897 SELECT * FROM reserves
898 WHERE biblionumber = ?
900 AND borrowernumber = ?
902 $sth = $dbh->prepare($query);
903 $sth->execute( $biblionumber, $resdate, $borrowernumber );
904 $query = "DELETE FROM reserves
905 WHERE biblionumber = ?
907 AND borrowernumber = ?
909 $sth = $dbh->prepare($query);
910 $sth->execute( $biblionumber, $resdate, $borrowernumber );
912 # now fix the priority on the others (if the priority wasn't
913 # already sorted!)....
914 unless ( $priority == 0 ) {
915 _FixPriority( $priority, $biblionumber );
919 =item ModReserveStatus
921 &ModReserveStatus($itemnumber, $newstatus);
923 Update the reserve status for the active (priority=0) reserve.
925 $itemnumber is the itemnumber the reserve is on
927 $newstatus is the new status.
931 sub ModReserveStatus {
933 #first : check if we have a reservation for this item .
934 my ($itemnumber, $newstatus) = @_;
935 my $dbh = C4::Context->dbh;
936 my $query = " UPDATE reserves
937 SET found=?,waitingdate = now()
942 my $sth_set = $dbh->prepare($query);
943 $sth_set->execute( $newstatus, $itemnumber );
946 =item ModReserveAffect
948 &ModReserveAffect($itemnumber,$borrowernumber,$diffBranchSend);
950 This function affect an item and a status for a given reserve
951 The itemnumber parameter is used to find the biblionumber.
952 with the biblionumber & the borrowernumber, we can affect the itemnumber
953 to the correct reserve.
955 if $transferToDo is not set, then the status is set to "Waiting" as well.
956 otherwise, a transfer is on the way, and the end of the transfer will
957 take care of the waiting status
960 sub ModReserveAffect {
961 my ( $itemnumber, $borrowernumber,$transferToDo ) = @_;
962 my $dbh = C4::Context->dbh;
964 # we want to attach $itemnumber to $borrowernumber, find the biblionumber
965 # attached to $itemnumber
966 my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
967 $sth->execute($itemnumber);
968 my ($biblionumber) = $sth->fetchrow;
969 # If we affect a reserve that has to be transfered, don't set to Waiting
976 WHERE borrowernumber = ?
981 # affect the reserve to Waiting as well.
988 WHERE borrowernumber = ?
992 $sth = $dbh->prepare($query);
993 $sth->execute( $itemnumber, $borrowernumber,$biblionumber);
998 =item ModReserveCancelAll
1000 ($messages,$nextreservinfo) = &ModReserveCancelAll($itemnumber,$borrowernumber);
1002 function to cancel reserv,check other reserves, and transfer document if it's necessary
1006 sub ModReserveCancelAll {
1009 my ( $itemnumber, $borrowernumber ) = @_;
1011 #step 1 : cancel the reservation
1012 my $CancelReserve = CancelReserve( undef, $itemnumber, $borrowernumber );
1014 #step 2 launch the subroutine of the others reserves
1015 ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
1017 return ( $messages, $nextreservinfo );
1020 =item ModReserveMinusPriority
1022 &ModReserveMinusPriority($itemnumber,$borrowernumber,$biblionumber)
1024 Reduce the values of queuded list
1028 sub ModReserveMinusPriority {
1029 my ( $itemnumber, $borrowernumber, $biblionumber ) = @_;
1031 #first step update the value of the first person on reserv
1032 my $dbh = C4::Context->dbh;
1035 SET priority = 0 , itemnumber = ?
1036 WHERE borrowernumber=?
1039 my $sth_upd = $dbh->prepare($query);
1040 $sth_upd->execute( $itemnumber, $borrowernumber, $biblionumber );
1041 # second step update all others reservs
1044 SET priority = priority-1
1045 WHERE biblionumber = ?
1048 $sth_upd = $dbh->prepare($query);
1049 $sth_upd->execute( $biblionumber );
1054 =item GetReserveInfo
1056 &GetReserveInfo($borrowernumber,$biblionumber);
1058 Get item and borrower details for a current hold.
1059 Current implementation this query should have a single result.
1062 sub GetReserveInfo {
1063 my ( $borrowernumber, $biblionumber ) = @_;
1064 my $dbh = C4::Context->dbh;
1065 my $strsth="SELECT reservedate, reservenotes, reserves.borrowernumber,
1066 reserves.biblionumber, reserves.branchcode,
1067 notificationdate, reminderdate, priority, found,
1068 firstname, surname, phone,
1069 email, address, address2,
1070 cardnumber, city, zipcode,
1071 biblio.title, biblio.author,
1072 items.holdingbranch, items.itemcallnumber, items.itemnumber,
1074 FROM reserves left join items
1075 ON items.itemnumber=reserves.itemnumber ,
1078 reserves.borrowernumber=? &&
1079 reserves.biblionumber=? &&
1080 reserves.borrowernumber=borrowers.borrowernumber &&
1081 reserves.biblionumber=biblio.biblionumber ";
1082 my $sth = $dbh->prepare($strsth);
1083 $sth->execute($borrowernumber,$biblionumber);
1085 my $data = $sth->fetchrow_hashref;
1090 =item IsAvailableForItemLevelRequest
1094 my $is_available = IsAvailableForItemLevelRequest($itemnumber);
1098 Checks whether a given item record is available for an
1099 item-level hold request. An item is available if
1101 * it is not lost AND
1102 * it is not damaged AND
1103 * it is not withdrawn AND
1104 * does not have a not for loan value > 0
1106 Whether or not the item is currently on loan is
1107 also checked - if the AllowOnShelfHolds system preference
1108 is ON, an item can be requested even if it is currently
1109 on loan to somebody else. If the system preference
1110 is OFF, an item that is currently checked out cannot
1111 be the target of an item-level hold request.
1113 Note that IsAvailableForItemLevelRequest() does not
1114 check if the staff operator is authorized to place
1115 a request on the item - in particular,
1116 this routine does not check IndependantBranches
1117 and canreservefromotherbranches.
1121 sub IsAvailableForItemLevelRequest {
1122 my $itemnumber = shift;
1124 my $item = GetItem($itemnumber);
1126 # must check the notforloan setting of the itemtype
1127 # FIXME - a lot of places in the code do this
1128 # or something similar - need to be
1130 my $dbh = C4::Context->dbh;
1131 my $notforloan_query;
1132 if (C4::Context->preference('item-level_itypes')) {
1133 $notforloan_query = "SELECT itemtypes.notforloan
1135 JOIN itemtypes ON (itemtypes.itemtype = items.itype)
1136 WHERE itemnumber = ?";
1138 $notforloan_query = "SELECT itemtypes.notforloan
1140 JOIN biblioitems USING (biblioitemnumber)
1141 JOIN itemtypes USING (itemtype)
1142 WHERE itemnumber = ?";
1144 my $sth = $dbh->prepare($notforloan_query);
1145 $sth->execute($itemnumber);
1146 my $notforloan_per_itemtype = 0;
1147 if (my ($notforloan) = $sth->fetchrow_array) {
1148 $notforloan_per_itemtype = 1 if $notforloan;
1151 my $available_per_item = 1;
1152 $available_per_item = 0 if $item->{itemlost} or
1153 ( $item->{notforloan} > 0 ) or
1154 ($item->{damaged} and not C4::Context->preference('AllowHoldsOnDamagedItems')) or
1155 $item->{wthdrawn} or
1156 $notforloan_per_itemtype;
1158 if (C4::Context->preference('AllowOnShelfHolds')) {
1159 return $available_per_item;
1161 return ($available_per_item and $item->{onloan});
1167 &_FixPriority($biblio,$borrowernumber,$rank);
1169 Only used internally (so don't export it)
1170 Changed how this functions works #
1171 Now just gets an array of reserves in the rank order and updates them with
1172 the array index (+1 as array starts from 0)
1173 and if $rank is supplied will splice item from the array and splice it back in again
1174 in new priority rank
1179 my ( $biblio, $borrowernumber, $rank ) = @_;
1180 my $dbh = C4::Context->dbh;
1181 if ( $rank eq "del" ) {
1182 CancelReserve( $biblio, undef, $borrowernumber );
1184 if ( $rank eq "W" || $rank eq "0" ) {
1186 # make sure priority for waiting items is 0
1190 WHERE biblionumber = ?
1191 AND borrowernumber = ?
1194 my $sth = $dbh->prepare($query);
1195 $sth->execute( $biblio, $borrowernumber );
1201 # FIXME adding a new security in returned elements for changing priority,
1202 # now, we don't care anymore any reservations with itemnumber linked (suppose a waiting reserve)
1203 # This is wrong a waiting reserve has W set
1204 # The assumption that having an itemnumber set means waiting is wrong and should be corrected any place it occurs
1206 SELECT borrowernumber, reservedate, constrainttype
1208 WHERE biblionumber = ?
1209 AND ((found <> 'W') or found is NULL)
1210 ORDER BY priority ASC
1212 my $sth = $dbh->prepare($query);
1213 $sth->execute($biblio);
1214 while ( my $line = $sth->fetchrow_hashref ) {
1215 push( @reservedates, $line );
1216 push( @priority, $line );
1219 # To find the matching index
1221 my $key = -1; # to allow for 0 to be a valid result
1222 for ( $i = 0 ; $i < @priority ; $i++ ) {
1223 if ( $borrowernumber == $priority[$i]->{'borrowernumber'} ) {
1224 $key = $i; # save the index
1229 # if index exists in array then move it to new position
1230 if ( $key > -1 && $rank ne 'del' && $rank > 0 ) {
1231 my $new_rank = $rank -
1232 1; # $new_rank is what you want the new index to be in the array
1233 my $moving_item = splice( @priority, $key, 1 );
1234 splice( @priority, $new_rank, 0, $moving_item );
1237 # now fix the priority on those that are left....
1241 WHERE biblionumber = ?
1242 AND borrowernumber = ?
1246 $sth = $dbh->prepare($query);
1247 for ( my $j = 0 ; $j < @priority ; $j++ ) {
1250 $priority[$j]->{'borrowernumber'},
1251 $priority[$j]->{'reservedate'}
1257 =item _Findgroupreserve
1259 @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber);
1262 I don't know what this does, because I don't understand how reserve
1263 constraints work. I think the idea is that you reserve a particular
1264 biblio, and the constraint allows you to restrict it to a given
1265 biblioitem (e.g., if you want to borrow the audio book edition of "The
1266 Prophet", rather than the first available publication).
1268 C<&_Findgroupreserve> returns :
1269 C<@results> is an array of references-to-hash whose keys are mostly
1270 fields from the reserves table of the Koha database, plus
1271 C<biblioitemnumber>.
1275 sub _Findgroupreserve {
1276 my ( $bibitem, $biblio, $itemnumber ) = @_;
1277 my $dbh = C4::Context->dbh;
1279 SELECT reserves.biblionumber AS biblionumber,
1280 reserves.borrowernumber AS borrowernumber,
1281 reserves.reservedate AS reservedate,
1282 reserves.branchcode AS branchcode,
1283 reserves.cancellationdate AS cancellationdate,
1284 reserves.found AS found,
1285 reserves.reservenotes AS reservenotes,
1286 reserves.priority AS priority,
1287 reserves.timestamp AS timestamp,
1288 reserveconstraints.biblioitemnumber AS biblioitemnumber,
1289 reserves.itemnumber AS itemnumber
1291 LEFT JOIN reserveconstraints ON reserves.biblionumber = reserveconstraints.biblionumber
1292 WHERE reserves.biblionumber = ?
1293 AND ( ( reserveconstraints.biblioitemnumber = ?
1294 AND reserves.borrowernumber = reserveconstraints.borrowernumber
1295 AND reserves.reservedate =reserveconstraints.reservedate )
1296 OR reserves.constrainttype='a' )
1297 AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?)
1299 my $sth = $dbh->prepare($query);
1300 $sth->execute( $biblio, $bibitem, $itemnumber );
1302 while ( my $data = $sth->fetchrow_hashref ) {
1303 push( @results, $data );
1312 Koha Developement team <info@koha.org>