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