epic-ts
[kivitendo-erp.git] / SL / Controller / CsvImport / CustomerVendor.pm
index e42a93d..4f78721 100644 (file)
@@ -3,18 +3,25 @@ package SL::Controller::CsvImport::CustomerVendor;
 use strict;
 
 use SL::Helper::Csv;
+use SL::Controller::CsvImport::Helper::Consistency;
 use SL::DB::Business;
 use SL::DB::CustomVariable;
 use SL::DB::CustomVariableConfig;
 use SL::DB::PaymentTerm;
+use SL::TransNumber;
 
 use parent qw(SL::Controller::CsvImport::Base);
 
 use Rose::Object::MakeMethods::Generic
 (
- 'scalar --get_set_init' => [ qw(table languages_by businesses_by) ],
+ 'scalar --get_set_init' => [ qw(table languages_by businesses_by salesmen_by) ],
 );
 
+sub set_profile_defaults {
+  my ($self) = @_;
+  $self->controller->profile->_set_defaults(table => 'customer');
+};
+
 sub init_table {
   my ($self) = @_;
   $self->table($self->controller->profile->get('table') eq 'customer' ? 'customer' : 'vendor');
@@ -43,55 +50,85 @@ sub init_languages_by {
   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $self->all_languages } } ) } qw(id description article_code) };
 }
 
+sub init_salesmen_by {
+  my ($self) = @_;
+
+  return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ SL::DB::Manager::Employee->get_all } } ) } qw(id name) };
+}
+
 sub check_objects {
   my ($self) = @_;
 
-  my $numbercolumn  = $self->controller->profile->get('table') . "number";
-  my %vcs_by_number = map { ( $_->$numbercolumn => 1 ) } @{ $self->existing_objects };
+  $self->controller->track_progress(phase => 'building data', progress => 0);
+
+  my $vc            = $self->controller->profile->get('table');
+  my $update_policy = $self->controller->profile->get('update_policy') || 'update_existing';
+  my $numbercolumn  = "${vc}number";
+  my %vcs_by_number = map { ( $_->$numbercolumn => $_ ) } @{ $self->existing_objects };
+  my $methods       = $self->controller->headers->{methods};
 
+  my $i;
+  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;
     my $object = $entry->{object};
 
     $self->check_name($entry);
     $self->check_language($entry);
     $self->check_business($entry);
     $self->check_payment($entry);
+    $self->check_delivery_term($entry);
+    $self->check_taxzone($entry,  take_default => 1);
+    $self->check_currency($entry, take_default => 1);
+    $self->check_salesman($entry);
     $self->handle_cvars($entry);
 
     next if @{ $entry->{errors} };
 
-    if ($vcs_by_number{ $object->$numbercolumn }) {
-      $entry->{object}->$numbercolumn('####');
-    } else {
-      $vcs_by_number{ $object->$numbercolumn } = $object;
-    }
-  }
+    my @cleaned_fields = $self->clean_fields(qr{[\r\n]}, $object, qw(name department_1 department_2 street zipcode city country contact phone fax homepage email cc bcc
+                                                                     taxnumber account_number bank_code bank username greeting taxzone));
 
-  $self->add_columns(map { "${_}_id" } grep { exists $self->controller->data->[0]->{raw_data}->{$_} } qw(language business payment));
-  $self->add_cvar_raw_data_columns;
-}
+    push @{ $entry->{information} }, $::locale->text('Illegal characters have been removed from the following fields: #1', join(', ', @cleaned_fields))
+      if @cleaned_fields;
 
-sub check_duplicates {
-  my ($self, %params) = @_;
+    my $existing_vc = $vcs_by_number{ $object->$numbercolumn };
+    if (!$existing_vc) {
+      $vcs_by_number{ $object->$numbercolumn } = $object if $object->$numbercolumn;
 
-  my $normalizer = sub { my $name = $_[0]; $name =~ s/[\s,\.\-]//g; return $name; };
+    } elsif ($update_policy eq 'skip') {
+      push(@{$entry->{errors}}, $::locale->text('Skipping due to existing entry in database'));
 
-  my %by_name;
-  if ('check_db' eq $self->controller->profile->get('duplicates')) {
-    %by_name = map { ( $normalizer->($_->name) => 'db' ) } @{ $self->existing_objects };
-  }
+    } elsif ($update_policy eq 'update_existing') {
+      # Update existing customer/vendor records.
+      $entry->{object_to_save} = $existing_vc;
 
-  foreach my $entry (@{ $self->controller->data }) {
-    next if @{ $entry->{errors} };
+      $existing_vc->$_( $entry->{object}->$_ ) for @{ $methods }, keys %{ $self->clone_methods };
 
-    my $name = $normalizer->($entry->{object}->name);
-    if (!$by_name{$name}) {
-      $by_name{$name} = 'csv';
+      push @{ $entry->{information} }, $::locale->text('Updating existing entry in database');
 
     } else {
-      push @{ $entry->{errors} }, $by_name{$name} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file');
+      $object->$numbercolumn('####');
     }
+  } continue {
+    $i++;
   }
+
+  $self->add_columns(map { "${_}_id" } grep { exists $self->controller->data->[0]->{raw_data}->{$_} } qw(language business payment delivery_term taxzone));
+  $self->add_cvar_raw_data_columns;
+}
+
+sub get_duplicate_check_fields {
+  return {
+    name => {
+      label     => $::locale->text('Customer Name'),
+      default   => 1,
+      maker     => sub {
+        my $name = shift->name;
+        $name =~ s/[\s,\.\-]//g;
+        return $name;
+      }
+    },
+  };
 }
 
 sub check_name {
@@ -129,6 +166,9 @@ sub check_language {
     }
 
     $object->language_id($language->id);
+
+    # register language_id for method copying later
+    $self->clone_methods->{language_id} = 1;
   }
 
   return 1;
@@ -140,7 +180,7 @@ sub check_business {
   my $object = $entry->{object};
 
   # Check whether or not business ID is valid.
-  if ($object->business_id && !$self->businesss_by->{id}->{ $object->business_id }) {
+  if ($object->business_id && !$self->businesses_by->{id}->{ $object->business_id }) {
     push @{ $entry->{errors} }, $::locale->text('Error: Invalid business');
     return 0;
   }
@@ -155,6 +195,38 @@ sub check_business {
     }
 
     $object->business_id($business->id);
+
+    # register business_id for method copying later
+    $self->clone_methods->{business_id} = 1;
+  }
+
+  return 1;
+}
+
+sub check_salesman {
+  my ($self, $entry) = @_;
+
+  my $object = $entry->{object};
+
+  # Check whether or not salesman ID is valid.
+  if ($object->salesman_id && !$self->salesmen_by->{id}->{ $object->salesman_id }) {
+    push @{ $entry->{errors} }, $::locale->text('Error: Invalid salesman');
+    return 0;
+  }
+
+  # Map name to ID if given.
+  if (!$object->salesman_id && $entry->{raw_data}->{salesman}) {
+    my $salesman = $self->salesmen_by->{name}->{ $entry->{raw_data}->{salesman} };
+
+    if (!$salesman) {
+      push @{ $entry->{errors} }, $::locale->text('Error: Invalid salesman');
+      return 0;
+    }
+
+    $object->salesman_id($salesman->id);
+
+    # register salesman_id for method copying later
+    $self->clone_methods->{salesman_id} = 1;
   }
 
   return 1;
@@ -167,38 +239,29 @@ sub save_objects {
   my $with_number    = [ grep { $_->{object}->$numbercolumn ne '####' } @{ $self->controller->data } ];
   my $without_number = [ grep { $_->{object}->$numbercolumn eq '####' } @{ $self->controller->data } ];
 
-  map { $_->{object}->$numbercolumn('') } @{ $without_number };
+  foreach my $entry (@{$with_number}, @{$without_number}) {
+    my $object = $entry->{object};
+
+    my $number = SL::TransNumber->new(type        => $self->table(),
+                                      number      => $object->$numbercolumn(),
+                                      business_id => $object->business_id(),
+                                      save        => 1);
+
+    if ( $object->$numbercolumn eq '####' || !$number->is_unique() ) {
+      $object->$numbercolumn($number->create_unique());
+    }
+  }
 
   $self->SUPER::save_objects(data => $with_number);
   $self->SUPER::save_objects(data => $without_number);
 }
 
-sub field_lengths {
-  return ( name           => 75,
-           department_1   => 75,
-           department_2   => 75,
-           street         => 75,
-           zipcode        => 10,
-           city           => 75,
-           country        => 75,
-           contact        => 75,
-           phone          => 30,
-           fax            => 30,
-           account_number => 15,
-           bank_code      => 10,
-           language       => 5,
-           username       => 50,
-           ustid          => 14,
-           iban           => 100,
-           bic            => 100,
-         );
-}
-
 sub init_profile {
   my ($self) = @_;
 
   my $profile = $self->SUPER::init_profile;
-  delete @{$profile}{qw(business datevexport language payment salesman salesman_id taxincluded terms)};
+  delete @{$profile}{qw(business datevexport language payment delivery_term taxincluded terms)};
+  delete @{$profile}{qw(salesman salesman_id)}    if $::instance_conf->get_vertreter;
 
   return $profile;
 }
@@ -222,9 +285,13 @@ sub setup_displayable_columns {
                                  { name => 'contact',           description => $::locale->text('Contact')                         },
                                  { name => 'country',           description => $::locale->text('Country')                         },
                                  { name => 'creditlimit',       description => $::locale->text('Credit Limit')                    },
+                                 { name => 'currency',          description => $::locale->text('Currency')                        },
+                                 { name => 'currency_id',       description => $::locale->text('Currency (database ID)')          },
                                  { name => 'customernumber',    description => $::locale->text('Customer Number')                 },
                                  { name => 'department_1',      description => $::locale->text('Department 1')                    },
                                  { name => 'department_2',      description => $::locale->text('Department 2')                    },
+                                 { name => 'delivery_term_id',  description => $::locale->text('Delivery terms (database ID)')    },
+                                 { name => 'delivery_term',     description => $::locale->text('Delivery terms (name)')           },
                                  { name => 'direct_debit',      description => $::locale->text('direct debit')                    },
                                  { name => 'discount',          description => $::locale->text('Discount')                        },
                                  { name => 'email',             description => $::locale->text('E-mail')                          },
@@ -243,15 +310,22 @@ sub setup_displayable_columns {
                                  { name => 'phone',             description => $::locale->text('Phone')                           },
                                  { name => 'street',            description => $::locale->text('Street')                          },
                                  { name => 'taxnumber',         description => $::locale->text('Tax Number / SSN')                },
-                                 { name => 'taxzone_id',        description => $::locale->text('Steuersatz')                      },
+                                 { name => 'taxzone',           description => $::locale->text('Tax zone (description)')          },
+                                 { name => 'taxzone_id',        description => $::locale->text('Tax zone (database ID)')          },
                                  { name => 'user_password',     description => $::locale->text('Password')                        },
                                  { name => 'username',          description => $::locale->text('Username')                        },
                                  { name => 'ustid',             description => $::locale->text('sales tax identification number') },
                                  { name => 'zipcode',           description => $::locale->text('Zipcode')                         },
                                 );
+
+  if (!$::instance_conf->get_vertreter) {
+    $self->add_displayable_columns({ name => 'salesman_id', description => $::locale->text('Salesman (database ID)') });
+    $self->add_displayable_columns({ name => 'salesman',    description => $::locale->text('Salesman') });
+  }
+
 }
 
 # TODO:
-# salesman_id -- Kunden mit Typ 'Verkäufer', falls $::vertreter an ist, ansonsten Employees
+# salesman_id -- Kunden mit Typ 'Verkäufer', falls Vertreter-Modus an ist, ansonsten Employees
 
 1;