Sprache auf ungültig setzen im Admin-Bereich
[kivitendo-erp.git] / SL / Controller / FinancialControllingReport.pm
index 7a62b62..f4f09ff 100644 (file)
@@ -3,89 +3,59 @@ package SL::Controller::FinancialControllingReport;
 use strict;
 use parent qw(SL::Controller::Base);
 
-use List::Util qw(sum);
+use List::Util qw(max min sum);
 
 use SL::DB::Order;
+use SL::DB::ProjectType;
 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 Rose::Object::MakeMethods::Generic (
-  scalar => [ qw(db_args flat_filter) ],
+  scalar                  => [ qw(orders) ],
+  'scalar --get_set_init' => [ qw(project_types models) ],
 );
 
 __PACKAGE__->run_before(sub { $::auth->assert('sales_order_edit'); });
 
-__PACKAGE__->get_models_url_params('flat_filter');
-__PACKAGE__->make_paginated(
-  MODEL         => 'Order',
-  PAGINATE_ARGS => 'db_args',
-  ONLY          => [ qw(list) ],
-);
-
-__PACKAGE__->make_sorted(
-  MODEL                   => 'Order',
-  ONLY                    => [ qw(list) ],
-
-  DEFAULT_BY              => 'transdate',
-  DEFAULT_DIR             => 1,
-
-  transdate               => t8('Order Date'),
+my %sort_columns = (
   ordnumber               => t8('Order'),
   customer                => t8('Customer'),
   transaction_description => t8('Transaction description'),
   globalprojectnumber     => t8('Project'),
-  netamount               => t8('Order amount'),
+  globalproject_type      => t8('Project Type'),
 );
 
 sub action_list {
   my ($self) = @_;
 
-  $self->db_args($self->setup_db_args_for_list(filter => $::form->{filter}));
-  $self->flat_filter({ map { $_->{key} => $_->{value} } $::form->flatten_variables('filter') });
   $self->make_filter_summary;
 
   $self->prepare_report;
 
-  $self->{orders} = $self->get_models(%{ $self->db_args });
+  $self->orders($self->models->get);
 
   $self->calculate_data;
 
+  $self->setup_list_action_bar;
   $self->list_objects;
 }
 
 # private functions
 
-sub setup_db_args_for_list {
-  my ($self) = @_;
-
-  $self->{filter} = {};
-  my %args     = ( parse_filter($::form->{filter}, with_objects => [ 'customer', 'globalproject' ], launder_to => $self->{filter}));
-  $args{query} = [
-    @{ $args{query} || [] },
-    SL::DB::Manager::Order->type_filter('sales_order'),
-  ];
-
-  return \%args;
-}
-
 sub prepare_report {
   my ($self)      = @_;
 
   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
   $self->{report} = $report;
 
-  my @columns     = qw(customer globalprojectnumber ordnumber transdate netamount delivered_amount delivered_amount_p billed_amount billed_amount_p paid_amount paid_amount_p
-                       billable_amount billable_amount_p other_amount open_amount transaction_description);
-  my @sortable    = qw(ordnumber transdate customer netamount globalprojectnumber);
-  $self->{number_columns} = [ qw(netamount billed_amount billed_amount_p delivered_amount delivered_amount_p paid_amount paid_amount_p open_amount other_amount billable_amount billable_amount_p) ];
+  my @columns     = qw(customer globalprojectnumber globalproject_type transaction_description ordnumber net_amount delivered_amount delivered_amount_p billed_amount billed_amount_p paid_amount paid_amount_p
+                       billable_amount billable_amount_p other_amount);
+  my @sortable    = qw(ordnumber transdate customer globalprojectnumber globalproject_type transaction_description );
+  $self->{number_columns} = [ qw(net_amount billed_amount billed_amount_p delivered_amount delivered_amount_p paid_amount paid_amount_p other_amount billable_amount billable_amount_p) ];
 
   my %column_defs           = (
-    transdate               => {      sub => sub { $_[0]->transdate_as_date                                           }  },
-    netamount               => {                                                                                         },
+    net_amount              => { text     => $::locale->text('Order amount')                                             },
     billed_amount           => { text     => $::locale->text('Billed amount')                                            },
     billed_amount_p         => { text     => $::locale->text('%')                                                        },
     delivered_amount        => { text     => $::locale->text('Delivered amount')                                         },
@@ -94,25 +64,25 @@ sub prepare_report {
     paid_amount_p           => { text     => $::locale->text('%')                                                        },
     billable_amount         => { text     => $::locale->text('Billable amount')                                          },
     billable_amount_p       => { text     => $::locale->text('%')                                                        },
-    open_amount             => { text     => $::locale->text('Bills receivable')                                         },
     other_amount            => { text     => $::locale->text('Billed extra expenses')                                    },
-    transaction_description => {                                                                                         },
+    transaction_description => { text     => $::locale->text('Transaction description')                                  },
     ordnumber               => { obj_link => sub { $self->link_to($_[0])                                              }  },
     customer                => {      sub => sub { $_[0]->customer->name                                              },
                                  obj_link => sub { $self->link_to($_[0]->customer)                                    }  },
-    globalprojectnumber     => {      sub => sub { $_[0]->globalproject_id ? $_[0]->globalproject->projectnumber : '' }  },
+    globalprojectnumber     => {      sub => sub { $_[0]->globalproject_id ? $_[0]->globalproject->projectnumber : '' },
+                                 obj_link => sub { $self->link_to($_[0]->globalproject)                               }  },
+    globalproject_type      => { text     => $::locale->text('Project type'),
+                                 sub      => sub { $_[0]->globalproject_id ? $_[0]->globalproject->project_type->description : '' }  },
   );
 
-  map { $column_defs{$_}->{text} ||= $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
-  map { $column_defs{$_}->{align} = 'right' } @{ $self->{number_columns} };
+  $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) for keys %column_defs;
+  $column_defs{$_}->{align}  = 'right'                                                        for @{ $self->{number_columns} };
 
   $report->set_options(
     std_column_visibility => 1,
-    controller_class      => 'FinancialControlling',
+    controller_class      => 'FinancialControllingReport',
     output_format         => 'HTML',
     top_info_text         => $::locale->text('Financial controlling report for open sales orders'),
-    raw_top_info_text     => $self->render('financial_controlling_report/report_top',    { no_output => 1, partial => 1 }),
-    raw_bottom_info_text  => $self->render('financial_controlling_report/report_bottom', { no_output => 1, partial => 1 }),
     title                 => $::locale->text('Financial Controlling Report'),
     allow_pdf_export      => 1,
     allow_csv_export      => 1,
@@ -121,46 +91,82 @@ sub prepare_report {
   $report->set_column_order(@columns);
   $report->set_export_options(qw(list filter));
   $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,
-  };
+  $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
+  $self->models->finalize;
+  $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
+  $report->set_options(
+    raw_top_info_text     => $self->render('financial_controlling_report/report_top',    { output => 0 }),
+    raw_bottom_info_text  => $self->render('financial_controlling_report/report_bottom', { output => 0 }, models => $self->models),
+  );
 }
 
 sub calculate_data {
   my ($self) = @_;
 
-  foreach my $order (@{ $self->{orders} }) {
-    my $delivery_orders = $order->linked_records(direction => 'to', to => 'DeliveryOrder', via => 'Order', query => [ '!customer_id' => undef ]);
-    my $invoices        = $order->linked_records(direction => 'to', to => 'Invoice',       via => [ 'Order', 'DeliveryOrder' ]);
+  foreach my $order (@{ $self->orders }) {
+    my @delivery_orders = @{ $order->linked_records(direction => 'to', to => 'DeliveryOrder', via => 'Order', query => [ '!customer_id' => undef ]) };
+    my @invoices        = @{ $order->linked_records(direction => 'to', to => 'Invoice',       via => [ 'Order', 'DeliveryOrder' ])                  };
+
+    @invoices = (
+      grep({ !$_->storno_id } @invoices),
+      map({ @{ $_->storno_invoices } } grep { $_->storno && !$_->storno_id } @invoices),
+    );
 
-    $order->{delivered_amount}  = sum map { $self->sum_relevant_items(order => $order, other => $_, by_order => 1) } @{ $delivery_orders };
-    $order->{billed_amount}     = sum map { $self->sum_relevant_items(order => $order, other => $_)                } @{ $invoices        };
-    $order->{paid_amount}       = sum map { $_->paid                                                               } @{ $invoices        };
-    my $billed_amount           = sum map { $_->netamount                                                          } @{ $invoices        };
+    $order->{delivered_amount}  = sum(map { $self->sum_relevant_items(order => $order, other => $_, by_order => 1)    } @delivery_orders) // 0;
+    $order->{billed_amount}     = sum(map { $self->sum_relevant_items(order => $order, other => $_)                   } @invoices)        // 0;
+    $order->{paid_amount}       = sum(map { $_->paid * $_->netamount / (($_->amount * 1) || ($_->netamount * 1) || 1) } @invoices)        // 0;
+    my $billed_amount           = sum(map { $_->netamount                                                             } @invoices)        // 0;
     $order->{other_amount}      = $billed_amount             - $order->{billed_amount};
     $order->{billable_amount}   = $order->{delivered_amount} - $order->{billed_amount};
-    $order->{open_amount}       = $billed_amount             - $order->{paid_amount  };
+
+    if ($order->periodic_invoices_config) {
+      $order->{net_amount} = $self->calculate_periodic_invoices_order_netamount($order);
+
+    } else {
+      $order->{net_amount} = $order->netamount;
+    }
 
     foreach (qw(delivered billed paid billable)) {
-      $order->{"${_}_amount_p"} = $order->netamount * 1 ? $order->{"${_}_amount"} * 100 / $order->netamount : undef;
+      $order->{"${_}_amount_p"} = $order->{net_amount} * 1 ? $order->{"${_}_amount"} * 100 / $order->{net_amount} : undef;
     }
   }
 }
 
+sub calculate_periodic_invoices_order_netamount {
+  my ($self, $order) = @_;
+
+  my $year       = DateTime->today_local->year;
+  my $year_start = DateTime->new_local(day =>  1, month =>  1, year => $year);
+  my $year_end   = DateTime->new_local(day => 31, month => 12, year => $year);
+
+  my $cfg        = $order->periodic_invoices_config;
+  my $period_len = $cfg->get_billing_period_length;
+  my $num_months = 0;
+  my $cur_date   = $cfg->start_date->clone;
+  my $end_date   = $cfg->terminated ? $cfg->end_date : undef;
+  $end_date    //= $year_end;
+  $end_date      = min $end_date, $year_end;
+
+  while ($cur_date <= $end_date) {
+    $num_months += $period_len if $cur_date >= $year_start;
+    $cur_date->add(months => $period_len);
+  }
+
+  return $num_months * $order->netamount / $order->periodic_invoices_config->get_order_value_period_length;
+}
+
 sub sum_items {
   my ($self, %params) = @_;
 
   my %vals;
 
   foreach my $item (@{ $params{obj}->items }) {
-    $vals{$item->parts_id}            ||= { parts_id => $item->parts_id, amount => 0, base_qty => 0 };
-    $vals{$item->parts_id}->{amount}   += $item->qty * $item->sellprice * (1 - $item->discount) / (($item->price_factor * 1) || 1);
-    $vals{$item->parts_id}->{base_qty} += $item->qty * $item->unit_obj->base_factor;
+    my $key  = $item->parts_id;
+    $key    .= ':' . $item->serialnumber if $item->serialnumber;
+
+    $vals{$key}            ||= { parts_id => $item->parts_id, serialnumber => $item->serialnumber, amount => 0, base_qty => 0 };
+    $vals{$key}->{amount}   += $item->qty * $item->sellprice * (1 - $item->discount) / (($item->price_factor * 1) || 1);
+    $vals{$key}->{base_qty} += $item->qty * $item->unit_obj->base_factor;
   }
 
   return \%vals;
@@ -174,12 +180,19 @@ sub sum_relevant_items {
   my $total                               = 0;
 
   foreach my $item (grep { $params{order}->{amounts_by_parts_id}->{ $_->{parts_id} } } values %{ $sums }) {
-    my $order_item = $params{order}->{amounts_by_parts_id}->{ $item->{parts_id} };
-    if ($params{by_order} && $order_item->{base_qty}) {
-      $total += $order_item->{amount} * $item->{base_qty} / $order_item->{base_qty};
-    } else {
-      $total += $item->{amount};
+    my $key = $item->{parts_id};
+
+    if ($params{by_order}) {
+      $key           .= ':' . $item->{serialnumber};
+      my $order_item  = $params{order}->{amounts_by_parts_id}->{ $key } || $params{order}->{amounts_by_parts_id}->{ $item->{parts_id} };
+
+      if ($order_item && $order_item->{base_qty}) {
+        $total += $order_item->{amount} * $item->{base_qty} / $order_item->{base_qty};
+        next;
+      }
     }
+
+    $total += $item->{amount};
   }
 
   return $total;
@@ -187,25 +200,13 @@ sub sum_relevant_items {
 
 sub list_objects {
   my ($self)      = @_;
-  my $column_defs = $self->{report_data}->{column_defs};
-
-  for my $obj (@{ $self->{orders} || [] }) {
-    my %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} || {} };
-
-    map { $data{$_}->{data} = defined $data{$_}->{data} ? int($data{$_}->{data}) : ''    } grep {  m/_p$/ } @{ $self->{number_columns} };
-    map { $data{$_}->{data} = $::form->format_amount(\%::myconfig, $data{$_}->{data}, 2) } grep { !m/_p$/ } @{ $self->{number_columns} };
-
-    $self->{report}->add_data(\%data);
-  }
+  my $modify_data = sub {
+    my ($data) = @_;
+    $data->{$_}->{data} = defined $data->{$_}->{data} ? int($data->{$_}->{data}) : ''  for grep {  m/_p$/ } @{ $self->{number_columns} };
+    $data->{$_}->{data} = $::form->format_amount(\%::myconfig, $data->{$_}->{data}, 2) for grep { !m/_p$/ } @{ $self->{number_columns} };
+  };
 
-  return $self->{report}->generate_with_headers;
+  return $self->report_generator_list_objects(report => $self->{report}, objects => $self->orders, data_callback => $modify_data);
 }
 
 sub make_filter_summary {
@@ -225,6 +226,48 @@ sub make_filter_summary {
   $self->{filter_summary} = join ', ', @filter_strings;
 }
 
+sub init_project_types { SL::DB::Manager::ProjectType->get_all_sorted }
+
+sub init_models {
+  my ($self) = @_;
+
+  SL::Controller::Helper::GetModels->new(
+    controller   => $self,
+    model        => 'Order',
+    sorted       => {
+      _default     => {
+        by           => 'globalprojectnumber',
+        dir          => 1,
+      },
+      %sort_columns,
+    },
+    query => [
+      SL::DB::Manager::Order->type_filter('sales_order'),
+      '!closed' => 1,
+      (salesman_id => SL::DB::Manager::Employee->current->id) x !$::auth->assert('sales_all_edit', 1),
+      or        => [
+        globalproject_id => undef,
+        and              => [
+          'globalproject.active' => 1,
+          'globalproject.valid'  => 1,
+        ]],
+      # keine WR
+      # oder aber (WR aktiv und (kein enddatum oder enddatum noch nicht überschritten))
+      or => [
+        'periodic_invoices_config.id' => undef,
+        # and => [
+          'periodic_invoices_config.active' => 1,
+        #   or => [
+        #     'periodic_invoices_config.end_date' => undef,
+        #     'periodic_invoices_config.end_date' => { le => DateTime->today_local },
+        # ]
+        # ]
+      ],
+    ],
+    with_objects => [ 'customer', 'globalproject', 'globalproject.project_type', 'periodic_invoices_config' ],
+  );
+}
+
 sub link_to {
   my ($self, $object, %params) = @_;
 
@@ -235,11 +278,33 @@ sub link_to {
     my $type = $object->type;
     my $id   = $object->id;
 
-    return "oe.pl?action=$action&type=$type&vc=customer&id=$id";
+    if ($::instance_conf->get_feature_experimental_order) {
+      return "controller.pl?action=Order/$action&type=$type&id=$id";
+    } else {
+      return "oe.pl?action=$action&type=$type&vc=customer&id=$id";
+    }
   }
   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";
+  }
+  if ($object->isa('SL::DB::Project')) {
+    my $id     = $object->id;
+    return "controller.pl?action=Project/$action&id=$id";
+  }
+}
+
+sub setup_list_action_bar {
+  my ($self, %params) = @_;
+
+  for my $bar ($::request->layout->get('actionbar')) {
+    $bar->add(
+      action => [
+        t8('Update'),
+        submit    => [ '#filter_form', { action => 'FinancialControllingReport/list' } ],
+        accesskey => 'enter',
+      ],
+    );
   }
 }