Bug 16011: $VERSION - Remove the $VERSION init
[koha.git] / C4 / HoldsQueue.pm
blob4fda2c6bd16ebf9fd35d6e8268a6f0566eae72f3
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
22 use strict;
23 use warnings;
25 use C4::Context;
26 use C4::Search;
27 use C4::Items;
28 use C4::Branch;
29 use C4::Circulation;
30 use C4::Members;
31 use C4::Biblio;
32 use Koha::DateUtils;
34 use List::Util qw(shuffle);
35 use List::MoreUtils qw(any);
36 use Data::Dumper;
38 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
39 BEGIN {
40 require Exporter;
41 @ISA = qw(Exporter);
42 @EXPORT_OK = qw(
43 &CreateQueue
44 &GetHoldsQueueItems
46 &TransportCostMatrix
47 &UpdateTransportCostMatrix
52 =head1 FUNCTIONS
54 =head2 TransportCostMatrix
56 TransportCostMatrix();
58 Returns Transport Cost Matrix as a hashref <to branch code> => <from branch code> => cost
60 =cut
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();
67 my $calendars;
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} = {
75 cost => $cost,
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> }
96 =cut
98 sub UpdateTransportCostMatrix {
99 my ($records) = @_;
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}) {
110 $cost ||= 0;
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";
114 $cost = 0;
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
127 =cut
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
135 FROM tmp_holdsqueue
136 JOIN biblio USING (biblionumber)
137 LEFT JOIN biblioitems USING (biblionumber)
138 LEFT JOIN items USING ( itemnumber)
140 if ($branchlimit) {
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);
147 my $items = [];
148 while ( my $row = $sth->fetchrow_hashref ){
149 my $record = GetMarcBiblio($row->{biblionumber});
150 if ($record){
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};
162 push @$items, $row;
164 return $items;
167 =head2 CreateQueue
169 CreateQueue();
171 Top level function that turns reserves into tmp_holdsqueue and hold_fill_targets.
173 =cut
175 sub CreateQueue {
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");
181 my $total_bibs = 0;
182 my $total_requests = 0;
183 my $total_available_items = 0;
184 my $num_items_mapped = 0;
186 my $branches_to_use;
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) {
203 $total_bibs++;
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);
210 $item_map or next;
211 my $item_map_size = scalar(keys %$item_map)
212 or next;
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
220 # FIXME
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.
234 =cut
236 sub GetBibsWithPendingHoldRequests {
237 my $dbh = C4::Context->dbh;
239 my $bib_query = "SELECT DISTINCT biblionumber
240 FROM reserves
241 WHERE found IS NULL
242 AND priority > 0
243 AND reservedate <= CURRENT_DATE()
244 AND suspend = 0
246 my $sth = $dbh->prepare($bib_query);
248 $sth->execute();
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:
262 biblionumber
263 borrowernumber
264 itemnumber
265 priority
266 branchcode
267 reservedate
268 reservenotes
269 borrowerbranch
271 The arrayref is sorted in order of increasing priority.
273 =cut
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
282 FROM reserves
283 JOIN borrowers USING (borrowernumber)
284 WHERE biblionumber = ?
285 AND found IS NULL
286 AND priority > 0
287 AND reservedate <= CURRENT_DATE()
288 AND suspend = 0
289 ORDER BY priority";
290 my $sth = $dbh->prepare($request_query);
291 $sth->execute($biblionumber);
293 my $requests = $sth->fetchall_arrayref({});
294 return $requests;
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:
306 * it is not on loan
307 * it is not withdrawn
308 * it is not marked notforloan
309 * it is not currently in transit
310 * it is not lost
311 * it is not sitting on the hold shelf
312 * it is not damaged (unless AllowHoldsOnDamagedItems is on)
314 =cut
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
321 FROM items ";
323 if (C4::Context->preference('item-level_itypes')) {
324 $items_query .= "LEFT JOIN itemtypes ON (itemtypes.itemtype = items.itype) ";
325 } else {
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
331 AND itemlost = 0
332 AND withdrawn = 0";
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 (
337 SELECT itemnumber
338 FROM reserves
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;
355 return [ grep {
356 my $rule = GetBranchItemRule($_->{homebranch}, $_->{itype});
357 $_->{holdallowed} = $rule->{holdallowed};
358 } @items ];
361 =head2 MapItemsToHoldRequests
363 MapItemsToHoldRequests($hold_requests, $available_items, $branches, $transport_cost_matrix)
365 =cut
367 sub MapItemsToHoldRequests {
368 my ($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix) = @_;
370 # handle trival cases
371 return unless scalar(@$hold_requests) > 0;
372 return unless scalar(@$available_items) > 0;
374 # identify item-level requests
375 my %specific_items_requested = map { $_->{itemnumber} => 1 }
376 grep { defined($_->{itemnumber}) }
377 @$hold_requests;
379 # group available items by itemnumber
380 my %items_by_itemnumber = map { $_->{itemnumber} => $_ } @$available_items;
382 # items already allocated
383 my %allocated_items = ();
385 # map of items to hold requests
386 my %item_map = ();
388 # figure out which item-level requests can be filled
389 my $num_items_remaining = scalar(@$available_items);
390 foreach my $request (@$hold_requests) {
391 last if $num_items_remaining == 0;
393 # is this an item-level request?
394 if (defined($request->{itemnumber})) {
395 # fill it if possible; if not skip it
396 if (exists $items_by_itemnumber{$request->{itemnumber}} and
397 not exists $allocated_items{$request->{itemnumber}}) {
398 $item_map{$request->{itemnumber}} = {
399 borrowernumber => $request->{borrowernumber},
400 biblionumber => $request->{biblionumber},
401 holdingbranch => $items_by_itemnumber{$request->{itemnumber}}->{holdingbranch},
402 pickup_branch => $request->{branchcode} || $request->{borrowerbranch},
403 item_level => 1,
404 reservedate => $request->{reservedate},
405 reservenotes => $request->{reservenotes},
407 $allocated_items{$request->{itemnumber}}++;
408 $num_items_remaining--;
410 } else {
411 # it's title-level request that will take up one item
412 $num_items_remaining--;
416 # group available items by branch
417 my %items_by_branch = ();
418 foreach my $item (@$available_items) {
419 next unless $item->{holdallowed};
421 push @{ $items_by_branch{ $item->{holdingbranch} } }, $item
422 unless exists $allocated_items{ $item->{itemnumber} };
424 return \%item_map unless keys %items_by_branch;
426 # now handle the title-level requests
427 $num_items_remaining = scalar(@$available_items) - scalar(keys %allocated_items);
428 my $pull_branches;
429 foreach my $request (@$hold_requests) {
430 last if $num_items_remaining == 0;
431 next if defined($request->{itemnumber}); # already handled these
433 # look for local match first
434 my $pickup_branch = $request->{branchcode} || $request->{borrowerbranch};
435 my ($itemnumber, $holdingbranch);
437 my $holding_branch_items = $items_by_branch{$pickup_branch};
438 if ( $holding_branch_items ) {
439 foreach my $item (@$holding_branch_items) {
440 if ( $request->{borrowerbranch} eq $item->{homebranch} ) {
441 $itemnumber = $item->{itemnumber};
442 last;
445 $holdingbranch = $pickup_branch;
447 elsif ($transport_cost_matrix) {
448 $pull_branches = [keys %items_by_branch];
449 $holdingbranch = least_cost_branch( $pickup_branch, $pull_branches, $transport_cost_matrix );
450 if ( $holdingbranch ) {
452 my $holding_branch_items = $items_by_branch{$holdingbranch};
453 foreach my $item (@$holding_branch_items) {
454 next if $request->{borrowerbranch} ne $item->{homebranch};
456 $itemnumber = $item->{itemnumber};
457 last;
460 else {
461 next;
465 unless ($itemnumber) {
466 # not found yet, fall back to basics
467 if ($branches_to_use) {
468 $pull_branches = $branches_to_use;
469 } else {
470 $pull_branches = [keys %items_by_branch];
473 # Try picking items where the home and pickup branch match first
474 PULL_BRANCHES:
475 foreach my $branch (@$pull_branches) {
476 my $holding_branch_items = $items_by_branch{$branch}
477 or next;
479 $holdingbranch ||= $branch;
480 foreach my $item (@$holding_branch_items) {
481 next if $pickup_branch ne $item->{homebranch};
482 next if ( $item->{holdallowed} == 1 && $item->{homebranch} ne $request->{borrowerbranch} );
484 $itemnumber = $item->{itemnumber};
485 $holdingbranch = $branch;
486 last PULL_BRANCHES;
490 # Now try items from the least cost branch based on the transport cost matrix or StaticHoldsQueueWeight
491 unless ( $itemnumber ) {
492 foreach my $current_item ( @{ $items_by_branch{$holdingbranch} } ) {
493 if ( $holdingbranch && ( $current_item->{holdallowed} == 2 || $request->{borrowerbranch} eq $current_item->{homebranch} ) ) {
494 $itemnumber = $current_item->{itemnumber};
495 last; # quit this loop as soon as we have a suitable item
500 # Now try for items for any item that can fill this hold
501 unless ( $itemnumber ) {
502 PULL_BRANCHES2:
503 foreach my $branch (@$pull_branches) {
504 my $holding_branch_items = $items_by_branch{$branch}
505 or next;
507 foreach my $item (@$holding_branch_items) {
508 next if ( $item->{holdallowed} == 1 && $item->{homebranch} ne $request->{borrowerbranch} );
510 $itemnumber = $item->{itemnumber};
511 $holdingbranch = $branch;
512 last PULL_BRANCHES2;
518 if ($itemnumber) {
519 my $holding_branch_items = $items_by_branch{$holdingbranch}
520 or die "Have $itemnumber, $holdingbranch, but no items!";
521 @$holding_branch_items = grep { $_->{itemnumber} != $itemnumber } @$holding_branch_items;
522 delete $items_by_branch{$holdingbranch} unless @$holding_branch_items;
524 $item_map{$itemnumber} = {
525 borrowernumber => $request->{borrowernumber},
526 biblionumber => $request->{biblionumber},
527 holdingbranch => $holdingbranch,
528 pickup_branch => $pickup_branch,
529 item_level => 0,
530 reservedate => $request->{reservedate},
531 reservenotes => $request->{reservenotes},
533 $num_items_remaining--;
536 return \%item_map;
539 =head2 CreatePickListFromItemMap
541 =cut
543 sub CreatePicklistFromItemMap {
544 my $item_map = shift;
546 my $dbh = C4::Context->dbh;
548 my $sth_load=$dbh->prepare("
549 INSERT INTO tmp_holdsqueue (biblionumber,itemnumber,barcode,surname,firstname,phone,borrowernumber,
550 cardnumber,reservedate,title, itemcallnumber,
551 holdingbranch,pickbranch,notes, item_level_request)
552 VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
555 foreach my $itemnumber (sort keys %$item_map) {
556 my $mapped_item = $item_map->{$itemnumber};
557 my $biblionumber = $mapped_item->{biblionumber};
558 my $borrowernumber = $mapped_item->{borrowernumber};
559 my $pickbranch = $mapped_item->{pickup_branch};
560 my $holdingbranch = $mapped_item->{holdingbranch};
561 my $reservedate = $mapped_item->{reservedate};
562 my $reservenotes = $mapped_item->{reservenotes};
563 my $item_level = $mapped_item->{item_level};
565 my $item = GetItem($itemnumber);
566 my $barcode = $item->{barcode};
567 my $itemcallnumber = $item->{itemcallnumber};
569 my $borrower = GetMember('borrowernumber'=>$borrowernumber);
570 my $cardnumber = $borrower->{'cardnumber'};
571 my $surname = $borrower->{'surname'};
572 my $firstname = $borrower->{'firstname'};
573 my $phone = $borrower->{'phone'};
575 my $bib = GetBiblioData($biblionumber);
576 my $title = $bib->{title};
578 $sth_load->execute($biblionumber, $itemnumber, $barcode, $surname, $firstname, $phone, $borrowernumber,
579 $cardnumber, $reservedate, $title, $itemcallnumber,
580 $holdingbranch, $pickbranch, $reservenotes, $item_level);
584 =head2 AddToHoldTargetMap
586 =cut
588 sub AddToHoldTargetMap {
589 my $item_map = shift;
591 my $dbh = C4::Context->dbh;
593 my $insert_sql = q(
594 INSERT INTO hold_fill_targets (borrowernumber, biblionumber, itemnumber, source_branchcode, item_level_request)
595 VALUES (?, ?, ?, ?, ?)
597 my $sth_insert = $dbh->prepare($insert_sql);
599 foreach my $itemnumber (keys %$item_map) {
600 my $mapped_item = $item_map->{$itemnumber};
601 $sth_insert->execute($mapped_item->{borrowernumber}, $mapped_item->{biblionumber}, $itemnumber,
602 $mapped_item->{holdingbranch}, $mapped_item->{item_level});
606 # Helper functions, not part of any interface
608 sub _trim {
609 return $_[0] unless $_[0];
610 $_[0] =~ s/^\s+//;
611 $_[0] =~ s/\s+$//;
612 $_[0];
615 sub load_branches_to_pull_from {
616 my @branches_to_use;
618 my $static_branch_list = C4::Context->preference("StaticHoldsQueueWeight");
619 @branches_to_use = map { _trim($_) } split( /,/, $static_branch_list )
620 if $static_branch_list;
622 @branches_to_use =
623 Koha::Database->new()->schema()->resultset('Branch')
624 ->get_column('branchcode')->all()
625 unless (@branches_to_use);
627 @branches_to_use = shuffle(@branches_to_use)
628 if C4::Context->preference("RandomizeHoldsQueueWeight");
630 my $today = dt_from_string();
631 if ( C4::Context->preference('HoldsQueueSkipClosed') ) {
632 @branches_to_use = grep {
633 !Koha::Calendar->new( branchcode => $_ )
634 ->is_holiday( $today )
635 } @branches_to_use;
638 return \@branches_to_use;
641 sub least_cost_branch {
643 #$from - arrayref
644 my ($to, $from, $transport_cost_matrix) = @_;
646 # Nothing really spectacular: supply to branch, a list of potential from branches
647 # and find the minimum from - to value from the transport_cost_matrix
648 return $from->[0] if ( @$from == 1 && $transport_cost_matrix->{$to}{$from->[0]}->{disable_transfer} != 1 );
650 # If the pickup library is in the list of libraries to pull from,
651 # return that library right away, it is obviously the least costly
652 return ($to) if any { $_ eq $to } @$from;
654 my ($least_cost, @branch);
655 foreach (@$from) {
656 my $cell = $transport_cost_matrix->{$to}{$_};
657 next if $cell->{disable_transfer};
659 my $cost = $cell->{cost};
660 next unless defined $cost; # XXX should this be reported?
662 unless (defined $least_cost) {
663 $least_cost = $cost;
664 push @branch, $_;
665 next;
668 next if $cost > $least_cost;
670 if ($cost == $least_cost) {
671 push @branch, $_;
672 next;
675 @branch = ($_);
676 $least_cost = $cost;
679 return $branch[0];
681 # XXX return a random @branch with minimum cost instead of the first one;
682 # return $branch[0] if @branch == 1;