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