-# -*- tab-width: 8 -*-
-# NOTE: This file uses standard 8-character tabs
-
package C4::Reserves;
# Copyright 2000-2002 Katipo Communications
+# 2006 SAN Ouest Provence
+# 2007 BibLibre Paul POULAIN
#
# This file is part of Koha.
#
# 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 warnings; # FIXME: someday
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);
-
-my $library_name = C4::Context->preference("LibraryName");
+# for _koha_notify_reserve
+use C4::Members::Messaging;
+use C4::Members qw( GetMember );
+use C4::Letters;
+use C4::Branch qw( GetBranchDetail );
+use C4::Dates qw( format_date_in_iso );
+use List::MoreUtils qw( firstidx );
-# set the version for version checking
-$VERSION = do { my @v = '$Revision$' =~ /\d+/g; shift(@v) . "." . join( "_", map { sprintf "%03d", $_ } @v ); };
+use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
=head1 NAME
=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
sub AddReserve {
my (
$branch, $borrowernumber, $biblionumber,
- $constraint, $bibitems, $priority, $notes,
+ $constraint, $bibitems, $priority, $resdate, $notes,
$title, $checkitem, $found
) = @_;
my $fee =
$bibitems );
my $dbh = C4::Context->dbh;
my $const = lc substr( $constraint, 0, 1 );
- my @datearr = localtime(time);
- my $resdate =
- ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
+ $resdate = format_date_in_iso( $resdate ) if ( $resdate );
+ $resdate = C4::Dates->today( 'iso' ) unless ( $resdate );
+ if ( C4::Context->preference( 'AllowHoldDateInFuture' ) ) {
+ # Make room in reserves for this before those of a later reserve date
+ $priority = _ShiftPriorityByDateAndPriority( $biblionumber, $resdate, $priority );
+ }
my $waitingdate;
# If the reserv had the waiting status, we had the value of the resdate
my $usth = $dbh->prepare($query);
$usth->execute( $borrowernumber, $nextacctno, $fee,
"Reserve Charge - $title", $fee );
- $usth->finish;
}
#if ($const eq 'a'){
$const, $priority, $notes, $checkitem,
$found, $waitingdate
);
- $sth->finish;
#}
- if ( ( $const eq "o" ) || ( $const eq "e" ) ) {
- my $numitems = @$bibitems;
- my $i = 0;
- while ( $i < $numitems ) {
- my $biblioitem = @$bibitems[$i];
- my $query = qq/
- INSERT INTO reserveconstraints
- (borrowernumber,biblionumber,reservedate,biblioitemnumber)
- VALUES
+ ($const eq "o" || $const eq "e") or return; # FIXME: why not have a useful return value?
+ $query = qq/
+ INSERT INTO reserveconstraints
+ (borrowernumber,biblionumber,reservedate,biblioitemnumber)
+ VALUES
(?,?,?,?)
- /;
- my $sth = $dbh->prepare("");
- $sth->execute( $borrowernumber, $biblionumber, $resdate,
- $biblioitem );
- $sth->finish;
- $i++;
- }
+ /;
+ $sth = $dbh->prepare($query); # keep prepare outside the loop!
+ foreach (@$bibitems) {
+ $sth->execute($borrowernumber, $biblionumber, $resdate, $_);
}
- return;
+ return; # FIXME: why not have a useful return value?
}
=item GetReservesFromBiblionumber
-@borrowerreserv=&GetReserves($biblionumber,$itemnumber,$borrowernumber);
+($count, $title_reserves) = &GetReserves($biblionumber);
-this function get the list of reservation for an C<$biblionumber>, C<$itemnumber> or C<$borrowernumber>
-given on input arg.
-Only 1 argument has to be passed.
+This function gets the list of reservations for one C<$biblionumber>, returning a count
+of the reserves and an arrayref pointing to the reserves for C<$biblionumber>.
=cut
sub GetReservesFromBiblionumber {
- my ( $biblionumber, $itemnumber, $borrowernumber ) = @_;
+ my ($biblionumber) = shift or return (0, []);
+ my ($all_dates) = shift;
my $dbh = C4::Context->dbh;
# Find the desired items in the reserves
reservedate,
constrainttype,
found,
- itemnumber
+ itemnumber,
+ reservenotes
FROM reserves
- WHERE cancellationdate IS NULL
- AND (found <> \'F\' OR found IS NULL)
- AND biblionumber = ?
- ORDER BY priority";
+ WHERE biblionumber = ? ";
+ unless ( $all_dates ) {
+ $query .= "AND reservedate <= CURRENT_DATE()";
+ }
+ $query .= "ORDER BY priority";
my $sth = $dbh->prepare($query);
$sth->execute($biblionumber);
my @results;
my $i = 0;
while ( my $data = $sth->fetchrow_hashref ) {
- # FIXME - What is this if-statement doing? How do constraints work?
- if ( $data->{constrainttype} eq 'o' ) {
+ # FIXME - What is this doing? How do constraints work?
+ if ($data->{constrainttype} eq 'o') {
$query = '
SELECT biblioitemnumber
- FROM reserveconstraints
- WHERE biblionumber = ?
- AND borrowernumber = ?
- AND reservedate = ?
+ FROM reserveconstraints
+ WHERE biblionumber = ?
+ AND borrowernumber = ?
+ AND reservedate = ?
';
my $csth = $dbh->prepare($query);
- $csth->execute( $data->{biblionumber}, $data->{borrowernumber},
- $data->{reservedate}, );
-
+ $csth->execute($data->{biblionumber}, $data->{borrowernumber}, $data->{reservedate});
my @bibitemno;
while ( my $bibitemnos = $csth->fetchrow_array ) {
- push( @bibitemno, $bibitemnos );
+ push( @bibitemno, $bibitemnos ); # FIXME: inefficient: use fetchall_arrayref
}
- my $count = @bibitemno;
-
+ my $count = scalar @bibitemno;
+
# if we have two or more different specific itemtypes
# reserved by same person on same day
my $bdata;
if ( $count > 1 ) {
- $bdata = GetBiblioItemData( $bibitemno[$i] );
- $i++;
+ $bdata = GetBiblioItemData( $bibitemno[$i] ); # FIXME: This doesn't make sense.
+ $i++; # $i can increase each pass, but the next @bibitemno might be smaller?
}
else {
-
# Look up the book we just found.
$bdata = GetBiblioItemData( $bibitemno[0] );
}
- $csth->finish;
-
# Add the results of this latest search to the current
# results.
# FIXME - An 'each' would probably be more efficient.
}
push @results, $data;
}
- $sth->finish;
return ( $#results + 1, \@results );
}
=cut
sub GetReservesFromItemnumber {
- my ( $itemnumber ) = @_;
+ my ( $itemnumber, $all_dates ) = @_;
my $dbh = C4::Context->dbh;
my $query = "
SELECT reservedate,borrowernumber,branchcode
FROM reserves
WHERE itemnumber=?
- AND cancellationdate IS NULL
- AND (found <> 'F' OR found IS NULL)
";
+ unless ( $all_dates ) {
+ $query .= " AND reservedate <= CURRENT_DATE()";
+ }
my $sth_res = $dbh->prepare($query);
$sth_res->execute($itemnumber);
my ( $reservedate, $borrowernumber,$branchcode ) = $sth_res->fetchrow_array;
=item GetReservesFromBorrowernumber
- $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
-
- TODO :: Descritpion
+ $borrowerreserv = GetReservesFromBorrowernumber($borrowernumber,$tatus);
+
+ TODO :: Descritpion
+
=cut
sub GetReservesFromBorrowernumber {
SELECT *
FROM reserves
WHERE borrowernumber=?
- AND cancellationdate IS NULL
AND found =?
ORDER BY reservedate
");
SELECT *
FROM reserves
WHERE borrowernumber=?
- AND cancellationdate IS NULL
- AND (found != 'F' or found is null)
ORDER BY reservedate
");
$sth->execute($borrowernumber);
return @$data;
}
#-------------------------------------------------------------------------------------
+=item CanBookBeReserved
+$error = &CanBookBeReserved($borrowernumber, $biblionumber)
+
+=cut
+
+sub CanBookBeReserved{
+ my ($borrowernumber, $biblionumber) = @_;
+
+ my $dbh = C4::Context->dbh;
+ my $biblio = GetBiblioData($biblionumber);
+ my $borrower = C4::Members::GetMember(borrowernumber=>$borrowernumber);
+ my $controlbranch = C4::Context->preference('ReservesControlBranch');
+ my $itype = C4::Context->preference('item-level_itypes');
+ my $reservesrights= 0;
+ my $reservescount = 0;
+
+ # we retrieve the user rights
+ my @args;
+ my $rightsquery = "SELECT categorycode, itemtype, branchcode, reservesallowed
+ FROM issuingrules
+ WHERE categorycode = ?";
+ push @args,$borrower->{categorycode};
+
+ if($controlbranch eq "ItemHomeLibrary"){
+ $rightsquery .= " AND branchcode = '*'";
+ }elsif($controlbranch eq "PatronLibrary"){
+ $rightsquery .= " AND branchcode IN (?,'*')";
+ push @args, $borrower->{branchcode};
+ }
+
+ if(not $itype){
+ $rightsquery .= " AND itemtype IN (?,'*')";
+ push @args, $biblio->{itemtype};
+ }else{
+ $rightsquery .= " AND itemtype = '*'";
+ }
+
+ $rightsquery .= " ORDER BY categorycode DESC, itemtype DESC, branchcode DESC";
+
+ my $sthrights = $dbh->prepare($rightsquery);
+ $sthrights->execute(@args);
+
+ if(my $row = $sthrights->fetchrow_hashref()){
+ $reservesrights = $row->{reservesallowed};
+ }
+
+ @args = ();
+ # we count how many reserves the borrower have
+ my $countquery = "SELECT count(*) as count
+ FROM reserves
+ LEFT JOIN items USING (itemnumber)
+ LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
+ LEFT JOIN borrowers USING (borrowernumber)
+ WHERE borrowernumber = ?
+ ";
+ push @args, $borrowernumber;
+
+ if(not $itype){
+ $countquery .= "AND itemtype = ?";
+ push @args, $biblio->{itemtype};
+ }
+
+ if($controlbranch eq "PatronLibrary"){
+ $countquery .= " AND borrowers.branchcode = ? ";
+ push @args, $borrower->{branchcode};
+ }
+
+ my $sthcount = $dbh->prepare($countquery);
+ $sthcount->execute(@args);
+
+ if(my $row = $sthcount->fetchrow_hashref()){
+ $reservescount = $row->{count};
+ }
+
+ if($reservescount < $reservesrights){
+ return 1;
+ }else{
+ return 0;
+ }
+
+}
+
+=item CanItemBeReserved
+
+$error = &CanItemBeReserved($borrowernumber, $itemnumber)
+
+this function return 1 if an item can be issued by this borrower.
+
+=cut
+
+sub CanItemBeReserved{
+ my ($borrowernumber, $itemnumber) = @_;
+
+ my $dbh = C4::Context->dbh;
+ my $allowedreserves = 0;
+
+ my $controlbranch = C4::Context->preference('ReservesControlBranch');
+ my $itype = C4::Context->preference('item-level_itypes') ? "itype" : "itemtype";
+
+ # we retrieve borrowers and items informations #
+ my $item = GetItem($itemnumber);
+ my $borrower = C4::Members::GetMember('borrowernumber'=>$borrowernumber);
+
+ # we retrieve user rights on this itemtype and branchcode
+ my $sth = $dbh->prepare("SELECT categorycode, itemtype, branchcode, reservesallowed
+ FROM issuingrules
+ WHERE (categorycode in (?,'*') )
+ AND (itemtype IN (?,'*'))
+ AND (branchcode IN (?,'*'))
+ ORDER BY
+ categorycode DESC,
+ itemtype DESC,
+ branchcode DESC;"
+ );
+
+ my $querycount ="SELECT
+ count(*) as count
+ FROM reserves
+ LEFT JOIN items USING (itemnumber)
+ LEFT JOIN biblioitems ON (reserves.biblionumber=biblioitems.biblionumber)
+ LEFT JOIN borrowers USING (borrowernumber)
+ WHERE borrowernumber = ?
+ ";
+
+
+ my $itemtype = $item->{$itype};
+ my $categorycode = $borrower->{categorycode};
+ my $branchcode = "";
+ my $branchfield = "reserves.branchcode";
+
+ if( $controlbranch eq "ItemHomeLibrary" ){
+ $branchfield = "items.homebranch";
+ $branchcode = $item->{homebranch};
+ }elsif( $controlbranch eq "PatronLibrary" ){
+ $branchfield = "borrowers.branchcode";
+ $branchcode = $borrower->{branchcode};
+ }
+
+ # we retrieve rights
+ $sth->execute($categorycode, $itemtype, $branchcode);
+ if(my $rights = $sth->fetchrow_hashref()){
+ $itemtype = $rights->{itemtype};
+ $allowedreserves = $rights->{reservesallowed};
+ }else{
+ $itemtype = '*';
+ }
+
+ # we retrieve count
+
+ $querycount .= "AND $branchfield = ?";
+
+ $querycount .= " AND $itype = ?" if ($itemtype ne "*");
+ my $sthcount = $dbh->prepare($querycount);
+
+ if($itemtype eq "*"){
+ $sthcount->execute($borrowernumber, $branchcode);
+ }else{
+ $sthcount->execute($borrowernumber, $branchcode, $itemtype);
+ }
+
+ my $reservecount = "0";
+ if(my $rowcount = $sthcount->fetchrow_hashref()){
+ $reservecount = $rowcount->{count};
+ }
+
+ # we check if it's ok or not
+ if( $reservecount < $allowedreserves ){
+ return 1;
+ }else{
+ return 0;
+ }
+}
+#--------------------------------------------------------------------------------
=item GetReserveCount
$number = &GetReserveCount($borrowernumber);
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);
my $row = $sth->fetchrow_hashref;
- $sth->finish;
-
return $row->{counter};
}
);
#launch the subroutine dotransfer
- C4::Circulation::ModItemTransfer(
+ C4::Items::ModItemTransfer(
$itemnumber,
$iteminfo->{'holdingbranch'},
$checkreserves->{'branchcode'}
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);
# 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 ) {
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 ) {
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;
$transreserv[$i] = $data;
$i++;
}
- $sth->finish;
return (@transreserv);
}
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 ) {
$transreserv[$i] = $data;
$i++;
}
- $sth->finish;
return (@transreserv);
}
=item CheckReserves
($status, $reserve) = &CheckReserves($itemnumber);
+ ($status, $reserve) = &CheckReserves(undef, $barcode);
Find a book in the reserves.
my ( $item, $barcode ) = @_;
my $dbh = C4::Context->dbh;
my $sth;
+ my $select = "
+ SELECT items.biblionumber,
+ items.biblioitemnumber,
+ itemtypes.notforloan,
+ items.notforloan AS itemnotforloan,
+ items.itemnumber
+ FROM items
+ LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
+ LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
+ ";
+
if ($item) {
- 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
- ";
- $sth = $dbh->prepare($query);
+ $sth = $dbh->prepare("$select WHERE itemnumber = ?");
+ $sth->execute($item);
}
else {
- my $qbc = $dbh->quote($barcode);
- # Look up the item by barcode
- my $query = "
- SELECT items.biblionumber, items.biblioitemnumber, itemtypes.notforloan
- FROM items, biblioitems, itemtypes
- WHERE items.biblioitemnumber = biblioitems.biblioitemnumber
- AND biblioitems.itemtype = itemtypes.itemtype
- AND barcode=$qbc
- ";
- $sth = $dbh->prepare($query);
-
- # FIXME - This function uses $item later on. Ought to set it here.
+ $sth = $dbh->prepare("$select WHERE barcode = ?");
+ $sth->execute($barcode);
}
- $sth->execute;
- my ( $biblio, $bibitem, $notforloan ) = $sth->fetchrow_array;
- $sth->finish;
+ # note: we get the itemnumber because we might have started w/ just the barcode. Now we know for sure we have it.
+ my ( $biblio, $bibitem, $notforloan_per_itemtype, $notforloan_per_item, $itemnumber ) = $sth->fetchrow_array;
+
+ return ( 0, 0 ) unless $itemnumber; # bail if we got nothing.
# if item is not for loan it cannot be reserved either.....
- return ( 0, 0 ) if $notforloan;
+ # execpt 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 $count = scalar @reserves;
+ my @reserves = _Findgroupreserve( $bibitem, $biblio, $itemnumber );
# $priority and $highest are used to find the most important item
# in the list returned by &_Findgroupreserve. (The lower $priority,
# the more important the item.)
# $highest is the most important item we've seen so far.
- my $priority = 10000000;
my $highest;
- if ($count) {
+ if (scalar @reserves) {
+ my $priority = 10000000;
foreach my $res (@reserves) {
- # FIXME - $item might be undefined or empty: the caller
- # might be searching by barcode.
- if ( $res->{'itemnumber'} == $item ) {
- # Found it
- return ( "Waiting", $res );
- }
- else {
- # See if this item is more important than what we've got
- # so far.
- if ( $res->{'priority'} != 0 && $res->{'priority'} < $priority )
- {
+ if ( $res->{'itemnumber'} == $itemnumber && $res->{'priority'} == 0) {
+ return ( "Waiting", $res ); # Found it
+ } else {
+ # See if this item is more important than what we've got so far
+ if ( $res->{'priority'} && $res->{'priority'} < $priority ) {
$priority = $res->{'priority'};
$highest = $res;
}
}
}
- # If we get this far, then no exact match was found. Print the
- # most important item on the list. I think this tells us who's
- # next in line to get this book.
- if ($highest) { # FIXME - $highest might be undefined
+ # If we get this far, then no exact match was found.
+ # We return the most important (i.e. next) reservation.
+ if ($highest) {
$highest->{'itemnumber'} = $item;
return ( "Reserved", $highest );
}
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 = "
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;
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 );
priority = 0
WHERE biblionumber = ?
AND borrowernumber = ?
- AND cancellationdate IS NULL
- AND (found <> 'F' or found IS NULL)
/;
# update the database, removing the record...
$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 );
}
=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
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);
$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 ) {
";
my $sth_set = $dbh->prepare($query);
$sth_set->execute( $newstatus, $itemnumber );
- $sth_set->finish;
+
+ if ( C4::Context->preference("ReturnToShelvingCart") && $newstatus ) {
+ CartToShelf( $itemnumber );
+ }
}
=item ModReserveAffect
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
my $sth = $dbh->prepare("SELECT biblionumber FROM items WHERE itemnumber=?");
$sth->execute($itemnumber);
my ($biblionumber) = $sth->fetchrow;
+
+ # get request - need to find out if item is already
+ # waiting in order to not send duplicate hold filled notifications
+ my $request = GetReserveInfo($borrowernumber, $biblionumber);
+ my $already_on_shelf = ($request && $request->{found} eq 'W') ? 1 : 0;
+
# If we affect a reserve that has to be transfered, don't set to Waiting
my $query;
if ($transferToDo) {
itemnumber = ?
WHERE borrowernumber = ?
AND biblionumber = ?
- AND reserves.cancellationdate IS NULL
- AND (reserves.found <> 'F' OR reserves.found IS NULL)
";
}
else {
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;
+ _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo && !$already_on_shelf );
+
+ if ( C4::Context->preference("ReturnToShelvingCart") ) {
+ CartToShelf( $itemnumber );
+ }
- # 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;
}
my $query = "
UPDATE reserves
SET priority = 0 , itemnumber = ?
- WHERE cancellationdate IS NULL
- AND borrowernumber=?
+ WHERE borrowernumber=?
AND biblionumber=?
";
my $sth_upd = $dbh->prepare($query);
$sth_upd->execute( $itemnumber, $borrowernumber, $biblionumber );
- $sth_upd->finish;
# second step update all others reservs
- $query = "
- UPDATE reserves
- SET priority = priority-1
- WHERE biblionumber = ?
- AND priority > 0
- AND cancellationdate IS NULL
- ";
- $sth_upd = $dbh->prepare($query);
- $sth_upd->execute( $biblionumber );
- $sth_upd->finish;
- $sth_upd->finish;
+ _FixPriority($biblionumber, $borrowernumber, '0');
+}
+
+=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
SET priority = 0
WHERE biblionumber = ?
AND borrowernumber = ?
- AND cancellationdate IS NULL
AND found ='W'
/;
my $sth = $dbh->prepare($query);
# 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);
=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
-constraints work. I think the idea is that you reserve a particular
-biblio, and the constraint allows you to restrict it to a given
-biblioitem (e.g., if you want to borrow the audio book edition of "The
-Prophet", rather than the first available publication).
+Looks for an item-specific match first, then for a title-level match, returning the
+first match found. If neither, then we look for a 3rd kind of match based on
+reserve constraints.
+
+TODO: add more explanation about reserve constraints
C<&_Findgroupreserve> returns :
C<@results> is an array of references-to-hash whose keys are mostly
=cut
sub _Findgroupreserve {
- my ( $bibitem, $biblio ) = @_;
+ my ( $bibitem, $biblio, $itemnumber ) = @_;
my $dbh = C4::Context->dbh;
+
+ # TODO: consolidate at least the SELECT portion of the first 2 queries to a common $select var.
+ # check for exact targetted match
+ my $item_level_target_query = qq/
+ SELECT reserves.biblionumber AS biblionumber,
+ reserves.borrowernumber AS borrowernumber,
+ reserves.reservedate AS reservedate,
+ reserves.branchcode AS branchcode,
+ reserves.cancellationdate AS cancellationdate,
+ reserves.found AS found,
+ reserves.reservenotes AS reservenotes,
+ reserves.priority AS priority,
+ reserves.timestamp AS timestamp,
+ biblioitems.biblioitemnumber AS biblioitemnumber,
+ reserves.itemnumber AS itemnumber
+ FROM reserves
+ JOIN biblioitems USING (biblionumber)
+ JOIN hold_fill_targets USING (biblionumber, borrowernumber, itemnumber)
+ WHERE found IS NULL
+ AND priority > 0
+ AND item_level_request = 1
+ AND itemnumber = ?
+ AND reservedate <= CURRENT_DATE()
+ /;
+ my $sth = $dbh->prepare($item_level_target_query);
+ $sth->execute($itemnumber);
+ my @results;
+ if ( my $data = $sth->fetchrow_hashref ) {
+ push( @results, $data );
+ }
+ return @results if @results;
+
+ # check for title-level targetted match
+ my $title_level_target_query = qq/
+ SELECT reserves.biblionumber AS biblionumber,
+ reserves.borrowernumber AS borrowernumber,
+ reserves.reservedate AS reservedate,
+ reserves.branchcode AS branchcode,
+ reserves.cancellationdate AS cancellationdate,
+ reserves.found AS found,
+ reserves.reservenotes AS reservenotes,
+ reserves.priority AS priority,
+ reserves.timestamp AS timestamp,
+ biblioitems.biblioitemnumber AS biblioitemnumber,
+ reserves.itemnumber AS itemnumber
+ FROM reserves
+ JOIN biblioitems USING (biblionumber)
+ JOIN hold_fill_targets USING (biblionumber, borrowernumber)
+ WHERE found IS NULL
+ AND priority > 0
+ AND item_level_request = 0
+ AND hold_fill_targets.itemnumber = ?
+ AND reservedate <= CURRENT_DATE()
+ /;
+ $sth = $dbh->prepare($title_level_target_query);
+ $sth->execute($itemnumber);
+ @results = ();
+ if ( my $data = $sth->fetchrow_hashref ) {
+ push( @results, $data );
+ }
+ return @results if @results;
+
my $query = qq/
- SELECT reserves.biblionumber AS biblionumber,
- reserves.borrowernumber AS borrowernumber,
- reserves.reservedate AS reservedate,
- reserves.branchcode AS branchcode,
- reserves.cancellationdate AS cancellationdate,
- reserves.found AS found,
- reserves.reservenotes AS reservenotes,
- reserves.priority AS priority,
- reserves.timestamp AS timestamp,
+ SELECT reserves.biblionumber AS biblionumber,
+ reserves.borrowernumber AS borrowernumber,
+ reserves.reservedate AS reservedate,
+ reserves.branchcode AS branchcode,
+ reserves.cancellationdate AS cancellationdate,
+ reserves.found AS found,
+ reserves.reservenotes AS reservenotes,
+ reserves.priority AS priority,
+ reserves.timestamp AS timestamp,
reserveconstraints.biblioitemnumber AS biblioitemnumber,
- reserves.itemnumber AS itemnumber
+ reserves.itemnumber AS itemnumber
FROM reserves
LEFT JOIN reserveconstraints ON reserves.biblionumber = reserveconstraints.biblionumber
WHERE reserves.biblionumber = ?
AND ( ( reserveconstraints.biblioitemnumber = ?
AND reserves.borrowernumber = reserveconstraints.borrowernumber
- AND reserves.reservedate =reserveconstraints.reservedate )
+ 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 = ?)
+ AND reserves.reservedate <= CURRENT_DATE()
/;
- my $sth = $dbh->prepare($query);
- $sth->execute( $biblio, $bibitem );
- my @results;
+ $sth = $dbh->prepare($query);
+ $sth->execute( $biblio, $bibitem, $itemnumber );
+ @results = ();
while ( my $data = $sth->fetchrow_hashref ) {
push( @results, $data );
}
- $sth->finish;
return @results;
}
+=item _koha_notify_reserve
+
+=over 4
+
+_koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber );
+
+=back
+
+Sends a notification to the patron that their hold has been filled (through
+ModReserveAffect, _not_ ModReserveFill)
+
+=cut
+
+sub _koha_notify_reserve {
+ my ($itemnumber, $borrowernumber, $biblionumber) = @_;
+
+ my $dbh = C4::Context->dbh;
+ my $messagingprefs = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber, message_name => 'Hold Filled' } );
+
+ return if ( !defined( $messagingprefs->{'letter_code'} ) );
+
+ my $sth = $dbh->prepare("
+ SELECT *
+ FROM reserves
+ WHERE borrowernumber = ?
+ AND biblionumber = ?
+ ");
+ $sth->execute( $borrowernumber, $biblionumber );
+ my $reserve = $sth->fetchrow_hashref;
+ my $branch_details = GetBranchDetail( $reserve->{'branchcode'} );
+
+ my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
+
+ my $letter = getletter( 'reserves', $messagingprefs->{'letter_code'} );
+
+ C4::Letters::parseletter( $letter, 'branches', $reserve->{'branchcode'} );
+ C4::Letters::parseletter( $letter, 'borrowers', $reserve->{'borrowernumber'} );
+ C4::Letters::parseletter( $letter, 'biblio', $reserve->{'biblionumber'} );
+ C4::Letters::parseletter( $letter, 'reserves', $reserve->{'borrowernumber'}, $reserve->{'biblionumber'} );
+
+ if ( $reserve->{'itemnumber'} ) {
+ C4::Letters::parseletter( $letter, 'items', $reserve->{'itemnumber'} );
+ }
+ $letter->{'content'} =~ s/<<[a-z0-9_]+\.[a-z0-9]+>>//g; #remove any stragglers
+
+ if ( -1 != firstidx { $_ eq 'email' } @{$messagingprefs->{transports}} ) {
+ # aka, 'email' in ->{'transports'}
+ C4::Letters::EnqueueLetter(
+ { letter => $letter,
+ borrowernumber => $borrowernumber,
+ message_transport_type => 'email',
+ from_address => $admin_email_address,
+ }
+ );
+ }
+
+ if ( -1 != firstidx { $_ eq 'sms' } @{$messagingprefs->{transports}} ) {
+ C4::Letters::EnqueueLetter(
+ { letter => $letter,
+ borrowernumber => $borrowernumber,
+ message_transport_type => 'sms',
+ }
+ );
+ }
+}
+
+=item _ShiftPriorityByDateAndPriority
+
+=over 4
+
+$new_priority = _ShiftPriorityByDateAndPriority( $biblionumber, $reservedate, $priority );
+
+=back
+
+This increments the priority of all reserves after the one
+ with either the lowest date after C<$reservedate>
+ or the lowest priority after C<$priority>.
+
+It effectively makes room for a new reserve to be inserted with a certain
+ priority, which is returned.
+
+This is most useful when the reservedate can be set by the user. It allows
+ the new reserve to be placed before other reserves that have a later
+ reservedate. Since priority also is set by the form in reserves/request.pl
+ the sub accounts for that too.
+
+=cut
+
+sub _ShiftPriorityByDateAndPriority {
+ my ( $biblio, $resdate, $new_priority ) = @_;
+
+ my $dbh = C4::Context->dbh;
+ my $query = "SELECT priority FROM reserves WHERE biblionumber = ? AND ( reservedate > ? OR priority > ? ) ORDER BY priority ASC";
+ my $sth = $dbh->prepare( $query );
+ $sth->execute( $biblio, $resdate, $new_priority );
+ my ( $min_priority ) = $sth->fetchrow;
+ $sth->finish; # $sth might have more data.
+ $new_priority = $min_priority if ( $min_priority );
+ my $updated_priority = $new_priority + 1;
+
+ $query = "
+ UPDATE reserves
+ SET priority = ?
+ WHERE biblionumber = ?
+ AND borrowernumber = ?
+ AND reservedate = ?
+ AND found IS NULL";
+ my $sth_update = $dbh->prepare( $query );
+
+ $query = "SELECT * FROM reserves WHERE priority >= ?";
+ $sth = $dbh->prepare( $query );
+ $sth->execute( $new_priority );
+ while ( my $row = $sth->fetchrow_hashref ) {
+ $sth_update->execute( $updated_priority, $biblio, $row->{borrowernumber}, $row->{reservedate} );
+ $updated_priority++;
+ }
+
+ return $new_priority; # so the caller knows what priority they end up at
+}
+
=back
=head1 AUTHOR
=cut
+1;
projects / koha.git / blobdiff