#
# This file is part of Koha.
#
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
#
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
# FIXME: expand perldoc, explain intended logic
use C4::Context;
use C4::Search;
use C4::Items;
-use C4::Branch;
use C4::Circulation;
use C4::Members;
use C4::Biblio;
-use C4::Dates qw/format_date/;
+use Koha::DateUtils;
+use Koha::Items;
+use Koha::Patrons;
+use Koha::Libraries;
use List::Util qw(shuffle);
use List::MoreUtils qw(any);
use Data::Dumper;
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
BEGIN {
- $VERSION = 3.03;
require Exporter;
@ISA = qw(Exporter);
@EXPORT_OK = qw(
=cut
sub TransportCostMatrix {
+ my ( $params ) = @_;
+ my $ignore_holds_queue_skip_closed = $params->{ignore_holds_queue_skip_closed};
+
my $dbh = C4::Context->dbh;
my $transport_costs = $dbh->selectall_arrayref("SELECT * FROM transport_cost",{ Slice => {} });
+ my $today = dt_from_string();
+ my $calendars;
my %transport_cost_matrix;
foreach (@$transport_costs) {
- my $from = $_->{frombranch};
- my $to = $_->{tobranch};
- my $cost = $_->{cost};
+ my $from = $_->{frombranch};
+ my $to = $_->{tobranch};
+ my $cost = $_->{cost};
my $disabled = $_->{disable_transfer};
- $transport_cost_matrix{$to}{$from} = { cost => $cost, disable_transfer => $disabled };
+ $transport_cost_matrix{$to}{$from} = {
+ cost => $cost,
+ disable_transfer => $disabled
+ };
+
+ if ( !$ignore_holds_queue_skip_closed && C4::Context->preference("HoldsQueueSkipClosed") ) {
+ $calendars->{$from} ||= Koha::Calendar->new( branchcode => $from );
+ $transport_cost_matrix{$to}{$from}{disable_transfer} ||=
+ $calendars->{$from}->is_holiday( $today );
+ }
+
}
return \%transport_cost_matrix;
}
my $sth = $dbh->prepare("INSERT INTO transport_cost (frombranch, tobranch, cost, disable_transfer) VALUES (?, ?, ?, ?)");
- $dbh->do("TRUNCATE TABLE transport_cost");
+ $dbh->do("DELETE FROM transport_cost");
foreach (@$records) {
my $cost = $_->{cost};
my $from = $_->{frombranch};
$cost ||= 0;
}
elsif ( !defined ($cost) || ($cost !~ m/(0|[1-9][0-9]*)(\.[0-9]*)?/o) ) {
- warn "Invalid $from -> $to cost $cost - must be a number >= 0, disablig";
+ warn "Invalid $from -> $to cost $cost - must be a number >= 0, disabling";
$cost = 0;
$_->{disable_transfer} = 1;
}
my $dbh = C4::Context->dbh;
my @bind_params = ();
- my $query = q/SELECT tmp_holdsqueue.*, biblio.author, items.ccode, items.itype, biblioitems.itemtype, items.location, items.enumchron, items.cn_sort, biblioitems.publishercode,biblio.copyrightdate,biblioitems.publicationyear,biblioitems.pages,biblioitems.size,biblioitems.publicationyear,biblioitems.isbn,items.copynumber
+ my $query = q/SELECT tmp_holdsqueue.*, biblio.author, items.ccode, items.itype, biblioitems.itemtype, items.location,
+ items.enumchron, items.cn_sort, biblioitems.publishercode,
+ biblio.copyrightdate, biblio.subtitle, biblio.medium,
+ biblio.part_number, biblio.part_name,
+ biblioitems.publicationyear, biblioitems.pages, biblioitems.size,
+ biblioitems.isbn, biblioitems.editionstatement, items.copynumber
FROM tmp_holdsqueue
JOIN biblio USING (biblionumber)
LEFT JOIN biblioitems USING (biblionumber)
$sth->execute(@bind_params);
my $items = [];
while ( my $row = $sth->fetchrow_hashref ){
- $row->{reservedate} = format_date($row->{reservedate});
- my $record = GetMarcBiblio($row->{biblionumber});
- if ($record){
- $row->{subtitle} = GetRecordValue('subtitle',$record,'')->[0]->{subfield};
- $row->{parts} = GetRecordValue('parts',$record,'')->[0]->{subfield};
- $row->{numbers} = GetRecordValue('numbers',$record,'')->[0]->{subfield};
- }
-
# return the bib-level or item-level itype per syspref
if (!C4::Context->preference('item-level_itypes')) {
$row->{itype} = $row->{itemtype};
my $dbh = C4::Context->dbh;
- my $request_query = "SELECT biblionumber, borrowernumber, itemnumber, priority, reserves.branchcode,
- reservedate, reservenotes, borrowers.branchcode AS borrowerbranch
+ my $request_query = "SELECT biblionumber, borrowernumber, itemnumber, priority, reserve_id, reserves.branchcode,
+ reservedate, reservenotes, borrowers.branchcode AS borrowerbranch, itemtype, item_level_hold
FROM reserves
JOIN borrowers USING (borrowernumber)
WHERE biblionumber = ?
* it is not currently in transit
* it is not lost
* it is not sitting on the hold shelf
+ * it is not damaged (unless AllowHoldsOnDamagedItems is on)
=cut
AND (found IS NOT NULL OR priority = 0)
)
AND items.biblionumber = ?";
- $items_query .= " AND damaged = 0 "
- unless C4::Context->preference('AllowHoldsOnDamagedItems');
my @params = ($biblionumber, $biblionumber);
if ($branches_to_use && @$branches_to_use) {
return [ grep {
my $rule = GetBranchItemRule($_->{homebranch}, $_->{itype});
$_->{holdallowed} = $rule->{holdallowed};
+ $_->{hold_fulfillment_policy} = $rule->{hold_fulfillment_policy};
} @items ];
}
+=head2 _checkHoldPolicy
+
+ _checkHoldPolicy($item, $request)
+
+ check if item agrees with hold policies
+
+=cut
+
+sub _checkHoldPolicy {
+ my ( $item, $request ) = @_;
+
+ return 0 unless $item->{holdallowed} ne 'not_allowed';
+
+ return 0
+ if $item->{holdallowed} eq 'from_home_library'
+ && $item->{homebranch} ne $request->{borrowerbranch};
+
+ return 0
+ if $item->{'holdallowed'} eq 'from_local_hold_group'
+ && !Koha::Libraries->find( $item->{homebranch} )
+ ->validate_hold_sibling( { branchcode => $request->{borrowerbranch} } );
+
+ my $hold_fulfillment_policy = $item->{hold_fulfillment_policy};
+
+ return 0
+ if $hold_fulfillment_policy eq 'holdgroup'
+ && !Koha::Libraries->find( $item->{homebranch} )
+ ->validate_hold_sibling( { branchcode => $request->{branchcode} } );
+
+ return 0
+ if $hold_fulfillment_policy eq 'homebranch'
+ && $request->{branchcode} ne $item->{$hold_fulfillment_policy};
+
+ return 0
+ if $hold_fulfillment_policy eq 'holdingbranch'
+ && $request->{branchcode} ne $item->{$hold_fulfillment_policy};
+
+ return 0
+ if $hold_fulfillment_policy eq 'patrongroup'
+ && !Koha::Libraries->find( $request->{borrowerbranch} )
+ ->validate_hold_sibling( { branchcode => $request->{branchcode} } );
+
+ return 1;
+
+}
+
=head2 MapItemsToHoldRequests
MapItemsToHoldRequests($hold_requests, $available_items, $branches, $transport_cost_matrix)
grep { defined($_->{itemnumber}) }
@$hold_requests;
+ map { $_->{_object} = Koha::Items->find( $_->{itemnumber} ) } @$available_items;
+ my $libraries = {};
+ map { $libraries->{$_->id} = $_ } Koha::Libraries->search();
+
# group available items by itemnumber
my %items_by_itemnumber = map { $_->{itemnumber} => $_ } @$available_items;
# figure out which item-level requests can be filled
my $num_items_remaining = scalar(@$available_items);
+
+ # Look for Local Holds Priority matches first
+ if ( C4::Context->preference('LocalHoldsPriority') ) {
+ my $LocalHoldsPriorityPatronControl =
+ C4::Context->preference('LocalHoldsPriorityPatronControl');
+ my $LocalHoldsPriorityItemControl =
+ C4::Context->preference('LocalHoldsPriorityItemControl');
+
+ foreach my $request (@$hold_requests) {
+ last if $num_items_remaining == 0;
+ my $patron = Koha::Patrons->find($request->{borrowernumber});
+ next if $patron->category->exclude_from_local_holds_priority;
+
+ my $local_hold_match;
+ foreach my $item (@$available_items) {
+ next if $item->{_object}->exclude_from_local_holds_priority;
+
+ next unless _checkHoldPolicy($item, $request);
+
+ next if $request->{itemnumber} && $request->{itemnumber} != $item->{itemnumber};
+
+ next unless $item->{_object}->can_be_transferred( { to => $libraries->{ $request->{branchcode} } } );
+
+ my $local_holds_priority_item_branchcode =
+ $item->{$LocalHoldsPriorityItemControl};
+
+ my $local_holds_priority_patron_branchcode =
+ ( $LocalHoldsPriorityPatronControl eq 'PickupLibrary' )
+ ? $request->{branchcode}
+ : ( $LocalHoldsPriorityPatronControl eq 'HomeLibrary' )
+ ? $request->{borrowerbranch}
+ : undef;
+
+ $local_hold_match =
+ $local_holds_priority_item_branchcode eq
+ $local_holds_priority_patron_branchcode;
+
+ if ($local_hold_match) {
+ if ( exists $items_by_itemnumber{ $item->{itemnumber} }
+ and not exists $allocated_items{ $item->{itemnumber} }
+ and not $request->{allocated})
+ {
+ $item_map{ $item->{itemnumber} } = {
+ borrowernumber => $request->{borrowernumber},
+ biblionumber => $request->{biblionumber},
+ holdingbranch => $item->{holdingbranch},
+ pickup_branch => $request->{branchcode}
+ || $request->{borrowerbranch},
+ reserve_id => $request->{reserve_id},
+ item_level => $request->{item_level_hold},
+ reservedate => $request->{reservedate},
+ reservenotes => $request->{reservenotes},
+ };
+ $allocated_items{ $item->{itemnumber} }++;
+ $request->{allocated} = 1;
+ $num_items_remaining--;
+ }
+ }
+ }
+ }
+ }
+
foreach my $request (@$hold_requests) {
last if $num_items_remaining == 0;
+ next if $request->{allocated};
# is this an item-level request?
if (defined($request->{itemnumber})) {
# fill it if possible; if not skip it
- if (exists $items_by_itemnumber{$request->{itemnumber}} and
- not exists $allocated_items{$request->{itemnumber}}) {
- $item_map{$request->{itemnumber}} = {
+ if (
+ exists $items_by_itemnumber{ $request->{itemnumber} }
+ and not exists $allocated_items{ $request->{itemnumber} }
+ and _checkHoldPolicy($items_by_itemnumber{ $request->{itemnumber} }, $request) # Don't fill item level holds that contravene the hold pickup policy at this time
+ and ( !$request->{itemtype} # If hold itemtype is set, item's itemtype must match
+ || $items_by_itemnumber{ $request->{itemnumber} }->{itype} eq $request->{itemtype} )
+
+ and $items_by_itemnumber{ $request->{itemnumber} }->{_object}->can_be_transferred( { to => $libraries->{ $request->{branchcode} } } )
+
+ )
+ {
+
+ $item_map{ $request->{itemnumber} } = {
borrowernumber => $request->{borrowernumber},
- biblionumber => $request->{biblionumber},
- holdingbranch => $items_by_itemnumber{$request->{itemnumber}}->{holdingbranch},
- pickup_branch => $request->{branchcode} || $request->{borrowerbranch},
- item_level => 1,
- reservedate => $request->{reservedate},
- reservenotes => $request->{reservenotes},
+ biblionumber => $request->{biblionumber},
+ holdingbranch => $items_by_itemnumber{ $request->{itemnumber} }->{holdingbranch},
+ pickup_branch => $request->{branchcode} || $request->{borrowerbranch},
+ reserve_id => $request->{reserve_id},
+ item_level => $request->{item_level_hold},
+ reservedate => $request->{reservedate},
+ reservenotes => $request->{reservenotes},
};
- $allocated_items{$request->{itemnumber}}++;
+ $allocated_items{ $request->{itemnumber} }++;
$num_items_remaining--;
}
} else {
# group available items by branch
my %items_by_branch = ();
foreach my $item (@$available_items) {
- next unless $item->{holdallowed};
+ next unless $item->{holdallowed} ne 'not_allowed';
push @{ $items_by_branch{ $item->{holdingbranch} } }, $item
unless exists $allocated_items{ $item->{itemnumber} };
my $pull_branches;
foreach my $request (@$hold_requests) {
last if $num_items_remaining == 0;
+ next if $request->{allocated};
next if defined($request->{itemnumber}); # already handled these
# look for local match first
my $holding_branch_items = $items_by_branch{$pickup_branch};
if ( $holding_branch_items ) {
foreach my $item (@$holding_branch_items) {
- if ( $request->{borrowerbranch} eq $item->{homebranch} ) {
+ next unless $items_by_itemnumber{ $item->{itemnumber} }->{_object}->can_be_transferred( { to => $libraries->{ $request->{branchcode} } } );
+
+ if (
+ $request->{borrowerbranch} eq $item->{homebranch}
+ && _checkHoldPolicy($item, $request) # Don't fill item level holds that contravene the hold pickup policy at this time
+ && ( !$request->{itemtype} # If hold itemtype is set, item's itemtype must match
+ || ( $request->{itemnumber} && ( $items_by_itemnumber{ $request->{itemnumber} }->{itype} eq $request->{itemtype} ) ) )
+ )
+ {
$itemnumber = $item->{itemnumber};
last;
}
}
$holdingbranch = $pickup_branch;
- $itemnumber ||= $holding_branch_items->[0]->{itemnumber};
}
elsif ($transport_cost_matrix) {
$pull_branches = [keys %items_by_branch];
my $holding_branch_items = $items_by_branch{$holdingbranch};
foreach my $item (@$holding_branch_items) {
next if $request->{borrowerbranch} ne $item->{homebranch};
+ next unless $items_by_itemnumber{ $item->{itemnumber} }->{_object}->can_be_transferred( { to => $libraries->{ $request->{branchcode} } } );
+
+ # Don't fill item level holds that contravene the hold pickup policy at this time
+ next unless _checkHoldPolicy($item, $request);
+
+ # If hold itemtype is set, item's itemtype must match
+ next unless ( !$request->{itemtype}
+ || $item->{itype} eq $request->{itemtype} );
$itemnumber = $item->{itemnumber};
last;
}
- $itemnumber ||= $holding_branch_items->[0]->{itemnumber};
}
else {
- warn "No transport costs for $pickup_branch";
+ next;
}
}
} else {
$pull_branches = [keys %items_by_branch];
}
+
+ # Try picking items where the home and pickup branch match first
PULL_BRANCHES:
foreach my $branch (@$pull_branches) {
my $holding_branch_items = $items_by_branch{$branch}
$holdingbranch ||= $branch;
foreach my $item (@$holding_branch_items) {
next if $pickup_branch ne $item->{homebranch};
+ next unless _checkHoldPolicy($item, $request);
+ next unless $items_by_itemnumber{ $item->{itemnumber} }->{_object}->can_be_transferred( { to => $libraries->{ $request->{branchcode} } } );
+
+ # Don't fill item level holds that contravene the hold pickup policy at this time
+ next unless $item->{hold_fulfillment_policy} eq 'any'
+ || $request->{branchcode} eq $item->{ $item->{hold_fulfillment_policy} };
+
+ # If hold itemtype is set, item's itemtype must match
+ next unless ( !$request->{itemtype}
+ || $item->{itype} eq $request->{itemtype} );
$itemnumber = $item->{itemnumber};
$holdingbranch = $branch;
}
}
- unless ( $itemnumber ) {
+ # Now try items from the least cost branch based on the transport cost matrix or StaticHoldsQueueWeight
+ unless ( $itemnumber || !$holdingbranch) {
foreach my $current_item ( @{ $items_by_branch{$holdingbranch} } ) {
- if ( $holdingbranch && ( $current_item->{holdallowed} == 2 || $pickup_branch eq $current_item->{homebranch} ) ) {
- $itemnumber = $current_item->{itemnumber};
- last; # quit this loop as soon as we have a suitable item
+ next unless _checkHoldPolicy($current_item, $request); # Don't fill item level holds that contravene the hold pickup policy at this time
+
+ # If hold itemtype is set, item's itemtype must match
+ next unless ( !$request->{itemtype}
+ || $current_item->{itype} eq $request->{itemtype} );
+
+ next unless $items_by_itemnumber{ $current_item->{itemnumber} }->{_object}->can_be_transferred( { to => $libraries->{ $request->{branchcode} } } );
+
+ $itemnumber = $current_item->{itemnumber};
+ last; # quit this loop as soon as we have a suitable item
+ }
+ }
+
+ # Now try for items for any item that can fill this hold
+ unless ( $itemnumber ) {
+ PULL_BRANCHES2:
+ foreach my $branch (@$pull_branches) {
+ my $holding_branch_items = $items_by_branch{$branch}
+ or next;
+
+ foreach my $item (@$holding_branch_items) {
+ # Don't fill item level holds that contravene the hold pickup policy at this time
+ next unless _checkHoldPolicy($item, $request);
+
+ # If hold itemtype is set, item's itemtype must match
+ next unless ( !$request->{itemtype}
+ || $item->{itype} eq $request->{itemtype} );
+
+ next unless $items_by_itemnumber{ $item->{itemnumber} }->{_object}->can_be_transferred( { to => $libraries->{ $request->{branchcode} } } );
+
+ $itemnumber = $item->{itemnumber};
+ $holdingbranch = $branch;
+ last PULL_BRANCHES2;
}
}
}
biblionumber => $request->{biblionumber},
holdingbranch => $holdingbranch,
pickup_branch => $pickup_branch,
- item_level => 0,
+ reserve_id => $request->{reserve_id},
+ item_level => $request->{item_level_hold},
reservedate => $request->{reservedate},
reservenotes => $request->{reservenotes},
};
my $reservenotes = $mapped_item->{reservenotes};
my $item_level = $mapped_item->{item_level};
- my $item = GetItem($itemnumber);
- my $barcode = $item->{barcode};
- my $itemcallnumber = $item->{itemcallnumber};
+ my $item = Koha::Items->find($itemnumber);
+ my $barcode = $item->barcode;
+ my $itemcallnumber = $item->itemcallnumber;
- my $borrower = GetMember('borrowernumber'=>$borrowernumber);
- my $cardnumber = $borrower->{'cardnumber'};
- my $surname = $borrower->{'surname'};
- my $firstname = $borrower->{'firstname'};
- my $phone = $borrower->{'phone'};
+ my $patron = Koha::Patrons->find( $borrowernumber );
+ my $cardnumber = $patron->cardnumber;
+ my $surname = $patron->surname;
+ my $firstname = $patron->firstname;
+ my $phone = $patron->phone;
- my $bib = GetBiblioData($biblionumber);
- my $title = $bib->{title};
+ my $biblio = Koha::Biblios->find( $biblionumber );
+ my $title = $biblio->title;
$sth_load->execute($biblionumber, $itemnumber, $barcode, $surname, $firstname, $phone, $borrowernumber,
$cardnumber, $reservedate, $title, $itemcallnumber,
my $dbh = C4::Context->dbh;
my $insert_sql = q(
- INSERT INTO hold_fill_targets (borrowernumber, biblionumber, itemnumber, source_branchcode, item_level_request)
- VALUES (?, ?, ?, ?, ?)
+ INSERT INTO hold_fill_targets (borrowernumber, biblionumber, itemnumber, source_branchcode, item_level_request, reserve_id)
+ VALUES (?, ?, ?, ?, ?, ?)
);
my $sth_insert = $dbh->prepare($insert_sql);
foreach my $itemnumber (keys %$item_map) {
my $mapped_item = $item_map->{$itemnumber};
$sth_insert->execute($mapped_item->{borrowernumber}, $mapped_item->{biblionumber}, $itemnumber,
- $mapped_item->{holdingbranch}, $mapped_item->{item_level});
+ $mapped_item->{holdingbranch}, $mapped_item->{item_level}, $mapped_item->{reserve_id});
}
}
}
sub load_branches_to_pull_from {
- my $static_branch_list = C4::Context->preference("StaticHoldsQueueWeight")
- or return;
-
- my @branches_to_use = map _trim($_), split /,/, $static_branch_list;
-
- @branches_to_use = shuffle(@branches_to_use) if C4::Context->preference("RandomizeHoldsQueueWeight");
+ my @branches_to_use;
+
+ my $static_branch_list = C4::Context->preference("StaticHoldsQueueWeight");
+ @branches_to_use = map { _trim($_) } split( /,/, $static_branch_list )
+ if $static_branch_list;
+
+ @branches_to_use =
+ Koha::Database->new()->schema()->resultset('Branch')
+ ->get_column('branchcode')->all()
+ unless (@branches_to_use);
+
+ @branches_to_use = shuffle(@branches_to_use)
+ if C4::Context->preference("RandomizeHoldsQueueWeight");
+
+ my $today = dt_from_string();
+ if ( C4::Context->preference('HoldsQueueSkipClosed') ) {
+ @branches_to_use = grep {
+ !Koha::Calendar->new( branchcode => $_ )
+ ->is_holiday( $today )
+ } @branches_to_use;
+ }
return \@branches_to_use;
}
# Nothing really spectacular: supply to branch, a list of potential from branches
# and find the minimum from - to value from the transport_cost_matrix
- return $from->[0] if @$from == 1;
+ return $from->[0] if ( @$from == 1 && $transport_cost_matrix->{$to}{$from->[0]}->{disable_transfer} != 1 );
# If the pickup library is in the list of libraries to pull from,
# return that library right away, it is obviously the least costly