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