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($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 $today = dt_from_string
();
69 my %transport_cost_matrix;
70 foreach (@
$transport_costs) {
71 my $from = $_->{frombranch
};
72 my $to = $_->{tobranch
};
73 my $cost = $_->{cost
};
74 my $disabled = $_->{disable_transfer
};
75 $transport_cost_matrix{$to}{$from} = {
77 disable_transfer
=> $disabled
80 if ( C4
::Context
->preference("HoldsQueueSkipClosed") ) {
81 $calendars->{$from} ||= Koha
::Calendar
->new( branchcode
=> $from );
82 $transport_cost_matrix{$to}{$from}{disable_transfer
} ||=
83 $calendars->{$from}->is_holiday( $today );
87 return \
%transport_cost_matrix;
90 =head2 UpdateTransportCostMatrix
92 UpdateTransportCostMatrix($records);
94 Updates full Transport Cost Matrix table. $records is an arrayref of records.
95 Records: { frombranch => <code>, tobranch => <code>, cost => <figure>, disable_transfer => <0,1> }
99 sub UpdateTransportCostMatrix
{
101 my $dbh = C4
::Context
->dbh;
103 my $sth = $dbh->prepare("INSERT INTO transport_cost (frombranch, tobranch, cost, disable_transfer) VALUES (?, ?, ?, ?)");
105 $dbh->do("TRUNCATE TABLE transport_cost");
106 foreach (@
$records) {
107 my $cost = $_->{cost
};
108 my $from = $_->{frombranch
};
109 my $to = $_->{tobranch
};
110 if ($_->{disable_transfer
}) {
113 elsif ( !defined ($cost) || ($cost !~ m/(0|[1-9][0-9]*)(\.[0-9]*)?/o) ) {
114 warn "Invalid $from -> $to cost $cost - must be a number >= 0, disablig";
116 $_->{disable_transfer
} = 1;
118 $sth->execute( $from, $to, $cost, $_->{disable_transfer
} ?
1 : 0 );
122 =head2 GetHoldsQueueItems
124 GetHoldsQueueItems($branch);
126 Returns hold queue for a holding branch. If branch is omitted, then whole queue is returned
130 sub GetHoldsQueueItems
{
131 my ($branchlimit) = @_;
132 my $dbh = C4
::Context
->dbh;
134 my @bind_params = ();
135 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
137 JOIN biblio USING
(biblionumber
)
138 LEFT JOIN biblioitems USING
(biblionumber
)
139 LEFT JOIN items USING
( itemnumber
)
142 $query .=" WHERE tmp_holdsqueue.holdingbranch = ?";
143 push @bind_params, $branchlimit;
145 $query .= " ORDER BY ccode, location, cn_sort, author, title, pickbranch, reservedate";
146 my $sth = $dbh->prepare($query);
147 $sth->execute(@bind_params);
149 while ( my $row = $sth->fetchrow_hashref ){
150 my $record = GetMarcBiblio
($row->{biblionumber
});
152 $row->{subtitle
} = [ map { $_->{subfield
} } @
{ GetRecordValue
( 'subtitle', $record, '' ) } ];
153 $row->{parts
} = GetRecordValue
('parts',$record,'')->[0]->{subfield
};
154 $row->{numbers
} = GetRecordValue
('numbers',$record,'')->[0]->{subfield
};
157 # return the bib-level or item-level itype per syspref
158 if (!C4
::Context
->preference('item-level_itypes')) {
159 $row->{itype
} = $row->{itemtype
};
161 delete $row->{itemtype
};
172 Top level function that turns reserves into tmp_holdsqueue and hold_fill_targets.
177 my $dbh = C4
::Context
->dbh;
179 $dbh->do("DELETE FROM tmp_holdsqueue"); # clear the old table for new info
180 $dbh->do("DELETE FROM hold_fill_targets");
183 my $total_requests = 0;
184 my $total_available_items = 0;
185 my $num_items_mapped = 0;
188 my $transport_cost_matrix;
189 my $use_transport_cost_matrix = C4
::Context
->preference("UseTransportCostMatrix");
190 if ($use_transport_cost_matrix) {
191 $transport_cost_matrix = TransportCostMatrix
();
192 unless (keys %$transport_cost_matrix) {
193 warn "UseTransportCostMatrix set to yes, but matrix not populated";
194 undef $transport_cost_matrix;
197 unless ($transport_cost_matrix) {
198 $branches_to_use = load_branches_to_pull_from
();
201 my $bibs_with_pending_requests = GetBibsWithPendingHoldRequests
();
203 foreach my $biblionumber (@
$bibs_with_pending_requests) {
205 my $hold_requests = GetPendingHoldRequestsForBib
($biblionumber);
206 my $available_items = GetItemsAvailableToFillHoldRequestsForBib
($biblionumber, $branches_to_use);
207 $total_requests += scalar(@
$hold_requests);
208 $total_available_items += scalar(@
$available_items);
210 my $item_map = MapItemsToHoldRequests
($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix);
212 my $item_map_size = scalar(keys %$item_map)
215 $num_items_mapped += $item_map_size;
216 CreatePicklistFromItemMap
($item_map);
217 AddToHoldTargetMap
($item_map);
218 if (($item_map_size < scalar(@
$hold_requests )) and
219 ($item_map_size < scalar(@
$available_items))) {
220 # DOUBLE CHECK, but this is probably OK - unfilled item-level requests
222 #warn "unfilled requests for $biblionumber";
223 #warn Dumper($hold_requests), Dumper($available_items), Dumper($item_map);
228 =head2 GetBibsWithPendingHoldRequests
230 my $biblionumber_aref = GetBibsWithPendingHoldRequests();
232 Return an arrayref of the biblionumbers of all bibs
233 that have one or more unfilled hold requests.
237 sub GetBibsWithPendingHoldRequests
{
238 my $dbh = C4
::Context
->dbh;
240 my $bib_query = "SELECT DISTINCT biblionumber
244 AND reservedate <= CURRENT_DATE()
247 my $sth = $dbh->prepare($bib_query);
250 my $biblionumbers = $sth->fetchall_arrayref();
252 return [ map { $_->[0] } @
$biblionumbers ];
255 =head2 GetPendingHoldRequestsForBib
257 my $requests = GetPendingHoldRequestsForBib($biblionumber);
259 Returns an arrayref of hashrefs to pending, unfilled hold requests
260 on the bib identified by $biblionumber. The following keys
261 are present in each hashref:
272 The arrayref is sorted in order of increasing priority.
276 sub GetPendingHoldRequestsForBib
{
277 my $biblionumber = shift;
279 my $dbh = C4
::Context
->dbh;
281 my $request_query = "SELECT biblionumber, borrowernumber, itemnumber, priority, reserves.branchcode,
282 reservedate, reservenotes, borrowers.branchcode AS borrowerbranch
284 JOIN borrowers USING (borrowernumber)
285 WHERE biblionumber = ?
288 AND reservedate <= CURRENT_DATE()
291 my $sth = $dbh->prepare($request_query);
292 $sth->execute($biblionumber);
294 my $requests = $sth->fetchall_arrayref({});
299 =head2 GetItemsAvailableToFillHoldRequestsForBib
301 my $available_items = GetItemsAvailableToFillHoldRequestsForBib($biblionumber, $branches_ar);
303 Returns an arrayref of items available to fill hold requests
304 for the bib identified by C<$biblionumber>. An item is available
305 to fill a hold request if and only if:
308 * it is not withdrawn
309 * it is not marked notforloan
310 * it is not currently in transit
312 * it is not sitting on the hold shelf
313 * it is not damaged (unless AllowHoldsOnDamagedItems is on)
317 sub GetItemsAvailableToFillHoldRequestsForBib
{
318 my ($biblionumber, $branches_to_use) = @_;
320 my $dbh = C4
::Context
->dbh;
321 my $items_query = "SELECT itemnumber, homebranch, holdingbranch, itemtypes.itemtype AS itype
324 if (C4
::Context
->preference('item-level_itypes')) {
325 $items_query .= "LEFT JOIN itemtypes ON (itemtypes.itemtype = items.itype) ";
327 $items_query .= "JOIN biblioitems USING (biblioitemnumber)
328 LEFT JOIN itemtypes USING (itemtype) ";
330 $items_query .= "WHERE items.notforloan = 0
331 AND holdingbranch IS NOT NULL
334 $items_query .= " AND damaged = 0" unless C4
::Context
->preference('AllowHoldsOnDamagedItems');
335 $items_query .= " AND items.onloan IS NULL
336 AND (itemtypes.notforloan IS NULL OR itemtypes.notforloan = 0)
337 AND itemnumber NOT IN (
340 WHERE biblionumber = ?
341 AND itemnumber IS NOT NULL
342 AND (found IS NOT NULL OR priority = 0)
344 AND items.biblionumber = ?";
346 my @params = ($biblionumber, $biblionumber);
347 if ($branches_to_use && @
$branches_to_use) {
348 $items_query .= " AND holdingbranch IN (" . join (",", map { "?" } @
$branches_to_use) . ")";
349 push @params, @
$branches_to_use;
351 my $sth = $dbh->prepare($items_query);
352 $sth->execute(@params);
354 my $itm = $sth->fetchall_arrayref({});
355 my @items = grep { ! scalar GetTransfers
($_->{itemnumber
}) } @
$itm;
357 my $rule = GetBranchItemRule
($_->{homebranch
}, $_->{itype
});
358 $_->{holdallowed
} = $rule->{holdallowed
};
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
397 if (exists $items_by_itemnumber{$request->{itemnumber
}} and
398 not exists $allocated_items{$request->{itemnumber
}}) {
399 $item_map{$request->{itemnumber
}} = {
400 borrowernumber
=> $request->{borrowernumber
},
401 biblionumber
=> $request->{biblionumber
},
402 holdingbranch
=> $items_by_itemnumber{$request->{itemnumber
}}->{holdingbranch
},
403 pickup_branch
=> $request->{branchcode
} || $request->{borrowerbranch
},
405 reservedate
=> $request->{reservedate
},
406 reservenotes
=> $request->{reservenotes
},
408 $allocated_items{$request->{itemnumber
}}++;
409 $num_items_remaining--;
412 # it's title-level request that will take up one item
413 $num_items_remaining--;
417 # group available items by branch
418 my %items_by_branch = ();
419 foreach my $item (@
$available_items) {
420 next unless $item->{holdallowed
};
422 push @
{ $items_by_branch{ $item->{holdingbranch
} } }, $item
423 unless exists $allocated_items{ $item->{itemnumber
} };
425 return \
%item_map unless keys %items_by_branch;
427 # now handle the title-level requests
428 $num_items_remaining = scalar(@
$available_items) - scalar(keys %allocated_items);
430 foreach my $request (@
$hold_requests) {
431 last if $num_items_remaining == 0;
432 next if defined($request->{itemnumber
}); # already handled these
434 # look for local match first
435 my $pickup_branch = $request->{branchcode
} || $request->{borrowerbranch
};
436 my ($itemnumber, $holdingbranch);
438 my $holding_branch_items = $items_by_branch{$pickup_branch};
439 if ( $holding_branch_items ) {
440 foreach my $item (@
$holding_branch_items) {
441 if ( $request->{borrowerbranch
} eq $item->{homebranch
} ) {
442 $itemnumber = $item->{itemnumber
};
446 $holdingbranch = $pickup_branch;
448 elsif ($transport_cost_matrix) {
449 $pull_branches = [keys %items_by_branch];
450 $holdingbranch = least_cost_branch
( $pickup_branch, $pull_branches, $transport_cost_matrix );
451 if ( $holdingbranch ) {
453 my $holding_branch_items = $items_by_branch{$holdingbranch};
454 foreach my $item (@
$holding_branch_items) {
455 next if $request->{borrowerbranch
} ne $item->{homebranch
};
457 $itemnumber = $item->{itemnumber
};
466 unless ($itemnumber) {
467 # not found yet, fall back to basics
468 if ($branches_to_use) {
469 $pull_branches = $branches_to_use;
471 $pull_branches = [keys %items_by_branch];
474 # Try picking items where the home and pickup branch match first
476 foreach my $branch (@
$pull_branches) {
477 my $holding_branch_items = $items_by_branch{$branch}
480 $holdingbranch ||= $branch;
481 foreach my $item (@
$holding_branch_items) {
482 next if $pickup_branch ne $item->{homebranch
};
483 next if ( $item->{holdallowed
} == 1 && $item->{homebranch
} ne $request->{borrowerbranch
} );
485 $itemnumber = $item->{itemnumber
};
486 $holdingbranch = $branch;
491 # Now try items from the least cost branch based on the transport cost matrix or StaticHoldsQueueWeight
492 unless ( $itemnumber ) {
493 foreach my $current_item ( @
{ $items_by_branch{$holdingbranch} } ) {
494 if ( $holdingbranch && ( $current_item->{holdallowed
} == 2 || $request->{borrowerbranch
} eq $current_item->{homebranch
} ) ) {
495 $itemnumber = $current_item->{itemnumber
};
496 last; # quit this loop as soon as we have a suitable item
501 # Now try for items for any item that can fill this hold
502 unless ( $itemnumber ) {
504 foreach my $branch (@
$pull_branches) {
505 my $holding_branch_items = $items_by_branch{$branch}
508 foreach my $item (@
$holding_branch_items) {
509 next if ( $item->{holdallowed
} == 1 && $item->{homebranch
} ne $request->{borrowerbranch
} );
511 $itemnumber = $item->{itemnumber
};
512 $holdingbranch = $branch;
520 my $holding_branch_items = $items_by_branch{$holdingbranch}
521 or die "Have $itemnumber, $holdingbranch, but no items!";
522 @
$holding_branch_items = grep { $_->{itemnumber
} != $itemnumber } @
$holding_branch_items;
523 delete $items_by_branch{$holdingbranch} unless @
$holding_branch_items;
525 $item_map{$itemnumber} = {
526 borrowernumber
=> $request->{borrowernumber
},
527 biblionumber
=> $request->{biblionumber
},
528 holdingbranch
=> $holdingbranch,
529 pickup_branch
=> $pickup_branch,
531 reservedate
=> $request->{reservedate
},
532 reservenotes
=> $request->{reservenotes
},
534 $num_items_remaining--;
540 =head2 CreatePickListFromItemMap
544 sub CreatePicklistFromItemMap
{
545 my $item_map = shift;
547 my $dbh = C4
::Context
->dbh;
549 my $sth_load=$dbh->prepare("
550 INSERT INTO tmp_holdsqueue (biblionumber,itemnumber,barcode,surname,firstname,phone,borrowernumber,
551 cardnumber,reservedate,title, itemcallnumber,
552 holdingbranch,pickbranch,notes, item_level_request)
553 VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
556 foreach my $itemnumber (sort keys %$item_map) {
557 my $mapped_item = $item_map->{$itemnumber};
558 my $biblionumber = $mapped_item->{biblionumber
};
559 my $borrowernumber = $mapped_item->{borrowernumber
};
560 my $pickbranch = $mapped_item->{pickup_branch
};
561 my $holdingbranch = $mapped_item->{holdingbranch
};
562 my $reservedate = $mapped_item->{reservedate
};
563 my $reservenotes = $mapped_item->{reservenotes
};
564 my $item_level = $mapped_item->{item_level
};
566 my $item = GetItem
($itemnumber);
567 my $barcode = $item->{barcode
};
568 my $itemcallnumber = $item->{itemcallnumber
};
570 my $borrower = GetMember
('borrowernumber'=>$borrowernumber);
571 my $cardnumber = $borrower->{'cardnumber'};
572 my $surname = $borrower->{'surname'};
573 my $firstname = $borrower->{'firstname'};
574 my $phone = $borrower->{'phone'};
576 my $bib = GetBiblioData
($biblionumber);
577 my $title = $bib->{title
};
579 $sth_load->execute($biblionumber, $itemnumber, $barcode, $surname, $firstname, $phone, $borrowernumber,
580 $cardnumber, $reservedate, $title, $itemcallnumber,
581 $holdingbranch, $pickbranch, $reservenotes, $item_level);
585 =head2 AddToHoldTargetMap
589 sub AddToHoldTargetMap
{
590 my $item_map = shift;
592 my $dbh = C4
::Context
->dbh;
595 INSERT INTO hold_fill_targets
(borrowernumber
, biblionumber
, itemnumber
, source_branchcode
, item_level_request
)
596 VALUES
(?
, ?
, ?
, ?
, ?
)
598 my $sth_insert = $dbh->prepare($insert_sql);
600 foreach my $itemnumber (keys %$item_map) {
601 my $mapped_item = $item_map->{$itemnumber};
602 $sth_insert->execute($mapped_item->{borrowernumber
}, $mapped_item->{biblionumber
}, $itemnumber,
603 $mapped_item->{holdingbranch
}, $mapped_item->{item_level
});
607 # Helper functions, not part of any interface
610 return $_[0] unless $_[0];
616 sub load_branches_to_pull_from
{
619 my $static_branch_list = C4
::Context
->preference("StaticHoldsQueueWeight");
620 @branches_to_use = map { _trim
($_) } split( /,/, $static_branch_list )
621 if $static_branch_list;
624 Koha
::Database
->new()->schema()->resultset('Branch')
625 ->get_column('branchcode')->all()
626 unless (@branches_to_use);
628 @branches_to_use = shuffle
(@branches_to_use)
629 if C4
::Context
->preference("RandomizeHoldsQueueWeight");
631 my $today = dt_from_string
();
632 if ( C4
::Context
->preference('HoldsQueueSkipClosed') ) {
633 @branches_to_use = grep {
634 !Koha
::Calendar
->new( branchcode
=> $_ )
635 ->is_holiday( $today )
639 return \
@branches_to_use;
642 sub least_cost_branch
{
645 my ($to, $from, $transport_cost_matrix) = @_;
647 # Nothing really spectacular: supply to branch, a list of potential from branches
648 # and find the minimum from - to value from the transport_cost_matrix
649 return $from->[0] if ( @
$from == 1 && $transport_cost_matrix->{$to}{$from->[0]}->{disable_transfer
} != 1 );
651 # If the pickup library is in the list of libraries to pull from,
652 # return that library right away, it is obviously the least costly
653 return ($to) if any
{ $_ eq $to } @
$from;
655 my ($least_cost, @branch);
657 my $cell = $transport_cost_matrix->{$to}{$_};
658 next if $cell->{disable_transfer
};
660 my $cost = $cell->{cost
};
661 next unless defined $cost; # XXX should this be reported?
663 unless (defined $least_cost) {
669 next if $cost > $least_cost;
671 if ($cost == $least_cost) {
682 # XXX return a random @branch with minimum cost instead of the first one;
683 # return $branch[0] if @branch == 1;