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
34 use List::Util qw(shuffle);
35 use List::MoreUtils qw(any);
38 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
47 &UpdateTransportCostMatrix
54 =head2 TransportCostMatrix
56 TransportCostMatrix();
58 Returns Transport Cost Matrix as a hashref <to branch code> => <from branch code> => cost
62 sub TransportCostMatrix {
63 my $dbh = C4::Context->dbh;
64 my $transport_costs = $dbh->selectall_arrayref("SELECT * FROM transport_cost",{ Slice => {} });
66 my $today = dt_from_string();
68 my %transport_cost_matrix;
69 foreach (@$transport_costs) {
70 my $from = $_->{frombranch};
71 my $to = $_->{tobranch};
72 my $cost = $_->{cost};
73 my $disabled = $_->{disable_transfer};
74 $transport_cost_matrix{$to}{$from} = {
76 disable_transfer => $disabled
79 if ( C4::Context->preference("HoldsQueueSkipClosed") ) {
80 $calendars->{$from} ||= Koha::Calendar->new( branchcode => $from );
81 $transport_cost_matrix{$to}{$from}{disable_transfer} ||=
82 $calendars->{$from}->is_holiday( $today );
86 return \%transport_cost_matrix;
89 =head2 UpdateTransportCostMatrix
91 UpdateTransportCostMatrix($records);
93 Updates full Transport Cost Matrix table. $records is an arrayref of records.
94 Records: { frombranch => <code>, tobranch => <code>, cost => <figure>, disable_transfer => <0,1> }
98 sub UpdateTransportCostMatrix {
100 my $dbh = C4::Context->dbh;
102 my $sth = $dbh->prepare("INSERT INTO transport_cost (frombranch, tobranch, cost, disable_transfer) VALUES (?, ?, ?, ?)");
104 $dbh->do("TRUNCATE TABLE transport_cost");
105 foreach (@$records) {
106 my $cost = $_->{cost};
107 my $from = $_->{frombranch};
108 my $to = $_->{tobranch};
109 if ($_->{disable_transfer}) {
112 elsif ( !defined ($cost) || ($cost !~ m/(0|[1-9][0-9]*)(\.[0-9]*)?/o) ) {
113 warn "Invalid $from -> $to cost $cost - must be a number >= 0, disablig";
115 $_->{disable_transfer} = 1;
117 $sth->execute( $from, $to, $cost, $_->{disable_transfer} ? 1 : 0 );
121 =head2 GetHoldsQueueItems
123 GetHoldsQueueItems($branch);
125 Returns hold queue for a holding branch. If branch is omitted, then whole queue is returned
129 sub GetHoldsQueueItems {
130 my ($branchlimit) = @_;
131 my $dbh = C4::Context->dbh;
133 my @bind_params = ();
134 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
136 JOIN biblio USING (biblionumber)
137 LEFT JOIN biblioitems USING (biblionumber)
138 LEFT JOIN items USING ( itemnumber)
141 $query .=" WHERE tmp_holdsqueue.holdingbranch = ?";
142 push @bind_params, $branchlimit;
144 $query .= " ORDER BY ccode, location, cn_sort, author, title, pickbranch, reservedate";
145 my $sth = $dbh->prepare($query);
146 $sth->execute(@bind_params);
148 while ( my $row = $sth->fetchrow_hashref ){
149 my $record = GetMarcBiblio($row->{biblionumber});
151 $row->{subtitle} = [ map { $_->{subfield} } @{ GetRecordValue( 'subtitle', $record, '' ) } ];
152 $row->{parts} = GetRecordValue('parts',$record,'')->[0]->{subfield};
153 $row->{numbers} = GetRecordValue('numbers',$record,'')->[0]->{subfield};
156 # return the bib-level or item-level itype per syspref
157 if (!C4::Context->preference('item-level_itypes')) {
158 $row->{itype} = $row->{itemtype};
160 delete $row->{itemtype};
171 Top level function that turns reserves into tmp_holdsqueue and hold_fill_targets.
176 my $dbh = C4::Context->dbh;
178 $dbh->do("DELETE FROM tmp_holdsqueue"); # clear the old table for new info
179 $dbh->do("DELETE FROM hold_fill_targets");
182 my $total_requests = 0;
183 my $total_available_items = 0;
184 my $num_items_mapped = 0;
187 my $transport_cost_matrix;
188 my $use_transport_cost_matrix = C4::Context->preference("UseTransportCostMatrix");
189 if ($use_transport_cost_matrix) {
190 $transport_cost_matrix = TransportCostMatrix();
191 unless (keys %$transport_cost_matrix) {
192 warn "UseTransportCostMatrix set to yes, but matrix not populated";
193 undef $transport_cost_matrix;
196 unless ($transport_cost_matrix) {
197 $branches_to_use = load_branches_to_pull_from();
200 my $bibs_with_pending_requests = GetBibsWithPendingHoldRequests();
202 foreach my $biblionumber (@$bibs_with_pending_requests) {
204 my $hold_requests = GetPendingHoldRequestsForBib($biblionumber);
205 my $available_items = GetItemsAvailableToFillHoldRequestsForBib($biblionumber, $branches_to_use);
206 $total_requests += scalar(@$hold_requests);
207 $total_available_items += scalar(@$available_items);
209 my $item_map = MapItemsToHoldRequests($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix);
211 my $item_map_size = scalar(keys %$item_map)
214 $num_items_mapped += $item_map_size;
215 CreatePicklistFromItemMap($item_map);
216 AddToHoldTargetMap($item_map);
217 if (($item_map_size < scalar(@$hold_requests )) and
218 ($item_map_size < scalar(@$available_items))) {
219 # DOUBLE CHECK, but this is probably OK - unfilled item-level requests
221 #warn "unfilled requests for $biblionumber";
222 #warn Dumper($hold_requests), Dumper($available_items), Dumper($item_map);
227 =head2 GetBibsWithPendingHoldRequests
229 my $biblionumber_aref = GetBibsWithPendingHoldRequests();
231 Return an arrayref of the biblionumbers of all bibs
232 that have one or more unfilled hold requests.
236 sub GetBibsWithPendingHoldRequests {
237 my $dbh = C4::Context->dbh;
239 my $bib_query = "SELECT DISTINCT biblionumber
243 AND reservedate <= CURRENT_DATE()
246 my $sth = $dbh->prepare($bib_query);
249 my $biblionumbers = $sth->fetchall_arrayref();
251 return [ map { $_->[0] } @$biblionumbers ];
254 =head2 GetPendingHoldRequestsForBib
256 my $requests = GetPendingHoldRequestsForBib($biblionumber);
258 Returns an arrayref of hashrefs to pending, unfilled hold requests
259 on the bib identified by $biblionumber. The following keys
260 are present in each hashref:
271 The arrayref is sorted in order of increasing priority.
275 sub GetPendingHoldRequestsForBib {
276 my $biblionumber = shift;
278 my $dbh = C4::Context->dbh;
280 my $request_query = "SELECT biblionumber, borrowernumber, itemnumber, priority, reserves.branchcode,
281 reservedate, reservenotes, borrowers.branchcode AS borrowerbranch
283 JOIN borrowers USING (borrowernumber)
284 WHERE biblionumber = ?
287 AND reservedate <= CURRENT_DATE()
290 my $sth = $dbh->prepare($request_query);
291 $sth->execute($biblionumber);
293 my $requests = $sth->fetchall_arrayref({});
298 =head2 GetItemsAvailableToFillHoldRequestsForBib
300 my $available_items = GetItemsAvailableToFillHoldRequestsForBib($biblionumber, $branches_ar);
302 Returns an arrayref of items available to fill hold requests
303 for the bib identified by C<$biblionumber>. An item is available
304 to fill a hold request if and only if:
307 * it is not withdrawn
308 * it is not marked notforloan
309 * it is not currently in transit
311 * it is not sitting on the hold shelf
312 * it is not damaged (unless AllowHoldsOnDamagedItems is on)
316 sub GetItemsAvailableToFillHoldRequestsForBib {
317 my ($biblionumber, $branches_to_use) = @_;
319 my $dbh = C4::Context->dbh;
320 my $items_query = "SELECT itemnumber, homebranch, holdingbranch, itemtypes.itemtype AS itype
323 if (C4::Context->preference('item-level_itypes')) {
324 $items_query .= "LEFT JOIN itemtypes ON (itemtypes.itemtype = items.itype) ";
326 $items_query .= "JOIN biblioitems USING (biblioitemnumber)
327 LEFT JOIN itemtypes USING (itemtype) ";
329 $items_query .= "WHERE items.notforloan = 0
330 AND holdingbranch IS NOT NULL
333 $items_query .= " AND damaged = 0" unless C4::Context->preference('AllowHoldsOnDamagedItems');
334 $items_query .= " AND items.onloan IS NULL
335 AND (itemtypes.notforloan IS NULL OR itemtypes.notforloan = 0)
336 AND itemnumber NOT IN (
339 WHERE biblionumber = ?
340 AND itemnumber IS NOT NULL
341 AND (found IS NOT NULL OR priority = 0)
343 AND items.biblionumber = ?";
345 my @params = ($biblionumber, $biblionumber);
346 if ($branches_to_use && @$branches_to_use) {
347 $items_query .= " AND holdingbranch IN (" . join (",", map { "?" } @$branches_to_use) . ")";
348 push @params, @$branches_to_use;
350 my $sth = $dbh->prepare($items_query);
351 $sth->execute(@params);
353 my $itm = $sth->fetchall_arrayref({});
354 my @items = grep { ! scalar GetTransfers($_->{itemnumber}) } @$itm;
356 my $rule = GetBranchItemRule($_->{homebranch}, $_->{itype});
357 $_->{holdallowed} = $rule->{holdallowed};
358 $_->{hold_fulfillment_policy} = $rule->{hold_fulfillment_policy};
362 =head2 MapItemsToHoldRequests
364 MapItemsToHoldRequests($hold_requests, $available_items, $branches, $transport_cost_matrix)
368 sub MapItemsToHoldRequests {
369 my ($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix) = @_;
371 # handle trival cases
372 return unless scalar(@$hold_requests) > 0;
373 return unless scalar(@$available_items) > 0;
375 # identify item-level requests
376 my %specific_items_requested = map { $_->{itemnumber} => 1 }
377 grep { defined($_->{itemnumber}) }
380 # group available items by itemnumber
381 my %items_by_itemnumber = map { $_->{itemnumber} => $_ } @$available_items;
383 # items already allocated
384 my %allocated_items = ();
386 # map of items to hold requests
389 # figure out which item-level requests can be filled
390 my $num_items_remaining = scalar(@$available_items);
391 foreach my $request (@$hold_requests) {
392 last if $num_items_remaining == 0;
394 # is this an item-level request?
395 if (defined($request->{itemnumber})) {
396 # fill it if possible; if not skip it
398 exists $items_by_itemnumber{ $request->{itemnumber} }
399 and not exists $allocated_items{ $request->{itemnumber} }
400 and ( # Don't fill item level holds that contravene the hold pickup policy at this time
401 ( $items_by_itemnumber{ $request->{itemnumber} }->{hold_fulfillment_policy} eq 'any' )
402 || ( $request->{branchcode} eq $items_by_itemnumber{ $request->{itemnumber} }->{ $items_by_itemnumber{ $request->{itemnumber} }->{hold_fulfillment_policy} } )
408 $item_map{ $request->{itemnumber} } = {
409 borrowernumber => $request->{borrowernumber},
410 biblionumber => $request->{biblionumber},
411 holdingbranch => $items_by_itemnumber{ $request->{itemnumber} }->{holdingbranch},
412 pickup_branch => $request->{branchcode} || $request->{borrowerbranch},
414 reservedate => $request->{reservedate},
415 reservenotes => $request->{reservenotes},
417 $allocated_items{ $request->{itemnumber} }++;
418 $num_items_remaining--;
421 # it's title-level request that will take up one item
422 $num_items_remaining--;
426 # group available items by branch
427 my %items_by_branch = ();
428 foreach my $item (@$available_items) {
429 next unless $item->{holdallowed};
431 push @{ $items_by_branch{ $item->{holdingbranch} } }, $item
432 unless exists $allocated_items{ $item->{itemnumber} };
434 return \%item_map unless keys %items_by_branch;
436 # now handle the title-level requests
437 $num_items_remaining = scalar(@$available_items) - scalar(keys %allocated_items);
439 foreach my $request (@$hold_requests) {
440 last if $num_items_remaining == 0;
441 next if defined($request->{itemnumber}); # already handled these
443 # look for local match first
444 my $pickup_branch = $request->{branchcode} || $request->{borrowerbranch};
445 my ($itemnumber, $holdingbranch);
447 my $holding_branch_items = $items_by_branch{$pickup_branch};
448 if ( $holding_branch_items ) {
449 foreach my $item (@$holding_branch_items) {
451 $request->{borrowerbranch} eq $item->{homebranch}
452 && ( ( $item->{hold_fulfillment_policy} eq 'any' ) # Don't fill item level holds that contravene the hold pickup policy at this time
453 || $request->{branchcode} eq $item->{ $item->{hold_fulfillment_policy} } )
456 $itemnumber = $item->{itemnumber};
460 $holdingbranch = $pickup_branch;
462 elsif ($transport_cost_matrix) {
463 $pull_branches = [keys %items_by_branch];
464 $holdingbranch = least_cost_branch( $pickup_branch, $pull_branches, $transport_cost_matrix );
465 if ( $holdingbranch ) {
467 my $holding_branch_items = $items_by_branch{$holdingbranch};
468 foreach my $item (@$holding_branch_items) {
469 next if $request->{borrowerbranch} ne $item->{homebranch};
471 # Don't fill item level holds that contravene the hold pickup policy at this time
472 next unless $item->{hold_fulfillment_policy} eq 'any'
473 || $request->{branchcode} eq $item->{ $item->{hold_fulfillment_policy} };
475 $itemnumber = $item->{itemnumber};
484 unless ($itemnumber) {
485 # not found yet, fall back to basics
486 if ($branches_to_use) {
487 $pull_branches = $branches_to_use;
489 $pull_branches = [keys %items_by_branch];
492 # Try picking items where the home and pickup branch match first
494 foreach my $branch (@$pull_branches) {
495 my $holding_branch_items = $items_by_branch{$branch}
498 $holdingbranch ||= $branch;
499 foreach my $item (@$holding_branch_items) {
500 next if $pickup_branch ne $item->{homebranch};
501 next if ( $item->{holdallowed} == 1 && $item->{homebranch} ne $request->{borrowerbranch} );
503 # Don't fill item level holds that contravene the hold pickup policy at this time
504 next unless $item->{hold_fulfillment_policy} eq 'any'
505 || $request->{branchcode} eq $item->{ $item->{hold_fulfillment_policy} };
507 $itemnumber = $item->{itemnumber};
508 $holdingbranch = $branch;
513 # Now try items from the least cost branch based on the transport cost matrix or StaticHoldsQueueWeight
514 unless ( $itemnumber ) {
515 foreach my $current_item ( @{ $items_by_branch{$holdingbranch} } ) {
516 if ( $holdingbranch && ( $current_item->{holdallowed} == 2 || $request->{borrowerbranch} eq $current_item->{homebranch} ) ) {
518 # Don't fill item level holds that contravene the hold pickup policy at this time
519 next unless $current_item->{hold_fulfillment_policy} eq 'any'
520 || $request->{branchcode} eq $current_item->{ $current_item->{hold_fulfillment_policy} };
522 $itemnumber = $current_item->{itemnumber};
523 last; # quit this loop as soon as we have a suitable item
528 # Now try for items for any item that can fill this hold
529 unless ( $itemnumber ) {
531 foreach my $branch (@$pull_branches) {
532 my $holding_branch_items = $items_by_branch{$branch}
535 foreach my $item (@$holding_branch_items) {
536 next if ( $item->{holdallowed} == 1 && $item->{homebranch} ne $request->{borrowerbranch} );
538 # Don't fill item level holds that contravene the hold pickup policy at this time
539 next unless $item->{hold_fulfillment_policy} eq 'any'
540 || $request->{branchcode} eq $item->{ $item->{hold_fulfillment_policy} };
542 $itemnumber = $item->{itemnumber};
543 $holdingbranch = $branch;
551 my $holding_branch_items = $items_by_branch{$holdingbranch}
552 or die "Have $itemnumber, $holdingbranch, but no items!";
553 @$holding_branch_items = grep { $_->{itemnumber} != $itemnumber } @$holding_branch_items;
554 delete $items_by_branch{$holdingbranch} unless @$holding_branch_items;
556 $item_map{$itemnumber} = {
557 borrowernumber => $request->{borrowernumber},
558 biblionumber => $request->{biblionumber},
559 holdingbranch => $holdingbranch,
560 pickup_branch => $pickup_branch,
562 reservedate => $request->{reservedate},
563 reservenotes => $request->{reservenotes},
565 $num_items_remaining--;
571 =head2 CreatePickListFromItemMap
575 sub CreatePicklistFromItemMap {
576 my $item_map = shift;
578 my $dbh = C4::Context->dbh;
580 my $sth_load=$dbh->prepare("
581 INSERT INTO tmp_holdsqueue (biblionumber,itemnumber,barcode,surname,firstname,phone,borrowernumber,
582 cardnumber,reservedate,title, itemcallnumber,
583 holdingbranch,pickbranch,notes, item_level_request)
584 VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
587 foreach my $itemnumber (sort keys %$item_map) {
588 my $mapped_item = $item_map->{$itemnumber};
589 my $biblionumber = $mapped_item->{biblionumber};
590 my $borrowernumber = $mapped_item->{borrowernumber};
591 my $pickbranch = $mapped_item->{pickup_branch};
592 my $holdingbranch = $mapped_item->{holdingbranch};
593 my $reservedate = $mapped_item->{reservedate};
594 my $reservenotes = $mapped_item->{reservenotes};
595 my $item_level = $mapped_item->{item_level};
597 my $item = GetItem($itemnumber);
598 my $barcode = $item->{barcode};
599 my $itemcallnumber = $item->{itemcallnumber};
601 my $borrower = GetMember('borrowernumber'=>$borrowernumber);
602 my $cardnumber = $borrower->{'cardnumber'};
603 my $surname = $borrower->{'surname'};
604 my $firstname = $borrower->{'firstname'};
605 my $phone = $borrower->{'phone'};
607 my $bib = GetBiblioData($biblionumber);
608 my $title = $bib->{title};
610 $sth_load->execute($biblionumber, $itemnumber, $barcode, $surname, $firstname, $phone, $borrowernumber,
611 $cardnumber, $reservedate, $title, $itemcallnumber,
612 $holdingbranch, $pickbranch, $reservenotes, $item_level);
616 =head2 AddToHoldTargetMap
620 sub AddToHoldTargetMap {
621 my $item_map = shift;
623 my $dbh = C4::Context->dbh;
626 INSERT INTO hold_fill_targets (borrowernumber, biblionumber, itemnumber, source_branchcode, item_level_request)
627 VALUES (?, ?, ?, ?, ?)
629 my $sth_insert = $dbh->prepare($insert_sql);
631 foreach my $itemnumber (keys %$item_map) {
632 my $mapped_item = $item_map->{$itemnumber};
633 $sth_insert->execute($mapped_item->{borrowernumber}, $mapped_item->{biblionumber}, $itemnumber,
634 $mapped_item->{holdingbranch}, $mapped_item->{item_level});
638 # Helper functions, not part of any interface
641 return $_[0] unless $_[0];
647 sub load_branches_to_pull_from {
650 my $static_branch_list = C4::Context->preference("StaticHoldsQueueWeight");
651 @branches_to_use = map { _trim($_) } split( /,/, $static_branch_list )
652 if $static_branch_list;
655 Koha::Database->new()->schema()->resultset('Branch')
656 ->get_column('branchcode')->all()
657 unless (@branches_to_use);
659 @branches_to_use = shuffle(@branches_to_use)
660 if C4::Context->preference("RandomizeHoldsQueueWeight");
662 my $today = dt_from_string();
663 if ( C4::Context->preference('HoldsQueueSkipClosed') ) {
664 @branches_to_use = grep {
665 !Koha::Calendar->new( branchcode => $_ )
666 ->is_holiday( $today )
670 return \@branches_to_use;
673 sub least_cost_branch {
676 my ($to, $from, $transport_cost_matrix) = @_;
678 # Nothing really spectacular: supply to branch, a list of potential from branches
679 # and find the minimum from - to value from the transport_cost_matrix
680 return $from->[0] if ( @$from == 1 && $transport_cost_matrix->{$to}{$from->[0]}->{disable_transfer} != 1 );
682 # If the pickup library is in the list of libraries to pull from,
683 # return that library right away, it is obviously the least costly
684 return ($to) if any { $_ eq $to } @$from;
686 my ($least_cost, @branch);
688 my $cell = $transport_cost_matrix->{$to}{$_};
689 next if $cell->{disable_transfer};
691 my $cost = $cell->{cost};
692 next unless defined $cost; # XXX should this be reported?
694 unless (defined $least_cost) {
700 next if $cost > $least_cost;
702 if ($cost == $least_cost) {
713 # XXX return a random @branch with minimum cost instead of the first one;
714 # return $branch[0] if @branch == 1;