Debugstatement entfernt
[kivitendo-erp.git] / SL / Controller / DeliveryPlan.pm
index e280a1b..ee4a292 100644 (file)
@@ -5,212 +5,159 @@ use parent qw(SL::Controller::Base);
 
 use Clone qw(clone);
 use SL::DB::OrderItem;
-use SL::Controller::Helper::ParseFilter;
+use SL::Controller::Helper::GetModels;
 use SL::Controller::Helper::ReportGenerator;
+use SL::Locale::String;
+
+use Rose::Object::MakeMethods::Generic (
+  scalar => [ qw(db_args flat_filter) ],
+  'scalar --get_set_init' => [ qw(models) ],
+);
 
 __PACKAGE__->run_before(sub { $::auth->assert('sales_order_edit'); });
 
-sub action_list {
-  my ($self) = @_;
-  my %list_params = (
-    sort_by  => $::form->{sort_by} || 'reqdate',
-    sort_dir => $::form->{sort_dir},
-    filter   => $::form->{filter},
-    page     => $::form->{page},
-  );
+my %sort_columns = (
+  reqdate           => t8('Reqdate'),
+  description       => t8('Description'),
+  partnumber        => t8('Part Number'),
+  qty               => t8('Qty'),
+  shipped_qty       => t8('shipped'),
+  not_shipped_qty   => t8('not shipped'),
+  ordnumber         => t8('Order'),
+  customer          => t8('Customer'),
+);
+
+my $delivery_plan_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'
+      )
 
-  my $db_args = $self->setup_for_list(%list_params);
-  $self->{pages} = SL::DB::Manager::OrderItem->paginate(%list_params, args => $db_args);
-  $self->{flat_filter} = { map { $_->{key} => $_->{value} } $::form->flatten_variables('filter') };
-  $self->make_filter_summary;
+    UNION ALL
 
-  my $top    = $::form->parse_html_template('delivery_plan/report_top', { FORM => $::form, SELF => $self });
-  my $bottom = $::form->parse_html_template('delivery_plan/report_bottom', { SELF => $self });
+    -- 5. In case someone deleted a line of the delivery_order there will be a record_link (4 fails)
+    --    but there won't be a delivery_order_items to find (3 fails too). Search for orphaned orderitems this way
+    SELECT oi.id FROM orderitems AS oi, oe, record_links AS rl
+    WHERE
+      rl.from_table = 'oe' AND
+      rl.to_table = 'delivery_orders' AND
 
-  $self->prepare_report(
-    report_generator_options => {
-      raw_top_info_text    => $top,
-      raw_bottom_info_text => $bottom,
-      controller_class     => 'DeliveryPlan',
-    },
-    report_generator_export_options => [
-      'list', qw(filter sort_by sort_dir),
-    ],
-    db_args => $db_args,
-  );
+      oi.trans_id = rl.from_id AND
+      oi.parts_id NOT IN (
+        SELECT doi.parts_id FROM delivery_order_items AS doi WHERE doi.delivery_order_id = rl.to_id
+      ) AND
 
-  $self->{orderitems} = SL::DB::Manager::OrderItem->get_all(%$db_args);
+      oe.id = oi.trans_id AND
 
-  $self->list_objects;
-}
+      oe.customer_id IS NOT NULL AND
+      (oe.quotation = 'f' OR oe.quotation IS NULL) AND
+      NOT oe.closed
+  " ],
+];
 
-# private functions
+sub action_list {
+  my ($self) = @_;
 
-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},
-    ),
-    sort_by => $self->set_sort_params(%params),
-    page    => $params{page},
-  );
+  $self->make_filter_summary;
+  $self->prepare_report;
 
-  $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;
-}
+  my $orderitems = $self->models->get;
 
-sub set_sort_params {
-  my ($self, %params) = @_;
-  my $sort_str;
-  ($self->{sort_by}, $self->{sort_dir}, $sort_str) =
-    SL::DB::Manager::OrderItem->make_sort_string(%params);
-  return $sort_str;
+  $self->report_generator_list_objects(report => $self->{report}, objects => $orderitems);
 }
 
+# private functions
+#
 sub prepare_report {
-  my ($self, %params) = @_;
+  my ($self)      = @_;
 
-  my $objects  = $params{objects} || [];
-  my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
+  my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
   $self->{report} = $report;
 
-  my @columns  = qw(reqdate customer ordnumber partnumber description qty shipped_qty);
-  my @visible  = qw(reqdate partnumber description qty shipped_qty ordnumber customer);
-  my @sortable = qw(reqdate partnumber description                 ordnumber customer);
+  my @columns     = qw(reqdate customer ordnumber partnumber description qty shipped_qty not_shipped_qty);
+  my @sortable    = qw(reqdate customer ordnumber partnumber description);
 
   my %column_defs = (
-    reqdate                 => { text => $::locale->text('Reqdate'),
-                                  sub => sub { $_[0]->reqdate_as_date || $_[0]->order->reqdate_as_date }},
-    description             => { text => $::locale->text('Description'),
-                                  sub => sub { $_[0]->description },
-                             obj_link => sub { $self->link_to($_[0]->part) }},
-    partnumber              => { text => $::locale->text('Part Number'),
-                                  sub => sub { $_[0]->part->partnumber },
-                             obj_link => sub { $self->link_to($_[0]->part) }},
-    qty                     => { text => $::locale->text('Qty'),
-                                  sub => sub { $_[0]->qty_as_number . ' ' . $_[0]->unit }},
-    missing                 => { text => $::locale->text('Missing qty'),
-                                  sub => sub { $::form->format_amount(\%::myconfig, $_[0]->qty - $_[0]->shipped_qty, 2) . ' ' . $_[0]->unit }},
-    shipped_qty             => { text => $::locale->text('shipped'),
-                                  sub => sub { $::form->format_amount(\%::myconfig, $_[0]->shipped_qty, 2) . ' ' . $_[0]->unit }},
-    ordnumber               => { text => $::locale->text('Order'),
-                                  sub => sub { $_[0]->order->ordnumber },
-                             obj_link => sub { $self->link_to($_[0]->order) }},
-    customer                => { text => $::locale->text('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 } },
+    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)                                          } },
   );
 
+  $column_defs{$_}->{text} = $sort_columns{$_} for keys %column_defs;
 
-  for my $col (@sortable) {
-    $column_defs{$col}{link} = $self->url_for(
-      action   => 'list',
-      sort_by  => $col,
-      sort_dir => ($self->{sort_by} eq $col ? 1 - $self->{sort_dir} : $self->{sort_dir}),
-      page     => $self->{pages}{cur},
-      %{ $self->{flat_filter} },
-    );
-  }
-
-  map { $column_defs{$_}->{visible} = 1 } @visible;
-
+  $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'),
+    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_options(allow_pdf_export => 1, allow_csv_export => 1);
-  $report->set_sort_indicator(%params);
-  $report->set_export_options(@{ $params{report_generator_export_options} || [] });
+  $report->set_export_options(qw(list filter));
+  $report->set_options_from_form;
+  $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(
-    %{ $params{report_generator_options} || {} },
-    output_format        => 'HTML',
-    top_info_text        => $::locale->text('Delivery Plan for currently outstanding sales orders'),
-    title                => $::locale->text('Delivery Plan'),
+    raw_top_info_text     => $self->render('delivery_plan/report_top',    { output => 0 }),
+    raw_bottom_info_text  => $self->render('delivery_plan/report_bottom', { output => 0 }, models => $self->models),
   );
-  $report->set_options_from_form;
-
-  SL::DB::Manager::OrderItem->disable_paginating(args => $params{db_args}) if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
-
-  $self->{report_data} = {
-    column_defs => \%column_defs,
-    columns     => \@columns,
-    visible     => \@visible,
-    sortable    => \@sortable,
-  };
-}
-
-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;
 }
 
 sub make_filter_summary {
@@ -220,24 +167,25 @@ sub make_filter_summary {
   my @filter_strings;
 
   my @filters = (
-    [ $filter->{order}{"ordnumber:substr::ilike"}, $::locale->text('Number') ],
-    [ $filter->{part}{"partnumber:substr::ilike"}, $::locale->text('Part Number') ],
-    [ $filter->{"description:substr::ilike"}, $::locale->text('Part Description') ],
-    [ $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}{customer}{"name:substr::ilike"}, $::locale->text('Customer') ],
-    [ $filter->{order}{customer}{"customernumber:substr::ilike"}, $::locale->text('Customer Number') ],
+    [ $filter->{order}{"ordnumber:substr::ilike"},                $::locale->text('Number')                                             ],
+    [ $filter->{part}{"partnumber:substr::ilike"},                $::locale->text('Part Number')                                        ],
+    [ $filter->{"description:substr::ilike"},                     $::locale->text('Part Description')                                   ],
+    [ $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}{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];
@@ -246,6 +194,24 @@ sub make_filter_summary {
   $self->{filter_summary} = join ', ', @filter_strings;
 }
 
+sub init_models {
+  my ($self) = @_;
+
+  SL::Controller::Helper::GetModels->new(
+    controller   => $self,
+    model        => 'OrderItem',
+    sorted       => {
+      _default     => {
+        by           => 'reqdate',
+        dir          => 1,
+      },
+      %sort_columns,
+    },
+    query        => $delivery_plan_query,
+    with_objects => [ 'order', 'order.customer', 'part' ],
+  );
+}
+
 sub link_to {
   my ($self, $object, %params) = @_;
 
@@ -265,49 +231,8 @@ sub link_to {
   }
   if ($object->isa('SL::DB::Customer')) {
     my $id     = $object->id;
-    return "ct.pl?action=$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;
-    }
+    return "controller.pl?action=CustomerVendor/$action&id=$id&db=customer";
   }
-
-  if (my $style = delete $filter->{searchstyle}) {
-    $self->{searchstyle}       = $style;
-    $launder_to->{searchstyle} = $style;
-  }
-
-  return $filter;
 }
 
 1;