DeliveryPlan: Cleanup, vc mitschleifen
[kivitendo-erp.git] / SL / Controller / DeliveryPlan.pm
index 642db34..5d83c5b 100644 (file)
@@ -6,195 +6,105 @@ use parent qw(SL::Controller::Base);
 use Clone qw(clone);
 use SL::DB::OrderItem;
 use SL::Controller::Helper::GetModels;
-use SL::Controller::Helper::Paginated;
-use SL::Controller::Helper::Sorted;
-use SL::Controller::Helper::ParseFilter;
 use SL::Controller::Helper::ReportGenerator;
+use SL::Locale::String;
+use Carp;
 
 use Rose::Object::MakeMethods::Generic (
   scalar => [ qw(db_args flat_filter) ],
+  'scalar --get_set_init' => [ qw(models all_edit_right vc) ],
 );
 
-__PACKAGE__->run_before(sub { $::auth->assert('sales_order_edit'); });
-
-__PACKAGE__->get_models_url_params('flat_filter');
-__PACKAGE__->make_paginated(
-  MODEL         => 'OrderItem',
-  PAGINATE_ARGS => 'db_args',
-  ONLY          => [ qw(list) ],
+__PACKAGE__->run_before(sub { $::auth->assert('delivery_plan'); });
+
+my %sort_columns = (
+  reqdate           => t8('Reqdate'),
+  description       => t8('Description'),
+  partnumber        => t8('Part Number'),
+  qty               => t8('Qty'),
+  shipped_qty       => t8('shipped'),
+  delivered_qty     => t8('transferred in / out'),
+  not_shipped_qty   => t8('not shipped'),
+  ordnumber         => t8('Order'),
+  customer          => t8('Customer'),
+  vendor            => t8('Vendor'),
+  value_of_goods    => t8('Value of transferred goods'),
 );
 
-__PACKAGE__->make_sorted(
-  MODEL       => 'OrderItem',
-  ONLY        => [ qw(list) ],
-
-  DEFAULT_BY  => 'reqdate',
-  DEFAULT_DIR => 1,
-
-  reqdate     => 'Reqdate',
-  description => 'Description',
-  partnumber  => 'Part Number',
-  qty         => 'Qty',
-  shipped_qty => 'shipped',
-  ordnumber   => 'Order',
-  customer    => 'Customer',
-);
 
 sub action_list {
   my ($self) = @_;
-
-  $self->db_args($self->setup_for_list(filter => $::form->{filter}));
-  $self->flat_filter({ map { $_->{key} => $_->{value} } $::form->flatten_variables('filter') });
   $self->make_filter_summary;
-
   $self->prepare_report;
 
-  $self->{orderitems} = $self->get_models(%{ $self->db_args });
+  my $orderitems = $self->models->get;
 
-  $self->list_objects;
+  $self->report_generator_list_objects(report => $self->{report}, objects => $orderitems);
 }
 
 # private functions
-
-sub setup_for_list {
-  my ($self, %params) = @_;
-  $self->{filter} = {};
-  my %args = (
-    parse_filter(
-      $self->_pre_parse_filter($::form->{filter}, $self->{filter}),
-      with_objects => [ 'order', 'order.customer', 'part' ],
-      launder_to => $self->{filter},
-    ),
-  );
-
-  $args{query} = [ @{ $args{query} || [] },
-    (
-      'order.customer_id' => { gt => 0 },
-      'order.closed' => 0,
-      or => [ 'order.quotation' => 0, 'order.quotation' => undef ],
-
-      # filter by shipped_qty < qty, read from innermost to outermost
-      'id' => [ \"
-        -- 3. resolve the desired information about those
-        SELECT oi.id FROM (
-          -- 2. slice only part, orderitem and both quantities from it
-          SELECT parts_id, trans_id, qty, SUM(doi_qty) AS doi_qty FROM (
-            -- 1. join orderitems and deliverorder items via record_links.
-            --    also add customer data to filter for sales_orders
-            SELECT oi.parts_id, oi.trans_id, oi.id, oi.qty, doi.qty AS doi_qty
-            FROM orderitems oi, oe, record_links rl, delivery_order_items doi
-            WHERE
-              oe.id = oi.trans_id AND
-              oe.customer_id IS NOT NULL AND
-              (oe.quotation = 'f' OR oe.quotation IS NULL) AND
-              NOT oe.closed AND
-              rl.from_id = oe.id AND
-              rl.from_id = oi.trans_id AND
-              oe.id = oi.trans_id AND
-              rl.from_table = 'oe' AND
-              rl.to_table = 'delivery_orders' AND
-              rl.to_id = doi.delivery_order_id AND
-              oi.parts_id = doi.parts_id
-          ) tuples GROUP BY parts_id, trans_id, qty
-        ) partials
-        LEFT JOIN orderitems oi ON partials.parts_id = oi.parts_id AND partials.trans_id = oi.trans_id
-        WHERE oi.qty > doi_qty
-
-        UNION ALL
-
-        -- 4. since the join over record_links fails for sales_orders wihtout any delivery order
-        --    retrieve those without record_links at all
-        SELECT oi.id FROM orderitems oi, oe
-        WHERE
-          oe.id = oi.trans_id AND
-          oe.customer_id IS NOT NULL AND
-          (oe.quotation = 'f' OR oe.quotation IS NULL) AND
-          NOT oe.closed AND
-          oi.trans_id NOT IN (
-            SELECT from_id
-            FROM record_links rl
-            WHERE
-              rl.from_table ='oe' AND
-              rl.to_table = 'delivery_orders'
-          )
-      " ],
-    )
-  ];
-
-  return \%args;
-}
-
+#
 sub prepare_report {
   my ($self)      = @_;
 
+  my $vc          = $self->vc;
   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
   $self->{report} = $report;
 
-  my @columns     = qw(reqdate customer ordnumber partnumber description qty shipped_qty);
-  my @sortable    = qw(reqdate customer ordnumber partnumber description                );
+  my @columns     = qw(reqdate customer vendor ordnumber partnumber description qty shipped_qty not_shipped_qty delivered_qty value_of_goods);
+
+  my @sortable    = qw(reqdate customer vendor ordnumber partnumber description);
 
   my %column_defs = (
-    reqdate       => {      sub => sub { $_[0]->reqdate_as_date || $_[0]->order->reqdate_as_date                         } },
-    description   => {      sub => sub { $_[0]->description                                                              },
-                       obj_link => sub { $self->link_to($_[0]->part)                                                     } },
-    partnumber    => {      sub => sub { $_[0]->part->partnumber                                                         },
-                       obj_link => sub { $self->link_to($_[0]->part)                                                     } },
-    qty           => {      sub => sub { $_[0]->qty_as_number . ' ' . $_[0]->unit                                        } },
-    shipped_qty   => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->shipped_qty, 2) . ' ' . $_[0]->unit } },
-    ordnumber     => {      sub => sub { $_[0]->order->ordnumber                                                         },
-                       obj_link => sub { $self->link_to($_[0]->order)                                                    } },
-    customer      => {      sub => sub { $_[0]->order->customer->name                                                    },
-                       obj_link => sub { $self->link_to($_[0]->order->customer)                                          } },
+    reqdate           => {      sub => sub { $_[0]->reqdate_as_date || $_[0]->order->reqdate_as_date                         } },
+    description       => {      sub => sub { $_[0]->description                                                              },
+                           obj_link => sub { $self->link_to($_[0]->part)                                                     } },
+    partnumber        => {      sub => sub { $_[0]->part->partnumber                                                         },
+                           obj_link => sub { $self->link_to($_[0]->part)                                                     } },
+    qty               => {      sub => sub { $_[0]->qty_as_number . ' ' . $_[0]->unit                                        } },
+    shipped_qty       => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->shipped_qty, 2) . ' ' . $_[0]->unit } },
+    not_shipped_qty   => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->qty - $_[0]->shipped_qty, 2) . ' ' . $_[0]->unit } },
+    delivered_qty     => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->delivered_qty, 2) . ' ' . $_[0]->unit } },
+    ordnumber         => {      sub => sub { $_[0]->order->ordnumber                                                         },
+                           obj_link => sub { $self->link_to($_[0]->order)                                                    } },
+    vendor            => {      sub => sub { $_[0]->order->vendor->name                                                      },
+                            visible => $vc eq 'vendor',
+                           obj_link => sub { $self->link_to($_[0]->order->vendor)                                            } },
+    customer          => {      sub => sub { $_[0]->order->customer->name                                                    },
+                            visible => $vc eq 'customer',
+                           obj_link => sub { $self->link_to($_[0]->order->customer)                                          } },
+    value_of_goods    => {      sub => sub { $::form->format_amount(\%::myconfig, $_[0]->value_of_goods, 2) . ' ' . $_[0]->taxincluded },
+                            visible => $::auth->assert('sales_order_edit', 1) && $::instance_conf->get_delivery_plan_show_value_of_goods, },
   );
 
-  map { $column_defs{$_}->{text} = $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
+  $column_defs{$_}->{text} = $sort_columns{$_} for keys %column_defs;
 
   $report->set_options(
     std_column_visibility => 1,
     controller_class      => 'DeliveryPlan',
     output_format         => 'HTML',
-    top_info_text         => $::locale->text('Delivery Plan for currently outstanding sales orders'),
-    raw_top_info_text     => $self->render('delivery_plan/report_top',    { no_output => 1, partial => 1 }),
-    raw_bottom_info_text  => $self->render('delivery_plan/report_bottom', { no_output => 1, partial => 1 }),
+    top_info_text         => ($vc eq 'customer') ? $::locale->text('Delivery Plan for currently outstanding sales orders') :
+                                                   $::locale->text('Delivery Plan for currently outstanding purchase orders'),
     title                 => $::locale->text('Delivery Plan'),
     allow_pdf_export      => 1,
     allow_csv_export      => 1,
   );
   $report->set_columns(%column_defs);
   $report->set_column_order(@columns);
-  $report->set_export_options(qw(list filter));
+  $report->set_export_options(qw(list filter vc));
   $report->set_options_from_form;
-  $self->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
-
-  $self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
-
-  $self->{report_data} = {
-    column_defs        => \%column_defs,
-    columns            => \@columns,
-  };
-}
-
-sub list_objects {
-  my ($self) = @_;
-  my $column_defs = $self->{report_data}{column_defs};
-  for my $obj (@{ $self->{orderitems} || [] }) {
-    $self->{report}->add_data({
-      map {
-        $_ => {
-          data => $column_defs->{$_}{sub} ? $column_defs->{$_}{sub}->($obj)
-                : $obj->can($_)           ? $obj->$_
-                :                           $obj->{$_},
-          link => $column_defs->{$_}{obj_link} ? $column_defs->{$_}{obj_link}->($obj) : '',
-        },
-      } @{ $self->{report_data}{columns} || {} }
-    });
-  }
-
-  return $self->{report}->generate_with_headers;
+  $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
+  $self->models->finalize; # for filter laundering
+  $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
+  $report->set_options(
+    raw_top_info_text     => $self->render('delivery_plan/report_top',    { output => 0 }, vc => $vc),
+    raw_bottom_info_text  => $self->render('delivery_plan/report_bottom', { output => 0 }, models => $self->models),
+  );
 }
 
 sub make_filter_summary {
   my ($self) = @_;
+  my $vc     = $self->vc;
 
   my $filter = $::form->{filter} || {};
   my @filter_strings;
@@ -206,18 +116,21 @@ sub make_filter_summary {
     [ $filter->{"reqdate:date::ge"},                              $::locale->text('Delivery Date') . " " . $::locale->text('From Date') ],
     [ $filter->{"reqdate:date::le"},                              $::locale->text('Delivery Date') . " " . $::locale->text('To Date')   ],
     [ $filter->{"qty:number"},                                    $::locale->text('Quantity')                                           ],
+    [ $filter->{order}{vendor}{"name:substr::ilike"},             $::locale->text('Vendor')                                             ],
+    [ $filter->{order}{vendor}{"vendornumber:substr::ilike"},     $::locale->text('Vendor Number')                                      ],
     [ $filter->{order}{customer}{"name:substr::ilike"},           $::locale->text('Customer')                                           ],
     [ $filter->{order}{customer}{"customernumber:substr::ilike"}, $::locale->text('Customer Number')                                    ],
   );
 
-  my @flags = (
-    [ $filter->{part}{type}{part},     $::locale->text('Parts')      ],
-    [ $filter->{part}{type}{service},  $::locale->text('Services')   ],
-    [ $filter->{part}{type}{assembly}, $::locale->text('Assemblies') ],
+  my %flags = (
+    part     => $::locale->text('Parts'),
+    service  => $::locale->text('Services'),
+    assembly => $::locale->text('Assemblies'),
   );
+  my @flags = map { $flags{$_} } @{ $filter->{part}{type} || [] };
 
   for (@flags) {
-    push @filter_strings, "$_->[1]" if $_->[0];
+    push @filter_strings, $_ if $_;
   }
   for (@filters) {
     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
@@ -226,6 +139,141 @@ sub make_filter_summary {
   $self->{filter_summary} = join ', ', @filter_strings;
 }
 
+sub delivery_plan_query {
+  my ($self) = @_;
+  my $vc     = $self->vc;
+  my $employee_id = SL::DB::Manager::Employee->current->id;
+  my $oe_owner = $_[0]->all_edit_right ? '' : " oe.employee_id = $employee_id AND";
+  # check delivered state for delivery_orders (transferred out) if enabled
+  my $filter_delivered = $::instance_conf->get_delivery_plan_calculate_transferred_do  ?
+      "AND (SELECT delivered from delivery_orders where id = doi.delivery_order_id)" : '';
+  [
+  "order.${vc}_id" => { gt => 0 },
+  'order.closed' => 0,
+  or => [ 'order.quotation' => 0, 'order.quotation' => undef ],
+
+  # filter by shipped_qty < qty, read from innermost to outermost
+  'id' => [ \"
+    -- 3. resolve the desired information about those
+    SELECT oi.id FROM (
+      -- 2. slice only part, orderitem and both quantities from it
+      SELECT parts_id, trans_id, qty, SUM(doi_qty) AS doi_qty FROM (
+        -- 1. join orderitems and deliverorder items via record_links.
+        --    also add customer data to filter for sales_orders
+        SELECT oi.parts_id, oi.trans_id, oi.id, oi.qty, doi.qty AS doi_qty
+        FROM orderitems oi, oe, record_links rl, delivery_order_items doi
+        WHERE
+          oe.id = oi.trans_id AND
+          oe.${vc}_id IS NOT NULL AND
+          (oe.quotation = 'f' OR oe.quotation IS NULL) AND
+          NOT oe.closed AND
+          $oe_owner
+          rl.from_id = oe.id AND
+          rl.from_id = oi.trans_id AND
+          oe.id = oi.trans_id AND
+          rl.from_table = 'oe' AND
+          rl.to_table = 'delivery_orders' AND
+          rl.to_id = doi.delivery_order_id AND
+          oi.parts_id = doi.parts_id
+          $filter_delivered
+      ) tuples GROUP BY parts_id, trans_id, qty
+    ) partials
+    LEFT JOIN orderitems oi ON partials.parts_id = oi.parts_id AND partials.trans_id = oi.trans_id
+    WHERE oi.qty > doi_qty
+
+    UNION ALL
+
+    -- 4. since the join over record_links fails for sales_orders without any delivery order
+    --    retrieve those without record_links at all
+    SELECT oi.id FROM orderitems oi, oe
+    WHERE
+      oe.id = oi.trans_id AND
+      oe.${vc}_id IS NOT NULL AND
+      (oe.quotation = 'f' OR oe.quotation IS NULL) AND
+      NOT oe.closed AND
+      $oe_owner
+      oi.trans_id NOT IN (
+        SELECT from_id
+        FROM record_links rl
+        WHERE
+          rl.from_table ='oe' AND
+          rl.to_table = 'delivery_orders'
+      )
+
+    UNION ALL
+
+    -- 5. now for the really nasty cases.
+    --    If someone partially delivered an order in several delivery orders,
+    --    there will be lots of record_links (4 doesn't catch those) but those
+    --    won't have matching part_ids in delivery_order_items, so 1-3 can't
+    --    find anything
+    --    In this case aggreg record_links - delivery_order - delivery_order_items
+    --    slice only oe.id, parts_id and sum of of qty
+    --    left join that onto orderitems to get matching qtys in doi while retaining
+    --    entrys without matches and then throw out those without record_links
+    --    TODO: join this and 1-3 into a general case
+                  -- need debug info? uncomment these:
+    SELECT oi.id  -- ,oi.trans_id, oi.parts_id, coalesce(sum, 0), agg.parts_id
+    FROM orderitems oi LEFT JOIN (
+      SELECT rl.from_id as oid, doi.parts_id, sum(doi.qty) FROM (
+        SELECT from_id, to_id
+        FROM record_links rl
+        LEFT JOIN oe ON oe.id = from_id
+        WHERE
+          rl.from_table = 'oe' AND
+          rl.to_table = 'delivery_orders' AND
+
+          oe.${vc}_id IS NOT NULL AND
+          $oe_owner
+          (oe.quotation = 'f' OR oe.quotation IS NULL) AND NOT oe.closed
+      ) rl
+      LEFT JOIN delivery_order_items doi ON (rl.to_id = doi.delivery_order_id)
+      WHERE 1 = 1
+      $filter_delivered
+      GROUP BY rl.from_id, doi.parts_id
+    ) agg ON (agg.oid = oi.trans_id AND agg.parts_id = oi.parts_id)
+    LEFT JOIN oe ON oe.id = oi.trans_id
+    WHERE
+      EXISTS (
+        SELECT to_id
+        FROM record_links rl
+        WHERE oi.trans_id = rl.from_id AND rl.from_table = 'oe' AND rl.to_table = 'delivery_orders'
+      ) AND
+      coalesce(sum, 0) < oi.qty AND
+      oe.${vc}_id IS NOT NULL AND
+      $oe_owner
+      (oe.quotation = 'f' OR oe.quotation IS NULL) AND NOT oe.closed
+  " ],
+  ]
+}
+
+sub init_models {
+  my ($self) = @_;
+  my $vc     = $self->vc;
+
+  SL::Controller::Helper::GetModels->new(
+    controller            => $self,
+    model                 => 'OrderItem',
+    sorted                => {
+      _default              => {
+        by                    => 'reqdate',
+        dir                   => 1,
+      },
+      %sort_columns,
+    },
+    query                 => $self->delivery_plan_query,
+    with_objects          => [ 'order', "order.$vc", 'part' ],
+    additional_url_params => { vc => $vc },
+  );
+}
+
+sub init_all_edit_right {
+  $::auth->assert('sales_all_edit', 1)
+}
+sub init_vc {
+  return $::form->{vc} if ($::form->{vc} eq 'customer' || $::form->{vc} eq 'vendor') || croak "self (DeliveryPlan) has no vc defined";
+}
+
 sub link_to {
   my ($self, $object, %params) = @_;
 
@@ -245,49 +293,8 @@ sub link_to {
   }
   if ($object->isa('SL::DB::Customer')) {
     my $id     = $object->id;
-    return "ct.pl?action=$action&id=$id&db=customer";
+    return "controller.pl?action=CustomerVendor/$action&id=$id&db=customer";
   }
 }
 
-# unfortunately ParseFilter can't handle compount filters.
-# so we clone the original filter (still need that for serializing)
-# rip out the options we know an replace them with the compound options.
-# ParseFilter will take care of the prefixing then.
-sub _pre_parse_filter {
-  my ($self, $orig_filter, $launder_to) = @_;
-
-  return undef unless $orig_filter;
-
-  my $filter = clone($orig_filter);
-  if ($filter->{part} && $filter->{part}{type}) {
-    $launder_to->{part}{type} = delete $filter->{part}{type};
-    my @part_filters = grep $_, map {
-      $launder_to->{part}{type}{$_} ? SL::DB::Manager::Part->type_filter($_) : ()
-    } qw(part service assembly);
-
-    push @{ $filter->{and} }, or => [ @part_filters ] if @part_filters;
-  }
-
-  for my $op (qw(le ge)) {
-    if ($filter->{"reqdate:date::$op"}) {
-      $launder_to->{"reqdate_date__$op"} = delete $filter->{"reqdate:date::$op"};
-      my $parsed_date = DateTime->from_lxoffice($launder_to->{"reqdate_date__$op"});
-      push @{ $filter->{and} }, or => [
-        'reqdate' => { $op => $parsed_date },
-        and => [
-          'reqdate' => undef,
-          'order.reqdate' => { $op => $parsed_date },
-        ]
-      ] if $parsed_date;
-    }
-  }
-
-  if (my $style = delete $filter->{searchstyle}) {
-    $self->{searchstyle}       = $style;
-    $launder_to->{searchstyle} = $style;
-  }
-
-  return $filter;
-}
-
 1;