-# -*- tab-width: 8 -*-
-# NOTE: This file uses standard 8-character tabs
-
package C4::Reserves;
# Copyright 2000-2002 Katipo Communications
use strict;
+# use warnings; # FIXME: someday
use C4::Context;
use C4::Biblio;
+use C4::Dates qw/format_date format_date_in_iso/;
+use C4::Members;
use C4::Items;
use C4::Search;
use C4::Circulation;
use C4::Accounts;
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+# for _koha_notify_reserve
+use C4::Members::Messaging;
+use C4::Letters;
+use C4::Branch qw( GetBranchDetail );
+use List::MoreUtils qw( firstidx any );
-my $library_name = C4::Context->preference("LibraryName");
+use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
=head1 NAME
=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
+ T(ransfet) : the reserve has an itemnumber affected, and is beeing transfered to pickup branch
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
@EXPORT = qw(
&AddReserve
+ &GetPendingReserves
&GetReservesFromItemnumber
&GetReservesFromBiblionumber
&GetReservesFromBorrowernumber
&GetReserveCount
&GetReserveFee
&GetReserveInfo
-
+ &GetReserveStatus
+
&GetOtherReserves
&ModReserveFill
&ModReserveMinusPriority
&CheckReserves
+ &CanBookBeReserved
+ &CanItemBeReserved
&CancelReserve
&IsAvailableForItemLevelRequest
=item AddReserve
- AddReserve($branch,$borrowernumber,$biblionumber,$constraint,$bibitems,$priority,$notes,$title,$checkitem,$found)
+ AddReserve($branch,$borrowernumber,$biblionumber,$constraint,$bibitems,$priority,$notes,$title,$checkitem,$found, $from)
=cut
my (
$branch, $borrowernumber, $biblionumber,
$constraint, $bibitems, $priority, $notes,
- $title, $checkitem, $found
+ $title, $checkitem, $found, $from
) = @_;
my $fee =
GetReserveFee($borrowernumber, $biblionumber, $constraint,
$found, $waitingdate
);
+ # Send e-mail to librarian if syspref is active
+ if(C4::Context->preference("emailLibrarianWhenHoldIsPlaced")){
+ my $borrower = GetMemberDetails($borrowernumber);
+ my $biblio = GetBiblioData($biblionumber);
+ my $lettertype = ($from eq "intranet") ? "STAFFHOLDPLACED" : "HOLDPLACED";
+ my $letter = C4::Letters::getletter( 'reserves', $lettertype);
+ my $admin_email_address = C4::Context->preference('KohaAdminEmailAddress');
+
+ my %keys = (%$borrower, %$biblio);
+ foreach my $key (keys %keys) {
+ my $replacefield = "<<$key>>";
+ $letter->{content} =~ s/$replacefield/$keys{$key}/g;
+ $letter->{title} =~ s/$replacefield/$keys{$key}/g;
+ }
+
+ C4::Letters::EnqueueLetter(
+ { letter => $letter,
+ borrowernumber => $borrowernumber,
+ message_transport_type => 'email',
+ from_address => $admin_email_address,
+ to_address => $admin_email_address,
+ }
+ );
+
+
+ }
+
+
#}
($const eq "o" || $const eq "e") or return; # FIXME: why not have a useful return value?
$query = qq/
foreach (@$bibitems) {
$sth->execute($borrowernumber, $biblionumber, $resdate, $_);
}
+
return; # FIXME: why not have a useful return value?
}
+
+
+=item GetPendingReserves
+
+=cut
+
+sub GetPendingReserves {
+ my ($filters, $startindex, $results) = @_;
+
+ $startindex = "0" if not $startindex;
+
+ my @query_params;
+ my $indepbranch = C4::Context->preference('IndependantBranches') ? C4::Context->userenv->{'branch'} : undef;
+ my $dbh = C4::Context->dbh;
+
+ my $query = "SELECT DISTINCT(biblionumber) AS biblionumber
+ FROM reserves
+ LEFT JOIN biblio USING(biblionumber)
+ WHERE reserves.found IS NULL ";
+
+ if ($indepbranch){
+ $query .= " AND branchcode = ? ";
+ push @query_params, $indepbranch;
+ }
+
+ my $sth = $dbh->prepare($query);
+ $sth->execute(@query_params);
+
+ my %reserves;
+
+ while ( my $reserve = $sth->fetchrow_hashref ) {
+ my $line;
+ unless( $line = $reserves{$reserve->{biblionumber}} ){
+ $line = {};
+ my $biblio = GetBiblioData($reserve->{biblionumber});
+ my @items = GetItemsInfo($reserve->{biblionumber});
+
+ $line->{title} = $biblio->{title};
+ foreach my $item (@items){
+ next if ( ($indepbranch && $indepbranch ne $item->{holdingbranch})
+ or $item->{onloan}
+ or $item->{notforloan}
+ or $item->{itemlost}
+ or $item->{count_reserves} eq "Waiting" or $item->{count_reserves} eq "Transit");
+ $line->{count}++;
+ $line->{holdingbranches}->{$item->{holdingbranch}} = 1;
+ $line->{callnumbers}->{$item->{itemcallnumber}} = 1;
+ $line->{locations}->{$item->{location}} = 1;
+ $line->{itemtypes}->{$item->{itemtype}} = 1;
+ }
+ }
+ $line->{reservecount}++;
+ $reserves{$reserve->{biblionumber}} = $line if($line->{count});
+ }
+
+ my @reserves;
+ foreach my $rkey (keys %reserves){
+ my $line = $reserves{$rkey};
+ $line->{biblionumber} = $rkey;
+
+ foreach my $datatype (qw/holdingbranches callnumbers locations itemtypes/){
+ my @newdatas = ();
+ foreach my $data (keys %{$line->{$datatype}}){
+ push @newdatas, { 'value' => $data}
+ }
+ $line->{$datatype} = \@newdatas;
+ }
+ my $filtered = 1;
+ foreach my $key (keys %$filters){
+ my $value = $filters->{$key};
+ $filtered = 0 if not (any { $_->{value} =~ /^$value$/ } @{$line->{$key}}) and $value;
+ }
+ push @reserves, $line if $filtered; # if (any { $_->{value} =~ /^FOSPC$/ } @{$line->{holdingbranches}});
+ }
+
+ my $count = scalar @reserves;
+ my $endindex = ($count > $startindex + $results) ? $startindex + $results : $count;
+
+ if($count){
+ @reserves = @reserves[$startindex..$endindex];
+ }
+
+
+ return ($count, \@reserves);
+}
+
=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 $dbh = C4::Context->dbh;
# Find the desired items in the reserves
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 ); # FIXME: inefficient: use fetchall_arrayref
# 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.
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= C4::Context->preference('maxreserves');
+ my $reservescount = 0;
+
+ # we retrieve the user rights
+ my @args;
+ my $branchcode;
+
+
+ if($controlbranch eq "ItemHomeLibrary"){
+ $branchcode = '*';
+ }elsif($controlbranch eq "PatronLibrary"){
+ $branchcode = $borrower->{branchcode};
+ }
+
+ $reservescount = GetReserveCount($borrowernumber);
+
+ 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 $controlbranch = C4::Context->preference('ReservesControlBranch') || "ItemHomeLibrary";
+ my $itype = C4::Context->preference('item-level_itypes') ? "itype" : "itemtype";
+ my $allowedreserves = C4::Context->preference('maxreserves');
+
+ # we retrieve borrowers and items informations #
+ my $item = C4::Items::GetItem($itemnumber);
+ my $borrower = C4::Members::GetMember($borrowernumber, 'borrowernumber');
+
+ my $branchcode = "*";
+ my $branchfield = "reserves.branchcode";
+
+ if( $controlbranch eq "ItemHomeLibrary" ){
+ $branchcode = $item->{homebranch};
+ }elsif( $controlbranch eq "PatronLibrary" ){
+ $branchcode = $borrower->{branchcode};
+ }
+
+ # we retrieve user rights on this itemtype and branchcode
+ my $issuingrule = C4::Circulation::GetIssuingRule($borrower->{categorycode}, $item->{$itype}, $branchcode);
+
+ # we retrieve count
+
+ my $reservecount = GetReserveCount($borrowernumber);
+
+ # we check if it's ok or not
+ if(( $reservecount < $allowedreserves ) and $issuingrule->{maxissueqty} ){
+ return 1;
+ }else{
+ return 0;
+ }
+}
+#-------------------------------------------------------------------------------------
=item GetReserveCount
);
#launch the subroutine dotransfer
- C4::Circulation::ModItemTransfer(
+ C4::Items::ModItemTransfer(
$itemnumber,
$iteminfo->{'holdingbranch'},
$checkreserves->{'branchcode'}
return (@transreserv);
}
+sub GetReserveStatus {
+ my ($itemnumber) = @_;
+
+ my $dbh = C4::Context->dbh;
+
+ my $itemstatus = $dbh->prepare("SELECT found FROM reserves WHERE itemnumber = ?");
+
+ $itemstatus->execute($itemnumber);
+ my ($found) = $itemstatus->fetchrow_array;
+ return $found;
+}
+
=item CheckReserves
($status, $reserve) = &CheckReserves($itemnumber);
# Found it
return ( "Waiting", $res );
}
+ elsif( $res->{'itemnumber'} == $item && $res->{'found'} eq 'T' ){
+ return ( "Transit", $res );
+ }
else {
# See if this item is more important than what we've got
# so far.
if ($transferToDo) {
$query = "
UPDATE reserves
- SET priority = 0,
- itemnumber = ?
+ SET priority = 0,
+ itemnumber = ?,
+ found = 'T'
WHERE borrowernumber = ?
AND biblionumber = ?
";
$sth = $dbh->prepare($query);
$sth->execute( $itemnumber, $borrowernumber,$biblionumber);
$sth->finish;
+
+ _koha_notify_reserve( $itemnumber, $borrowernumber, $biblionumber ) if ( !$transferToDo );
+
return;
}
my $sth_upd = $dbh->prepare($query);
$sth_upd->execute( $itemnumber, $borrowernumber, $biblionumber );
# second step update all others reservs
- $query = "
- UPDATE reserves
- SET priority = priority-1
- WHERE biblionumber = ?
- AND priority > 0
- ";
- $sth_upd = $dbh->prepare($query);
- $sth_upd->execute( $biblionumber );
- $sth_upd->finish;
- $sth_upd->finish;
+ _FixPriority($biblionumber, $borrowernumber, '0');
}
=item GetReserveInfo
$item->{wthdrawn} or
$notforloan_per_itemtype;
+
if (C4::Context->preference('AllowOnShelfHolds')) {
return $available_per_item;
} else {
- return ($available_per_item and $item->{onloan});
+ return ($available_per_item and ($item->{onloan} or GetReserveStatus($itemnumber) eq "W"));
}
}
@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
sub _Findgroupreserve {
my ( $bibitem, $biblio, $itemnumber ) = @_;
my $dbh = C4::Context->dbh;
+
+ # check for exact targetted match
+ # This select is valid for both item_level and biblio_level
+ 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 hold_fill_targets.itemnumber = ?
+
+ /;
+ my $sth = $dbh->prepare($item_level_target_query);
+ $sth->execute($itemnumber);
+ my $data = $sth->fetchall_arrayref({});
+ return @$data if (@$data);
+
+ # 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 = ?
+ /;
+ $sth = $dbh->prepare($title_level_target_query);
+ $sth->execute($itemnumber);
+ $data = $sth->fetchall_arrayref({});
+ return @$data if (@$data);
+
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.itemnumber IS NULL OR reserves.itemnumber = ?)
/;
- my $sth = $dbh->prepare($query);
+ $sth = $dbh->prepare($query);
$sth->execute( $biblio, $bibitem, $itemnumber );
- my @results;
- while ( my $data = $sth->fetchrow_hashref ) {
- push( @results, $data );
+ $data = $sth->fetchall_arrayref({});
+ return @$data if (@$data);
+ return undef;
+}
+
+=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',
+ }
+ );
}
- return @results;
}
=back