Lieferbedingungen analog zu Zahlungsbedingungen eingeführt.

[mfinanz.git] / SL / Controller / CsvImport / Base.pm

diff --git a/SL/Controller/CsvImport/Base.pm b/SL/Controller/CsvImport/Base.pm
index 9921cc989d8e756e0563fd555ecc1041c0a4e495..f8e9b591c6f2e3f08773db4da467215688646070 100644 (file)
--- a/SL/Controller/CsvImport/Base.pm
+++ b/SL/Controller/CsvImport/Base.pm
@@ -2,53 +2,84 @@ package SL::Controller::CsvImport::Base;
 
 use strict;
 
 
 use strict;
 

-use List::MoreUtils qw(pairwise);
+use List::MoreUtils qw(pairwise any);

 
 use SL::Helper::Csv;
 
 use SL::Helper::Csv;

+use SL::DB::Customer;

 use SL::DB::Language;
 use SL::DB::PaymentTerm;
 use SL::DB::Language;
 use SL::DB::PaymentTerm;

+use SL::DB::DeliveryTerm;
+use SL::DB::Vendor;
+use SL::DB::Contact;
+use SL::DB::History;

 
 use parent qw(Rose::Object);
 
 use Rose::Object::MakeMethods::Generic
 (
 
 use parent qw(Rose::Object);
 
 use Rose::Object::MakeMethods::Generic
 (

- scalar                  => [ qw(controller file csv) ],
- 'scalar --get_set_init' => [ qw(profile displayable_columns existing_objects class manager_class cvar_columns all_cvar_configs all_languages payment_terms_by) ],
+ scalar                  => [ qw(controller file csv test_run save_with_cascade) ],
+ 'scalar --get_set_init' => [ qw(profile displayable_columns existing_objects class manager_class cvar_columns all_cvar_configs all_languages payment_terms_by delivery_terms_by all_vc vc_by) ],

 );
 
 sub run {
 );
 
 sub run {

-  my ($self) = @_;
+  my ($self, %params) = @_;
+
+  $self->test_run($params{test_run});
+
+  $self->controller->track_progress(phase => 'parsing csv', progress => 0);

 
   my $profile = $self->profile;
   $self->csv(SL::Helper::Csv->new(file                   => $self->file->file_name,
                                   encoding               => $self->controller->profile->get('charset'),
 
   my $profile = $self->profile;
   $self->csv(SL::Helper::Csv->new(file                   => $self->file->file_name,
                                   encoding               => $self->controller->profile->get('charset'),

-                                  class                  => $self->class,
-                                  profile                => $profile,
+                                  profile                => [{ profile => $profile, class => $self->class }],

                                   ignore_unknown_columns => 1,
                                   strict_profile         => 1,
                                   ignore_unknown_columns => 1,
                                   strict_profile         => 1,

+                                  case_insensitive_header => 1,

                                   map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
                                  ));
                                   map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
                                  ));

+
+  $self->controller->track_progress(progress => 10);
+
+  my $old_numberformat      = $::myconfig{numberformat};
+  $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
+

   $self->csv->parse;
 
   $self->csv->parse;
 

+  $self->controller->track_progress(progress => 50);
+

   $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
 
   $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
 

-  return unless $self->csv->header;
+  return if ( !$self->csv->header || $self->csv->errors );

 
   my $headers         = { headers => [ grep { $profile->{$_} } @{ $self->csv->header } ] };
   $headers->{methods} = [ map { $profile->{$_} } @{ $headers->{headers} } ];
   $headers->{used}    = { map { ($_ => 1) }      @{ $headers->{headers} } };
   $self->controller->headers($headers);
   $self->controller->raw_data_headers({ used => { }, headers => [ ] });
 
   my $headers         = { headers => [ grep { $profile->{$_} } @{ $self->csv->header } ] };
   $headers->{methods} = [ map { $profile->{$_} } @{ $headers->{headers} } ];
   $headers->{used}    = { map { ($_ => 1) }      @{ $headers->{headers} } };
   $self->controller->headers($headers);
   $self->controller->raw_data_headers({ used => { }, headers => [ ] });

+  $self->controller->info_headers({ used => { }, headers => [ ] });

 
 

-  # my @data;
-  # foreach my $object ($self->csv->get_objects)

   my @objects  = $self->csv->get_objects;
   my @objects  = $self->csv->get_objects;

+
+  $self->controller->track_progress(progress => 70);
+

   my @raw_data = @{ $self->csv->get_data };
   my @raw_data = @{ $self->csv->get_data };

-  $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [] } } @objects, @raw_data ]);
+
+  $self->controller->track_progress(progress => 80);
+
+  $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @objects, @raw_data ]);
+
+  $self->controller->track_progress(progress => 90);

 
   $self->check_objects;
 
   $self->check_objects;

-  $self->check_duplicates if $self->controller->profile->get('duplicates', 'no_check') ne 'no_check';
+  if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
+    $self->check_std_duplicates();
+    $self->check_duplicates();
+  }

   $self->fix_field_lengths;
   $self->fix_field_lengths;

+
+  $self->controller->track_progress(progress => 100);
+
+  $::myconfig{numberformat} = $old_numberformat;

 }
 
 sub add_columns {
 }
 
 sub add_columns {


@@ -63,6 +94,18 @@ sub add_columns {
   }
 }
 
   }
 }
 

+sub add_info_columns {
+  my ($self, @columns) = @_;
+
+  my $h = $self->controller->info_headers;
+
+  foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
+    $h->{used}->{ $column->{method} } = 1;
+    push @{ $h->{methods} }, $column->{method};
+    push @{ $h->{headers} }, $column->{header};
+  }
+}
+

 sub add_raw_data_columns {
   my ($self, @columns) = @_;
 
 sub add_raw_data_columns {
   my ($self, @columns) = @_;
 


@@ -80,6 +123,11 @@ sub add_cvar_raw_data_columns {
   map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
 }
 
   map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
 }
 

+sub init_all_cvar_configs {
+  # Must be overridden by derived specialized importer classes.
+  return [];
+}
+

 sub init_cvar_columns {
   my ($self) = @_;
 
 sub init_cvar_columns {
   my ($self) = @_;
 


@@ -99,11 +147,67 @@ sub init_payment_terms_by {
   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
 }
 
   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
 }
 

+sub init_delivery_terms_by {
+  my ($self) = @_;
+
+  my $all_delivery_terms = SL::DB::Manager::DeliveryTerm->get_all;
+  return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_delivery_terms } } ) } qw(id description) };
+}
+
+sub init_all_vc {
+  my ($self) = @_;
+
+  return { customers => SL::DB::Manager::Customer->get_all,
+           vendors   => SL::DB::Manager::Vendor->get_all };
+}
+
+sub force_allow_columns {
+  return ();
+}
+
+sub init_vc_by {
+  my ($self)    = @_;
+
+  my %by_id     = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
+  my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
+                    vendors   => { map { ( $_->vendornumber   => $_ ) } @{ $self->all_vc->{vendors}   } } );
+  my %by_name   = ( customers => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{customers} } },
+                    vendors   => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{vendors}   } } );
+
+  return { id     => \%by_id,
+           number => \%by_number,
+           name   => \%by_name,   };
+}
+
+sub check_vc {
+  my ($self, $entry, $id_column) = @_;
+
+  if ($entry->{object}->$id_column) {
+    $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
+  }
+
+  if (!$entry->{object}->$id_column) {
+    my $vc = $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} }
+          || $self->vc_by->{number}->{vendors}->{   $entry->{raw_data}->{vendornumber}   };
+    $entry->{object}->$id_column($vc->id) if $vc;
+  }
+
+  if (!$entry->{object}->$id_column) {
+    my $vc = $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} }
+          || $self->vc_by->{name}->{vendors}->{   $entry->{raw_data}->{vendor}   };
+    $entry->{object}->$id_column($vc->id) if $vc;
+  }
+
+  if ($entry->{object}->$id_column) {
+    $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
+  } else {
+    push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
+  }
+}
+

 sub handle_cvars {
   my ($self, $entry) = @_;
 
 sub handle_cvars {
   my ($self, $entry) = @_;
 

-  return unless $self->can('all_cvar_configs');
-

   my %type_to_column = ( text      => 'text_value',
                          textfield => 'text_value',
                          select    => 'text_value',
   my %type_to_column = ( text      => 'text_value',
                          textfield => 'text_value',
                          select    => 'text_value',


@@ -118,7 +222,7 @@ sub handle_cvars {
     my $value  = $entry->{raw_data}->{ "cvar_" . $config->name };
     my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
 
     my $value  = $entry->{raw_data}->{ "cvar_" . $config->name };
     my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
 

-    push @cvars, SL::DB::CustomVariable->new(config_id => $config->id, $column => $value);
+    push @cvars, SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');

   }
 
   $entry->{object}->custom_variables(\@cvars);
   }
 
   $entry->{object}->custom_variables(\@cvars);


@@ -130,6 +234,8 @@ sub init_profile {
   eval "require " . $self->class;
 
   my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
   eval "require " . $self->class;
 
   my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });

+  delete $unwanted{$_} for ($self->force_allow_columns);
+

   my %profile;
   for my $col ($self->class->meta->columns) {
     next if $unwanted{$col};
   my %profile;
   for my $col ($self->class->meta->columns) {
     next if $unwanted{$col};


@@ -142,7 +248,9 @@ sub init_profile {
     $profile{$col} = $name;
   }
 
     $profile{$col} = $name;
   }
 

-  $self->profile(\%profile);
+  $profile{ 'cvar_' . $_->name } = '' for @{ $self->all_cvar_configs };
+
+  \%profile;

 }
 
 sub add_displayable_columns {
 }
 
 sub add_displayable_columns {


@@ -171,8 +279,6 @@ sub setup_displayable_columns {
 sub add_cvar_columns_to_displayable_columns {
   my ($self) = @_;
 
 sub add_cvar_columns_to_displayable_columns {
   my ($self) = @_;
 

-  return unless $self->can('all_cvar_configs');
-

   $self->add_displayable_columns(map { { name        => 'cvar_' . $_->name,
                                          description => $::locale->text('#1 (custom variable)', $_->description) } }
                                      @{ $self->all_cvar_configs });
   $self->add_displayable_columns(map { { name        => 'cvar_' . $_->name,
                                          description => $::locale->text('#1 (custom variable)', $_->description) } }
                                      @{ $self->all_cvar_configs });


@@ -196,12 +302,68 @@ sub init_manager_class {
   $self->manager_class("SL::DB::Manager::" . $1);
 }
 
   $self->manager_class("SL::DB::Manager::" . $1);
 }
 

+sub is_multiplexed { 0 }
+

 sub check_objects {
 }
 
 sub check_duplicates {
 }
 
 sub check_objects {
 }
 
 sub check_duplicates {
 }
 

+sub check_std_duplicates {
+  my $self = shift;
+
+  my $duplicates = {};
+
+  my $all_fields = $self->get_duplicate_check_fields();
+
+  foreach my $key (keys(%{ $all_fields })) {
+    if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} )  ) {
+      $duplicates->{$key} = {};
+    }
+  }
+
+  my @duplicates_keys = keys(%{ $duplicates });
+
+  if ( !scalar(@duplicates_keys) ) {
+    return;
+  }
+
+  if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
+    foreach my $object (@{ $self->existing_objects }) {
+      foreach my $key (@duplicates_keys) {
+        my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
+        $duplicates->{$key}->{$value} = 'db';
+      }
+    }
+  }
+
+  foreach my $entry (@{ $self->controller->data }) {
+    if ( @{ $entry->{errors} } ) {
+      next;
+    }
+
+    my $object = $entry->{object};
+
+    foreach my $key (@duplicates_keys) {
+      my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
+
+      if ( exists($duplicates->{$key}->{$value}) ) {
+        push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
+        last;
+      } else {
+        $duplicates->{$key}->{$value} = 'csv';
+      }
+
+    }
+  }
+
+}
+
+sub get_duplicate_check_fields {
+  return {};
+}
+

 sub check_payment {
   my ($self, $entry) = @_;
 
 sub check_payment {
   my ($self, $entry) = @_;
 


@@ -228,20 +390,68 @@ sub check_payment {
   return 1;
 }
 
   return 1;
 }
 

+sub check_delivery_term {
+  my ($self, $entry) = @_;
+
+  my $object = $entry->{object};
+
+  # Check whether or not delivery term ID is valid.
+  if ($object->delivery_term_id && !$self->delivery_terms_by->{id}->{ $object->delivery_term_id }) {
+    push @{ $entry->{errors} }, $::locale->text('Error: Invalid delivery terms');
+    return 0;
+  }
+
+  # Map name to ID if given.
+  if (!$object->delivery_term_id && $entry->{raw_data}->{delivery_term}) {
+    my $terms = $self->delivery_terms_by->{description}->{ $entry->{raw_data}->{delivery_term} };
+
+    if (!$terms) {
+      push @{ $entry->{errors} }, $::locale->text('Error: Invalid delivery terms');
+      return 0;
+    }
+
+    $object->delivery_term_id($terms->id);
+  }
+
+  return 1;
+}
+

 sub save_objects {
   my ($self, %params) = @_;
 
   my $data = $params{data} || $self->controller->data;
 
 sub save_objects {
   my ($self, %params) = @_;
 
   my $data = $params{data} || $self->controller->data;
 

-  foreach my $entry (@{ $data }) {
+  return unless $data->[0];
+  return unless $data->[0]{object};
+
+  $self->controller->track_progress(phase => 'saving data', progress => 0); # scale from 45..95%;
+
+  my $dbh = $data->[0]{object}->db;
+
+  $dbh->begin_work;
+  foreach my $entry_index (0 .. $#$data) {
+    my $entry = $data->[$entry_index];

     next if @{ $entry->{errors} };
 
     next if @{ $entry->{errors} };
 

-    if (!$entry->{object}->save) {
+    my $object = $entry->{object_to_save} || $entry->{object};
+
+    my $ret;
+    if (!eval { $ret = $object->save(cascade => !!$self->save_with_cascade()); 1 }) {
+      push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $@);
+    } elsif ( !$ret ) {

       push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $entry->{object}->db->error);
     } else {
       push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $entry->{object}->db->error);
     } else {

+      $self->_save_history($object);

       $self->controller->num_imported($self->controller->num_imported + 1);
     }
       $self->controller->num_imported($self->controller->num_imported + 1);
     }

+  } continue {
+    if ($entry_index % 100 == 0) {
+      $dbh->commit;
+      $self->controller->track_progress(progress => $entry_index/scalar(@$data) * 100); # scale from 45..95%;
+      $dbh->begin_work;
+    }

   }
   }

+  $dbh->commit;

 }
 
 sub field_lengths {
 }
 
 sub field_lengths {


@@ -258,4 +468,43 @@ sub fix_field_lengths {
   }
 }
 
   }
 }
 

+sub clean_fields {
+  my ($self, $illegal_chars, $object, @fields) = @_;
+
+  my @cleaned_fields;
+  foreach my $field (grep { $object->can($_) } @fields) {
+    my $value = $object->$field;
+
+    next unless defined($value) && ($value =~ s/$illegal_chars/ /g);
+
+    $object->$field($value);
+    push @cleaned_fields, $field;
+  }
+
+  return @cleaned_fields;
+}
+
+sub _save_history {
+  my ($self, $object) = @_;
+
+  if (any { $_ eq $self->controller->{type} } qw(parts customers_vendors orders)) {
+    my $snumbers = $self->controller->{type} eq 'parts'             ? 'partnumber_' . $object->partnumber
+                 : $self->controller->{type} eq 'customers_vendors' ?
+                     ($self->table eq 'customer' ? 'customernumber_' . $object->customernumber : 'vendornumber_' . $object->vendornumber)
+                 : $self->controller->{type} eq 'orders'            ? 'ordnumber_' . $object->ordnumber
+                 : '';
+
+    my $what_done = $self->controller->{type} eq 'orders' ? 'sales_order'
+                  : '';
+
+    SL::DB::History->new(
+      trans_id    => $object->id,
+      snumbers    => $snumbers,
+      employee_id => $self->controller->{employee_id},
+      addition    => 'SAVED',
+      what_done   => $what_done,
+    )->save();
+  }
+}
+

 1;
 1;