1 package SL::Helper::Inventory;
6 use Exporter qw(import);
7 use List::Util qw(min sum);
8 use List::UtilsBy qw(sort_by);
9 use List::MoreUtils qw(any);
12 use SL::Locale::String qw(t8);
13 use SL::MoreCommon qw(listify);
14 use SL::DBUtils qw(selectall_hashref_query selectrow_query);
15 use SL::DB::TransferType;
16 use SL::Helper::Number qw(_format_number _round_number);
17 use SL::Helper::Inventory::Allocation;
20 our @EXPORT_OK = qw(get_stock get_onhand allocate allocate_for_assembly produce_assembly check_constraints);
21 our %EXPORT_TAGS = (ALL => \@EXPORT_OK);
23 sub _get_stock_onhand {
26 my $onhand_mode = !!$params{onhand};
30 'MIN(EXTRACT(epoch FROM inventory.itime)) AS itime',
37 my @ids = map { ref $_ ? $_->id : $_ } listify($params{part});
38 push @where, sprintf "parts_id IN (%s)", join ', ', ("?") x @ids;
43 my @ids = map { ref $_ ? $_->id : $_ } listify($params{bin});
44 push @where, sprintf "bin_id IN (%s)", join ', ', ("?") x @ids;
48 if ($params{warehouse}) {
49 my @ids = map { ref $_ ? $_->id : $_ } listify($params{warehouse});
50 push @where, sprintf "warehouse.id IN (%s)", join ', ', ("?") x @ids;
54 if ($params{chargenumber}) {
55 my @ids = listify($params{chargenumber});
56 push @where, sprintf "chargenumber IN (%s)", join ', ', ("?") x @ids;
61 Carp::croak("not DateTime ".$params{date}) unless ref($params{date}) eq 'DateTime';
62 push @where, sprintf "shippingdate <= ?";
63 push @values, $params{date};
66 if (!$params{bestbefore} && $onhand_mode && default_show_bestbefore()) {
67 $params{bestbefore} = DateTime->now_local;
70 if ($params{bestbefore}) {
71 Carp::croak("not DateTime ".$params{date}) unless ref($params{bestbefore}) eq 'DateTime';
72 push @where, sprintf "(bestbefore IS NULL OR bestbefore >= ?)";
73 push @values, $params{bestbefore};
78 part => [ qw(parts_id) ],
79 bin => [ qw(bin_id inventory.warehouse_id)],
80 warehouse => [ qw(inventory.warehouse_id) ],
81 chargenumber => [ qw(chargenumber) ],
82 bestbefore => [ qw(bestbefore) ],
83 for_allocate => [ qw(parts_id bin_id inventory.warehouse_id chargenumber bestbefore) ],
87 for (listify($params{by})) {
88 my $selects = $allowed_by{$_} or Carp::croak("unknown option for by: $_");
89 push @selects, @$selects;
90 push @groups, @$selects;
94 my $select = join ',', @selects;
95 my $where = @where ? 'WHERE ' . join ' AND ', @where : '';
96 my $group_by = @groups ? 'GROUP BY ' . join ', ', @groups : '';
99 SELECT $select FROM inventory
100 LEFT JOIN bin ON bin_id = bin.id
101 LEFT JOIN warehouse ON bin.warehouse_id = warehouse.id
106 $query .= ' HAVING SUM(qty) > 0';
109 my $results = selectall_hashref_query($::form, SL::DB->client->dbh, $query, @values);
112 part => 'SL::DB::Manager::Part',
113 bin => 'SL::DB::Manager::Bin',
114 warehouse => 'SL::DB::Manager::Warehouse',
120 warehouse => 'warehouse_id',
123 if ($params{by} && $params{with_objects}) {
124 for my $with_object (listify($params{with_objects})) {
125 Carp::croak("unknown with_object $with_object") if !exists $with_objects{$with_object};
127 my $manager = $with_objects{$with_object};
128 my $slot = $slots{$with_object};
129 next if !(my @ids = map { $_->{$slot} } @$results);
130 my $objects = $manager->get_all(query => [ id => \@ids ]);
131 my %objects_by_id = map { $_->id => $_ } @$objects;
133 $_->{$with_object} = $objects_by_id{$_->{$slot}} for @$results;
140 return $results->[0]{qty};
145 _get_stock_onhand(@_, onhand => 0);
149 _get_stock_onhand(@_, onhand => 1);
155 croak('allocate needs a part') unless $params{part};
156 croak('allocate needs a qty') unless $params{qty};
158 my $part = $params{part};
159 my $qty = $params{qty};
161 return () if $qty <= 0;
163 my $results = get_stock(part => $part, by => 'for_allocate');
164 my %bin_whitelist = map { (ref $_ ? $_->id : $_) => 1 } grep defined, listify($params{bin});
165 my %wh_whitelist = map { (ref $_ ? $_->id : $_) => 1 } grep defined, listify($params{warehouse});
166 my %chargenumbers = map { (ref $_ ? $_->id : $_) => 1 } grep defined, listify($params{chargenumber});
168 # sort results so that chargenumbers are matched first, then wanted bins, then wanted warehouses
169 my @sorted_results = sort {
170 exists $chargenumbers{$b->{chargenumber}} <=> exists $chargenumbers{$a->{chargenumber}} # then prefer wanted chargenumbers
171 || exists $bin_whitelist{$b->{bin_id}} <=> exists $bin_whitelist{$a->{bin_id}} # then prefer wanted bins
172 || exists $wh_whitelist{$b->{warehouse_id}} <=> exists $wh_whitelist{$a->{warehouse_id}} # then prefer wanted bins
173 || $a->{itime} <=> $b->{itime} # and finally prefer earlier charges
178 for my $chunk (@sorted_results) {
179 my $qty = min($chunk->{qty}, $rest_qty);
181 # since allocate operates on stock, this also ensures that no negative stock results are used
183 push @allocations, SL::Helper::Inventory::Allocation->new(
184 parts_id => $chunk->{parts_id},
186 comment => $params{comment},
187 bin_id => $chunk->{bin_id},
188 warehouse_id => $chunk->{warehouse_id},
189 chargenumber => $chunk->{chargenumber},
190 bestbefore => $chunk->{bestbefore},
191 for_object_id => undef,
193 $rest_qty -= _round_number($qty, 5);
195 $rest_qty = _round_number($rest_qty, 5);
196 last if $rest_qty == 0;
199 die SL::X::Inventory::Allocation->new(
200 code => 'not enough to allocate',
201 message => t8("can not allocate #1 units of #2, missing #3 units", _format_number($qty), $part->displayable_name, _format_number($rest_qty)),
204 if ($params{constraints}) {
205 check_constraints($params{constraints},\@allocations);
211 sub allocate_for_assembly {
214 my $part = $params{part} or Carp::croak('allocate needs a part');
215 my $qty = $params{qty} or Carp::croak('allocate needs a qty');
217 Carp::croak('not an assembly') unless $part->is_assembly;
219 my %parts_to_allocate;
221 for my $assembly ($part->assemblies) {
222 $parts_to_allocate{ $assembly->part->id } //= 0;
223 $parts_to_allocate{ $assembly->part->id } += $assembly->qty * $qty;
228 for my $part_id (keys %parts_to_allocate) {
229 my $part = SL::DB::Part->load_cached($part_id);
230 push @allocations, allocate(%params, part => $part, qty => $parts_to_allocate{$part_id});
236 sub check_constraints {
237 my ($constraints, $allocations) = @_;
238 if ('CODE' eq ref $constraints) {
239 if (!$constraints->(@$allocations)) {
240 die SL::X::Inventory::Allocation->new(
241 code => 'allocation constraints failure',
242 message => t8("Allocations didn't pass constraints"),
246 croak 'constraints needs to be a hashref' unless 'HASH' eq ref $constraints;
248 my %supported_constraints = (
250 warehouse_id => 'warehouse_id',
251 chargenumber => 'chargenumber',
254 for (keys %$constraints ) {
255 croak "unsupported constraint '$_'" unless $supported_constraints{$_};
256 next unless defined $constraints->{$_};
258 my %whitelist = map { (ref $_ ? $_->id : $_) => 1 } listify($constraints->{$_});
259 my $accessor = $supported_constraints{$_};
261 if (any { !$whitelist{$_->$accessor} } @$allocations) {
262 my %error_constraints = (
263 bin_id => t8('Bins'),
264 warehouse_id => t8('Warehouses'),
265 chargenumber => t8('Chargenumbers'),
267 my @allocs = grep { $whitelist{$_->$accessor} } @$allocations;
268 my $needed = sum map { $_->qty } grep { !$whitelist{$_->$accessor} } @$allocations;
269 my $err = t8("Cannot allocate parts.");
270 $err .= ' '.t8('part \'#\'1 in bin \'#2\' only with qty #3 (need additional #4) and chargenumber \'#5\'.',
271 SL::DB::Part->load_cached($_->parts_id)->description,
272 SL::DB::Bin->load_cached($_->bin_id)->full_description,
273 _format_number($_->qty), _format_number($needed), $_->chargenumber ? $_->chargenumber : '--') for @allocs;
274 die SL::X::Inventory::Allocation->new(
275 code => 'allocation constraints failure',
283 sub produce_assembly {
286 my $part = $params{part} or Carp::croak('produce_assembly needs a part');
287 my $qty = $params{qty} or Carp::croak('produce_assembly needs a qty');
289 my $allocations = $params{allocations};
290 if ($params{auto_allocate}) {
291 Carp::croak("produce_assembly: can't have both allocations and auto_allocate") if $params{allocations};
292 $allocations = [ allocate_for_assembly(part => $part, qty => $qty) ];
294 Carp::croak("produce_assembly: need allocations or auto_allocate to produce something") if !$params{allocations};
295 $allocations = $params{allocations};
298 my $bin = $params{bin} or Carp::croak("need target bin");
299 my $chargenumber = $params{chargenumber};
300 my $bestbefore = $params{bestbefore};
301 my $for_object_id = $params{for_object_id};
302 my $comment = $params{comment} // '';
304 my $invoice = $params{invoice};
305 my $project = $params{project};
307 my $shippingdate = $params{shippingsdate} // DateTime->now_local;
309 my $trans_id = $params{trans_id};
310 ($trans_id) = selectrow_query($::form, SL::DB->client->dbh, qq|SELECT nextval('id')| ) unless $trans_id;
312 my $trans_type_out = SL::DB::Manager::TransferType->find_by(direction => 'out', description => 'used');
313 my $trans_type_in = SL::DB::Manager::TransferType->find_by(direction => 'in', description => 'assembled');
315 # check whether allocations are sane
316 if (!$params{no_check_allocations} && !$params{auto_allocate}) {
317 my %allocations_by_part = map { $_->parts_id => $_->qty } @$allocations;
318 for my $assembly ($part->assemblies) {
319 $allocations_by_part{ $assembly->parts_id } -= $assembly->qty * $qty;
322 die SL::X::Inventory::Allocation->new(
323 code => "allocations are insufficient for production",
324 message => t8('can not allocate enough resources for production'),
325 ) if any { $_ < 0 } values %allocations_by_part;
329 for my $allocation (@$allocations) {
330 my $oe_id = delete $allocation->{for_object_id};
331 push @transfers, $allocation->transfer_object(
332 trans_id => $trans_id,
333 qty => -$allocation->qty,
334 trans_type => $trans_type_out,
335 shippingdate => $shippingdate,
336 employee => SL::DB::Manager::Employee->current,
340 push @transfers, SL::DB::Inventory->new(
341 trans_id => $trans_id,
342 trans_type => $trans_type_in,
346 warehouse => $bin->warehouse_id,
347 chargenumber => $chargenumber,
348 bestbefore => $bestbefore,
349 shippingdate => $shippingdate,
353 employee => SL::DB::Manager::Employee->current,
354 oe_id => $for_object_id,
357 SL::DB->client->with_transaction(sub {
358 $_->save for @transfers;
361 die SL::DB->client->error;
367 sub default_show_bestbefore {
368 $::instance_conf->get_show_bestbefore
377 SL::WH - Warehouse and Inventory API
381 # See description for an intro to the concepts used here.
383 use SL::Helper::Inventory qw(:ALL);
385 # stock, get "what's there" for a part with various conditions:
386 my $qty = get_stock(part => $part); # how much is on stock?
387 my $qty = get_stock(part => $part, date => $date); # how much was on stock at a specific time?
388 my $qty = get_stock(part => $part, bin => $bin); # how much is on stock in a specific bin?
389 my $qty = get_stock(part => $part, warehouse => $warehouse); # how much is on stock in a specific warehouse?
390 my $qty = get_stock(part => $part, chargenumber => $chargenumber); # how much is on stock of a specific chargenumber?
392 # onhand, get "what's available" for a part with various conditions:
393 my $qty = get_onhand(part => $part); # how much is available?
394 my $qty = get_onhand(part => $part, date => $date); # how much was available at a specific time?
395 my $qty = get_onhand(part => $part, bin => $bin); # how much is available in a specific bin?
396 my $qty = get_onhand(part => $part, warehouse => $warehouse); # how much is available in a specific warehouse?
397 my $qty = get_onhand(part => $part, chargenumber => $chargenumber); # how much is availbale of a specific chargenumber?
400 my $data = get_onhand(
401 warehouse => $warehouse,
402 by => [ qw(bin part chargenumber) ],
403 with_objects => [ qw(bin part) ],
407 my @allocations = allocate(
408 part => $part, # part_id works too
409 qty => $qty, # must be positive
410 chargenumber => $chargenumber, # optional, may be arrayref. if provided these charges will be used first
411 bestbefore => $datetime, # optional, defaults to today. items with bestbefore prior to that date wont be used
412 bin => $bin, # optional, may be arrayref. if provided
415 # shortcut to allocate all that is needed for producing an assembly, will use chargenumbers as appropriate
416 my @allocations = allocate_for_assembly(
417 part => $assembly, # part_id works too
418 qty => $qty, # must be positive
421 # create allocation manually, bypassing checks. all of these need to be passed, even undefs
422 my $allocation = SL::Helper::Inventory::Allocation->new(
423 part_id => $part->id,
425 bin_id => $bin_obj->id,
426 warehouse_id => $bin_obj->warehouse_id,
427 chargenumber => '1823772365',
429 for_object_id => $order->id,
434 part => $part, # target assembly
436 allocations => \@allocations, # allocations to use. alternatively use "auto_allocate => 1,"
439 bin => $bin, # needed unless a global standard target is configured
440 chargenumber => $chargenumber, # optional
441 bestbefore => $datetime, # optional
442 comment => $comment, # optional
447 New functions for the warehouse and inventory api.
449 The WH api currently has three large shortcomings: It is very hard to just get
450 the current stock for an item, it's extremely complicated to use it to produce
451 assemblies while ensuring that no stock ends up negative, and it's very hard to
452 use it to get an overview over the actual contents of the inventory.
454 The first problem has spawned several dozen small functions in the program that
455 try to implement that, and those usually miss some details. They may ignore
456 bestbefore times, comments, ignore negative quantities etc.
458 To get this cleaned up a bit this code introduces two concepts: stock and onhand.
462 =item * Stock is defined as the actual contents of the inventory, everything that is
465 =item * Onhand is what is available, which means things that are stocked,
466 not expired and not in any other way reserved for other uses.
470 The two new functions C<get_stock> and C<get_onhand> encapsulate these principles and
471 allow simple access with some optional filters for chargenumbers or warehouses.
472 Both of them have a batch mode that can be used to get these information to
473 supplement simple reports.
475 To address the safe assembly creation a new function has been added.
476 C<allocate> will try to find the requested quantity of a part in the inventory
477 and will return allocations of it which can then be used to create the
478 assembly. Allocation will happen with the C<onhand> semantics defined above,
479 meaning that by default no expired goods will be used. The caller can supply
480 hints of what shold be used and in those cases chargenumbers will be used up as
481 much as possible first. C<allocate> will always try to fulfil the request even
482 beyond those. Should the required amount not be stocked, allocate will throw an
485 C<produce_assembly> has been rewritten to only accept parameters about the
486 target of the production, and requires allocations to complete the request. The
487 allocations can be supplied manually, or can be generated automatically.
488 C<produce_assembly> will check whether enough allocations are given to create
489 the assembly, but will not check whether the allocations are backed. If the
490 allocations are not sufficient or if the auto-allocation fails an exception
491 is returned. If you need to produce something that is not in the inventory, you
492 can bypass those checks by creating the allocations yourself (see
493 L</"ALLOCATION DATA STRUCTURE">).
495 Note: this is only intended to cover the scenarios described above. For other cases:
501 If you need actual inventory objects because of record links or something like
502 that load them directly. And strongly consider redesigning that, because it's
507 You need weight or accounting information you're on your own. The inventory api
508 only concerns itself with the raw quantities.
512 If you need the first stock date of parts, or anything related to a specific
513 transfer type or direction, this is not covered yet.
521 =item * get_stock PARAMS
523 Returns for single parts how much actually exists in the inventory.
531 The part. Must be present without C<by>. May be arrayref with C<by>. Can be object or id.
535 If given, will only return stock on these bins. Optional. May be array, May be object or id.
539 If given, will only return stock on these warehouses. Optional. May be array, May be object or id.
543 If given, will return stock as it were on this timestamp. Optional. Must be L<DateTime> object.
547 If given, will only show stock with this chargenumber. Optional. May be array.
551 See L</"STOCK/ONHAND REPORT MODE">
555 See L</"STOCK/ONHAND REPORT MODE">
559 Will return a single qty normally, see L</"STOCK/ONHAND REPORT MODE"> for batch
560 mode when C<by> is given.
562 =item * get_onhand PARAMS
564 Returns for single parts how much is available in the inventory. That excludes
565 stock with expired bestbefore.
567 It takes the same options as L</get_stock>.
573 If given, will only return stock with a bestbefore at or after the given date.
574 Optional. Must be L<DateTime> object.
578 =item * allocate PARAMS
590 Bin object. Optional.
594 Warehouse object. Optional.
606 Tries to allocate the required quantity using what is currently onhand. If
607 given any of C<bin>, C<warehouse>, C<chargenumber>
609 =item * allocate_for_assembly PARAMS
611 Shortcut to allocate everything for an assembly. Takes the same arguments. Will
612 compute the required amount for each assembly part and allocate all of them.
614 =item * produce_assembly
619 =head1 STOCK/ONHAND REPORT MODE
621 If the special option C<by> is given with an arrayref, the result will instead
622 be an arrayref of partitioned stocks by those fields. Valid partitions are:
628 If this is given, part is optional in the parameters
640 Note: If you want to use the returned data to create allocations you I<need> to
641 enable all of these. To make this easier a special shortcut exists
643 In this mode, C<with_objects> can be used to load C<warehouse>, C<bin>,
644 C<parts> objects in one go, just like with Rose. They
645 need to be present in C<by> before that though.
647 =head1 ALLOCATION ALGORITHM
649 When calling allocate, the current onhand (== available stock) of the item will
650 be used to decide which bins/chargenumbers/bestbefore can be used.
652 In general allocate will try to make the request happen, and will use the
653 provided charges up first, and then tap everything else. If you need to only
654 I<exactly> use the provided charges, you'll need to craft the allocations
655 yourself. See L</"ALLOCATION DATA STRUCTURE"> for that.
657 If C<chargenumber> is given, those will be used up next.
659 After that normal quantities will be used.
661 These are tiebreakers and expected to rarely matter in reality. If you need
662 finegrained control over which allocation is used, you may want to get the
663 onhands yourself and select the appropriate ones.
665 Only quantities with C<bestbefore> unset or after the given date will be
666 considered. If more than one charge is eligible, the earlier C<bestbefore>
669 Allocations do NOT have an internal memory and can't react to other allocations
670 of the same part earlier. Never double allocate the same part within a
673 =head1 ALLOCATION DATA STRUCTURE
675 Allocations are instances of the helper class C<SL::Helper::Inventory::Allocation>. They require
676 each of the following attributes to be set at creation time:
692 =item * for_object_id
694 If set the allocations will be marked as allocated for the given object.
695 If these allocations are later used to produce an assembly, the resulting
696 consuming transactions will be marked as belonging to the given object.
697 The object may be an order, productionorder or other objects
701 C<chargenumber>, C<bestbefore> and C<for_object_id> and C<comment> may be
702 C<undef> (but must still be present at creation time). Instances are considered
705 Allocations also provide the method C<transfer_object> which will create a new
706 C<SL::DB::Inventory> bject with all the playload.
710 # whitelist constraints
714 bin_id => \@allowed_bins,
715 chargenumber => \@allowed_chargenumbers,
722 # only allow chargenumbers with specific format
723 all { $_->chargenumber =~ /^ C \d{8} - \a{d2} $/x } @_
726 # and must all have a bestbefore date
727 all { $_->bestbefore } @_;
731 C<allocation> is "best effort" in nature. It will take the C<bin>,
732 C<chargenumber> etc hints from the parameters, but will try it's bvest to
733 fulfil the request anyway and only bail out if it is absolutely not possible.
735 Sometimes you need to restrict allocations though. For this you can pass
736 additional constraints to C<allocate>. A constraint serves as a whitelist.
737 Every allocation must fulfil every constraint by having that attribute be one
740 In case even that is not enough, you may supply a custom check by passing a
741 function that will be given the allocation objects.
743 Note that both whitelists and constraints do not influence the order of
744 allocations, which is done purely from the initial parameters. They only serve
745 to reject allocations made in good faith which do fulfil required assertions.
747 =head1 ERROR HANDLING
749 C<allocate> and C<produce_assembly> will throw exceptions if the request can
750 not be completed. The usual reason will be insufficient onhand to allocate, or
751 insufficient allocations to process the request.
753 =head1 KNOWN PROBLEMS
755 * It's not currently possible to identify allocations between requests, for
756 example for presenting the user possible allocations and then actually using
757 them on the next request.
758 * It's not currently possible to give C<allocate> prior constraints.
759 Currently all constraints are treated as hints (and will be preferred) but
760 the internal ordering of the hints is fixed and more complex preferentials
762 * bestbefore handling is untested
763 * interaction with config option "transfer_default_ignore_onhand" is
764 currently undefined (and implicitly ignores it)
768 * define and describe error classes
769 * define wrapper classes for stock/onhand batch mode return values
770 * handle extra arguments in produce: shippingdate, project
780 Sven Schöling E<lt>sven.schoeling@googlemail.comE<gt>