Bug 15758: Koha::Libraries - Ultimate duel for C4::Branch
[koha.git] / C4 / HoldsQueue.pm
1 package C4::HoldsQueue;
2
3 # Copyright 2011 Catalyst IT
4 #
5 # This file is part of Koha.
6 #
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.
11 #
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.
16 #
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>.
19
20 # FIXME: expand perldoc, explain intended logic
21
22 use strict;
23 use warnings;
24
25 use C4::Context;
26 use C4::Search;
27 use C4::Items;
28 use C4::Circulation;
29 use C4::Members;
30 use C4::Biblio;
31 use Koha::DateUtils;
32
33 use List::Util qw(shuffle);
34 use List::MoreUtils qw(any);
35 use Data::Dumper;
36
37 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
38 BEGIN {
39     require Exporter;
40     @ISA = qw(Exporter);
41     @EXPORT_OK = qw(
42         &CreateQueue
43         &GetHoldsQueueItems
44
45         &TransportCostMatrix
46         &UpdateTransportCostMatrix
47      );
48 }
49
50
51 =head1 FUNCTIONS
52
53 =head2 TransportCostMatrix
54
55   TransportCostMatrix();
56
57 Returns Transport Cost Matrix as a hashref <to branch code> => <from branch code> => cost
58
59 =cut
60
61 sub TransportCostMatrix {
62     my $dbh   = C4::Context->dbh;
63     my $transport_costs = $dbh->selectall_arrayref("SELECT * FROM transport_cost",{ Slice => {} });
64
65     my $today = dt_from_string();
66     my $calendars;
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} = {
74             cost             => $cost,
75             disable_transfer => $disabled
76         };
77
78         if ( C4::Context->preference("HoldsQueueSkipClosed") ) {
79             $calendars->{$from} ||= Koha::Calendar->new( branchcode => $from );
80             $transport_cost_matrix{$to}{$from}{disable_transfer} ||=
81               $calendars->{$from}->is_holiday( $today );
82         }
83
84     }
85     return \%transport_cost_matrix;
86 }
87
88 =head2 UpdateTransportCostMatrix
89
90   UpdateTransportCostMatrix($records);
91
92 Updates full Transport Cost Matrix table. $records is an arrayref of records.
93 Records: { frombranch => <code>, tobranch => <code>, cost => <figure>, disable_transfer => <0,1> }
94
95 =cut
96
97 sub UpdateTransportCostMatrix {
98     my ($records) = @_;
99     my $dbh   = C4::Context->dbh;
100
101     my $sth = $dbh->prepare("INSERT INTO transport_cost (frombranch, tobranch, cost, disable_transfer) VALUES (?, ?, ?, ?)");
102
103     $dbh->do("TRUNCATE TABLE transport_cost");
104     foreach (@$records) {
105         my $cost = $_->{cost};
106         my $from = $_->{frombranch};
107         my $to = $_->{tobranch};
108         if ($_->{disable_transfer}) {
109             $cost ||= 0;
110         }
111         elsif ( !defined ($cost) || ($cost !~ m/(0|[1-9][0-9]*)(\.[0-9]*)?/o) ) {
112             warn  "Invalid $from -> $to cost $cost - must be a number >= 0, disablig";
113             $cost = 0;
114             $_->{disable_transfer} = 1;
115         }
116         $sth->execute( $from, $to, $cost, $_->{disable_transfer} ? 1 : 0 );
117     }
118 }
119
120 =head2 GetHoldsQueueItems
121
122   GetHoldsQueueItems($branch);
123
124 Returns hold queue for a holding branch. If branch is omitted, then whole queue is returned
125
126 =cut
127
128 sub GetHoldsQueueItems {
129     my ($branchlimit) = @_;
130     my $dbh   = C4::Context->dbh;
131
132     my @bind_params = ();
133     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
134                   FROM tmp_holdsqueue
135                        JOIN biblio      USING (biblionumber)
136                   LEFT JOIN biblioitems USING (biblionumber)
137                   LEFT JOIN items       USING (  itemnumber)
138                 /;
139     if ($branchlimit) {
140         $query .=" WHERE tmp_holdsqueue.holdingbranch = ?";
141         push @bind_params, $branchlimit;
142     }
143     $query .= " ORDER BY ccode, location, cn_sort, author, title, pickbranch, reservedate";
144     my $sth = $dbh->prepare($query);
145     $sth->execute(@bind_params);
146     my $items = [];
147     while ( my $row = $sth->fetchrow_hashref ){
148         my $record = GetMarcBiblio($row->{biblionumber});
149         if ($record){
150             $row->{subtitle} = [ map { $_->{subfield} } @{ GetRecordValue( 'subtitle', $record, '' ) } ];
151             $row->{parts} = GetRecordValue('parts',$record,'')->[0]->{subfield};
152             $row->{numbers} = GetRecordValue('numbers',$record,'')->[0]->{subfield};
153         }
154
155         # return the bib-level or item-level itype per syspref
156         if (!C4::Context->preference('item-level_itypes')) {
157             $row->{itype} = $row->{itemtype};
158         }
159         delete $row->{itemtype};
160
161         push @$items, $row;
162     }
163     return $items;
164 }
165
166 =head2 CreateQueue
167
168   CreateQueue();
169
170 Top level function that turns reserves into tmp_holdsqueue and hold_fill_targets.
171
172 =cut
173
174 sub CreateQueue {
175     my $dbh   = C4::Context->dbh;
176
177     $dbh->do("DELETE FROM tmp_holdsqueue");  # clear the old table for new info
178     $dbh->do("DELETE FROM hold_fill_targets");
179
180     my $total_bibs            = 0;
181     my $total_requests        = 0;
182     my $total_available_items = 0;
183     my $num_items_mapped      = 0;
184
185     my $branches_to_use;
186     my $transport_cost_matrix;
187     my $use_transport_cost_matrix = C4::Context->preference("UseTransportCostMatrix");
188     if ($use_transport_cost_matrix) {
189         $transport_cost_matrix = TransportCostMatrix();
190         unless (keys %$transport_cost_matrix) {
191             warn "UseTransportCostMatrix set to yes, but matrix not populated";
192             undef $transport_cost_matrix;
193         }
194     }
195     unless ($transport_cost_matrix) {
196         $branches_to_use = load_branches_to_pull_from();
197     }
198
199     my $bibs_with_pending_requests = GetBibsWithPendingHoldRequests();
200
201     foreach my $biblionumber (@$bibs_with_pending_requests) {
202         $total_bibs++;
203         my $hold_requests   = GetPendingHoldRequestsForBib($biblionumber);
204         my $available_items = GetItemsAvailableToFillHoldRequestsForBib($biblionumber, $branches_to_use);
205         $total_requests        += scalar(@$hold_requests);
206         $total_available_items += scalar(@$available_items);
207
208         my $item_map = MapItemsToHoldRequests($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix);
209         $item_map  or next;
210         my $item_map_size = scalar(keys %$item_map)
211           or next;
212
213         $num_items_mapped += $item_map_size;
214         CreatePicklistFromItemMap($item_map);
215         AddToHoldTargetMap($item_map);
216         if (($item_map_size < scalar(@$hold_requests  )) and
217             ($item_map_size < scalar(@$available_items))) {
218             # DOUBLE CHECK, but this is probably OK - unfilled item-level requests
219             # FIXME
220             #warn "unfilled requests for $biblionumber";
221             #warn Dumper($hold_requests), Dumper($available_items), Dumper($item_map);
222         }
223     }
224 }
225
226 =head2 GetBibsWithPendingHoldRequests
227
228   my $biblionumber_aref = GetBibsWithPendingHoldRequests();
229
230 Return an arrayref of the biblionumbers of all bibs
231 that have one or more unfilled hold requests.
232
233 =cut
234
235 sub GetBibsWithPendingHoldRequests {
236     my $dbh = C4::Context->dbh;
237
238     my $bib_query = "SELECT DISTINCT biblionumber
239                      FROM reserves
240                      WHERE found IS NULL
241                      AND priority > 0
242                      AND reservedate <= CURRENT_DATE()
243                      AND suspend = 0
244                      ";
245     my $sth = $dbh->prepare($bib_query);
246
247     $sth->execute();
248     my $biblionumbers = $sth->fetchall_arrayref();
249
250     return [ map { $_->[0] } @$biblionumbers ];
251 }
252
253 =head2 GetPendingHoldRequestsForBib
254
255   my $requests = GetPendingHoldRequestsForBib($biblionumber);
256
257 Returns an arrayref of hashrefs to pending, unfilled hold requests
258 on the bib identified by $biblionumber.  The following keys
259 are present in each hashref:
260
261     biblionumber
262     borrowernumber
263     itemnumber
264     priority
265     branchcode
266     reservedate
267     reservenotes
268     borrowerbranch
269
270 The arrayref is sorted in order of increasing priority.
271
272 =cut
273
274 sub GetPendingHoldRequestsForBib {
275     my $biblionumber = shift;
276
277     my $dbh = C4::Context->dbh;
278
279     my $request_query = "SELECT biblionumber, borrowernumber, itemnumber, priority, reserves.branchcode,
280                                 reservedate, reservenotes, borrowers.branchcode AS borrowerbranch, itemtype
281                          FROM reserves
282                          JOIN borrowers USING (borrowernumber)
283                          WHERE biblionumber = ?
284                          AND found IS NULL
285                          AND priority > 0
286                          AND reservedate <= CURRENT_DATE()
287                          AND suspend = 0
288                          ORDER BY priority";
289     my $sth = $dbh->prepare($request_query);
290     $sth->execute($biblionumber);
291
292     my $requests = $sth->fetchall_arrayref({});
293     return $requests;
294
295 }
296
297 =head2 GetItemsAvailableToFillHoldRequestsForBib
298
299   my $available_items = GetItemsAvailableToFillHoldRequestsForBib($biblionumber, $branches_ar);
300
301 Returns an arrayref of items available to fill hold requests
302 for the bib identified by C<$biblionumber>.  An item is available
303 to fill a hold request if and only if:
304
305     * it is not on loan
306     * it is not withdrawn
307     * it is not marked notforloan
308     * it is not currently in transit
309     * it is not lost
310     * it is not sitting on the hold shelf
311     * it is not damaged (unless AllowHoldsOnDamagedItems is on)
312
313 =cut
314
315 sub GetItemsAvailableToFillHoldRequestsForBib {
316     my ($biblionumber, $branches_to_use) = @_;
317
318     my $dbh = C4::Context->dbh;
319     my $items_query = "SELECT itemnumber, homebranch, holdingbranch, itemtypes.itemtype AS itype
320                        FROM items ";
321
322     if (C4::Context->preference('item-level_itypes')) {
323         $items_query .=   "LEFT JOIN itemtypes ON (itemtypes.itemtype = items.itype) ";
324     } else {
325         $items_query .=   "JOIN biblioitems USING (biblioitemnumber)
326                            LEFT JOIN itemtypes USING (itemtype) ";
327     }
328     $items_query .=   "WHERE items.notforloan = 0
329                        AND holdingbranch IS NOT NULL
330                        AND itemlost = 0
331                        AND withdrawn = 0";
332     $items_query .= "  AND damaged = 0" unless C4::Context->preference('AllowHoldsOnDamagedItems');
333     $items_query .= "  AND items.onloan IS NULL
334                        AND (itemtypes.notforloan IS NULL OR itemtypes.notforloan = 0)
335                        AND itemnumber NOT IN (
336                            SELECT itemnumber
337                            FROM reserves
338                            WHERE biblionumber = ?
339                            AND itemnumber IS NOT NULL
340                            AND (found IS NOT NULL OR priority = 0)
341                         )
342                        AND items.biblionumber = ?";
343
344     my @params = ($biblionumber, $biblionumber);
345     if ($branches_to_use && @$branches_to_use) {
346         $items_query .= " AND holdingbranch IN (" . join (",", map { "?" } @$branches_to_use) . ")";
347         push @params, @$branches_to_use;
348     }
349     my $sth = $dbh->prepare($items_query);
350     $sth->execute(@params);
351
352     my $itm = $sth->fetchall_arrayref({});
353     my @items = grep { ! scalar GetTransfers($_->{itemnumber}) } @$itm;
354     return [ grep {
355         my $rule = GetBranchItemRule($_->{homebranch}, $_->{itype});
356         $_->{holdallowed} = $rule->{holdallowed};
357         $_->{hold_fulfillment_policy} = $rule->{hold_fulfillment_policy};
358     } @items ];
359 }
360
361 =head2 MapItemsToHoldRequests
362
363   MapItemsToHoldRequests($hold_requests, $available_items, $branches, $transport_cost_matrix)
364
365 =cut
366
367 sub MapItemsToHoldRequests {
368     my ($hold_requests, $available_items, $branches_to_use, $transport_cost_matrix) = @_;
369
370
371     # handle trival cases
372     return unless scalar(@$hold_requests) > 0;
373     return unless scalar(@$available_items) > 0;
374
375     # identify item-level requests
376     my %specific_items_requested = map { $_->{itemnumber} => 1 }
377                                    grep { defined($_->{itemnumber}) }
378                                    @$hold_requests;
379
380     # group available items by itemnumber
381     my %items_by_itemnumber = map { $_->{itemnumber} => $_ } @$available_items;
382
383     # items already allocated
384     my %allocated_items = ();
385
386     # map of items to hold requests
387     my %item_map = ();
388
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;
393
394         # is this an item-level request?
395         if (defined($request->{itemnumber})) {
396             # fill it if possible; if not skip it
397             if (
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} }  )
403                 and ( !$request->{itemtype} # If hold itemtype is set, item's itemtype must match
404                     || $items_by_itemnumber{ $request->{itemnumber} }->{itype} eq $request->{itemtype} )
405                 )
406
407               )
408             {
409
410                 $item_map{ $request->{itemnumber} } = {
411                     borrowernumber => $request->{borrowernumber},
412                     biblionumber   => $request->{biblionumber},
413                     holdingbranch  => $items_by_itemnumber{ $request->{itemnumber} }->{holdingbranch},
414                     pickup_branch  => $request->{branchcode} || $request->{borrowerbranch},
415                     item_level     => 1,
416                     reservedate    => $request->{reservedate},
417                     reservenotes   => $request->{reservenotes},
418                 };
419                 $allocated_items{ $request->{itemnumber} }++;
420                 $num_items_remaining--;
421             }
422         } else {
423             # it's title-level request that will take up one item
424             $num_items_remaining--;
425         }
426     }
427
428     # group available items by branch
429     my %items_by_branch = ();
430     foreach my $item (@$available_items) {
431         next unless $item->{holdallowed};
432
433         push @{ $items_by_branch{ $item->{holdingbranch} } }, $item
434           unless exists $allocated_items{ $item->{itemnumber} };
435     }
436     return \%item_map unless keys %items_by_branch;
437
438     # now handle the title-level requests
439     $num_items_remaining = scalar(@$available_items) - scalar(keys %allocated_items);
440     my $pull_branches;
441     foreach my $request (@$hold_requests) {
442         last if $num_items_remaining == 0;
443         next if defined($request->{itemnumber}); # already handled these
444
445         # look for local match first
446         my $pickup_branch = $request->{branchcode} || $request->{borrowerbranch};
447         my ($itemnumber, $holdingbranch);
448
449         my $holding_branch_items = $items_by_branch{$pickup_branch};
450         if ( $holding_branch_items ) {
451             foreach my $item (@$holding_branch_items) {
452                 if (
453                     $request->{borrowerbranch} eq $item->{homebranch}
454                     && ( ( $item->{hold_fulfillment_policy} eq 'any' ) # Don't fill item level holds that contravene the hold pickup policy at this time
455                         || $request->{branchcode} eq $item->{ $item->{hold_fulfillment_policy} } )
456                     && ( !$request->{itemtype} # If hold itemtype is set, item's itemtype must match
457                         || $items_by_itemnumber{ $request->{itemnumber} }->{itype} eq $request->{itemtype} )
458                   )
459                 {
460                     $itemnumber = $item->{itemnumber};
461                     last;
462                 }
463             }
464             $holdingbranch = $pickup_branch;
465         }
466         elsif ($transport_cost_matrix) {
467             $pull_branches = [keys %items_by_branch];
468             $holdingbranch = least_cost_branch( $pickup_branch, $pull_branches, $transport_cost_matrix );
469             if ( $holdingbranch ) {
470
471                 my $holding_branch_items = $items_by_branch{$holdingbranch};
472                 foreach my $item (@$holding_branch_items) {
473                     next if $request->{borrowerbranch} ne $item->{homebranch};
474
475                     # Don't fill item level holds that contravene the hold pickup policy at this time
476                     next unless $item->{hold_fulfillment_policy} eq 'any'
477                         || $request->{branchcode} eq $item->{ $item->{hold_fulfillment_policy} };
478
479                     # If hold itemtype is set, item's itemtype must match
480                     next unless ( !$request->{itemtype}
481                         || $item->{itype} eq $request->{itemtype} );
482
483                     $itemnumber = $item->{itemnumber};
484                     last;
485                 }
486             }
487             else {
488                 next;
489             }
490         }
491
492         unless ($itemnumber) {
493             # not found yet, fall back to basics
494             if ($branches_to_use) {
495                 $pull_branches = $branches_to_use;
496             } else {
497                 $pull_branches = [keys %items_by_branch];
498             }
499
500             # Try picking items where the home and pickup branch match first
501             PULL_BRANCHES:
502             foreach my $branch (@$pull_branches) {
503                 my $holding_branch_items = $items_by_branch{$branch}
504                   or next;
505
506                 $holdingbranch ||= $branch;
507                 foreach my $item (@$holding_branch_items) {
508                     next if $pickup_branch ne $item->{homebranch};
509                     next if ( $item->{holdallowed} == 1 && $item->{homebranch} ne $request->{borrowerbranch} );
510
511                     # Don't fill item level holds that contravene the hold pickup policy at this time
512                     next unless $item->{hold_fulfillment_policy} eq 'any'
513                         || $request->{branchcode} eq $item->{ $item->{hold_fulfillment_policy} };
514
515                     # If hold itemtype is set, item's itemtype must match
516                     next unless ( !$request->{itemtype}
517                         || $item->{itype} eq $request->{itemtype} );
518
519                     $itemnumber = $item->{itemnumber};
520                     $holdingbranch = $branch;
521                     last PULL_BRANCHES;
522                 }
523             }
524
525             # Now try items from the least cost branch based on the transport cost matrix or StaticHoldsQueueWeight
526             unless ( $itemnumber ) {
527                 foreach my $current_item ( @{ $items_by_branch{$holdingbranch} } ) {
528                     if ( $holdingbranch && ( $current_item->{holdallowed} == 2 || $request->{borrowerbranch} eq $current_item->{homebranch} ) ) {
529
530                         # Don't fill item level holds that contravene the hold pickup policy at this time
531                         next unless $current_item->{hold_fulfillment_policy} eq 'any'
532                             || $request->{branchcode} eq $current_item->{ $current_item->{hold_fulfillment_policy} };
533
534                         # If hold itemtype is set, item's itemtype must match
535                         next unless ( !$request->{itemtype}
536                             || $current_item->{itype} eq $request->{itemtype} );
537
538                         $itemnumber = $current_item->{itemnumber};
539                         last; # quit this loop as soon as we have a suitable item
540                     }
541                 }
542             }
543
544             # Now try for items for any item that can fill this hold
545             unless ( $itemnumber ) {
546                 PULL_BRANCHES2:
547                 foreach my $branch (@$pull_branches) {
548                     my $holding_branch_items = $items_by_branch{$branch}
549                       or next;
550
551                     foreach my $item (@$holding_branch_items) {
552                         next if ( $item->{holdallowed} == 1 && $item->{homebranch} ne $request->{borrowerbranch} );
553
554                         # Don't fill item level holds that contravene the hold pickup policy at this time
555                         next unless $item->{hold_fulfillment_policy} eq 'any'
556                             || $request->{branchcode} eq $item->{ $item->{hold_fulfillment_policy} };
557
558                         # If hold itemtype is set, item's itemtype must match
559                         next unless ( !$request->{itemtype}
560                             || $item->{itype} eq $request->{itemtype} );
561
562                         $itemnumber = $item->{itemnumber};
563                         $holdingbranch = $branch;
564                         last PULL_BRANCHES2;
565                     }
566                 }
567             }
568         }
569
570         if ($itemnumber) {
571             my $holding_branch_items = $items_by_branch{$holdingbranch}
572               or die "Have $itemnumber, $holdingbranch, but no items!";
573             @$holding_branch_items = grep { $_->{itemnumber} != $itemnumber } @$holding_branch_items;
574             delete $items_by_branch{$holdingbranch} unless @$holding_branch_items;
575
576             $item_map{$itemnumber} = {
577                 borrowernumber => $request->{borrowernumber},
578                 biblionumber => $request->{biblionumber},
579                 holdingbranch => $holdingbranch,
580                 pickup_branch => $pickup_branch,
581                 item_level => 0,
582                 reservedate => $request->{reservedate},
583                 reservenotes => $request->{reservenotes},
584             };
585             $num_items_remaining--;
586         }
587     }
588     return \%item_map;
589 }
590
591 =head2 CreatePickListFromItemMap
592
593 =cut
594
595 sub CreatePicklistFromItemMap {
596     my $item_map = shift;
597
598     my $dbh = C4::Context->dbh;
599
600     my $sth_load=$dbh->prepare("
601         INSERT INTO tmp_holdsqueue (biblionumber,itemnumber,barcode,surname,firstname,phone,borrowernumber,
602                                     cardnumber,reservedate,title, itemcallnumber,
603                                     holdingbranch,pickbranch,notes, item_level_request)
604         VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
605     ");
606
607     foreach my $itemnumber  (sort keys %$item_map) {
608         my $mapped_item = $item_map->{$itemnumber};
609         my $biblionumber = $mapped_item->{biblionumber};
610         my $borrowernumber = $mapped_item->{borrowernumber};
611         my $pickbranch = $mapped_item->{pickup_branch};
612         my $holdingbranch = $mapped_item->{holdingbranch};
613         my $reservedate = $mapped_item->{reservedate};
614         my $reservenotes = $mapped_item->{reservenotes};
615         my $item_level = $mapped_item->{item_level};
616
617         my $item = GetItem($itemnumber);
618         my $barcode = $item->{barcode};
619         my $itemcallnumber = $item->{itemcallnumber};
620
621         my $borrower = GetMember('borrowernumber'=>$borrowernumber);
622         my $cardnumber = $borrower->{'cardnumber'};
623         my $surname = $borrower->{'surname'};
624         my $firstname = $borrower->{'firstname'};
625         my $phone = $borrower->{'phone'};
626
627         my $bib = GetBiblioData($biblionumber);
628         my $title = $bib->{title};
629
630         $sth_load->execute($biblionumber, $itemnumber, $barcode, $surname, $firstname, $phone, $borrowernumber,
631                            $cardnumber, $reservedate, $title, $itemcallnumber,
632                            $holdingbranch, $pickbranch, $reservenotes, $item_level);
633     }
634 }
635
636 =head2 AddToHoldTargetMap
637
638 =cut
639
640 sub AddToHoldTargetMap {
641     my $item_map = shift;
642
643     my $dbh = C4::Context->dbh;
644
645     my $insert_sql = q(
646         INSERT INTO hold_fill_targets (borrowernumber, biblionumber, itemnumber, source_branchcode, item_level_request)
647                                VALUES (?, ?, ?, ?, ?)
648     );
649     my $sth_insert = $dbh->prepare($insert_sql);
650
651     foreach my $itemnumber (keys %$item_map) {
652         my $mapped_item = $item_map->{$itemnumber};
653         $sth_insert->execute($mapped_item->{borrowernumber}, $mapped_item->{biblionumber}, $itemnumber,
654                              $mapped_item->{holdingbranch}, $mapped_item->{item_level});
655     }
656 }
657
658 # Helper functions, not part of any interface
659
660 sub _trim {
661     return $_[0] unless $_[0];
662     $_[0] =~ s/^\s+//;
663     $_[0] =~ s/\s+$//;
664     $_[0];
665 }
666
667 sub load_branches_to_pull_from {
668     my @branches_to_use;
669
670     my $static_branch_list = C4::Context->preference("StaticHoldsQueueWeight");
671     @branches_to_use = map { _trim($_) } split( /,/, $static_branch_list )
672       if $static_branch_list;
673
674     @branches_to_use =
675       Koha::Database->new()->schema()->resultset('Branch')
676       ->get_column('branchcode')->all()
677       unless (@branches_to_use);
678
679     @branches_to_use = shuffle(@branches_to_use)
680       if C4::Context->preference("RandomizeHoldsQueueWeight");
681
682     my $today = dt_from_string();
683     if ( C4::Context->preference('HoldsQueueSkipClosed') ) {
684         @branches_to_use = grep {
685             !Koha::Calendar->new( branchcode => $_ )
686               ->is_holiday( $today )
687         } @branches_to_use;
688     }
689
690     return \@branches_to_use;
691 }
692
693 sub least_cost_branch {
694
695     #$from - arrayref
696     my ($to, $from, $transport_cost_matrix) = @_;
697
698     # Nothing really spectacular: supply to branch, a list of potential from branches
699     # and find the minimum from - to value from the transport_cost_matrix
700     return $from->[0] if ( @$from == 1 && $transport_cost_matrix->{$to}{$from->[0]}->{disable_transfer} != 1 );
701
702     # If the pickup library is in the list of libraries to pull from,
703     # return that library right away, it is obviously the least costly
704     return ($to) if any { $_ eq $to } @$from;
705
706     my ($least_cost, @branch);
707     foreach (@$from) {
708         my $cell = $transport_cost_matrix->{$to}{$_};
709         next if $cell->{disable_transfer};
710
711         my $cost = $cell->{cost};
712         next unless defined $cost; # XXX should this be reported?
713
714         unless (defined $least_cost) {
715             $least_cost = $cost;
716             push @branch, $_;
717             next;
718         }
719
720         next if $cost > $least_cost;
721
722         if ($cost == $least_cost) {
723             push @branch, $_;
724             next;
725         }
726
727         @branch = ($_);
728         $least_cost = $cost;
729     }
730
731     return $branch[0];
732
733     # XXX return a random @branch with minimum cost instead of the first one;
734     # return $branch[0] if @branch == 1;
735 }
736
737
738 1;