a74130b95788e0bb000e4801b93f996d649cfc59
[kivitendo-erp.git] / SL / Controller / DeliveryPlan.pm
1 package SL::Controller::DeliveryPlan;
2
3 use strict;
4 use parent qw(SL::Controller::Base);
5
6 use Clone qw(clone);
7 use SL::DB::OrderItem;
8 use SL::Controller::Helper::GetModels;
9 use SL::Controller::Helper::Paginated;
10 use SL::Controller::Helper::Sorted;
11 use SL::Controller::Helper::Filtered;
12 use SL::Controller::Helper::ReportGenerator;
13 use SL::Locale::String;
14
15 use Rose::Object::MakeMethods::Generic (
16   scalar => [ qw(db_args flat_filter) ],
17 );
18
19 __PACKAGE__->run_before(sub { $::auth->assert('sales_order_edit'); });
20
21 __PACKAGE__->get_models_url_params('flat_filter');
22 __PACKAGE__->make_filtered(
23   MODEL             => 'OrderItem',
24   LAUNDER_TO        => 'filter'
25 );
26 __PACKAGE__->make_paginated(
27   MODEL         => 'OrderItem',
28   ONLY          => [ qw(list) ],
29 );
30
31 __PACKAGE__->make_sorted(
32   MODEL             => 'OrderItem',
33   ONLY              => [ qw(list) ],
34
35   DEFAULT_BY        => 'reqdate',
36   DEFAULT_DIR       => 1,
37
38   reqdate           => t8('Reqdate'),
39   description       => t8('Description'),
40   partnumber        => t8('Part Number'),
41   qty               => t8('Qty'),
42   shipped_qty       => t8('shipped'),
43   not_shipped_qty   => t8('not shipped'),
44   ordnumber         => t8('Order'),
45   customer          => t8('Customer'),
46 );
47
48 my $delivery_plan_query = [
49   'order.customer_id' => { gt => 0 },
50   'order.closed' => 0,
51   or => [ 'order.quotation' => 0, 'order.quotation' => undef ],
52
53   # filter by shipped_qty < qty, read from innermost to outermost
54   'id' => [ \"
55     -- 3. resolve the desired information about those
56     SELECT oi.id FROM (
57       -- 2. slice only part, orderitem and both quantities from it
58       SELECT parts_id, trans_id, qty, SUM(doi_qty) AS doi_qty FROM (
59         -- 1. join orderitems and deliverorder items via record_links.
60         --    also add customer data to filter for sales_orders
61         SELECT oi.parts_id, oi.trans_id, oi.id, oi.qty, doi.qty AS doi_qty
62         FROM orderitems oi, oe, record_links rl, delivery_order_items doi
63         WHERE
64           oe.id = oi.trans_id AND
65           oe.customer_id IS NOT NULL AND
66           (oe.quotation = 'f' OR oe.quotation IS NULL) AND
67           NOT oe.closed AND
68           rl.from_id = oe.id AND
69           rl.from_id = oi.trans_id AND
70           oe.id = oi.trans_id AND
71           rl.from_table = 'oe' AND
72           rl.to_table = 'delivery_orders' AND
73           rl.to_id = doi.delivery_order_id AND
74           oi.parts_id = doi.parts_id
75       ) tuples GROUP BY parts_id, trans_id, qty
76     ) partials
77     LEFT JOIN orderitems oi ON partials.parts_id = oi.parts_id AND partials.trans_id = oi.trans_id
78     WHERE oi.qty > doi_qty
79
80     UNION ALL
81
82     -- 4. since the join over record_links fails for sales_orders wihtout any delivery order
83     --    retrieve those without record_links at all
84     SELECT oi.id FROM orderitems oi, oe
85     WHERE
86       oe.id = oi.trans_id AND
87       oe.customer_id IS NOT NULL AND
88       (oe.quotation = 'f' OR oe.quotation IS NULL) AND
89       NOT oe.closed AND
90       oi.trans_id NOT IN (
91         SELECT from_id
92         FROM record_links rl
93         WHERE
94           rl.from_table ='oe' AND
95           rl.to_table = 'delivery_orders'
96       )
97
98     UNION ALL
99
100     -- 5. In case someone deleted a line of the delivery_order there will be a record_link (4 fails)
101     --    but there won't be a delivery_order_items to find (3 fails too). Search for orphaned orderitems this way
102     SELECT oi.id FROM orderitems AS oi, oe, record_links AS rl
103     WHERE
104       rl.from_table = 'oe' AND
105       rl.to_table = 'delivery_orders' AND
106
107       oi.trans_id = rl.from_id AND
108       oi.parts_id NOT IN (
109         SELECT doi.parts_id FROM delivery_order_items AS doi WHERE doi.delivery_order_id = rl.to_id
110       ) AND
111
112       oe.id = oi.trans_id AND
113
114       oe.customer_id IS NOT NULL AND
115       (oe.quotation = 'f' OR oe.quotation IS NULL) AND
116       NOT oe.closed
117   " ],
118 ];
119
120 sub action_list {
121   my ($self) = @_;
122
123   $self->make_filter_summary;
124
125   my $orderitems = $self->get_models(query => $delivery_plan_query, with_objects => [ 'order', 'order.customer', 'part' ]);
126
127   $self->prepare_report;
128   $self->report_generator_list_objects(report => $self->{report}, objects => $orderitems);
129 }
130
131 # private functions
132 #
133 sub prepare_report {
134   my ($self)      = @_;
135
136   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
137   $self->{report} = $report;
138
139   my @columns     = qw(reqdate customer ordnumber partnumber description qty shipped_qty not_shipped_qty);
140   my @sortable    = qw(reqdate customer ordnumber partnumber description);
141
142   my %column_defs = (
143     reqdate           => {      sub => sub { $_[0]->reqdate_as_date || $_[0]->order->reqdate_as_date                         } },
144     description       => {      sub => sub { $_[0]->description                                                              },
145                            obj_link => sub { $self->link_to($_[0]->part)                                                     } },
146     partnumber        => {      sub => sub { $_[0]->part->partnumber                                                         },
147                            obj_link => sub { $self->link_to($_[0]->part)                                                     } },
148     qty               => {      sub => sub { $_[0]->qty_as_number . ' ' . $_[0]->unit                                        } },
149     shipped_qty       => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->shipped_qty, 2) . ' ' . $_[0]->unit } },
150     not_shipped_qty   => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->qty - $_[0]->shipped_qty, 2) . ' ' . $_[0]->unit } },
151     ordnumber         => {      sub => sub { $_[0]->order->ordnumber                                                         },
152                            obj_link => sub { $self->link_to($_[0]->order)                                                    } },
153     customer          => {      sub => sub { $_[0]->order->customer->name                                                    },
154                            obj_link => sub { $self->link_to($_[0]->order->customer)                                          } },
155   );
156
157   map { $column_defs{$_}->{text} = $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
158
159   $report->set_options(
160     std_column_visibility => 1,
161     controller_class      => 'DeliveryPlan',
162     output_format         => 'HTML',
163     top_info_text         => $::locale->text('Delivery Plan for currently outstanding sales orders'),
164     raw_top_info_text     => $self->render('delivery_plan/report_top',    { output => 0 }),
165     raw_bottom_info_text  => $self->render('delivery_plan/report_bottom', { output => 0 }),
166     title                 => $::locale->text('Delivery Plan'),
167     allow_pdf_export      => 1,
168     allow_csv_export      => 1,
169   );
170   $report->set_columns(%column_defs);
171   $report->set_column_order(@columns);
172   $report->set_export_options(qw(list filter));
173   $report->set_options_from_form;
174   $self->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
175
176   $self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
177 }
178
179 sub make_filter_summary {
180   my ($self) = @_;
181
182   my $filter = $::form->{filter} || {};
183   my @filter_strings;
184
185   my @filters = (
186     [ $filter->{order}{"ordnumber:substr::ilike"},                $::locale->text('Number')                                             ],
187     [ $filter->{part}{"partnumber:substr::ilike"},                $::locale->text('Part Number')                                        ],
188     [ $filter->{"description:substr::ilike"},                     $::locale->text('Part Description')                                   ],
189     [ $filter->{"reqdate:date::ge"},                              $::locale->text('Delivery Date') . " " . $::locale->text('From Date') ],
190     [ $filter->{"reqdate:date::le"},                              $::locale->text('Delivery Date') . " " . $::locale->text('To Date')   ],
191     [ $filter->{"qty:number"},                                    $::locale->text('Quantity')                                           ],
192     [ $filter->{order}{customer}{"name:substr::ilike"},           $::locale->text('Customer')                                           ],
193     [ $filter->{order}{customer}{"customernumber:substr::ilike"}, $::locale->text('Customer Number')                                    ],
194   );
195
196   my %flags = (
197     part     => $::locale->text('Parts'),
198     service  => $::locale->text('Services'),
199     assembly => $::locale->text('Assemblies'),
200   );
201   my @flags = map { $flags{$_} } @{ $filter->{part}{type} || [] };
202
203   for (@flags) {
204     push @filter_strings, $_ if $_;
205   }
206   for (@filters) {
207     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
208   }
209
210   $self->{filter_summary} = join ', ', @filter_strings;
211 }
212
213 sub link_to {
214   my ($self, $object, %params) = @_;
215
216   return unless $object;
217   my $action = $params{action} || 'edit';
218
219   if ($object->isa('SL::DB::Order')) {
220     my $type   = $object->type;
221     my $vc     = $object->is_sales ? 'customer' : 'vendor';
222     my $id     = $object->id;
223
224     return "oe.pl?action=$action&type=$type&vc=$vc&id=$id";
225   }
226   if ($object->isa('SL::DB::Part')) {
227     my $id     = $object->id;
228     return "ic.pl?action=$action&id=$id";
229   }
230   if ($object->isa('SL::DB::Customer')) {
231     my $id     = $object->id;
232     return "ct.pl?action=$action&id=$id&db=customer";
233   }
234 }
235
236 1;