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