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 all_edit_right vc) ],
  15 );
  16
  17 __PACKAGE__->run_before(sub { $::auth->assert('delivery_plan'); });
  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   delivered_qty     => t8('transferred in / out'),
  26   not_shipped_qty   => t8('not shipped'),
  27   ordnumber         => t8('Order'),
  28   customer          => t8('Customer'),
  29   vendor            => t8('Vendor'),
  30   value_of_goods    => t8('Value of goods'),
  31 );
  32
  33
  34 sub action_list {
  35   my ($self) = @_;
  36   $self->make_filter_summary;
  37   $self->prepare_report;
  38
  39   my $orderitems = $self->models->get;
  40
  41   $self->report_generator_list_objects(report => $self->{report}, objects => $orderitems);
  42 }
  43
  44 # private functions
  45 #
  46 sub prepare_report {
  47   my ($self)      = @_;
  48
  49   my $vc          = $self->vc;
  50   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
  51   $self->{report} = $report;
  52
  53   my @columns     = qw(reqdate customer ordnumber partnumber description qty shipped_qty not_shipped_qty delivered_qty value_of_goods);
  54   my @sortable    = qw(reqdate customer ordnumber partnumber description);
  55
  56   my %column_defs = (
  57     reqdate           => {      sub => sub { $_[0]->reqdate_as_date || $_[0]->order->reqdate_as_date                         } },
  58     description       => {      sub => sub { $_[0]->description                                                              },
  59                            obj_link => sub { $self->link_to($_[0]->part)                                                     } },
  60     partnumber        => {      sub => sub { $_[0]->part->partnumber                                                         },
  61                            obj_link => sub { $self->link_to($_[0]->part)                                                     } },
  62     qty               => {      sub => sub { $_[0]->qty_as_number . ' ' . $_[0]->unit                                        } },
  63     shipped_qty       => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->shipped_qty, 2) . ' ' . $_[0]->unit } },
  64     not_shipped_qty   => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->qty - $_[0]->shipped_qty, 2) . ' ' . $_[0]->unit } },
  65     delivered_qty     => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->delivered_qty, 2) . ' ' . $_[0]->unit } },
  66     ordnumber         => {      sub => sub { $_[0]->order->ordnumber                                                         },
  67                            obj_link => sub { $self->link_to($_[0]->order)                                                    } },
  68     $vc               => {      sub => sub { $_[0]->order->$vc->name                                                    },
  69                            obj_link => sub { $self->link_to($_[0]->order->$vc)                                          } },
  70   );
  71
  72   # add value of goods in report
  73   if ($main::auth->assert('sales_order_edit') && $::instance_conf->get_delivery_plan_show_value_of_goods) {
  74     $column_defs{value_of_goods} = { sub =>  sub { $::form->format_amount(\%::myconfig, $_[0]->value_of_goods, 2) . ' ' . $_[0]->taxincluded } };
  75   }
  76   $column_defs{$_}->{text} = $sort_columns{$_} for keys %column_defs;
  77
  78   $report->set_options(
  79     std_column_visibility => 1,
  80     controller_class      => 'DeliveryPlan',
  81     output_format         => 'HTML',
  82     top_info_text         => ($vc eq 'customer') ? $::locale->text('Delivery Plan for currently outstanding sales orders') :
  83                                                    $::locale->text('Delivery Plan for currently outstanding purchase orders'),
  84     title                 => $::locale->text('Delivery Plan'),
  85     allow_pdf_export      => 1,
  86     allow_csv_export      => 1,
  87   );
  88   $report->set_columns(%column_defs);
  89   $report->set_column_order(@columns);
  90   $report->set_export_options(qw(list filter vc));
  91   $report->set_options_from_form;
  92   $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
  93   $self->models->finalize; # for filter laundering
  94   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
  95   $report->set_options(
  96     raw_top_info_text     => $self->render('delivery_plan/report_top',    { output => 0 }, vc => $vc),
  97     raw_bottom_info_text  => $self->render('delivery_plan/report_bottom', { output => 0 }, models => $self->models),
  98   );
  99 }
 100
 101 sub make_filter_summary {
 102   my ($self) = @_;
 103   my $vc     = $self->vc;
 104
 105   my $filter = $::form->{filter} || {};
 106   my @filter_strings;
 107
 108   my @filters = (
 109     [ $filter->{order}{"ordnumber:substr::ilike"},                $::locale->text('Number')                                             ],
 110     [ $filter->{part}{"partnumber:substr::ilike"},                $::locale->text('Part Number')                                        ],
 111     [ $filter->{"description:substr::ilike"},                     $::locale->text('Part Description')                                   ],
 112     [ $filter->{"reqdate:date::ge"},                              $::locale->text('Delivery Date') . " " . $::locale->text('From Date') ],
 113     [ $filter->{"reqdate:date::le"},                              $::locale->text('Delivery Date') . " " . $::locale->text('To Date')   ],
 114     [ $filter->{"qty:number"},                                    $::locale->text('Quantity')                                           ],
 115     [ $filter->{order}{$vc}{"name:substr::ilike"},                ($vc eq 'customer') ? $::locale->text('Customer') : $::locale->text('Vendor')   ],
 116     [ $filter->{order}{$vc}{"${vc}number:substr::ilike"},         ($vc eq 'customer') ? $::locale->text('Customer Number') : $::locale->text('Vendor Number') ],
 117   );
 118
 119   my %flags = (
 120     part     => $::locale->text('Parts'),
 121     service  => $::locale->text('Services'),
 122     assembly => $::locale->text('Assemblies'),
 123   );
 124   my @flags = map { $flags{$_} } @{ $filter->{part}{type} || [] };
 125
 126   for (@flags) {
 127     push @filter_strings, $_ if $_;
 128   }
 129   for (@filters) {
 130     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
 131   }
 132
 133   $self->{filter_summary} = join ', ', @filter_strings;
 134 }
 135
 136 sub delivery_plan_query {
 137   my ($self) = @_;
 138   my $vc     = $self->vc;
 139   my $employee_id = SL::DB::Manager::Employee->current->id;
 140   my $oe_owner = $_[0]->all_edit_right ? '' : " oe.employee_id = $employee_id AND";
 141   # check delivered state for delivery_orders (transferred out) if enabled
 142   my $filter_delivered = $::instance_conf->get_delivery_plan_calculate_transferred_do  ?
 143       "AND (SELECT delivered from delivery_orders where id = doi.delivery_order_id)" : '';
 144   [
 145   "order.${vc}_id" => { gt => 0 },
 146   'order.closed' => 0,
 147   or => [ 'order.quotation' => 0, 'order.quotation' => undef ],
 148
 149   # filter by shipped_qty < qty, read from innermost to outermost
 150   'id' => [ \"
 151     -- 3. resolve the desired information about those
 152     SELECT oi.id FROM (
 153       -- 2. slice only part, orderitem and both quantities from it
 154       SELECT parts_id, trans_id, qty, SUM(doi_qty) AS doi_qty FROM (
 155         -- 1. join orderitems and deliverorder items via record_links.
 156         --    also add customer data to filter for sales_orders
 157         SELECT oi.parts_id, oi.trans_id, oi.id, oi.qty, doi.qty AS doi_qty
 158         FROM orderitems oi, oe, record_links rl, delivery_order_items doi
 159         WHERE
 160           oe.id = oi.trans_id AND
 161           oe.${vc}_id IS NOT NULL AND
 162           (oe.quotation = 'f' OR oe.quotation IS NULL) AND
 163           NOT oe.closed AND
 164           $oe_owner
 165           rl.from_id = oe.id AND
 166           rl.from_id = oi.trans_id AND
 167           oe.id = oi.trans_id AND
 168           rl.from_table = 'oe' AND
 169           rl.to_table = 'delivery_orders' AND
 170           rl.to_id = doi.delivery_order_id AND
 171           oi.parts_id = doi.parts_id
 172           $filter_delivered
 173       ) tuples GROUP BY parts_id, trans_id, qty
 174     ) partials
 175     LEFT JOIN orderitems oi ON partials.parts_id = oi.parts_id AND partials.trans_id = oi.trans_id
 176     WHERE oi.qty > doi_qty
 177
 178     UNION ALL
 179
 180     -- 4. since the join over record_links fails for sales_orders without any delivery order
 181     --    retrieve those without record_links at all
 182     SELECT oi.id FROM orderitems oi, oe
 183     WHERE
 184       oe.id = oi.trans_id AND
 185       oe.${vc}_id IS NOT NULL AND
 186       (oe.quotation = 'f' OR oe.quotation IS NULL) AND
 187       NOT oe.closed AND
 188       $oe_owner
 189       oi.trans_id NOT IN (
 190         SELECT from_id
 191         FROM record_links rl
 192         WHERE
 193           rl.from_table ='oe' AND
 194           rl.to_table = 'delivery_orders'
 195       )
 196
 197     UNION ALL
 198
 199     -- 5. now for the really nasty cases.
 200     --    If someone partially delivered an order in several delivery orders,
 201     --    there will be lots of record_links (4 doesn't catch those) but those
 202     --    won't have matching part_ids in delivery_order_items, so 1-3 can't
 203     --    find anything
 204     --    In this case aggreg record_links - delivery_order - delivery_order_items
 205     --    slice only oe.id, parts_id and sum of of qty
 206     --    left join that onto orderitems to get matching qtys in doi while retaining
 207     --    entrys without matches and then throw out those without record_links
 208     --    TODO: join this and 1-3 into a general case
 209                   -- need debug info? uncomment these:
 210     SELECT oi.id  -- ,oi.trans_id, oi.parts_id, coalesce(sum, 0), agg.parts_id
 211     FROM orderitems oi LEFT JOIN (
 212       SELECT rl.from_id as oid, doi.parts_id, sum(doi.qty) FROM (
 213         SELECT from_id, to_id
 214         FROM record_links rl
 215         LEFT JOIN oe ON oe.id = from_id
 216         WHERE
 217           rl.from_table = 'oe' AND
 218           rl.to_table = 'delivery_orders' AND
 219
 220           oe.${vc}_id IS NOT NULL AND
 221           $oe_owner
 222           (oe.quotation = 'f' OR oe.quotation IS NULL) AND NOT oe.closed
 223       ) rl
 224       LEFT JOIN delivery_order_items doi ON (rl.to_id = doi.delivery_order_id)
 225       WHERE 1 = 1
 226       $filter_delivered
 227       GROUP BY rl.from_id, doi.parts_id
 228     ) agg ON (agg.oid = oi.trans_id AND agg.parts_id = oi.parts_id)
 229     LEFT JOIN oe ON oe.id = oi.trans_id
 230     WHERE
 231       EXISTS (
 232         SELECT to_id
 233         FROM record_links rl
 234         WHERE oi.trans_id = rl.from_id AND rl.from_table = 'oe' AND rl.to_table = 'delivery_orders'
 235       ) AND
 236       coalesce(sum, 0) < oi.qty AND
 237       oe.${vc}_id IS NOT NULL AND
 238       $oe_owner
 239       (oe.quotation = 'f' OR oe.quotation IS NULL) AND NOT oe.closed
 240   " ],
 241   ]
 242 }
 243
 244 sub init_models {
 245   my ($self) = @_;
 246   my $vc     = $self->vc;
 247
 248   SL::Controller::Helper::GetModels->new(
 249     controller   => $self,
 250     model        => 'OrderItem',
 251     sorted       => {
 252       _default     => {
 253         by           => 'reqdate',
 254         dir          => 1,
 255       },
 256       %sort_columns,
 257     },
 258     query        => $self->delivery_plan_query,
 259     with_objects => [ 'order', "order.$vc", 'part' ],
 260   );
 261 }
 262
 263 sub init_all_edit_right {
 264   $::auth->assert('sales_all_edit', 1)
 265 }
 266 sub init_vc {
 267   return $::form->{vc} || croak "self (DeliveryPlan) has no vc defined";
 268 }
 269
 270 sub link_to {
 271   my ($self, $object, %params) = @_;
 272
 273   return unless $object;
 274   my $action = $params{action} || 'edit';
 275
 276   if ($object->isa('SL::DB::Order')) {
 277     my $type   = $object->type;
 278     my $vc     = $object->is_sales ? 'customer' : 'vendor';
 279     my $id     = $object->id;
 280
 281     return "oe.pl?action=$action&type=$type&vc=$vc&id=$id";
 282   }
 283   if ($object->isa('SL::DB::Part')) {
 284     my $id     = $object->id;
 285     return "ic.pl?action=$action&id=$id";
 286   }
 287   if ($object->isa('SL::DB::Customer')) {
 288     my $id     = $object->id;
 289     return "controller.pl?action=CustomerVendor/$action&id=$id&db=customer";
 290   }
 291 }
 292
 293 1;