1 package C4
::HoldsQueue
;
3 # Copyright 2011 Catalyst IT
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 # FIXME: expand perldoc, explain intended logic
32 use C4
::Dates qw
/format_date/;
34 use List
::Util
qw(shuffle);
35 use List
::MoreUtils
qw(any);
38 use vars
qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
48 &UpdateTransportCostMatrix
55 =head2 TransportCostMatrix
57 TransportCostMatrix();
59 Returns Transport Cost Matrix as a hashref <to branch code> => <from branch code> => cost
63 sub TransportCostMatrix
{
64 my $dbh = C4
::Context
->dbh;
65 my $transport_costs = $dbh->selectall_arrayref("SELECT * FROM transport_cost",{ Slice
=> {} });
67 my %transport_cost_matrix;
68 foreach (@
$transport_costs) {
69 my $from = $_->{frombranch
};
70 my $to = $_->{tobranch
};
71 my $cost = $_->{cost
};
72 my $disabled = $_->{disable_transfer
};
73 $transport_cost_matrix{$to}{$from} = { cost
=> $cost, disable_transfer
=> $disabled };
75 return \
%transport_cost_matrix;
78 =head2 UpdateTransportCostMatrix
80 UpdateTransportCostMatrix($records);
82 Updates full Transport Cost Matrix table. $records is an arrayref of records.
83 Records: { frombranch => <code>, tobranch => <code>, cost => <figure>, disable_transfer => <0,1> }
87 sub UpdateTransportCostMatrix
{
89 my $dbh = C4
::Context
->dbh;
91 my $sth = $dbh->prepare("INSERT INTO transport_cost (frombranch, tobranch, cost, disable_transfer) VALUES (?, ?, ?, ?)");
93 $dbh->do("TRUNCATE TABLE transport_cost");
95 my $cost = $_->{cost
};
96 my $from = $_->{frombranch
};
97 my $to = $_->{tobranch
};
98 if ($_->{disable_transfer
}) {
101 elsif ( !defined ($cost) || ($cost !~ m/(0|[1-9][0-9]*)(\.[0-9]*)?/o) ) {
102 warn "Invalid $from -> $to cost $cost - must be a number >= 0, disablig";
104 $_->{disable_transfer
} = 1;
106 $sth->execute( $from, $to, $cost, $_->{disable_transfer
} ?
1 : 0 );
110 =head2 GetHoldsQueueItems
112 GetHoldsQueueItems($branch);
114 Returns hold queue for a holding branch. If branch is omitted, then whole queue is returned
118 sub GetHoldsQueueItems
{
119 my ($branchlimit) = @_;
120 my $dbh = C4
::Context
->dbh;
122 my @bind_params = ();
123 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
125 JOIN biblio USING
(biblionumber
)
126 LEFT JOIN biblioitems USING
(biblionumber
)
127 LEFT JOIN items USING
( itemnumber
)
130 $query .=" WHERE tmp_holdsqueue.holdingbranch = ?";
131 push @bind_params, $branchlimit;
133 $query .= " ORDER BY ccode, location, cn_sort, author, title, pickbranch, reservedate";
134 my $sth = $dbh->prepare($query);
135 $sth->execute(@bind_params);
137 while ( my $row = $sth->fetchrow_hashref ){
138 my $record = GetMarcBiblio
($row->{biblionumber
});
140 $row->{subtitle
} = [ map { $_->{subfield
} } @
{ GetRecordValue
( 'subtitle', $record, '' ) } ];
141 $row->{parts
} = GetRecordValue
('parts',$record,'')->[0]->{subfield
};
142 $row->{numbers
} = GetRecordValue
('numbers',$record,'')->[0]->{subfield
};
145 # return the bib-level or item-level itype per syspref
146 if (!C4
::Context
->preference('item-level_itypes')) {
147 $row->{itype
} = $row->{itemtype
};
149 delete $row->{itemtype
};
160 Top level function that turns reserves into tmp_holdsqueue and hold_fill_targets.
165 my $dbh = C4
::Context
->dbh;
167 $dbh->do("DELETE FROM tmp_holdsqueue"); # clear the old table for new info
168 $dbh->do("DELETE FROM hold_fill_targets");
171 my $total_requests = 0;
172 my $total_available_items = 0;
173 my $num_items_mapped = 0;
176 my $transport_cost_matrix;
177 my $use_transport_cost_matrix = C4
::Context
->preference("UseTransportCostMatrix");
178 if ($use_transport_cost_matrix) {
179 $transport_cost_matrix = TransportCostMatrix
();
180 unless (keys %$transport_cost_matrix) {
181 warn "UseTransportCostMatrix set to yes, but matrix not populated";
182 undef $transport_cost_matrix;
185 unless ($transport_cost_matrix) {
186 $branches_to_use = load_branches_to_pull_from
();
189 my $bibs_with_pending_requests = GetBibsWithPendingHoldRequests
();
191 foreach my $biblionumber (@
$bibs_with_pending_requests) {
193 my $hold_requests = GetPendingHoldRequestsForBib
($biblionumber);
194 my $available_items = GetItemsAvailableToFillHoldRequestsForBib
($biblionumber, $branches_to_use);
195 $total_requests += scalar(@
$hold_requests);
196 $total_available_items += scalar(@
$available_items);
198 my $item_map = MapItemsToHoldRequests
($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix);
200 my $item_map_size = scalar(keys %$item_map)
203 $num_items_mapped += $item_map_size;
204 CreatePicklistFromItemMap
($item_map);
205 AddToHoldTargetMap
($item_map);
206 if (($item_map_size < scalar(@
$hold_requests )) and
207 ($item_map_size < scalar(@
$available_items))) {
208 # DOUBLE CHECK, but this is probably OK - unfilled item-level requests
210 #warn "unfilled requests for $biblionumber";
211 #warn Dumper($hold_requests), Dumper($available_items), Dumper($item_map);
216 =head2 GetBibsWithPendingHoldRequests
218 my $biblionumber_aref = GetBibsWithPendingHoldRequests();
220 Return an arrayref of the biblionumbers of all bibs
221 that have one or more unfilled hold requests.
225 sub GetBibsWithPendingHoldRequests
{
226 my $dbh = C4
::Context
->dbh;
228 my $bib_query = "SELECT DISTINCT biblionumber
232 AND reservedate <= CURRENT_DATE()
235 my $sth = $dbh->prepare($bib_query);
238 my $biblionumbers = $sth->fetchall_arrayref();
240 return [ map { $_->[0] } @
$biblionumbers ];
243 =head2 GetPendingHoldRequestsForBib
245 my $requests = GetPendingHoldRequestsForBib($biblionumber);
247 Returns an arrayref of hashrefs to pending, unfilled hold requests
248 on the bib identified by $biblionumber. The following keys
249 are present in each hashref:
260 The arrayref is sorted in order of increasing priority.
264 sub GetPendingHoldRequestsForBib
{
265 my $biblionumber = shift;
267 my $dbh = C4
::Context
->dbh;
269 my $request_query = "SELECT biblionumber, borrowernumber, itemnumber, priority, reserves.branchcode,
270 reservedate, reservenotes, borrowers.branchcode AS borrowerbranch
272 JOIN borrowers USING (borrowernumber)
273 WHERE biblionumber = ?
276 AND reservedate <= CURRENT_DATE()
279 my $sth = $dbh->prepare($request_query);
280 $sth->execute($biblionumber);
282 my $requests = $sth->fetchall_arrayref({});
287 =head2 GetItemsAvailableToFillHoldRequestsForBib
289 my $available_items = GetItemsAvailableToFillHoldRequestsForBib($biblionumber, $branches_ar);
291 Returns an arrayref of items available to fill hold requests
292 for the bib identified by C<$biblionumber>. An item is available
293 to fill a hold request if and only if:
296 * it is not withdrawn
297 * it is not marked notforloan
298 * it is not currently in transit
300 * it is not sitting on the hold shelf
301 * it is not damaged (unless AllowHoldsOnDamagedItems is on)
305 sub GetItemsAvailableToFillHoldRequestsForBib
{
306 my ($biblionumber, $branches_to_use) = @_;
308 my $dbh = C4
::Context
->dbh;
309 my $items_query = "SELECT itemnumber, homebranch, holdingbranch, itemtypes.itemtype AS itype
312 if (C4
::Context
->preference('item-level_itypes')) {
313 $items_query .= "LEFT JOIN itemtypes ON (itemtypes.itemtype = items.itype) ";
315 $items_query .= "JOIN biblioitems USING (biblioitemnumber)
316 LEFT JOIN itemtypes USING (itemtype) ";
318 $items_query .= "WHERE items.notforloan = 0
319 AND holdingbranch IS NOT NULL
322 $items_query .= " AND damaged = 0" unless C4
::Context
->preference('AllowHoldsOnDamagedItems');
323 $items_query .= " AND items.onloan IS NULL
324 AND (itemtypes.notforloan IS NULL OR itemtypes.notforloan = 0)
325 AND itemnumber NOT IN (
328 WHERE biblionumber = ?
329 AND itemnumber IS NOT NULL
330 AND (found IS NOT NULL OR priority = 0)
332 AND items.biblionumber = ?";
334 my @params = ($biblionumber, $biblionumber);
335 if ($branches_to_use && @
$branches_to_use) {
336 $items_query .= " AND holdingbranch IN (" . join (",", map { "?" } @
$branches_to_use) . ")";
337 push @params, @
$branches_to_use;
339 my $sth = $dbh->prepare($items_query);
340 $sth->execute(@params);
342 my $itm = $sth->fetchall_arrayref({});
343 my @items = grep { ! scalar GetTransfers
($_->{itemnumber
}) } @
$itm;
345 my $rule = GetBranchItemRule
($_->{homebranch
}, $_->{itype
});
346 $_->{holdallowed
} = $rule->{holdallowed
};
350 =head2 MapItemsToHoldRequests
352 MapItemsToHoldRequests($hold_requests, $available_items, $branches, $transport_cost_matrix)
356 sub MapItemsToHoldRequests
{
357 my ($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix) = @_;
359 # handle trival cases
360 return unless scalar(@
$hold_requests) > 0;
361 return unless scalar(@
$available_items) > 0;
363 # identify item-level requests
364 my %specific_items_requested = map { $_->{itemnumber
} => 1 }
365 grep { defined($_->{itemnumber
}) }
368 # group available items by itemnumber
369 my %items_by_itemnumber = map { $_->{itemnumber
} => $_ } @
$available_items;
371 # items already allocated
372 my %allocated_items = ();
374 # map of items to hold requests
377 # figure out which item-level requests can be filled
378 my $num_items_remaining = scalar(@
$available_items);
379 foreach my $request (@
$hold_requests) {
380 last if $num_items_remaining == 0;
382 # is this an item-level request?
383 if (defined($request->{itemnumber
})) {
384 # fill it if possible; if not skip it
385 if (exists $items_by_itemnumber{$request->{itemnumber
}} and
386 not exists $allocated_items{$request->{itemnumber
}}) {
387 $item_map{$request->{itemnumber
}} = {
388 borrowernumber
=> $request->{borrowernumber
},
389 biblionumber
=> $request->{biblionumber
},
390 holdingbranch
=> $items_by_itemnumber{$request->{itemnumber
}}->{holdingbranch
},
391 pickup_branch
=> $request->{branchcode
} || $request->{borrowerbranch
},
393 reservedate
=> $request->{reservedate
},
394 reservenotes
=> $request->{reservenotes
},
396 $allocated_items{$request->{itemnumber
}}++;
397 $num_items_remaining--;
400 # it's title-level request that will take up one item
401 $num_items_remaining--;
405 # group available items by branch
406 my %items_by_branch = ();
407 foreach my $item (@
$available_items) {
408 next unless $item->{holdallowed
};
410 push @
{ $items_by_branch{ $item->{holdingbranch
} } }, $item
411 unless exists $allocated_items{ $item->{itemnumber
} };
413 return \
%item_map unless keys %items_by_branch;
415 # now handle the title-level requests
416 $num_items_remaining = scalar(@
$available_items) - scalar(keys %allocated_items);
418 foreach my $request (@
$hold_requests) {
419 last if $num_items_remaining == 0;
420 next if defined($request->{itemnumber
}); # already handled these
422 # look for local match first
423 my $pickup_branch = $request->{branchcode
} || $request->{borrowerbranch
};
424 my ($itemnumber, $holdingbranch);
426 my $holding_branch_items = $items_by_branch{$pickup_branch};
427 if ( $holding_branch_items ) {
428 foreach my $item (@
$holding_branch_items) {
429 if ( $request->{borrowerbranch
} eq $item->{homebranch
} ) {
430 $itemnumber = $item->{itemnumber
};
434 $holdingbranch = $pickup_branch;
436 elsif ($transport_cost_matrix) {
437 $pull_branches = [keys %items_by_branch];
438 $holdingbranch = least_cost_branch
( $pickup_branch, $pull_branches, $transport_cost_matrix );
439 if ( $holdingbranch ) {
441 my $holding_branch_items = $items_by_branch{$holdingbranch};
442 foreach my $item (@
$holding_branch_items) {
443 next if $request->{borrowerbranch
} ne $item->{homebranch
};
445 $itemnumber = $item->{itemnumber
};
450 warn "No transport costs for $pickup_branch";
454 unless ($itemnumber) {
455 # not found yet, fall back to basics
456 if ($branches_to_use) {
457 $pull_branches = $branches_to_use;
459 $pull_branches = [keys %items_by_branch];
462 foreach my $branch (@
$pull_branches) {
463 my $holding_branch_items = $items_by_branch{$branch}
466 $holdingbranch ||= $branch;
467 foreach my $item (@
$holding_branch_items) {
468 next if $pickup_branch ne $item->{homebranch
};
469 next if ( $item->{holdallowed
} == 1 && $item->{homebranch
} ne $request->{borrowerbranch
} );
471 $itemnumber = $item->{itemnumber
};
472 $holdingbranch = $branch;
477 unless ( $itemnumber ) {
478 foreach my $current_item ( @
{ $items_by_branch{$holdingbranch} } ) {
479 if ( $holdingbranch && ( $current_item->{holdallowed
} == 2 || $request->{borrowerbranch
} eq $current_item->{homebranch
} ) ) {
480 $itemnumber = $current_item->{itemnumber
};
481 last; # quit this loop as soon as we have a suitable item
488 my $holding_branch_items = $items_by_branch{$holdingbranch}
489 or die "Have $itemnumber, $holdingbranch, but no items!";
490 @
$holding_branch_items = grep { $_->{itemnumber
} != $itemnumber } @
$holding_branch_items;
491 delete $items_by_branch{$holdingbranch} unless @
$holding_branch_items;
493 $item_map{$itemnumber} = {
494 borrowernumber
=> $request->{borrowernumber
},
495 biblionumber
=> $request->{biblionumber
},
496 holdingbranch
=> $holdingbranch,
497 pickup_branch
=> $pickup_branch,
499 reservedate
=> $request->{reservedate
},
500 reservenotes
=> $request->{reservenotes
},
502 $num_items_remaining--;
508 =head2 CreatePickListFromItemMap
512 sub CreatePicklistFromItemMap
{
513 my $item_map = shift;
515 my $dbh = C4
::Context
->dbh;
517 my $sth_load=$dbh->prepare("
518 INSERT INTO tmp_holdsqueue (biblionumber,itemnumber,barcode,surname,firstname,phone,borrowernumber,
519 cardnumber,reservedate,title, itemcallnumber,
520 holdingbranch,pickbranch,notes, item_level_request)
521 VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
524 foreach my $itemnumber (sort keys %$item_map) {
525 my $mapped_item = $item_map->{$itemnumber};
526 my $biblionumber = $mapped_item->{biblionumber
};
527 my $borrowernumber = $mapped_item->{borrowernumber
};
528 my $pickbranch = $mapped_item->{pickup_branch
};
529 my $holdingbranch = $mapped_item->{holdingbranch
};
530 my $reservedate = $mapped_item->{reservedate
};
531 my $reservenotes = $mapped_item->{reservenotes
};
532 my $item_level = $mapped_item->{item_level
};
534 my $item = GetItem
($itemnumber);
535 my $barcode = $item->{barcode
};
536 my $itemcallnumber = $item->{itemcallnumber
};
538 my $borrower = GetMember
('borrowernumber'=>$borrowernumber);
539 my $cardnumber = $borrower->{'cardnumber'};
540 my $surname = $borrower->{'surname'};
541 my $firstname = $borrower->{'firstname'};
542 my $phone = $borrower->{'phone'};
544 my $bib = GetBiblioData
($biblionumber);
545 my $title = $bib->{title
};
547 $sth_load->execute($biblionumber, $itemnumber, $barcode, $surname, $firstname, $phone, $borrowernumber,
548 $cardnumber, $reservedate, $title, $itemcallnumber,
549 $holdingbranch, $pickbranch, $reservenotes, $item_level);
553 =head2 AddToHoldTargetMap
557 sub AddToHoldTargetMap
{
558 my $item_map = shift;
560 my $dbh = C4
::Context
->dbh;
563 INSERT INTO hold_fill_targets
(borrowernumber
, biblionumber
, itemnumber
, source_branchcode
, item_level_request
)
564 VALUES
(?
, ?
, ?
, ?
, ?
)
566 my $sth_insert = $dbh->prepare($insert_sql);
568 foreach my $itemnumber (keys %$item_map) {
569 my $mapped_item = $item_map->{$itemnumber};
570 $sth_insert->execute($mapped_item->{borrowernumber
}, $mapped_item->{biblionumber
}, $itemnumber,
571 $mapped_item->{holdingbranch
}, $mapped_item->{item_level
});
575 # Helper functions, not part of any interface
578 return $_[0] unless $_[0];
584 sub load_branches_to_pull_from
{
585 my $static_branch_list = C4
::Context
->preference("StaticHoldsQueueWeight")
588 my @branches_to_use = map _trim
($_), split /,/, $static_branch_list;
590 @branches_to_use = shuffle
(@branches_to_use) if C4
::Context
->preference("RandomizeHoldsQueueWeight");
592 return \
@branches_to_use;
595 sub least_cost_branch
{
598 my ($to, $from, $transport_cost_matrix) = @_;
600 # Nothing really spectacular: supply to branch, a list of potential from branches
601 # and find the minimum from - to value from the transport_cost_matrix
602 return $from->[0] if @
$from == 1;
604 # If the pickup library is in the list of libraries to pull from,
605 # return that library right away, it is obviously the least costly
606 return ($to) if any
{ $_ eq $to } @
$from;
608 my ($least_cost, @branch);
610 my $cell = $transport_cost_matrix->{$to}{$_};
611 next if $cell->{disable_transfer
};
613 my $cost = $cell->{cost
};
614 next unless defined $cost; # XXX should this be reported?
616 unless (defined $least_cost) {
622 next if $cost > $least_cost;
624 if ($cost == $least_cost) {
635 # XXX return a random @branch with minimum cost instead of the first one;
636 # return $branch[0] if @branch == 1;