CSV-Import Waren: Fehlermeldungen verbessern bei nicht vorhandenen Warengruppen
[kivitendo-erp.git] / SL / Controller / CsvImport / BankTransaction.pm
index ae49616..8b5b5e7 100644 (file)
@@ -12,9 +12,18 @@ use parent qw(SL::Controller::CsvImport::Base);
 
 use Rose::Object::MakeMethods::Generic
 (
- 'scalar --get_set_init' => [ qw(table bank_accounts_by) ],
+ 'scalar --get_set_init' => [ qw(bank_accounts_by) ],
 );
 
+sub set_profile_defaults {
+  my ($self) = @_;
+
+  $self->controller->profile->_set_defaults(
+                       charset       => 'UTF8',  # override charset from defaults
+                       update_policy => 'skip',
+                      );
+};
+
 sub init_class {
   my ($self) = @_;
   $self->class('SL::DB::BankTransaction');
@@ -23,13 +32,14 @@ sub init_class {
 sub init_bank_accounts_by {
   my ($self) = @_;
 
-  return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $self->all_bank_accounts } } ) } qw(id account_number) };
+  return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $self->all_bank_accounts } } ) } qw(id account_number iban) };
 }
 
 sub check_objects {
   my ($self) = @_;
 
   $self->controller->track_progress(phase => 'building data', progress => 0);
+  my $update_policy  = $self->controller->profile->get('update_policy') || 'skip';
 
   my $i;
   my $num_data = scalar @{ $self->controller->data };
@@ -38,14 +48,71 @@ sub check_objects {
 
     $self->check_bank_account($entry);
     $self->check_currency($entry, take_default => 1);
-
     $self->join_purposes($entry);
-    #TODO: adde checks für die Variablen
+    $self->join_remote_names($entry);
+    $self->check_existing($entry) unless @{ $entry->{errors} };
   } continue {
     $i++;
   }
 
-  $self->add_cvar_raw_data_columns;
+  $self->add_info_columns({ header => $::locale->text('Bank account'), method => 'local_bank_name' });
+  $self->add_raw_data_columns("currency", "currency_id") if grep { /^currency(?:_id)?$/ } @{ $self->csv->header };
+}
+
+sub check_existing {
+  my ($self, $entry) = @_;
+
+  my $object = $entry->{object};
+
+  # for each imported entry (line) we make a database call to find existing entries
+  # we don't use the init_by hash because we have to check several fields
+  # this means that we can't detect duplicates in the import file
+
+  if ( $object->amount ) {
+    # check for same
+    # * purpose
+    # * transdate
+    # * remote_account_number  (may be empty for records of our own bank)
+    # * amount
+    # * local_bank_account_id (case flatrate bank charges for two accounts in one bank: same purpose, transdate, remote_account_number(empty), amount. Just different local_bank_account_id)
+    my $num;
+    if ( $num = SL::DB::Manager::BankTransaction->get_all_count(query =>[ remote_account_number => $object->remote_account_number, transdate => $object->transdate, purpose => $object->purpose, amount => $object->amount, local_bank_account_id => $object->local_bank_account_id] ) ) {
+      push(@{$entry->{errors}}, $::locale->text('Skipping due to existing bank transaction in database'));
+    };
+  } else {
+      push(@{$entry->{errors}}, $::locale->text('Skipping because transfer amount is empty.'));
+  };
+}
+
+sub _displayable_columns {
+ (
+   { name => 'local_bank_code',       description => $::locale->text('Own bank code') },
+   { name => 'local_account_number',  description => $::locale->text('Own bank account number or IBAN') },
+   { name => 'local_bank_account_id', description => $::locale->text('ID of own bank account') },
+   { name => 'remote_bank_code',      description => $::locale->text('Bank code of the goal/source') },
+   { name => 'remote_account_number', description => $::locale->text('Account number of the goal/source') },
+   { name => 'transdate',             description => $::locale->text('Transdate') },
+   { name => 'valutadate',            description => $::locale->text('Valutadate') },
+   { name => 'amount',                description => $::locale->text('Amount') },
+   { name => 'currency',              description => $::locale->text('Currency') },
+   { name => 'currency_id',           description => $::locale->text('Currency (database ID)')          },
+   { name => 'remote_name',           description => $::locale->text('Name of the goal/source (if field names remote_name and remote_name_1 exist they will be combined into field "remote_name")') },
+   { name => 'remote_name_1',          description => $::locale->text('Name of the goal/source (if field names remote_name and remote_name_1 exist they will be combined into field "remote_name")') },
+   { name => 'purpose',               description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose1',              description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose2',              description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose3',              description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose4',              description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose5',              description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose6',              description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose7',              description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose8',              description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose9',              description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose10',             description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose11',             description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose12',             description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') },
+   { name => 'purpose13',             description => $::locale->text('Purpose (if field names purpose, purpose1, purpose2 ... exist they will all combined into the field "purpose")') }
+ );
 }
 
 sub setup_displayable_columns {
@@ -53,21 +120,7 @@ sub setup_displayable_columns {
 
   $self->SUPER::setup_displayable_columns;
 
-  $self->add_displayable_columns({ name => 'transaction_id',   description => $::locale->text('Transaction ID') },
-                                 { name => 'local_bank_code',   description => $::locale->text('Own bank code') },
-                                 { name => 'local_account_number',   description => $::locale->text('Own bank account number') },
-                                 { name => 'local_bank_account_id',   description => $::locale->text('ID of own bank account') },
-                                 { name => 'remote_bank_code',   description => $::locale->text('Bank code of the goal/source') },
-                                 { name => 'remote_account_number',   description => $::locale->text('Account number of the goal/source') },
-                                 { name => 'transdate',   description => $::locale->text('Date of transaction') },
-                                 { name => 'valutadate',   description => $::locale->text('Valuta') },
-                                 { name => 'amount',   description => $::locale->text('Amount') },
-                                 { name => 'currency',   description => $::locale->text('Currency') },
-                                 { name => 'currency_id',       description => $::locale->text('Currency (database ID)')          },
-                                 { name => 'remote_name',   description => $::locale->text('Name of the goal/source') },
-                                 { name => 'remote_name_1',   description => $::locale->text('Name of the goal/source') },
-                                 { name => 'purpose',   description => $::locale->text('Purpose') },
-                                );
+  $self->add_displayable_columns($self->_displayable_columns);
 }
 
 sub check_bank_account {
@@ -75,9 +128,9 @@ sub check_bank_account {
 
   my $object = $entry->{object};
 
-  # Check whether or not local_bank_account ID is valid.
+  # import via id: check whether or not local_bank_account ID exists and is valid.
   if ($object->local_bank_account_id && !$self->bank_accounts_by->{id}->{ $object->local_bank_account_id }) {
-    push @{ $entry->{errors} }, $::locale->text('Error: Invalid local bank account');
+    push @{ $entry->{errors} }, $::locale->text('Error: unknown local bank account id');
     return 0;
   }
 
@@ -85,31 +138,35 @@ sub check_bank_account {
   if ($object->local_bank_account_id && $entry->{raw_data}->{local_account_number}) {
     my $bank_account = $self->bank_accounts_by->{id}->{ $object->local_bank_account_id };
     if ($bank_account->account_number ne $entry->{raw_data}->{local_account_number}) {
-      push @{ $entry->{errors} }, $::locale->text('Error: Invalid local bank account');
+      push @{ $entry->{errors} }, $::locale->text('Error: local bank account id doesn\'t match local bank account number');
       return 0;
     }
     if ($entry->{raw_data}->{local_bank_code} && $entry->{raw_data}->{local_bank_code} ne $bank_account->bank_code) {
-      push @{ $entry->{errors} }, $::locale->text('Error: Invalid local bank account');
+      push @{ $entry->{errors} }, $::locale->text('Error: local bank account id doesn\'t match local bank code');
       return 0;
     }
 
   }
 
-  # Map account information to ID if given.
+  # Map account information to ID via local_account_number if no local_bank_account_id was given
+  # local_account_number checks for match of account number or IBAN
   if (!$object->local_bank_account_id && $entry->{raw_data}->{local_account_number}) {
     my $bank_account = $self->bank_accounts_by->{account_number}->{ $entry->{raw_data}->{local_account_number} };
     if (!$bank_account) {
-      push @{ $entry->{errors} }, $::locale->text('Error: Invalid local bank account');
+       $bank_account = $self->bank_accounts_by->{iban}->{ $entry->{raw_data}->{local_account_number} };
+    };
+    if (!$bank_account) {
+      push @{ $entry->{errors} }, $::locale->text('Error: unknown local bank account') . ": " . $entry->{raw_data}->{local_account_number};
       return 0;
     }
     if ($entry->{raw_data}->{local_bank_code} && $entry->{raw_data}->{local_bank_code} ne $bank_account->bank_code) {
-      push @{ $entry->{errors} }, $::locale->text('Error: Invalid local bank account');
+      push @{ $entry->{errors} }, $::locale->text('Error: Found local bank account number but local bank code doesn\'t match') . ": " . $entry->{raw_data}->{local_bank_code};
       return 0;
     }
 
     $object->local_bank_account_id($bank_account->id);
+    $entry->{info_data}->{local_bank_name} = $bank_account->name;
   }
-
   return $object->local_bank_account_id ? 1 : 0;
 }
 
@@ -118,19 +175,28 @@ sub join_purposes {
 
   my $object = $entry->{object};
 
-  my $purpose = join('', $entry->{raw_data}->{purpose},
-                        $entry->{raw_data}->{purpose1},
-                        $entry->{raw_data}->{purpose2},
-                        $entry->{raw_data}->{purpose3},
-                        $entry->{raw_data}->{purpose4},
-                        $entry->{raw_data}->{purpose5},
-                        $entry->{raw_data}->{purpose6},
-                        $entry->{raw_data}->{purpose7},
-                        $entry->{raw_data}->{purpose8},
-                        $entry->{raw_data}->{purpose9},
-                        $entry->{raw_data}->{purpose10},
-                        $entry->{raw_data}->{purpose11} );
+  my $purpose =
+    join ' ',
+    grep { ($_ // '') !~ m{^ *$} }
+    map  { $entry->{raw_data}->{"purpose$_"} }
+    ('', 1..13);
+
   $object->purpose($purpose);
+
+}
+
+sub join_remote_names {
+  my ($self, $entry) = @_;
+
+  my $object = $entry->{object};
+
+  my $remote_name = join(' ', $entry->{raw_data}->{remote_name},
+                             $entry->{raw_data}->{remote_name_1} );
+  $object->remote_name($remote_name);
+}
+
+sub check_auth {
+  $::auth->assert('config') if ! $::auth->assert('bank_transaction',1);
 }
 
 1;