weitere Methoden aus aus check_objects ausgelagert
[kivitendo-erp.git] / SL / Controller / CsvImport / Order.pm
index 8eebb28..34f0931 100644 (file)
@@ -24,7 +24,7 @@ use parent qw(SL::Controller::CsvImport::BaseMulti);
 
 use Rose::Object::MakeMethods::Generic
 (
- 'scalar --get_set_init' => [ qw(settings languages_by parts_by contacts_by departments_by projects_by ct_shiptos_by taxzones_by price_factors_by pricegroups_by) ],
+ 'scalar --get_set_init' => [ qw(settings languages_by parts_by contacts_by departments_by projects_by ct_shiptos_by taxzones_by price_factors_by pricegroups_by currencies_by) ],
 );
 
 
@@ -46,24 +46,24 @@ sub init_profile {
 
   my $profile = $self->SUPER::init_profile;
 
-  # SUPER::init_profile sets row_ident to the class name
+  # SUPER::init_profile sets row_ident to the translated class name
   # overwrite it with the user specified settings
   foreach my $p (@{ $profile }) {
-    if ($p->{row_ident} eq 'Order') {
-      $p->{row_ident} = $self->settings->{'order_column'};
+    if ($p->{class} eq 'SL::DB::Order') {
+      $p->{row_ident} = $self->_order_column;
     }
-    if ($p->{row_ident} eq 'OrderItem') {
-      $p->{row_ident} = $self->settings->{'item_column'};
+    if ($p->{class} eq 'SL::DB::OrderItem') {
+      $p->{row_ident} = $self->_item_column;
     }
   }
 
   foreach my $p (@{ $profile }) {
     my $prof = $p->{profile};
-    if ($p->{row_ident} eq $self->settings->{'order_column'}) {
+    if ($p->{row_ident} eq $self->_order_column) {
       # no need to handle
       delete @{$prof}{qw(delivery_customer_id delivery_vendor_id proforma quotation amount netamount)};
     }
-    if ($p->{row_ident} eq $self->settings->{'item_column'}) {
+    if ($p->{row_ident} eq $self->_item_column) {
       # no need to handle
       delete @{$prof}{qw(trans_id)};
     }
@@ -78,10 +78,11 @@ sub setup_displayable_columns {
 
   $self->SUPER::setup_displayable_columns;
 
-  $self->add_displayable_columns($self->settings->{'order_column'},
-                                 { name => 'datatype',         description => $::locale->text('Zeilenkennung')                  },
+  $self->add_displayable_columns($self->_order_column,
+                                 { name => 'datatype',         description => $self->_order_column                              },
                                  { name => 'closed',           description => $::locale->text('Closed')                         },
-                                 { name => 'curr',             description => $::locale->text('Currency')                       },
+                                 { name => 'currency',         description => $::locale->text('Currency')                       },
+                                 { name => 'currency_id',      description => $::locale->text('Currency (database ID)')         },
                                  { name => 'cusordnumber',     description => $::locale->text('Customer Order Number')          },
                                  { name => 'delivered',        description => $::locale->text('Delivered')                      },
                                  { name => 'employee_id',      description => $::locale->text('Employee (database ID)')         },
@@ -122,8 +123,8 @@ sub setup_displayable_columns {
                                  { name => 'shipto_id',        description => $::locale->text('Ship to (database ID)')          },
                                 );
 
-  $self->add_displayable_columns($self->settings->{'item_column'},
-                                 { name => 'datatype',        description => $::locale->text('Zeilenkennung')              },
+  $self->add_displayable_columns($self->_item_column,
+                                 { name => 'datatype',        description => $self->_item_column                           },
                                  { name => 'cusordnumber',    description => $::locale->text('Customer Order Number')      },
                                  { name => 'description',     description => $::locale->text('Description')                },
                                  { name => 'discount',        description => $::locale->text('Discount')                   },
@@ -225,193 +226,132 @@ sub init_pricegroups_by {
   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_pricegroups } } ) } qw(id pricegroup) };
 }
 
+sub init_currencies_by {
+  my ($self) = @_;
+
+  return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $self->all_currencies } } ) } qw(id name) };
+}
+
 sub check_objects {
   my ($self) = @_;
 
   $self->controller->track_progress(phase => 'building data', progress => 0);
 
-  my $i;
+  my $i = 0;
   my $num_data = scalar @{ $self->controller->data };
   foreach my $entry (@{ $self->controller->data }) {
     $self->controller->track_progress(progress => $i/$num_data * 100) if $i % 100 == 0;
 
-    if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
-
-      my $vc_obj;
-      if (any { $entry->{raw_data}->{$_} } qw(customer customernumber customer_id)) {
-        $self->check_vc($entry, 'customer_id');
-        $vc_obj = SL::DB::Customer->new(id => $entry->{object}->customer_id)->load if $entry->{object}->customer_id;
-      } elsif (any { $entry->{raw_data}->{$_} } qw(vendor vendornumber vendor_id)) {
-        $self->check_vc($entry, 'vendor_id');
-        $vc_obj = SL::DB::Vendor->new(id => $entry->{object}->vendor_id)->load if $entry->{object}->vendor_id;
-      } else {
-        push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor missing');
-      }
-
-      $self->check_contact($entry);
-      $self->check_language($entry);
-      $self->check_payment($entry);
-      $self->check_department($entry);
-      $self->check_project($entry, global => 1);
-      $self->check_ct_shipto($entry);
-      $self->check_taxzone($entry);
-
-      if ($vc_obj) {
-        # copy from customer if not given
-        foreach (qw(payment_id language_id taxzone_id)) {
-          $entry->{object}->$_($vc_obj->$_) unless $entry->{object}->$_;
-        }
-      }
-
-      # ToDo: salesman and emloyee by name
-      # salesman from customer or login if not given
-      if (!$entry->{object}->salesman) {
-        if ($vc_obj && $vc_obj->salesman_id) {
-          $entry->{object}->salesman(SL::DB::Manager::Employee->find_by(id => $vc_obj->salesman_id));
-        } else {
-          $entry->{object}->salesman(SL::DB::Manager::Employee->find_by(login => $::myconfig{login}));
-        }
-      }
-
-      # employee from login if not given
-      if (!$entry->{object}->employee_id) {
-        $entry->{object}->employee_id(SL::DB::Manager::Employee->find_by(login => $::myconfig{login})->id);
-      }
-
+    if ($entry->{raw_data}->{datatype} eq $self->_order_column) {
+      $self->handle_order($entry);
+    } elsif ($entry->{raw_data}->{datatype} eq $self->_item_column && $entry->{object}->can('part')) {
+      $self->handle_item($entry);
     }
+
+  } continue {
+    $i++;
   }
 
-  $self->add_info_columns($self->settings->{'order_column'},
+  $self->add_info_columns($self->_order_column,
                           { header => $::locale->text('Customer/Vendor'), method => 'vc_name' });
   # Todo: access via ->[0] ok? Better: search first order column and use this
-  $self->add_columns($self->settings->{'order_column'},
-                     map { "${_}_id" } grep { exists $self->controller->data->[0]->{raw_data}->{$_} } qw(payment language department globalproject taxzone cp));
-  $self->add_columns($self->settings->{'order_column'}, 'globalproject_id') if exists $self->controller->data->[0]->{raw_data}->{globalprojectnumber};
-  $self->add_columns($self->settings->{'order_column'}, 'cp_id')            if exists $self->controller->data->[0]->{raw_data}->{contact};
-
-  foreach my $entry (@{ $self->controller->data }) {
-    if ($entry->{raw_data}->{datatype} eq $self->settings->{'item_column'} && $entry->{object}->can('part')) {
-
-      next if !$self->check_part($entry);
-
-      my $part_obj = SL::DB::Part->new(id => $entry->{object}->parts_id)->load;
-
-      # copy from part if not given
-      $entry->{object}->description($part_obj->description) unless $entry->{object}->description;
-      $entry->{object}->longdescription($part_obj->notes)   unless $entry->{object}->longdescription;
-      $entry->{object}->unit($part_obj->unit)               unless $entry->{object}->unit;
+  $self->add_columns($self->_order_column,
+                     map { "${_}_id" } grep { exists $self->controller->data->[0]->{raw_data}->{$_} } qw(payment language department globalproject taxzone cp currency));
+  $self->add_columns($self->_order_column, 'globalproject_id') if exists $self->controller->data->[0]->{raw_data}->{globalprojectnumber};
+  $self->add_columns($self->_order_column, 'cp_id')            if exists $self->controller->data->[0]->{raw_data}->{contact};
 
-      # set to 0 if not given
-      $entry->{object}->discount(0)      unless $entry->{object}->discount;
-      $entry->{object}->ship(0)          unless $entry->{object}->ship;
-
-      $self->check_project($entry, global => 0);
-      $self->check_price_factor($entry);
-      $self->check_pricegroup($entry);
-    }
-  }
-
-  $self->add_info_columns($self->settings->{'item_column'},
+  $self->add_info_columns($self->_item_column,
                           { header => $::locale->text('Part Number'), method => 'partnumber' });
   # Todo: access via ->[1] ok? Better: search first item column and use this
-  $self->add_columns($self->settings->{'item_column'},
+  $self->add_columns($self->_item_column,
                      map { "${_}_id" } grep { exists $self->controller->data->[1]->{raw_data}->{$_} } qw(project price_factor pricegroup));
-  $self->add_columns($self->settings->{'item_column'}, 'project_id') if exists $self->controller->data->[1]->{raw_data}->{projectnumber};
+  $self->add_columns($self->_item_column, 'project_id') if exists $self->controller->data->[1]->{raw_data}->{projectnumber};
 
-  # add orderitems to order
-  my $order_entry;
-  my @orderitems;
-  foreach my $entry (@{ $self->controller->data }) {
-    # search first Order
-    if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
 
-      # new order entry: add collected orderitems to the last one
-      if (defined $order_entry) {
-        $order_entry->{object}->orderitems(@orderitems);
-        @orderitems = ();
-      }
+  $self->add_items_to_order();
+  $self->handle_prices_and_taxes();
 
-      $order_entry = $entry;
 
-    } elsif ( defined $order_entry && $entry->{raw_data}->{datatype} eq $self->settings->{'item_column'} ) {
-      # collect orderitems to add to order (if they have no errors)
-      # ( add_orderitems does not work here if we want to call
-      #   calculate_prices_and_taxes afterwards ...
-      #   so collect orderitems and add them at once)
-      if (scalar @{ $entry->{errors} } == 0) {
-        push @orderitems, $entry->{object};
-      }
+  # If order has errors set error for orderitems as well
+  my $order_entry;
+  foreach my $entry (@{ $self->controller->data }) {
+    # Search first order
+    if ($entry->{raw_data}->{datatype} eq $self->_order_column) {
+      $order_entry = $entry;
+    } elsif ( defined $order_entry
+              && $entry->{raw_data}->{datatype} eq $self->_item_column
+              && scalar @{ $order_entry->{errors} } > 0 ) {
+      push @{ $entry->{errors} }, $::locale->text('order not valid for this orderitem!');
     }
   }
-  # add last collected orderitems to last order
-  if ($order_entry) {
-    $order_entry->{object}->orderitems(@orderitems);
-  }
 
-  # calculate prices and taxes
-  foreach my $entry (@{ $self->controller->data }) {
-    next if @{ $entry->{errors} };
+}
 
-    if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
+sub handle_order {
+  my ($self, $entry) = @_;
 
-      $entry->{object}->calculate_prices_and_taxes;
+  my $object = $entry->{object};
 
-      $entry->{info_data}->{calc_amount}    = $entry->{object}->amount_as_number;
-      $entry->{info_data}->{calc_netamount} = $entry->{object}->netamount_as_number;
+  my $vc_obj;
+  if (any { $entry->{raw_data}->{$_} } qw(customer customernumber customer_id)) {
+    $self->check_vc($entry, 'customer_id');
+    $vc_obj = SL::DB::Customer->new(id => $object->customer_id)->load if $object->customer_id;
+  } elsif (any { $entry->{raw_data}->{$_} } qw(vendor vendornumber vendor_id)) {
+    $self->check_vc($entry, 'vendor_id');
+    $vc_obj = SL::DB::Vendor->new(id => $object->vendor_id)->load if $object->vendor_id;
+  } else {
+    push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor missing');
+  }
+
+  $self->check_contact($entry);
+  $self->check_language($entry);
+  $self->check_payment($entry);
+  $self->check_department($entry);
+  $self->check_project($entry, global => 1);
+  $self->check_ct_shipto($entry);
+  $self->check_taxzone($entry);
+  $self->check_currency($entry);
+
+  if ($vc_obj) {
+    # copy from customer if not given
+    foreach (qw(payment_id language_id taxzone_id currency_id)) {
+      $object->$_($vc_obj->$_) unless $object->$_;
     }
   }
 
-  # If amounts are given, show calculated amounts as info and given amounts (verify_xxx).
-  # And throw an error if the differences are too big.
-  my @to_verify = ( { column      => 'amount',
-                      raw_column  => 'verify_amount',
-                      info_header => 'Calc. Amount',
-                      info_method => 'calc_amount',
-                      err_msg     => 'Amounts differ too much',
-                    },
-                    { column      => 'netamount',
-                      raw_column  => 'verify_netamount',
-                      info_header => 'Calc. Net amount',
-                      info_method => 'calc_netamount',
-                      err_msg     => 'Net amounts differ too much',
-                    } );
+  $self->handle_salesman($entry);
+  $self->handle_employee($entry);
+}
 
-  foreach my $tv (@to_verify) {
-    # Todo: access via ->[0] ok? Better: search first order column and use this
-    if (exists $self->controller->data->[0]->{raw_data}->{ $tv->{raw_column} }) {
-      $self->add_raw_data_columns($self->settings->{'order_column'}, $tv->{raw_column});
-      $self->add_info_columns($self->settings->{'order_column'},
-                              { header => $::locale->text($tv->{info_header}), method => $tv->{info_method} });
-    }
+# ToDo: salesman by name
+sub handle_salesman {
+  my ($self, $entry) = @_;
 
-    # check differences
-    foreach my $entry (@{ $self->controller->data }) {
-      next if @{ $entry->{errors} };
-      if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
-        next if !$entry->{raw_data}->{ $tv->{raw_column} };
-        my $parsed_value = $::form->parse_amount(\%::myconfig, $entry->{raw_data}->{ $tv->{raw_column} });
-        if (abs($entry->{object}->${ \$tv->{column} } - $parsed_value) > $self->settings->{'max_amount_diff'}) {
-          push @{ $entry->{errors} }, $::locale->text($tv->{err_msg});
-        }
-      }
+  my $object = $entry->{object};
+  my $vc_obj = SL::DB::Customer->new(id => $object->customer_id)->load if $object->customer_id;
+  $vc_obj    = SL::DB::Vendor->new(id   => $object->vendor_id)->load   if (!$vc_obj && $object->vendor_id);
+
+  # salesman from customer/vendor or login if not given
+  if (!$object->salesman) {
+    if ($vc_obj && $vc_obj->salesman_id) {
+      $object->salesman(SL::DB::Manager::Employee->find_by(id => $vc_obj->salesman_id));
+    } else {
+      $object->salesman(SL::DB::Manager::Employee->find_by(login => $::myconfig{login}));
     }
   }
+}
 
-  # If order has errors set error for orderitems as well
-  my $order_entry;
-  foreach my $entry (@{ $self->controller->data }) {
-    # Search first order
-    if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
-      $order_entry = $entry;
-    } elsif ( defined $order_entry
-              && $entry->{raw_data}->{datatype} eq $self->settings->{'item_column'}
-              && scalar @{ $order_entry->{errors} } > 0 ) {
-      push @{ $entry->{errors} }, $::locale->text('order not valid for this orderitem!');
-    }
-  }
+# ToDo: employee by name
+sub handle_employee {
+  my ($self, $entry) = @_;
 
-}
+  my $object = $entry->{object};
 
+  # employee from login if not given
+  if (!$object->employee_id) {
+    $object->employee_id(SL::DB::Manager::Employee->find_by(login => $::myconfig{login})->id);
+  }
+}
 
 sub check_language {
   my ($self, $entry) = @_;
@@ -444,6 +384,28 @@ sub check_language {
   return 1;
 }
 
+sub handle_item {
+  my ($self, $entry) = @_;
+
+  my $object = $entry->{object};
+  return unless $self->check_part($entry);
+
+  my $part_obj = SL::DB::Part->new(id => $object->parts_id)->load;
+
+  # copy from part if not given
+  $object->description($part_obj->description) unless $object->description;
+  $object->longdescription($part_obj->notes)   unless $object->longdescription;
+  $object->unit($part_obj->unit)               unless $object->unit;
+
+  # set to 0 if not given
+  $object->discount(0) unless $object->discount;
+  $object->ship(0)     unless $object->ship;
+
+  $self->check_project($entry, global => 0);
+  $self->check_price_factor($entry);
+  $self->check_pricegroup($entry);
+}
+
 sub check_part {
   my ($self, $entry) = @_;
 
@@ -615,7 +577,6 @@ sub check_taxzone {
   return 1;
 }
 
-
 sub check_price_factor {
   my ($self, $entry) = @_;
 
@@ -666,6 +627,114 @@ sub check_pricegroup {
   return 1;
 }
 
+sub check_currency {
+  my ($self, $entry) = @_;
+
+  my $object = $entry->{object};
+
+  # Check whether or not currency ID is valid.
+  if ($object->currency_id && !$self->currencies_by->{id}->{ $object->currency_id }) {
+    push @{ $entry->{errors} }, $::locale->text('Error: Invalid currency');
+    return 0;
+  }
+
+  # Map name to ID if given.
+  if (!$object->currency_id && $entry->{raw_data}->{currency}) {
+    my $currency = $self->currencies_by->{name}->{  $entry->{raw_data}->{currency} };
+    if (!$currency) {
+      push @{ $entry->{errors} }, $::locale->text('Error: Invalid currency');
+      return 0;
+    }
+
+    $object->currency_id($currency->id);
+  }
+
+  return 1;
+}
+
+sub add_items_to_order {
+  my ($self) = @_;
+
+  # add orderitems to order
+  my $order_entry;
+  my @orderitems;
+  foreach my $entry (@{ $self->controller->data }) {
+    # search first order
+    if ($entry->{raw_data}->{datatype} eq $self->_order_column) {
+
+      # new order entry: add collected orderitems to the previous one
+      if (defined $order_entry) {
+        $order_entry->{object}->orderitems(@orderitems);
+        @orderitems = ();
+      }
+
+      $order_entry = $entry;
+
+    } elsif ( defined $order_entry && $entry->{raw_data}->{datatype} eq $self->_item_column ) {
+      # collect orderitems to add to order (if they have no errors)
+      # ( add_orderitems does not work here if we want to call
+      #   calculate_prices_and_taxes afterwards ...
+      #   so collect orderitems and add them at once )
+      push @orderitems, $entry->{object} if (scalar @{ $entry->{errors} } == 0);
+    }
+  }
+  # add last collected orderitems to last order
+  $order_entry->{object}->orderitems(@orderitems) if $order_entry;
+}
+
+sub handle_prices_and_taxes() {
+  my ($self) = @_;
+
+  # calculate prices and taxes
+  foreach my $entry (@{ $self->controller->data }) {
+    next if @{ $entry->{errors} };
+
+    if ($entry->{raw_data}->{datatype} eq $self->_order_column) {
+
+      $entry->{object}->calculate_prices_and_taxes;
+
+      $entry->{info_data}->{calc_amount}    = $entry->{object}->amount_as_number;
+      $entry->{info_data}->{calc_netamount} = $entry->{object}->netamount_as_number;
+    }
+  }
+
+  # If amounts are given, show calculated amounts as info and given amounts (verify_xxx).
+  # And throw an error if the differences are too big.
+  my @to_verify = ( { column      => 'amount',
+                      raw_column  => 'verify_amount',
+                      info_header => 'Calc. Amount',
+                      info_method => 'calc_amount',
+                      err_msg     => 'Amounts differ too much',
+                    },
+                    { column      => 'netamount',
+                      raw_column  => 'verify_netamount',
+                      info_header => 'Calc. Net amount',
+                      info_method => 'calc_netamount',
+                      err_msg     => 'Net amounts differ too much',
+                    } );
+
+  foreach my $tv (@to_verify) {
+    # Todo: access via ->[0] ok? Better: search first order column and use this
+    if (exists $self->controller->data->[0]->{raw_data}->{ $tv->{raw_column} }) {
+      $self->add_raw_data_columns($self->_order_column, $tv->{raw_column});
+      $self->add_info_columns($self->_order_column,
+                              { header => $::locale->text($tv->{info_header}), method => $tv->{info_method} });
+    }
+
+    # check differences
+    foreach my $entry (@{ $self->controller->data }) {
+      next if @{ $entry->{errors} };
+      if ($entry->{raw_data}->{datatype} eq $self->_order_column) {
+        next if !$entry->{raw_data}->{ $tv->{raw_column} };
+        my $parsed_value = $::form->parse_amount(\%::myconfig, $entry->{raw_data}->{ $tv->{raw_column} });
+        if (abs($entry->{object}->${ \$tv->{column} } - $parsed_value) > $self->settings->{'max_amount_diff'}) {
+          push @{ $entry->{errors} }, $::locale->text($tv->{err_msg});
+        }
+      }
+    }
+  }
+
+}
 
 sub save_objects {
   my ($self, %params) = @_;
@@ -675,7 +744,7 @@ sub save_objects {
   foreach my $entry (@{ $self->controller->data }) {
     next if @{ $entry->{errors} };
 
-    if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'} && !$entry->{object}->ordnumber) {
+    if ($entry->{raw_data}->{datatype} eq $self->_order_column && !$entry->{object}->ordnumber) {
       my $number = SL::TransNumber->new(type        => 'sales_order',
                                         save        => 1);
       $entry->{object}->ordnumber($number->create_unique());
@@ -687,5 +756,12 @@ sub save_objects {
   $self->SUPER::save_objects(data => $objects_to_save);
 }
 
+sub _order_column {
+  $_[0]->settings->{'order_column'}
+}
+
+sub _item_column {
+  $_[0]->settings->{'item_column'}
+}
 
 1;