1 package SL::Helper::ShippedQty;
4 use parent qw(Rose::Object);
7 use Scalar::Util qw(blessed);
8 use SL::DBUtils qw(selectall_hashref_query selectall_as_map);
9 use List::Util qw(min);
10 use List::MoreUtils qw(any all uniq);
11 use List::UtilsBy qw(partition_by);
12 use SL::Locale::String qw(t8);
14 use Rose::Object::MakeMethods::Generic (
15 'scalar' => [ qw(objects objects_or_ids shipped_qty keep_matches) ],
16 'scalar --get_set_init' => [ qw(oe_ids dbh require_stock_out fill_up item_identity_fields oi2oe oi_qty delivered matches) ],
19 my $no_stock_item_links_query = <<'';
20 SELECT oi.trans_id, oi.id AS oi_id, oi.qty AS oi_qty, oi.unit AS oi_unit, doi.id AS doi_id, doi.qty AS doi_qty, doi.unit AS doi_unit
22 INNER JOIN orderitems oi ON oi.id = rl.from_id AND rl.from_table = 'orderitems'
23 INNER JOIN delivery_order_items doi ON doi.id = rl.to_id AND rl.to_table = 'delivery_order_items'
24 WHERE oi.trans_id IN (%s)
25 ORDER BY oi.trans_id, oi.position
27 # oi not item linked. takes about 250ms for 100k hits
28 my $fill_up_oi_query = <<'';
29 SELECT oi.id, oi.trans_id, oi.position, oi.parts_id, oi.description, oi.reqdate, oi.serialnumber, oi.qty, oi.unit
31 WHERE oi.trans_id IN (%s)
32 ORDER BY oi.trans_id, oi.position
34 # doi linked by record, but not by items; 250ms for 100k hits
35 my $no_stock_fill_up_doi_query = <<'';
36 SELECT doi.id, doi.delivery_order_id, doi.position, doi.parts_id, doi.description, doi.reqdate, doi.serialnumber, doi.qty, doi.unit
37 FROM delivery_order_items doi
38 WHERE doi.delivery_order_id IN (
43 AND to_table = 'delivery_orders'
44 AND to_id = doi.delivery_order_id)
48 WHERE from_table = 'orderitems'
49 AND to_table = 'delivery_order_items'
52 my $stock_item_links_query = <<'';
53 SELECT oi.trans_id, oi.id AS oi_id, oi.qty AS oi_qty, oi.unit AS oi_unit, doi.id AS doi_id,
54 (CASE WHEN doe.customer_id > 0 THEN -1 ELSE 1 END) * i.qty AS doi_qty, p.unit AS doi_unit
56 INNER JOIN orderitems oi ON oi.id = rl.from_id AND rl.from_table = 'orderitems'
57 INNER JOIN delivery_order_items doi ON doi.id = rl.to_id AND rl.to_table = 'delivery_order_items'
58 INNER JOIN delivery_orders doe ON doe.id = doi.delivery_order_id
59 INNER JOIN delivery_order_items_stock dois ON dois.delivery_order_item_id = doi.id
60 INNER JOIN inventory i ON dois.id = i.delivery_order_items_stock_id
61 INNER JOIN parts p ON p.id = doi.parts_id
62 WHERE oi.trans_id IN (%s)
63 ORDER BY oi.trans_id, oi.position
65 my $stock_fill_up_doi_query = <<'';
66 SELECT doi.id, doi.delivery_order_id, doi.position, doi.parts_id, doi.description, doi.reqdate, doi.serialnumber,
67 (CASE WHEN doe.customer_id > 0 THEN -1 ELSE 1 END) * i.qty, p.unit
68 FROM delivery_order_items doi
69 INNER JOIN parts p ON p.id = doi.parts_id
70 INNER JOIN delivery_order_items_stock dois ON dois.delivery_order_item_id = doi.id
71 INNER JOIN delivery_orders doe ON doe.id = doi.delivery_order_id
72 INNER JOIN inventory i ON dois.id = i.delivery_order_items_stock_id
73 WHERE doi.delivery_order_id IN (
78 AND to_table = 'delivery_orders'
79 AND to_id = doi.delivery_order_id)
83 WHERE from_table = 'orderitems'
84 AND to_table = 'delivery_order_items'
87 my $oe_do_record_links = <<'';
92 AND to_table = 'delivery_orders'
94 my @known_item_identity_fields = qw(parts_id description reqdate serialnumber);
95 my %item_identity_fields = (
96 parts_id => t8('Part'),
97 description => t8('Description'),
98 reqdate => t8('Reqdate'),
99 serialnumber => t8('Serial Number'),
103 my ($self, $data) = @_;
105 die 'Need exactly one argument, either id, object or arrayref of ids or objects.' unless 2 == @_;
107 $self->normalize_input($data);
109 return $self unless @{ $self->oe_ids };
111 $self->calculate_item_links;
112 $self->calculate_fill_up if $self->fill_up;
117 sub calculate_item_links {
120 my @oe_ids = @{ $self->oe_ids };
122 my $item_links_query = $self->require_stock_out ? $stock_item_links_query : $no_stock_item_links_query;
124 my $query = sprintf $item_links_query, join (', ', ('?')x @oe_ids);
126 my $data = selectall_hashref_query($::form, $self->dbh, $query, @oe_ids);
129 my $qty = $_->{doi_qty} * AM->convert_unit($_->{doi_unit} => $_->{oi_unit});
130 $self->shipped_qty->{$_->{oi_id}} //= 0;
131 $self->shipped_qty->{$_->{oi_id}} += $qty;
132 $self->oi2oe->{$_->{oi_id}} = $_->{trans_id};
133 $self->oi_qty->{$_->{oi_id}} = $_->{oi_qty};
135 push @{ $self->matches }, [ $_->{oi_id}, $_->{doi_id}, $qty, 1 ] if $self->keep_matches;
142 grep { $seen{$_}++ } @$a1, @$a2;
145 sub calculate_fill_up {
148 my @oe_ids = @{ $self->oe_ids };
150 my $fill_up_doi_query = $self->require_stock_out ? $stock_fill_up_doi_query : $no_stock_fill_up_doi_query;
152 my $oi_query = sprintf $fill_up_oi_query, join (', ', ('?')x@oe_ids);
153 my $doi_query = sprintf $fill_up_doi_query, join (', ', ('?')x@oe_ids);
154 my $rl_query = sprintf $oe_do_record_links, join (', ', ('?')x@oe_ids);
156 my $oi = selectall_hashref_query($::form, $self->dbh, $oi_query, @oe_ids);
160 my $doi = selectall_hashref_query($::form, $self->dbh, $doi_query, @oe_ids);
161 my $rl = selectall_hashref_query($::form, $self->dbh, $rl_query, @oe_ids);
163 my %oi_by_identity = partition_by { $self->item_identity($_) } @$oi;
164 my %doi_by_id = partition_by { $_->{delivery_order_id} } @$doi;
166 push @{ $doi_by_trans_id{$_->{from_id}} //= [] }, @{ $doi_by_id{$_->{to_id}} }
167 for grep { exists $doi_by_id{$_->{to_id}} } @$rl;
169 my %doi_by_identity = partition_by { $self->item_identity($_) } @$doi;
171 for my $match (sort keys %oi_by_identity) {
172 next unless exists $doi_by_identity{$match};
174 my %oi_by_oe = partition_by { $_->{trans_id} } @{ $oi_by_identity{$match} };
175 for my $trans_id (sort { $a <=> $b } keys %oi_by_oe) {
176 next unless my @sorted_doi = _intersect($doi_by_identity{$match}, $doi_by_trans_id{$trans_id});
178 # sorting should be quite fast here, because there are usually only a handful of matches
179 next unless my @sorted_oi = sort { $a->{position} <=> $b->{position} } @{ $oi_by_oe{$trans_id} };
181 # parallel walk through sorted oi/doi entries
182 my $oi_i = my $doi_i = 0;
183 my ($oi, $doi) = ($sorted_oi[$oi_i], $sorted_doi[$doi_i]);
184 while ($oi_i < @sorted_oi && $doi_i < @sorted_doi) {
185 $oi = $sorted_oi[++$oi_i], next if $oi->{qty} <= $self->shipped_qty->{$oi->{id}};
186 $doi = $sorted_doi[++$doi_i], next if 0 == $doi->{qty};
188 my $factor = AM->convert_unit($doi->{unit} => $oi->{unit});
189 my $min_qty = min($oi->{qty} - $self->shipped_qty->{$oi->{id}}, $doi->{qty} * $factor);
191 # min_qty should never be 0 now. the first part triggers the first next,
192 # the second triggers the second next and factor must not be 0
193 # but it would lead to an infinite loop, so catch that.
194 die 'panic! invalid shipping quantity' unless $min_qty;
196 $self->shipped_qty->{$oi->{id}} += $min_qty;
197 $doi->{qty} -= $min_qty / $factor; # TODO: find a way to avoid float rounding
198 push @{ $self->matches }, [ $oi->{id}, $doi->{id}, $min_qty, 0 ] if $self->keep_matches;
203 $self->oi2oe->{$_->{id}} = $_->{trans_id} for @$oi;
204 $self->oi_qty->{$_->{id}} = $_->{qty} for @$oi;
208 my ($self, $objects) = @_;
210 die 'expecting array of objects' unless 'ARRAY' eq ref $objects;
212 my $shipped_qty = $self->shipped_qty;
214 for my $obj (@$objects) {
215 if ('SL::DB::OrderItem' eq ref $obj) {
216 $obj->{shipped_qty} = $shipped_qty->{$obj->id} //= 0;
217 $obj->{delivered} = $shipped_qty->{$obj->id} == $obj->qty;
218 } elsif ('SL::DB::Order' eq ref $obj) {
219 if (defined $obj->{orderitems}) {
220 $self->write_to($obj->{orderitems});
221 $obj->{delivered} = all { $_->{delivered} } @{ $obj->{orderitems} };
223 # don't force a load on items. just compute by oe_id directly
224 $obj->{delivered} = $self->delivered->{$obj->id};
227 die "unknown reference '@{[ ref $obj ]}' for @{[ __PACKAGE__ ]}::write_to";
233 sub write_to_objects {
236 return unless @{ $self->oe_ids };
238 die 'Can only use write_to_objects, when calculate was called with objects. Use write_to instead.' unless $self->objects_or_ids;
240 $self->write_to($self->objects);
244 my ($self, $row) = @_;
246 join $;, map $row->{$_}, @{ $self->item_identity_fields };
249 sub normalize_input {
250 my ($self, $data) = @_;
252 $data = [$data] if 'ARRAY' ne ref $data;
254 $self->objects_or_ids(!!blessed($data->[0]));
256 if ($self->objects_or_ids) {
257 die 'unblessed object in data while expecting object' if any { !blessed($_) } @$data;
258 $self->objects($data);
260 die 'object or reference in data while expecting ids' if any { ref($_) } @$data;
261 $self->oe_ids($data);
264 $self->shipped_qty({});
267 sub available_item_identity_fields {
268 map { [ $_ => $item_identity_fields{$_} ] } @known_item_identity_fields;
274 die 'oe_ids not initialized in id mode' if !$self->objects_or_ids;
275 die 'objects not initialized before accessing ids' if $self->objects_or_ids && !defined $self->objects;
276 die 'objects need to be Order or OrderItem' if any { ref($_) !~ /^SL::DB::Order(?:Item)?$/ } @{ $self->objects };
278 [ uniq map { ref($_) =~ /Item/ ? $_->trans_id : $_->id } @{ $self->objects } ]
281 sub init_dbh { SL::DB->client->dbh }
283 sub init_oi2oe { {} }
284 sub init_oi_qty { {} }
285 sub init_matches { [] }
289 for (keys %{ $self->oi_qty }) {
290 my $oe_id = $self->oi2oe->{$_};
292 $d->{$oe_id} &&= $self->shipped_qty->{$_} == $self->oi_qty->{$_};
297 sub init_require_stock_out { $::instance_conf->get_shipped_qty_require_stock_out }
298 sub init_item_identity_fields { [ grep $item_identity_fields{$_}, @{ $::instance_conf->get_shipped_qty_item_identity_fields } ] }
299 sub init_fill_up { $::instance_conf->get_shipped_qty_fill_up }
309 SL::Helper::ShippedQty - Algorithmic module for calculating shipped qty
313 use SL::Helper::ShippedQty;
315 my $helper = SL::Helper::ShippedQty->new(
317 require_stock_out => 0,
318 item_identity_fields => [ qw(parts_id description reqdate serialnumber) ],
321 $helper->calculate($order_object);
322 $helper->calculate(\@order_objects);
323 $helper->calculate($orderitem_object);
324 $helper->calculate(\@orderitem_objects);
325 $helper->calculate($oe_id);
326 $helper->calculate(\@oe_ids);
328 # if these are items set elivered and shipped_qty
329 # if these are orders, iterate through their items and set delivered on order
330 $helper->write_to($objects);
332 # if calculate was called with objects, you can use this shortcut:
333 $helper->write_to_objects;
335 # shipped_qtys by oi_id
336 my $shipped_qty = $helper->shipped_qty->{$oi->id};
339 my $delivered = $helper->delievered->{$oi->id};
341 # calculate and write_to can be chained:
342 my $helper = SL::Helper::ShippedQty->new->calculate($orders)->write_to_objects;
346 This module encapsulates the algorithm needed to compute the shipped qty for
347 orderitems (hopefully) correctly and efficiently for several use cases.
349 While this is used in object accessors, it can not be fast when called in a
350 loop over and over, so take advantage of batch processing when possible.
352 =head1 MOTIVATION AND PROBLEMS
354 The concept of shipped qty is sadly not as straight forward as it sounds at
355 first glance. Any correct implementation must in some way deal with the
362 When is an order shipped? For users that use the inventory it
363 will mean when a delivery order is stocked out. For those not using the
364 inventory it will mean when the delivery order is saved.
368 How to find the correct matching elements. After the changes
369 to record item links it's natural to assume that each position is linked, but
370 for various reasons this might not be the case. Positions that are not linked
371 in the database need to be matched by marching.
375 Double links need to be accounted for (these can stem from buggy code).
379 orderitems and oe entries may link to many of their counterparts in
380 delivery_orders. delivery_orders my be created from multiple orders. The
381 only constant is that a single entry in delivery_order_items has at most one
382 link from an orderitem.
386 For the fill up case the identity of positions is not clear. The naive approach
387 is just the same part, but description, charge number, reqdate and qty can all
388 be part of the identity of a position for finding shipped matches.
392 Certain delivery orders might not be eligible for qty calculations if delivery
393 orders are used for other purposes.
397 Units need to be handled correctly
401 Negative positions must be taken into account. A negative delivery order is
402 assumed to be a RMA of sorts, but a negative order is not as straight forward.
406 Must be able to work with plain ids and Rose objects, and absolutely must
407 include a bulk mode to speed up multiple objects.
418 Creates a new helper object. PARAMS may include:
422 =item * C<require_stock_out>
424 Boolean. If set, delivery orders must be stocked out to be considered
425 delivered. The default is a client setting.
429 Boolean. If set, unlinked delivery order items will be used to fill up
430 undelivered order items. Not needed in newer installations. The default is a
433 =item * C<item_identity_fields ARRAY>
435 If set, the fields are used to compute the identity of matching positions. The
436 default is a client setting. Possible values include:
442 =item * C<description>
446 =item * C<serialnumber>
450 =item * C<keep_matches>
452 Boolean. If set to true the internal matchings of OrderItems and
453 DeliveryOrderItems will be kept for later postprocessing, in case you need more
454 than this modules provides.
456 See C<matches> for the returned format.
460 =item C<calculate OBJECTS>
462 =item C<calculate IDS>
464 Do the main work. There must be a single argument: Either an id or an
465 C<SL::DB::Order> object, or an arrayref of one of these types.
467 Mixing ids and objects will generate an exception.
469 No return value. All internal errors will throw an exception.
471 =item C<write_to OBJECTS>
473 =item C<write_to_objects>
475 Save the C<shipped_qty> and C<delivered> state to the given objects. If
476 L</calculate> was called with objects, then C<write_to_objects> will use these.
478 C<shipped_qty> and C<delivered> will be directly infused into the objects
479 without calling the accessor for delivered. If you want to save afterwards,
480 you'll have to do that yourself.
482 C<shipped_qty> is guaranteed to be coerced to a number. If no delivery_order
483 was found it will be set to zero.
485 C<delivered> is guaranteed only to be the correct boolean value, but not
488 Note: C<write_to> will avoid loading unnecessary objects. This means if it is
489 called with an Order object that has not loaded its orderitems yet, only
490 C<delivered> will be set in the Order object. A subsequent C<<
491 $order->orderitems->[0]->{delivered} >> will return C<undef>, and C<<
492 $order->orderitems->[0]->shipped_qty >> will invoke another implicit
497 Valid after L</calculate>. Returns a hasref with shipped qtys by orderitems id.
499 Unlike the result of C</write_to>, entries in C<shipped_qty> may be C<undef> if
500 linked elements were found.
504 Valid after L</calculate>. Returns a hashref with a delivered flag by order id.
508 Valid after L</calculate> with C<with_matches> set. Returns an arrayref of
509 individual matches. Each match is an arrayref with these fields:
515 The id of the OrderItem.
519 The id of the DeliveryOrderItem.
523 The qty that was matched between the two converted to the unit of the OrderItem.
527 A boolean flag indicating if this match was found with record_item links. If
528 false, the match was made in the fill up stage.
534 =head1 REPLACED FUNCTIONALITY
536 =head2 delivered mode
538 Originally used in mark_orders_if_delivered. Searches for orders associated
539 with a delivery order and evaluates whether those are delivered or not. No
540 detailed information is needed.
542 This is to be integrated into fast delivered check on the orders. The calling
543 convention for the delivery_order is not part of the scope of this module.
547 Originally used for printing delivery orders. Resolves for each position for
548 how much was originally ordered, and how much remains undelivered.
550 This one is likely to be dropped. The information only makes sense without
551 combined merge/split deliveries and is very fragile with unaccounted delivery
556 Same from the order perspective. Used for transitions to delivery orders, where
557 delivered qtys should be removed from positions. Also used each time a record
558 is rendered to show the shipped qtys. Also used to find orders that are not
561 Acceptable shortcuts would be the concepts fully shipped (for the order) and
562 providing already loaded objects.
564 =head2 Replaces the following functions
566 C<DO::get_shipped_qty>
568 C<SL::Controller::DeliveryPlan::calc_qtys>
570 C<SL::DB::OrderItem::shipped_qty>
572 C<SL::DB::OrderItem::delivered_qty>
576 this is the old get_shipped_qty algorithm by Martin for reference
578 in: oe_id, do_id, doctype, delivered flag
580 not needed with better signatures
582 load oe->do links for this id,
583 set oe_ids from those
590 2 load all orderitems for these oe_ids
593 set undelivered := qty
596 create tuple: [ position => qty_ordered, qty_not_delivered, orderitem.id ]
598 1 load all oe->do links for these oe_ids
601 return all tuples so far
604 4 create dictionary for orderitems from [2] by id
606 3 load all delivery_order_items for do_ids from [1], with recorditem_links from orderitems
607 - optionally with doctype filter (identity filter)
609 # first pass for record_item_links
612 if link from orderitem exists and orderitem is in dictionary [4]
613 reduce qty_notdelivered in orderitem by doi.qty
614 keep link to do entry in orderitem
617 # second pass fill up
619 ignroe if from link exists or qty == 0
621 for orderitems from [2]:
622 next if notdelivered_qty == 0
623 if doi.parts_id == orderitem.parts_id:
624 if oi.notdelivered_qty < 0:
625 doi :+= -oi.notdelivered_qty,
626 oi.notdelivered_qty := 0
628 fi doi.qty < oi.notdelivered_qty:
630 oi.notdelivered_qty :-= doi.qty
632 doi.qty :-= oi.notdelivered_qty
633 oi.notdelivered_qty := 0
635 keep link to oi in doi
638 last wenn doi.qty <= 0
642 # post process for return
645 copy notdelivered from oe to ship{position}{notdelivered}
646 if !oe_id and do_id and delivered:
647 ship.{oi.trans_id}.delivered := oi.notdelivered_qty <= 0
648 if !oe_id and do_id and !delivered:
650 ignore if do.id != doi.delivery_order_id
651 if oi in doi verlinkt und position bekannt:
652 addiere oi.qty zu doi.ordered_qty
653 addiere oi.notdelievered_qty zu doi.notdelivered_qty
660 in: orders, parameters
662 normalize orders to ids
664 # handle record_item links
665 retrieve record_links entries with inner joins on orderitems, delivery_orderitems and stock/inventory if requested
666 for all record_links:
667 initialize shipped_qty for this doi to 0 if not yet seen
668 convert doi.qty to oi.unit
669 add normalized doi.qty to shipped_qty
673 abort if fill up is not requested
675 retrieve all orderitems matching the given order ids
676 retrieve all doi with a link to the given order ids but without item link (and optionally with stock/inventory)
677 retrieve all record_links between orders and delivery_orders (1)
679 abort when no dois were found
681 create a partition of the delivery order items by do_id (2)
682 create empty mapping for delivery order items by order_id (3)
683 for all record_links from [1]:
684 add all matching doi from (2) to (3)
687 create a partition of the orderitems by item identity (4)
688 create a partition of the delivery order items by item identity (5)
690 for each identity in (4):
691 skip if no matching entries in (5)
693 create partition of all orderitems for this identity by order id (6)
694 for each sorted order id in [6]:
695 look up matching delivery order items by identity from [5] (7)
696 look up matching delivery order items by order id from [3] (8)
697 create stable sorted intersection between [7] and [8] (9)
699 sort the orderitems from (6) by position (10)
701 parallel walk through [9] and [10]:
702 missing qty := oi.qty - shipped_qty[oi]
705 next orderitem if missing_qty <= 0
706 next delivery order item if doi.qty == 0
708 min_qty := minimum(missing_qty, [doi.qty converted to oi.unit]
710 # transfer min_qty from doi.qty to shipped[qty]:
711 shipped_qty[oi] += min_qty
712 doi.qty -= [min_qty converted to doi.unit]
717 =head1 COMPLEXITY OBSERVATIONS
719 Perl ops except for sort are expected to be constant (relative to the op overhead).
721 =head2 Record item links
723 The query itself has indices available for all joins and filters and should
724 scale with sublinear with the number of affected orderitems.
726 The rest of the code iterates through the result and calls C<AM::convert_unit>,
727 which caches internally and is asymptotically constant.
731 C<partition_by> and C<intersect> both scale linearly. The first two scale with
732 input size, but use existing indices. The delivery order items query scales
733 with the nested loop anti join of the "NOT EXISTS" subquery, which takes most
734 of the time. For large databases omitting the order id filter may be faster.
736 Three partitions after that scale linearly. Building the doi_by_oe_id
737 multimap is O(n²) worst case, but will be linear for most real life data.
739 Iterating through the values of the partitions scales with the number of
740 elements in the multimap, and does not add additional complexity.
742 The sort and parallel walk are O(nlogn) for the length of the subdivisions,
743 which again makes square worst case, but much less than that in the general
746 =head3 Space requirements
748 In the current form the results of the 4 queries get fetched, and 4 of them are
749 held in memory at the same time. Three persistent structures are held:
750 C<shipped_qty>, C<oi2oe>, and C<oi_qty> - all hashes with one entry for each
751 orderitem. C<delivered> is calculated on demand and is a hash with an entry for
752 each order id of input.
754 Temporary structures are partitions of the orderitems, of which again the fill
755 up multi map between order id and delivery order items is potentially the
756 largest with square requierment worst case.
761 * delivery order identity
763 * rewrite to avoid division
764 * rewrite to avoid selectall for really large queries (no problem for up to 100k)
765 * calling mode or return to flag delivery_orders as delivered?
766 * add localized field white list
767 * reduce worst case square space requirement to linear
771 None yet, but there are most likely a lot in code this funky.
775 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>