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);
37 use vars
qw($VERSION @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 %transport_cost_matrix;
67 foreach (@
$transport_costs) {
68 my $from = $_->{frombranch
};
69 my $to = $_->{tobranch
};
70 my $cost = $_->{cost
};
71 my $disabled = $_->{disable_transfer
};
72 $transport_cost_matrix{$to}{$from} = { cost
=> $cost, disable_transfer
=> $disabled };
74 return \
%transport_cost_matrix;
77 =head2 UpdateTransportCostMatrix
79 UpdateTransportCostMatrix($records);
81 Updates full Transport Cost Matrix table. $records is an arrayref of records.
82 Records: { frombranch => <code>, tobranch => <code>, cost => <figure>, disable_transfer => <0,1> }
86 sub UpdateTransportCostMatrix
{
88 my $dbh = C4
::Context
->dbh;
90 my $sth = $dbh->prepare("INSERT INTO transport_cost (frombranch, tobranch, cost, disable_transfer) VALUES (?, ?, ?, ?)");
92 $dbh->do("TRUNCATE TABLE transport_cost");
94 my $cost = $_->{cost
};
95 my $from = $_->{frombranch
};
96 my $to = $_->{tobranch
};
97 if ($_->{disable_transfer
}) {
100 elsif ( !defined ($cost) || ($cost !~ m/(0|[1-9][0-9]*)(\.[0-9]*)?/o) ) {
101 warn "Invalid $from -> $to cost $cost - must be a number >= 0, disablig";
103 $_->{disable_transfer
} = 1;
105 $sth->execute( $from, $to, $cost, $_->{disable_transfer
} ?
1 : 0 );
109 =head2 GetHoldsQueueItems
111 GetHoldsQueueItems($branch);
113 Returns hold queue for a holding branch. If branch is omitted, then whole queue is returned
117 sub GetHoldsQueueItems
{
118 my ($branchlimit) = @_;
119 my $dbh = C4
::Context
->dbh;
121 my @bind_params = ();
122 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
124 JOIN biblio USING
(biblionumber
)
125 LEFT JOIN biblioitems USING
(biblionumber
)
126 LEFT JOIN items USING
( itemnumber
)
129 $query .=" WHERE tmp_holdsqueue.holdingbranch = ?";
130 push @bind_params, $branchlimit;
132 $query .= " ORDER BY ccode, location, cn_sort, author, title, pickbranch, reservedate";
133 my $sth = $dbh->prepare($query);
134 $sth->execute(@bind_params);
136 while ( my $row = $sth->fetchrow_hashref ){
137 $row->{reservedate
} = format_date
($row->{reservedate
});
138 my $record = GetMarcBiblio
($row->{biblionumber
});
140 $row->{subtitle
} = GetRecordValue
('subtitle',$record,'')->[0]->{subfield
};
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
304 sub GetItemsAvailableToFillHoldRequestsForBib
{
305 my ($biblionumber, $branches_to_use) = @_;
307 my $dbh = C4
::Context
->dbh;
308 my $items_query = "SELECT itemnumber, homebranch, holdingbranch, itemtypes.itemtype AS itype
311 if (C4
::Context
->preference('item-level_itypes')) {
312 $items_query .= "LEFT JOIN itemtypes ON (itemtypes.itemtype = items.itype) ";
314 $items_query .= "JOIN biblioitems USING (biblioitemnumber)
315 LEFT JOIN itemtypes USING (itemtype) ";
317 $items_query .= "WHERE items.notforloan = 0
318 AND holdingbranch IS NOT NULL
321 $items_query .= " AND damaged = 0" unless C4
::Context
->preference('AllowHoldsOnDamagedItems');
322 $items_query .= " AND items.onloan IS NULL
323 AND (itemtypes.notforloan IS NULL OR itemtypes.notforloan = 0)
324 AND itemnumber NOT IN (
327 WHERE biblionumber = ?
328 AND itemnumber IS NOT NULL
329 AND (found IS NOT NULL OR priority = 0)
331 AND items.biblionumber = ?";
332 $items_query .= " AND damaged = 0 "
333 unless C4
::Context
->preference('AllowHoldsOnDamagedItems');
335 my @params = ($biblionumber, $biblionumber);
336 if ($branches_to_use && @
$branches_to_use) {
337 $items_query .= " AND holdingbranch IN (" . join (",", map { "?" } @
$branches_to_use) . ")";
338 push @params, @
$branches_to_use;
340 my $sth = $dbh->prepare($items_query);
341 $sth->execute(@params);
343 my $itm = $sth->fetchall_arrayref({});
344 my @items = grep { ! scalar GetTransfers
($_->{itemnumber
}) } @
$itm;
346 my $rule = GetBranchItemRule
($_->{homebranch
}, $_->{itype
});
347 $_->{holdallowed
} = $rule->{holdallowed
} != 0
351 =head2 MapItemsToHoldRequests
353 MapItemsToHoldRequests($hold_requests, $available_items, $branches, $transport_cost_matrix)
357 sub MapItemsToHoldRequests
{
358 my ($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix) = @_;
360 # handle trival cases
361 return unless scalar(@
$hold_requests) > 0;
362 return unless scalar(@
$available_items) > 0;
364 my $automatic_return = C4
::Context
->preference("AutomaticItemReturn");
366 # identify item-level requests
367 my %specific_items_requested = map { $_->{itemnumber
} => 1 }
368 grep { defined($_->{itemnumber
}) }
371 # group available items by itemnumber
372 my %items_by_itemnumber = map { $_->{itemnumber
} => $_ } @
$available_items;
374 # items already allocated
375 my %allocated_items = ();
377 # map of items to hold requests
380 # figure out which item-level requests can be filled
381 my $num_items_remaining = scalar(@
$available_items);
382 foreach my $request (@
$hold_requests) {
383 last if $num_items_remaining == 0;
385 # is this an item-level request?
386 if (defined($request->{itemnumber
})) {
387 # fill it if possible; if not skip it
388 if (exists $items_by_itemnumber{$request->{itemnumber
}} and
389 not exists $allocated_items{$request->{itemnumber
}}) {
390 $item_map{$request->{itemnumber
}} = {
391 borrowernumber
=> $request->{borrowernumber
},
392 biblionumber
=> $request->{biblionumber
},
393 holdingbranch
=> $items_by_itemnumber{$request->{itemnumber
}}->{holdingbranch
},
394 pickup_branch
=> $request->{branchcode
} || $request->{borrowerbranch
},
396 reservedate
=> $request->{reservedate
},
397 reservenotes
=> $request->{reservenotes
},
399 $allocated_items{$request->{itemnumber
}}++;
400 $num_items_remaining--;
403 # it's title-level request that will take up one item
404 $num_items_remaining--;
408 # group available items by branch
409 my %items_by_branch = ();
410 foreach my $item (@
$available_items) {
411 next unless $item->{holdallowed
};
413 push @
{ $items_by_branch{ $item->{holdingbranch
} } }, $item
414 unless exists $allocated_items{ $item->{itemnumber
} };
416 return \
%item_map unless keys %items_by_branch;
418 # now handle the title-level requests
419 $num_items_remaining = scalar(@
$available_items) - scalar(keys %allocated_items);
421 foreach my $request (@
$hold_requests) {
422 last if $num_items_remaining == 0;
423 next if defined($request->{itemnumber
}); # already handled these
425 # look for local match first
426 my $pickup_branch = $request->{branchcode
} || $request->{borrowerbranch
};
427 my ($itemnumber, $holdingbranch);
429 my $holding_branch_items = $automatic_return ?
undef : $items_by_branch{$pickup_branch};
430 if ( $holding_branch_items ) {
431 foreach my $item (@
$holding_branch_items) {
432 if ( $request->{borrowerbranch
} eq $item->{homebranch
} ) {
433 $itemnumber = $item->{itemnumber
};
437 $holdingbranch = $pickup_branch;
438 $itemnumber ||= $holding_branch_items->[0]->{itemnumber
};
440 elsif ($transport_cost_matrix) {
441 $pull_branches = [keys %items_by_branch];
442 $holdingbranch = least_cost_branch
( $pickup_branch, $pull_branches, $transport_cost_matrix );
443 if ( $holdingbranch ) {
445 my $holding_branch_items = $items_by_branch{$holdingbranch};
446 foreach my $item (@
$holding_branch_items) {
447 next if $request->{borrowerbranch
} ne $item->{homebranch
};
449 $itemnumber = $item->{itemnumber
};
452 $itemnumber ||= $holding_branch_items->[0]->{itemnumber
};
455 warn "No transport costs for $pickup_branch";
459 unless ($itemnumber) {
460 # not found yet, fall back to basics
461 if ($branches_to_use) {
462 $pull_branches = $branches_to_use;
464 $pull_branches = [keys %items_by_branch];
467 foreach my $branch (@
$pull_branches) {
468 my $holding_branch_items = $items_by_branch{$branch}
471 $holdingbranch ||= $branch;
472 foreach my $item (@
$holding_branch_items) {
473 next if $pickup_branch ne $item->{homebranch
};
475 $itemnumber = $item->{itemnumber
};
476 $holdingbranch = $branch;
480 $itemnumber ||= $items_by_branch{$holdingbranch}->[0]->{itemnumber
}
485 my $holding_branch_items = $items_by_branch{$holdingbranch}
486 or die "Have $itemnumber, $holdingbranch, but no items!";
487 @
$holding_branch_items = grep { $_->{itemnumber
} != $itemnumber } @
$holding_branch_items;
488 delete $items_by_branch{$holdingbranch} unless @
$holding_branch_items;
490 $item_map{$itemnumber} = {
491 borrowernumber
=> $request->{borrowernumber
},
492 biblionumber
=> $request->{biblionumber
},
493 holdingbranch
=> $holdingbranch,
494 pickup_branch
=> $pickup_branch,
496 reservedate
=> $request->{reservedate
},
497 reservenotes
=> $request->{reservenotes
},
499 $num_items_remaining--;
505 =head2 CreatePickListFromItemMap
509 sub CreatePicklistFromItemMap
{
510 my $item_map = shift;
512 my $dbh = C4
::Context
->dbh;
514 my $sth_load=$dbh->prepare("
515 INSERT INTO tmp_holdsqueue (biblionumber,itemnumber,barcode,surname,firstname,phone,borrowernumber,
516 cardnumber,reservedate,title, itemcallnumber,
517 holdingbranch,pickbranch,notes, item_level_request)
518 VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
521 foreach my $itemnumber (sort keys %$item_map) {
522 my $mapped_item = $item_map->{$itemnumber};
523 my $biblionumber = $mapped_item->{biblionumber
};
524 my $borrowernumber = $mapped_item->{borrowernumber
};
525 my $pickbranch = $mapped_item->{pickup_branch
};
526 my $holdingbranch = $mapped_item->{holdingbranch
};
527 my $reservedate = $mapped_item->{reservedate
};
528 my $reservenotes = $mapped_item->{reservenotes
};
529 my $item_level = $mapped_item->{item_level
};
531 my $item = GetItem
($itemnumber);
532 my $barcode = $item->{barcode
};
533 my $itemcallnumber = $item->{itemcallnumber
};
535 my $borrower = GetMember
('borrowernumber'=>$borrowernumber);
536 my $cardnumber = $borrower->{'cardnumber'};
537 my $surname = $borrower->{'surname'};
538 my $firstname = $borrower->{'firstname'};
539 my $phone = $borrower->{'phone'};
541 my $bib = GetBiblioData
($biblionumber);
542 my $title = $bib->{title
};
544 $sth_load->execute($biblionumber, $itemnumber, $barcode, $surname, $firstname, $phone, $borrowernumber,
545 $cardnumber, $reservedate, $title, $itemcallnumber,
546 $holdingbranch, $pickbranch, $reservenotes, $item_level);
550 =head2 AddToHoldTargetMap
554 sub AddToHoldTargetMap
{
555 my $item_map = shift;
557 my $dbh = C4
::Context
->dbh;
560 INSERT INTO hold_fill_targets
(borrowernumber
, biblionumber
, itemnumber
, source_branchcode
, item_level_request
)
561 VALUES
(?
, ?
, ?
, ?
, ?
)
563 my $sth_insert = $dbh->prepare($insert_sql);
565 foreach my $itemnumber (keys %$item_map) {
566 my $mapped_item = $item_map->{$itemnumber};
567 $sth_insert->execute($mapped_item->{borrowernumber
}, $mapped_item->{biblionumber
}, $itemnumber,
568 $mapped_item->{holdingbranch
}, $mapped_item->{item_level
});
572 # Helper functions, not part of any interface
575 return $_[0] unless $_[0];
581 sub load_branches_to_pull_from
{
582 my $static_branch_list = C4
::Context
->preference("StaticHoldsQueueWeight")
585 my @branches_to_use = map _trim
($_), split /,/, $static_branch_list;
587 @branches_to_use = shuffle
(@branches_to_use) if C4
::Context
->preference("RandomizeHoldsQueueWeight");
589 return \
@branches_to_use;
592 sub least_cost_branch
{
595 my ($to, $from, $transport_cost_matrix) = @_;
597 # Nothing really spectacular: supply to branch, a list of potential from branches
598 # and find the minimum from - to value from the transport_cost_matrix
599 return $from->[0] if @
$from == 1;
601 my ($least_cost, @branch);
603 my $cell = $transport_cost_matrix->{$to}{$_};
604 next if $cell->{disable_transfer
};
606 my $cost = $cell->{cost
};
607 next unless defined $cost; # XXX should this be reported?
609 unless (defined $least_cost) {
615 next if $cost > $least_cost;
617 if ($cost == $least_cost) {
628 # XXX return a random @branch with minimum cost instead of the first one;
629 # return $branch[0] if @branch == 1;