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