X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=C4%2FReserves.pm;h=8de6d3707a038dbd527f2e083eafffed3b2b0984;hb=8cd4d221d880da21a1d2c5d83fac792934f1c87e;hp=f9f974704e0a368def94880d83417248854382ea;hpb=8ee881174fbb75e983e9ea09f70b2fcecee396ab;p=koha.git diff --git a/C4/Reserves.pm b/C4/Reserves.pm old mode 100755 new mode 100644 index f9f974704e..8de6d3707a --- a/C4/Reserves.pm +++ b/C4/Reserves.pm @@ -4,6 +4,8 @@ package C4::Reserves; # Copyright 2000-2002 Katipo Communications +# 2006 SAN Ouest Provence +# 2007 BibLibre Paul POULAIN # # This file is part of Koha. # @@ -20,22 +22,19 @@ package C4::Reserves; # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place, # Suite 330, Boston, MA 02111-1307 USA -# $Id$ use strict; -require Exporter; use C4::Context; use C4::Biblio; +use C4::Items; use C4::Search; use C4::Circulation; +use C4::Accounts; -our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,%EXPORT_TAGS); +use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS); my $library_name = C4::Context->preference("LibraryName"); -# set the version for version checking -$VERSION = do { my @v = '$Revision$' =~ /\d+/g; shift(@v) . "." . join( "_", map { sprintf "%03d", $_ } @v ); }; - =head1 NAME C4::Reserves - Koha functions for dealing with reservation. @@ -47,40 +46,71 @@ C4::Reserves - Koha functions for dealing with reservation. =head1 DESCRIPTION this modules provides somes functions to deal with reservations. - + + Reserves are stored in reserves table. + The following columns contains important values : + - priority >0 : then the reserve is at 1st stage, and not yet affected to any item. + =0 : then the reserve is being dealed + - found : NULL : means the patron requested the 1st available, and we haven't choosen the item + W(aiting) : the reserve has an itemnumber affected, and is on the way + F(inished) : the reserve has been completed, and is done + - itemnumber : empty : the reserve is still unaffected to an item + filled: the reserve is attached to an item + The complete workflow is : + ==== 1st use case ==== + patron request a document, 1st available : P >0, F=NULL, I=NULL + a library having it run "transfertodo", and clic on the list + if there is no transfer to do, the reserve waiting + patron can pick it up P =0, F=W, I=filled + if there is a transfer to do, write in branchtransfer P =0, F=NULL, I=filled + The pickup library recieve the book, it check in P =0, F=W, I=filled + The patron borrow the book P =0, F=F, I=filled + + ==== 2nd use case ==== + patron requests a document, a given item, + If pickup is holding branch P =0, F=W, I=filled + If transfer needed, write in branchtransfer P =0, F=NULL, I=filled + The pickup library recieve the book, it checks it in P =0, F=W, I=filled + The patron borrow the book P =0, F=F, I=filled + =head1 FUNCTIONS =over 2 =cut -@ISA = qw(Exporter); - -@EXPORT = qw( - &AddReserve - - &GetReservesFromItemnumber - &GetReservesFromBiblionumber - &GetReservesFromBorrowernumber - &GetReservesForBranch - &GetReservesToBranch - &GetReserveCount - &GetReserveFee - &GetReservesForBranch - &GetReservesToBranch - &GetOtherReserves +BEGIN { + # set the version for version checking + $VERSION = 3.01; + require Exporter; + @ISA = qw(Exporter); + @EXPORT = qw( + &AddReserve - &ModReserveFill - &ModReserveAffect - &ModReserve - &ModReserveStatus - &ModReserveCancelAll - &ModReserveMinusPriority - - &CheckReserves - &CancelReserve -); + &GetReservesFromItemnumber + &GetReservesFromBiblionumber + &GetReservesFromBorrowernumber + &GetReservesForBranch + &GetReservesToBranch + &GetReserveCount + &GetReserveFee + &GetReserveInfo + + &GetOtherReserves + + &ModReserveFill + &ModReserveAffect + &ModReserve + &ModReserveStatus + &ModReserveCancelAll + &ModReserveMinusPriority + + &CheckReserves + &CancelReserve + &IsAvailableForItemLevelRequest + ); +} =item AddReserve @@ -188,11 +218,10 @@ sub GetReservesFromBiblionumber { reservedate, constrainttype, found, - itemnumber + itemnumber, + reservenotes FROM reserves - WHERE cancellationdate IS NULL - AND (found <> \'F\' OR found IS NULL) - AND biblionumber = ? + WHERE biblionumber = ? ORDER BY priority"; my $sth = $dbh->prepare($query); $sth->execute($biblionumber); @@ -261,8 +290,6 @@ sub GetReservesFromItemnumber { SELECT reservedate,borrowernumber,branchcode FROM reserves WHERE itemnumber=? - AND cancellationdate IS NULL - AND (found <> 'F' OR found IS NULL) "; my $sth_res = $dbh->prepare($query); $sth_res->execute($itemnumber); @@ -287,7 +314,6 @@ sub GetReservesFromBorrowernumber { SELECT * FROM reserves WHERE borrowernumber=? - AND cancellationdate IS NULL AND found =? ORDER BY reservedate "); @@ -297,8 +323,6 @@ sub GetReservesFromBorrowernumber { SELECT * FROM reserves WHERE borrowernumber=? - AND cancellationdate IS NULL - AND (found != 'F' or found is null) ORDER BY reservedate "); $sth->execute($borrowernumber); @@ -325,8 +349,6 @@ sub GetReserveCount { SELECT COUNT(*) AS counter FROM reserves WHERE borrowernumber = ? - AND cancellationdate IS NULL - AND (found != \'F\' OR found IS NULL) '; my $sth = $dbh->prepare($query); $sth->execute($borrowernumber); @@ -401,9 +423,9 @@ sub GetReserveFee { my $dbh = C4::Context->dbh; my $const = lc substr( $constraint, 0, 1 ); my $query = qq/ - SELECT * FROM borrowers,categories + SELECT * FROM borrowers + LEFT JOIN categories ON borrowers.categorycode = categories.categorycode WHERE borrowernumber = ? - AND borrowers.categorycode = categories.categorycode /; my $sth = $dbh->prepare($query); $sth->execute($borrowernumber); @@ -418,9 +440,8 @@ sub GetReserveFee { # first find biblioitem records my @biblioitems; my $sth1 = $dbh->prepare( - "SELECT * FROM biblio,biblioitems - WHERE (biblio.biblionumber = ?) - AND (biblio.biblionumber = biblioitems.biblionumber)" + "SELECT * FROM biblio LEFT JOIN biblioitems on biblio.biblionumber = biblioitems.biblionumber + WHERE (biblio.biblionumber = ?)" ); $sth1->execute($biblionumber); while ( my $data1 = $sth1->fetchrow_hashref ) { @@ -465,8 +486,7 @@ sub GetReserveFee { while ( my $itdata = $sth2->fetchrow_hashref ) { my $sth3 = $dbh->prepare( "SELECT * FROM issues - WHERE itemnumber = ? - AND returndate IS NULL" + WHERE itemnumber = ?" ); $sth3->execute( $itdata->{'itemnumber'} ); if ( my $isdata = $sth3->fetchrow_hashref ) { @@ -505,9 +525,8 @@ sub GetReservesToBranch { my $sth = $dbh->prepare( "SELECT borrowernumber,reservedate,itemnumber,timestamp FROM reserves - WHERE priority='0' AND cancellationdate is null - AND branchcode=? - AND found IS NULL " + WHERE priority='0' + AND branchcode=?" ); $sth->execute( $frombranch ); my @transreserv; @@ -529,15 +548,21 @@ sub GetReservesToBranch { sub GetReservesForBranch { my ($frombranch) = @_; my $dbh = C4::Context->dbh; - my $sth = $dbh->prepare( " - SELECT borrowernumber,reservedate,itemnumber,waitingdate + my $query = "SELECT borrowernumber,reservedate,itemnumber,waitingdate FROM reserves WHERE priority='0' - AND cancellationdate IS NULL - AND found='W' - AND branchcode=? - ORDER BY waitingdate" ); - $sth->execute($frombranch); + AND found='W' "; + if ($frombranch){ + $query .= " AND branchcode=? "; + } + $query .= "ORDER BY waitingdate" ; + my $sth = $dbh->prepare($query); + if ($frombranch){ + $sth->execute($frombranch); + } + else { + $sth->execute(); + } my @transreserv; my $i = 0; while ( my $data = $sth->fetchrow_hashref ) { @@ -582,11 +607,11 @@ sub CheckReserves { my $qitem = $dbh->quote($item); # Look up the item by itemnumber my $query = " - SELECT items.biblionumber, items.biblioitemnumber, itemtypes.notforloan - FROM items, biblioitems, itemtypes - WHERE items.biblioitemnumber = biblioitems.biblioitemnumber - AND biblioitems.itemtype = itemtypes.itemtype - AND itemnumber=$qitem + SELECT items.biblionumber, items.biblioitemnumber, itemtypes.notforloan, items.notforloan AS itemnotforloan + FROM items + LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber + LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype + WHERE itemnumber=$qitem "; $sth = $dbh->prepare($query); } @@ -594,8 +619,10 @@ sub CheckReserves { my $qbc = $dbh->quote($barcode); # Look up the item by barcode my $query = " - SELECT items.biblionumber, items.biblioitemnumber, itemtypes.notforloan - FROM items, biblioitems, itemtypes + SELECT items.biblionumber, items.biblioitemnumber, itemtypes.notforloan, items.notforloan AS itemnotforloan + FROM items + LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber + LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype WHERE items.biblioitemnumber = biblioitems.biblioitemnumber AND biblioitems.itemtype = itemtypes.itemtype AND barcode=$qbc @@ -605,15 +632,15 @@ sub CheckReserves { # FIXME - This function uses $item later on. Ought to set it here. } $sth->execute; - my ( $biblio, $bibitem, $notforloan ) = $sth->fetchrow_array; + my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item ) = $sth->fetchrow_array; $sth->finish; - # if item is not for loan it cannot be reserved either..... - return ( 0, 0 ) if $notforloan; + # execption to notforloan is where items.notforloan < 0 : This indicates the item is holdable. + return ( 0, 0 ) if ( $notforloan_per_item > 0 ) or $notforloan_per_itemtype; # get the reserves... # Find this item in the reserves - my @reserves = _Findgroupreserve( $bibitem, $biblio ); + my @reserves = _Findgroupreserve( $bibitem, $biblio, $item ); my $count = scalar @reserves; # $priority and $highest are used to find the most important item @@ -626,7 +653,7 @@ sub CheckReserves { foreach my $res (@reserves) { # FIXME - $item might be undefined or empty: the caller # might be searching by barcode. - if ( $res->{'itemnumber'} == $item ) { + if ( $res->{'itemnumber'} == $item && $res->{'priority'} == 0) { # Found it return ( "Waiting", $res ); } @@ -675,7 +702,7 @@ priorities of the other people who are waiting on the book. sub CancelReserve { my ( $biblio, $item, $borr ) = @_; my $dbh = C4::Context->dbh; - if ( ( $item and $borr ) and ( not $biblio ) ) { + if ( $item and $borr ) { # removing a waiting reserve record.... # update the database... my $query = " @@ -689,8 +716,23 @@ sub CancelReserve { my $sth = $dbh->prepare($query); $sth->execute( $item, $borr ); $sth->finish; + $query = " + INSERT INTO old_reserves + SELECT * FROM reserves + WHERE itemnumber = ? + AND borrowernumber = ? + "; + $sth = $dbh->prepare($query); + $sth->execute( $item, $borr ); + $query = " + DELETE FROM reserves + WHERE itemnumber = ? + AND borrowernumber = ? + "; + $sth = $dbh->prepare($query); + $sth->execute( $item, $borr ); } - if ( ( $biblio and $borr ) and ( not $item ) ) { + else { # removing a reserve record.... # get the prioritiy on this record.... my $priority; @@ -700,7 +742,6 @@ sub CancelReserve { AND borrowernumber = ? AND cancellationdate IS NULL AND itemnumber IS NULL - AND (found <> 'F' OR found IS NULL) /; my $sth = $dbh->prepare($query); $sth->execute( $biblio, $borr ); @@ -713,8 +754,6 @@ sub CancelReserve { priority = 0 WHERE biblionumber = ? AND borrowernumber = ? - AND cancellationdate IS NULL - AND (found <> 'F' or found IS NULL) /; # update the database, removing the record... @@ -722,6 +761,23 @@ sub CancelReserve { $sth->execute( $biblio, $borr ); $sth->finish; + $query = qq/ + INSERT INTO old_reserves + SELECT * FROM reserves + WHERE biblionumber = ? + AND borrowernumber = ? + /; + $sth = $dbh->prepare($query); + $sth->execute( $biblio, $borr ); + + $query = qq/ + DELETE FROM reserves + WHERE biblionumber = ? + AND borrowernumber = ? + /; + $sth = $dbh->prepare($query); + $sth->execute( $biblio, $borr ); + # now fix the priority on the others.... _FixPriority( $priority, $biblio ); } @@ -729,7 +785,36 @@ sub CancelReserve { =item ModReserve -&ModReserve($rank,$biblio,$borrower,$branch) +=over 4 + +ModReserve($rank, $biblio, $borrower, $branch[, $itemnumber]) + +=back + +Change a hold request's priority or cancel it. + +C<$rank> specifies the effect of the change. If C<$rank> +is 'W' or 'n', nothing happens. This corresponds to leaving a +request alone when changing its priority in the holds queue +for a bib. + +If C<$rank> is 'del', the hold request is cancelled. + +If C<$rank> is an integer greater than zero, the priority of +the request is set to that value. Since priority != 0 means +that the item is not waiting on the hold shelf, setting the +priority to a non-zero value also sets the request's found +status and waiting date to NULL. + +The optional C<$itemnumber> parameter is used only when +C<$rank> is a non-zero integer; if supplied, the itemnumber +of the hold request is set accordingly; if omitted, the itemnumber +is cleared. + +FIXME: Note that the forgoing can have the effect of causing +item-level hold requests to turn into title-level requests. This +will be fixed once reserves has separate columns for requested +itemnumber and supplying itemnumber. =cut @@ -745,21 +830,33 @@ sub ModReserve { SET cancellationdate=now() WHERE biblionumber = ? AND borrowernumber = ? - AND cancellationdate is NULL - AND (found <> 'F' or found is NULL) /; my $sth = $dbh->prepare($query); $sth->execute( $biblio, $borrower ); $sth->finish; + $query = qq/ + INSERT INTO old_reserves + SELECT * + FROM reserves + WHERE biblionumber = ? + AND borrowernumber = ? + /; + $sth = $dbh->prepare($query); + $sth->execute( $biblio, $borrower ); + $query = qq/ + DELETE FROM reserves + WHERE biblionumber = ? + AND borrowernumber = ? + /; + $sth = $dbh->prepare($query); + $sth->execute( $biblio, $borrower ); } - else { + elsif ($rank =~ /^\d+/ and $rank > 0) { my $query = qq/ - UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL + UPDATE reserves SET priority = ? ,branchcode = ?, itemnumber = ?, found = NULL, waitingdate = NULL WHERE biblionumber = ? AND borrowernumber = ? - AND cancellationdate is NULL - AND (found <> 'F' or found is NULL) /; my $sth = $dbh->prepare($query); $sth->execute( $rank, $branch,$itemnumber, $biblio, $borrower); @@ -812,6 +909,23 @@ sub ModReserveFill { $sth->execute( $biblionumber, $resdate, $borrowernumber ); $sth->finish; + # move to old_reserves + $query = "INSERT INTO old_reserves + SELECT * FROM reserves + WHERE biblionumber = ? + AND reservedate = ? + AND borrowernumber = ? + "; + $sth = $dbh->prepare($query); + $sth->execute( $biblionumber, $resdate, $borrowernumber ); + $query = "DELETE FROM reserves + WHERE biblionumber = ? + AND reservedate = ? + AND borrowernumber = ? + "; + $sth = $dbh->prepare($query); + $sth->execute( $biblionumber, $resdate, $borrowernumber ); + # now fix the priority on the others (if the priority wasn't # already sorted!).... unless ( $priority == 0 ) { @@ -856,7 +970,7 @@ The itemnumber parameter is used to find the biblionumber. with the biblionumber & the borrowernumber, we can affect the itemnumber to the correct reserve. -if $transferToDo is set, then the status is set to "Waiting" as well. +if $transferToDo is not set, then the status is set to "Waiting" as well. otherwise, a transfer is on the way, and the end of the transfer will take care of the waiting status =cut @@ -879,8 +993,6 @@ sub ModReserveAffect { itemnumber = ? WHERE borrowernumber = ? AND biblionumber = ? - AND reserves.cancellationdate IS NULL - AND (reserves.found <> 'F' OR reserves.found IS NULL) "; } else { @@ -893,16 +1005,11 @@ sub ModReserveAffect { itemnumber = ? WHERE borrowernumber = ? AND biblionumber = ? - AND reserves.cancellationdate IS NULL - AND (reserves.found <> 'F' OR reserves.found IS NULL) "; } $sth = $dbh->prepare($query); $sth->execute( $itemnumber, $borrowernumber,$biblionumber); $sth->finish; - - # now fix up the remaining priorities.... -# _FixPriority( $data->{'priority'}, $biblio ); # can't work, 1st parameter should be $biblionumbern NOT priority. FIXME : remove this line if no problem seen once it is commented. return; } @@ -944,8 +1051,7 @@ sub ModReserveMinusPriority { my $query = " UPDATE reserves SET priority = 0 , itemnumber = ? - WHERE cancellationdate IS NULL - AND borrowernumber=? + WHERE borrowernumber=? AND biblionumber=? "; my $sth_upd = $dbh->prepare($query); @@ -957,7 +1063,6 @@ sub ModReserveMinusPriority { SET priority = priority-1 WHERE biblionumber = ? AND priority > 0 - AND cancellationdate IS NULL "; $sth_upd = $dbh->prepare($query); $sth_upd->execute( $biblionumber ); @@ -965,6 +1070,117 @@ sub ModReserveMinusPriority { $sth_upd->finish; } +=item GetReserveInfo + +&GetReserveInfo($borrowernumber,$biblionumber); + + Get item and borrower details for a current hold. + Current implementation this query should have a single result. +=cut + +sub GetReserveInfo { + my ( $borrowernumber, $biblionumber ) = @_; + my $dbh = C4::Context->dbh; + my $strsth="SELECT reservedate, reservenotes, reserves.borrowernumber, + reserves.biblionumber, reserves.branchcode, + notificationdate, reminderdate, priority, found, + firstname, surname, phone, + email, address, address2, + cardnumber, city, zipcode, + biblio.title, biblio.author, + items.holdingbranch, items.itemcallnumber, items.itemnumber, + barcode, notes + FROM reserves left join items + ON items.itemnumber=reserves.itemnumber , + borrowers, biblio + WHERE + reserves.borrowernumber=? && + reserves.biblionumber=? && + reserves.borrowernumber=borrowers.borrowernumber && + reserves.biblionumber=biblio.biblionumber "; + my $sth = $dbh->prepare($strsth); + $sth->execute($borrowernumber,$biblionumber); + + my $data = $sth->fetchrow_hashref; + return $data; + +} + +=item IsAvailableForItemLevelRequest + +=over 4 + +my $is_available = IsAvailableForItemLevelRequest($itemnumber); + +=back + +Checks whether a given item record is available for an +item-level hold request. An item is available if + +* it is not lost AND +* it is not damaged AND +* it is not withdrawn AND +* does not have a not for loan value > 0 + +Whether or not the item is currently on loan is +also checked - if the AllowOnShelfHolds system preference +is ON, an item can be requested even if it is currently +on loan to somebody else. If the system preference +is OFF, an item that is currently checked out cannot +be the target of an item-level hold request. + +Note that IsAvailableForItemLevelRequest() does not +check if the staff operator is authorized to place +a request on the item - in particular, +this routine does not check IndependantBranches +and canreservefromotherbranches. + +=cut + +sub IsAvailableForItemLevelRequest { + my $itemnumber = shift; + + my $item = GetItem($itemnumber); + + # must check the notforloan setting of the itemtype + # FIXME - a lot of places in the code do this + # or something similar - need to be + # consolidated + my $dbh = C4::Context->dbh; + my $notforloan_query; + if (C4::Context->preference('item-level_itypes')) { + $notforloan_query = "SELECT itemtypes.notforloan + FROM items + JOIN itemtypes ON (itemtypes.itemtype = items.itype) + WHERE itemnumber = ?"; + } else { + $notforloan_query = "SELECT itemtypes.notforloan + FROM items + JOIN biblioitems USING (biblioitemnumber) + JOIN itemtypes USING (itemtype) + WHERE itemnumber = ?"; + } + my $sth = $dbh->prepare($notforloan_query); + $sth->execute($itemnumber); + my $notforloan_per_itemtype = 0; + if (my ($notforloan) = $sth->fetchrow_array) { + $notforloan_per_itemtype = 1 if $notforloan; + } + + my $available_per_item = 1; + $available_per_item = 0 if $item->{itemlost} or + ( $item->{notforloan} > 0 ) or + ($item->{damaged} and not C4::Context->preference('AllowHoldsOnDamagedItems')) or + $item->{wthdrawn} or + $notforloan_per_itemtype; + + if (C4::Context->preference('AllowOnShelfHolds')) { + return $available_per_item; + } else { + return ($available_per_item and $item->{onloan}); + } +} + =item _FixPriority &_FixPriority($biblio,$borrowernumber,$rank); @@ -992,7 +1208,6 @@ sub _FixPriority { SET priority = 0 WHERE biblionumber = ? AND borrowernumber = ? - AND cancellationdate IS NULL AND found ='W' /; my $sth = $dbh->prepare($query); @@ -1004,13 +1219,13 @@ sub _FixPriority { # get whats left # FIXME adding a new security in returned elements for changing priority, # now, we don't care anymore any reservations with itemnumber linked (suppose a waiting reserve) + # This is wrong a waiting reserve has W set + # The assumption that having an itemnumber set means waiting is wrong and should be corrected any place it occurs my $query = qq/ SELECT borrowernumber, reservedate, constrainttype FROM reserves WHERE biblionumber = ? - AND cancellationdate IS NULL - AND itemnumber IS NULL - AND ((found <> 'F' and found <> 'W') or found is NULL) + AND ((found <> 'W') or found is NULL) ORDER BY priority ASC /; my $sth = $dbh->prepare($query); @@ -1060,7 +1275,7 @@ sub _FixPriority { =item _Findgroupreserve - @results = &_Findgroupreserve($biblioitemnumber, $biblionumber); + @results = &_Findgroupreserve($biblioitemnumber, $biblionumber, $itemnumber); ****** FIXME ****** I don't know what this does, because I don't understand how reserve @@ -1077,7 +1292,7 @@ C. =cut sub _Findgroupreserve { - my ( $bibitem, $biblio ) = @_; + my ( $bibitem, $biblio, $itemnumber ) = @_; my $dbh = C4::Context->dbh; my $query = qq/ SELECT reserves.biblionumber AS biblionumber, @@ -1098,11 +1313,10 @@ sub _Findgroupreserve { AND reserves.borrowernumber = reserveconstraints.borrowernumber AND reserves.reservedate =reserveconstraints.reservedate ) OR reserves.constrainttype='a' ) - AND reserves.cancellationdate is NULL - AND (reserves.found <> 'F' or reserves.found is NULL) + AND (reserves.itemnumber IS NULL OR reserves.itemnumber = ?) /; my $sth = $dbh->prepare($query); - $sth->execute( $biblio, $bibitem ); + $sth->execute( $biblio, $bibitem, $itemnumber ); my @results; while ( my $data = $sth->fetchrow_hashref ) { push( @results, $data ); @@ -1119,3 +1333,4 @@ Koha Developement team =cut +1;