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 under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
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.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 $row->{reservedate} = format_date($row->{reservedate});
139 my $record = GetMarcBiblio($row->{biblionumber});
141 $row->{subtitle} = GetRecordValue('subtitle',$record,'')->[0]->{subfield};
142 $row->{parts} = GetRecordValue('parts',$record,'')->[0]->{subfield};
143 $row->{numbers} = GetRecordValue('numbers',$record,'')->[0]->{subfield};
154 Top level function that turns reserves into tmp_holdsqueue and hold_fill_targets.
159 my $dbh = C4::Context->dbh;
161 $dbh->do("DELETE FROM tmp_holdsqueue"); # clear the old table for new info
162 $dbh->do("DELETE FROM hold_fill_targets");
165 my $total_requests = 0;
166 my $total_available_items = 0;
167 my $num_items_mapped = 0;
170 my $transport_cost_matrix;
171 my $use_transport_cost_matrix = C4::Context->preference("UseTransportCostMatrix");
172 if ($use_transport_cost_matrix) {
173 $transport_cost_matrix = TransportCostMatrix();
174 unless (keys %$transport_cost_matrix) {
175 warn "UseTransportCostMatrix set to yes, but matrix not populated";
176 undef $transport_cost_matrix;
179 unless ($transport_cost_matrix) {
180 $branches_to_use = load_branches_to_pull_from();
183 my $bibs_with_pending_requests = GetBibsWithPendingHoldRequests();
185 foreach my $biblionumber (@$bibs_with_pending_requests) {
187 my $hold_requests = GetPendingHoldRequestsForBib($biblionumber);
188 my $available_items = GetItemsAvailableToFillHoldRequestsForBib($biblionumber, $branches_to_use);
189 $total_requests += scalar(@$hold_requests);
190 $total_available_items += scalar(@$available_items);
192 my $item_map = MapItemsToHoldRequests($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix);
194 my $item_map_size = scalar(keys %$item_map)
197 $num_items_mapped += $item_map_size;
198 CreatePicklistFromItemMap($item_map);
199 AddToHoldTargetMap($item_map);
200 if (($item_map_size < scalar(@$hold_requests )) and
201 ($item_map_size < scalar(@$available_items))) {
202 # DOUBLE CHECK, but this is probably OK - unfilled item-level requests
204 #warn "unfilled requests for $biblionumber";
205 #warn Dumper($hold_requests), Dumper($available_items), Dumper($item_map);
210 =head2 GetBibsWithPendingHoldRequests
212 my $biblionumber_aref = GetBibsWithPendingHoldRequests();
214 Return an arrayref of the biblionumbers of all bibs
215 that have one or more unfilled hold requests.
219 sub GetBibsWithPendingHoldRequests {
220 my $dbh = C4::Context->dbh;
222 my $bib_query = "SELECT DISTINCT biblionumber
226 AND reservedate <= CURRENT_DATE()
229 my $sth = $dbh->prepare($bib_query);
232 my $biblionumbers = $sth->fetchall_arrayref();
234 return [ map { $_->[0] } @$biblionumbers ];
237 =head2 GetPendingHoldRequestsForBib
239 my $requests = GetPendingHoldRequestsForBib($biblionumber);
241 Returns an arrayref of hashrefs to pending, unfilled hold requests
242 on the bib identified by $biblionumber. The following keys
243 are present in each hashref:
254 The arrayref is sorted in order of increasing priority.
258 sub GetPendingHoldRequestsForBib {
259 my $biblionumber = shift;
261 my $dbh = C4::Context->dbh;
263 my $request_query = "SELECT biblionumber, borrowernumber, itemnumber, priority, reserves.branchcode,
264 reservedate, reservenotes, borrowers.branchcode AS borrowerbranch
266 JOIN borrowers USING (borrowernumber)
267 WHERE biblionumber = ?
270 AND reservedate <= CURRENT_DATE()
273 my $sth = $dbh->prepare($request_query);
274 $sth->execute($biblionumber);
276 my $requests = $sth->fetchall_arrayref({});
281 =head2 GetItemsAvailableToFillHoldRequestsForBib
283 my $available_items = GetItemsAvailableToFillHoldRequestsForBib($biblionumber, $branches_ar);
285 Returns an arrayref of items available to fill hold requests
286 for the bib identified by C<$biblionumber>. An item is available
287 to fill a hold request if and only if:
290 * it is not withdrawn
291 * it is not marked notforloan
292 * it is not currently in transit
294 * it is not sitting on the hold shelf
298 sub GetItemsAvailableToFillHoldRequestsForBib {
299 my ($biblionumber, $branches_to_use) = @_;
301 my $dbh = C4::Context->dbh;
302 my $items_query = "SELECT itemnumber, homebranch, holdingbranch, itemtypes.itemtype AS itype
305 if (C4::Context->preference('item-level_itypes')) {
306 $items_query .= "LEFT JOIN itemtypes ON (itemtypes.itemtype = items.itype) ";
308 $items_query .= "JOIN biblioitems USING (biblioitemnumber)
309 LEFT JOIN itemtypes USING (itemtype) ";
311 $items_query .= "WHERE items.notforloan = 0
312 AND holdingbranch IS NOT NULL
315 $items_query .= " AND damaged = 0" unless C4::Context->preference('AllowHoldsOnDamagedItems');
316 $items_query .= " AND items.onloan IS NULL
317 AND (itemtypes.notforloan IS NULL OR itemtypes.notforloan = 0)
318 AND itemnumber NOT IN (
321 WHERE biblionumber = ?
322 AND itemnumber IS NOT NULL
323 AND (found IS NOT NULL OR priority = 0)
325 AND items.biblionumber = ?";
326 $items_query .= " AND damaged = 0 "
327 unless C4::Context->preference('AllowHoldsOnDamagedItems');
329 my @params = ($biblionumber, $biblionumber);
330 if ($branches_to_use && @$branches_to_use) {
331 $items_query .= " AND holdingbranch IN (" . join (",", map { "?" } @$branches_to_use) . ")";
332 push @params, @$branches_to_use;
334 my $sth = $dbh->prepare($items_query);
335 $sth->execute(@params);
337 my $itm = $sth->fetchall_arrayref({});
338 my @items = grep { ! scalar GetTransfers($_->{itemnumber}) } @$itm;
340 my $rule = GetBranchItemRule($_->{homebranch}, $_->{itype});
341 $_->{holdallowed} = $rule->{holdallowed};
345 =head2 MapItemsToHoldRequests
347 MapItemsToHoldRequests($hold_requests, $available_items, $branches, $transport_cost_matrix)
351 sub MapItemsToHoldRequests {
352 my ($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix) = @_;
354 # handle trival cases
355 return unless scalar(@$hold_requests) > 0;
356 return unless scalar(@$available_items) > 0;
358 # identify item-level requests
359 my %specific_items_requested = map { $_->{itemnumber} => 1 }
360 grep { defined($_->{itemnumber}) }
363 # group available items by itemnumber
364 my %items_by_itemnumber = map { $_->{itemnumber} => $_ } @$available_items;
366 # items already allocated
367 my %allocated_items = ();
369 # map of items to hold requests
372 # figure out which item-level requests can be filled
373 my $num_items_remaining = scalar(@$available_items);
374 foreach my $request (@$hold_requests) {
375 last if $num_items_remaining == 0;
377 # is this an item-level request?
378 if (defined($request->{itemnumber})) {
379 # fill it if possible; if not skip it
380 if (exists $items_by_itemnumber{$request->{itemnumber}} and
381 not exists $allocated_items{$request->{itemnumber}}) {
382 $item_map{$request->{itemnumber}} = {
383 borrowernumber => $request->{borrowernumber},
384 biblionumber => $request->{biblionumber},
385 holdingbranch => $items_by_itemnumber{$request->{itemnumber}}->{holdingbranch},
386 pickup_branch => $request->{branchcode} || $request->{borrowerbranch},
388 reservedate => $request->{reservedate},
389 reservenotes => $request->{reservenotes},
391 $allocated_items{$request->{itemnumber}}++;
392 $num_items_remaining--;
395 # it's title-level request that will take up one item
396 $num_items_remaining--;
400 # group available items by branch
401 my %items_by_branch = ();
402 foreach my $item (@$available_items) {
403 next unless $item->{holdallowed};
405 push @{ $items_by_branch{ $item->{holdingbranch} } }, $item
406 unless exists $allocated_items{ $item->{itemnumber} };
408 return \%item_map unless keys %items_by_branch;
410 # now handle the title-level requests
411 $num_items_remaining = scalar(@$available_items) - scalar(keys %allocated_items);
413 foreach my $request (@$hold_requests) {
414 last if $num_items_remaining == 0;
415 next if defined($request->{itemnumber}); # already handled these
417 # look for local match first
418 my $pickup_branch = $request->{branchcode} || $request->{borrowerbranch};
419 my ($itemnumber, $holdingbranch);
421 my $holding_branch_items = $items_by_branch{$pickup_branch};
422 if ( $holding_branch_items ) {
423 foreach my $item (@$holding_branch_items) {
424 if ( $request->{borrowerbranch} eq $item->{homebranch} ) {
425 $itemnumber = $item->{itemnumber};
429 $holdingbranch = $pickup_branch;
430 $itemnumber ||= $holding_branch_items->[0]->{itemnumber};
432 elsif ($transport_cost_matrix) {
433 $pull_branches = [keys %items_by_branch];
434 $holdingbranch = least_cost_branch( $pickup_branch, $pull_branches, $transport_cost_matrix );
435 if ( $holdingbranch ) {
437 my $holding_branch_items = $items_by_branch{$holdingbranch};
438 foreach my $item (@$holding_branch_items) {
439 next if $request->{borrowerbranch} ne $item->{homebranch};
441 $itemnumber = $item->{itemnumber};
446 warn "No transport costs for $pickup_branch";
450 unless ($itemnumber) {
451 # not found yet, fall back to basics
452 if ($branches_to_use) {
453 $pull_branches = $branches_to_use;
455 $pull_branches = [keys %items_by_branch];
458 foreach my $branch (@$pull_branches) {
459 my $holding_branch_items = $items_by_branch{$branch}
462 $holdingbranch ||= $branch;
463 foreach my $item (@$holding_branch_items) {
464 next if $pickup_branch ne $item->{homebranch};
466 $itemnumber = $item->{itemnumber};
467 $holdingbranch = $branch;
472 unless ( $itemnumber ) {
473 foreach my $current_item ( @{ $items_by_branch{$holdingbranch} } ) {
474 if ( $holdingbranch && ( $current_item->{holdallowed} == 2 || $pickup_branch eq $current_item->{homebranch} ) ) {
475 $itemnumber = $current_item->{itemnumber};
476 last; # quit this loop as soon as we have a suitable item
483 my $holding_branch_items = $items_by_branch{$holdingbranch}
484 or die "Have $itemnumber, $holdingbranch, but no items!";
485 @$holding_branch_items = grep { $_->{itemnumber} != $itemnumber } @$holding_branch_items;
486 delete $items_by_branch{$holdingbranch} unless @$holding_branch_items;
488 $item_map{$itemnumber} = {
489 borrowernumber => $request->{borrowernumber},
490 biblionumber => $request->{biblionumber},
491 holdingbranch => $holdingbranch,
492 pickup_branch => $pickup_branch,
494 reservedate => $request->{reservedate},
495 reservenotes => $request->{reservenotes},
497 $num_items_remaining--;
503 =head2 CreatePickListFromItemMap
507 sub CreatePicklistFromItemMap {
508 my $item_map = shift;
510 my $dbh = C4::Context->dbh;
512 my $sth_load=$dbh->prepare("
513 INSERT INTO tmp_holdsqueue (biblionumber,itemnumber,barcode,surname,firstname,phone,borrowernumber,
514 cardnumber,reservedate,title, itemcallnumber,
515 holdingbranch,pickbranch,notes, item_level_request)
516 VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
519 foreach my $itemnumber (sort keys %$item_map) {
520 my $mapped_item = $item_map->{$itemnumber};
521 my $biblionumber = $mapped_item->{biblionumber};
522 my $borrowernumber = $mapped_item->{borrowernumber};
523 my $pickbranch = $mapped_item->{pickup_branch};
524 my $holdingbranch = $mapped_item->{holdingbranch};
525 my $reservedate = $mapped_item->{reservedate};
526 my $reservenotes = $mapped_item->{reservenotes};
527 my $item_level = $mapped_item->{item_level};
529 my $item = GetItem($itemnumber);
530 my $barcode = $item->{barcode};
531 my $itemcallnumber = $item->{itemcallnumber};
533 my $borrower = GetMember('borrowernumber'=>$borrowernumber);
534 my $cardnumber = $borrower->{'cardnumber'};
535 my $surname = $borrower->{'surname'};
536 my $firstname = $borrower->{'firstname'};
537 my $phone = $borrower->{'phone'};
539 my $bib = GetBiblioData($biblionumber);
540 my $title = $bib->{title};
542 $sth_load->execute($biblionumber, $itemnumber, $barcode, $surname, $firstname, $phone, $borrowernumber,
543 $cardnumber, $reservedate, $title, $itemcallnumber,
544 $holdingbranch, $pickbranch, $reservenotes, $item_level);
548 =head2 AddToHoldTargetMap
552 sub AddToHoldTargetMap {
553 my $item_map = shift;
555 my $dbh = C4::Context->dbh;
558 INSERT INTO hold_fill_targets (borrowernumber, biblionumber, itemnumber, source_branchcode, item_level_request)
559 VALUES (?, ?, ?, ?, ?)
561 my $sth_insert = $dbh->prepare($insert_sql);
563 foreach my $itemnumber (keys %$item_map) {
564 my $mapped_item = $item_map->{$itemnumber};
565 $sth_insert->execute($mapped_item->{borrowernumber}, $mapped_item->{biblionumber}, $itemnumber,
566 $mapped_item->{holdingbranch}, $mapped_item->{item_level});
570 # Helper functions, not part of any interface
573 return $_[0] unless $_[0];
579 sub load_branches_to_pull_from {
580 my $static_branch_list = C4::Context->preference("StaticHoldsQueueWeight")
583 my @branches_to_use = map _trim($_), split /,/, $static_branch_list;
585 @branches_to_use = shuffle(@branches_to_use) if C4::Context->preference("RandomizeHoldsQueueWeight");
587 return \@branches_to_use;
590 sub least_cost_branch {
593 my ($to, $from, $transport_cost_matrix) = @_;
595 # Nothing really spectacular: supply to branch, a list of potential from branches
596 # and find the minimum from - to value from the transport_cost_matrix
597 return $from->[0] if @$from == 1;
599 # If the pickup library is in the list of libraries to pull from,
600 # return that library right away, it is obviously the least costly
601 return ($to) if any { $_ eq $to } @$from;
603 my ($least_cost, @branch);
605 my $cell = $transport_cost_matrix->{$to}{$_};
606 next if $cell->{disable_transfer};
608 my $cost = $cell->{cost};
609 next unless defined $cost; # XXX should this be reported?
611 unless (defined $least_cost) {
617 next if $cost > $least_cost;
619 if ($cost == $least_cost) {
630 # XXX return a random @branch with minimum cost instead of the first one;
631 # return $branch[0] if @branch == 1;