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 656495e3761eee6490e3f96e816b794b4f631977..f8e9b591c6f2e3f08773db4da467215688646070 100644 (file)
--- a/SL/Controller/CsvImport/Base.pm
+++ b/SL/Controller/CsvImport/Base.pm
@@ -2,42 +2,51 @@ 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::DB::Customer;
 use SL::DB::Language;
 use SL::DB::PaymentTerm;
 
 use SL::Helper::Csv;
 use SL::DB::Customer;
 use SL::DB::Language;
 use SL::DB::PaymentTerm;

+use SL::DB::DeliveryTerm;

 use SL::DB::Vendor;
 use SL::DB::Contact;
 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 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 all_vc vc_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,
                                   case_insensitive_header => 1,
                                   map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
                                  ));
 
                                   ignore_unknown_columns => 1,
                                   strict_profile         => 1,
                                   case_insensitive_header => 1,
                                   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;
 
   my $old_numberformat      = $::myconfig{numberformat};
   $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
 
   $self->csv->parse;
 

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

   $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
 
   return if ( !$self->csv->header || $self->csv->errors );
   $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
 
   return if ( !$self->csv->header || $self->csv->errors );


@@ -50,9 +59,17 @@ sub run {
   $self->controller->info_headers({ used => { }, headers => [ ] });
 
   my @objects  = $self->csv->get_objects;
   $self->controller->info_headers({ used => { }, headers => [ ] });
 
   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->track_progress(progress => 80);
+

   $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @objects, @raw_data ]);
 
   $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;
   if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
     $self->check_std_duplicates();
   $self->check_objects;
   if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
     $self->check_std_duplicates();


@@ -60,6 +77,8 @@ sub run {
   }
   $self->fix_field_lengths;
 
   }
   $self->fix_field_lengths;
 

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

   $::myconfig{numberformat} = $old_numberformat;
 }
 
   $::myconfig{numberformat} = $old_numberformat;
 }
 


@@ -104,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) = @_;
 


@@ -123,6 +147,13 @@ 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) = @_;
 
 sub init_all_vc {
   my ($self) = @_;
 


@@ -130,6 +161,10 @@ sub init_all_vc {
            vendors   => SL::DB::Manager::Vendor->get_all };
 }
 
            vendors   => SL::DB::Manager::Vendor->get_all };
 }
 

+sub force_allow_columns {
+  return ();
+}
+

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


@@ -173,8 +208,6 @@ sub check_vc {
 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',


@@ -201,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};


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

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

 
 

-  $self->profile(\%profile);
+  \%profile;

 }
 
 sub add_displayable_columns {
 }
 
 sub add_displayable_columns {


@@ -248,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 });


@@ -273,6 +302,8 @@ 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_objects {
 }
 


@@ -359,22 +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} };
 
     my $object = $entry->{object_to_save} || $entry->{object};
 
     next if @{ $entry->{errors} };
 
     my $object = $entry->{object_to_save} || $entry->{object};
 

-    if ( !$object->save(cascade => !!$self->save_with_cascade()) ) {
+    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 {


@@ -391,5 +468,43 @@ sub fix_field_lengths {
   }
 }
 
   }
 }
 

-1;
+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;