1 package SL::Controller::CsvImport::Base;
 
   5 use English qw(-no_match_vars);
 
   6 use List::Util qw(min);
 
   7 use List::MoreUtils qw(pairwise any);
 
  12 use SL::DB::BankAccount;
 
  15 use SL::DB::PaymentTerm;
 
  16 use SL::DB::DeliveryTerm;
 
  21 use parent qw(Rose::Object);
 
  23 use Rose::Object::MakeMethods::Generic
 
  25  scalar                  => [ qw(controller file csv test_run save_with_cascade) ],
 
  26  '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_bank_accounts all_vc vc_by vc_counts_by clone_methods) ],
 
  30   my ($self, %params) = @_;
 
  32   $self->test_run($params{test});
 
  34   $self->controller->track_progress(phase => 'parsing csv', progress => 0);
 
  36   my $profile = $self->profile;
 
  37   $self->csv(SL::Helper::Csv->new(file                   => $self->file->file_name,
 
  38                                   encoding               => $self->controller->profile->get('charset'),
 
  39                                   profile                => [{ profile => $profile, class => $self->class, mapping => $self->controller->mappings_for_profile }],
 
  40                                   ignore_unknown_columns => 1,
 
  42                                   case_insensitive_header => 1,
 
  43                                   map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
 
  46   $self->controller->track_progress(progress => 10);
 
  48   my $old_numberformat      = $::myconfig{numberformat};
 
  49   $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
 
  53   $self->controller->track_progress(progress => 50);
 
  55   $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
 
  57   return if ( !$self->csv->header || $self->csv->errors );
 
  59   my $headers         = { headers => [ grep { $self->csv->dispatcher->is_known($_, 0) } @{ $self->csv->header } ] };
 
  60   $headers->{methods} = [ map { $_->{path} } @{ $self->csv->specs->[0] } ];
 
  61   $headers->{used}    = { map { ($_ => 1) }  @{ $headers->{headers} } };
 
  62   $self->controller->headers($headers);
 
  63   $self->controller->raw_data_headers({ used => { }, headers => [ ] });
 
  64   $self->controller->info_headers({ used => { }, headers => [ ] });
 
  66   my $objects  = $self->csv->get_objects;
 
  68   $self->controller->track_progress(progress => 70);
 
  70   my @raw_data = @{ $self->csv->get_data };
 
  72   $self->controller->track_progress(progress => 80);
 
  74   $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @$objects, @raw_data ]);
 
  76   $self->controller->track_progress(progress => 90);
 
  79   if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
 
  80     $self->check_std_duplicates();
 
  81     $self->check_duplicates();
 
  83   $self->fix_field_lengths;
 
  85   $self->controller->track_progress(progress => 100);
 
  87   $::myconfig{numberformat} = $old_numberformat;
 
  91   my ($self, @columns) = @_;
 
  93   my $h = $self->controller->headers;
 
  95   foreach my $column (grep { !$h->{used}->{$_} } @columns) {
 
  96     $h->{used}->{$column} = 1;
 
  97     push @{ $h->{methods} }, $column;
 
  98     push @{ $h->{headers} }, $column;
 
 102 sub add_info_columns {
 
 103   my ($self, @columns) = @_;
 
 105   my $h = $self->controller->info_headers;
 
 107   foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
 
 108     $h->{used}->{ $column->{method} } = 1;
 
 109     push @{ $h->{methods} }, $column->{method};
 
 110     push @{ $h->{headers} }, $column->{header};
 
 114 sub add_raw_data_columns {
 
 115   my ($self, @columns) = @_;
 
 117   my $h = $self->controller->raw_data_headers;
 
 119   foreach my $column (grep { !$h->{used}->{$_} } @columns) {
 
 120     $h->{used}->{$column} = 1;
 
 121     push @{ $h->{headers} }, $column;
 
 125 sub add_cvar_raw_data_columns {
 
 128   map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
 
 131 sub init_all_cvar_configs {
 
 132   # Must be overridden by derived specialized importer classes.
 
 136 sub init_cvar_columns {
 
 139   return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
 
 142 sub init_all_languages {
 
 145   return SL::DB::Manager::Language->get_all;
 
 148 sub init_all_bank_accounts {
 
 151   return SL::DB::Manager::BankAccount->get_all_sorted( query => [ obsolete => 0 ] );
 
 154 sub init_payment_terms_by {
 
 157   my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
 
 158   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
 
 161 sub init_delivery_terms_by {
 
 164   my $all_delivery_terms = SL::DB::Manager::DeliveryTerm->get_all;
 
 165   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_delivery_terms } } ) } qw(id description) };
 
 171   return { customers => SL::DB::Manager::Customer->get_all,
 
 172            vendors   => SL::DB::Manager::Vendor->get_all };
 
 175 sub init_clone_methods {
 
 179 sub force_allow_columns {
 
 186   my %by_id     = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
 
 187   my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
 
 188                     vendors   => { map { ( $_->vendornumber   => $_ ) } @{ $self->all_vc->{vendors}   } } );
 
 189   my %by_name   = ( customers => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{customers} } },
 
 190                     vendors   => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{vendors}   } } );
 
 191   my %by_gln    = ( customers => { map { ( $_->gln            => $_ ) } @{ $self->all_vc->{customers} } },
 
 192                     vendors   => { map { ( $_->gln            => $_ ) } @{ $self->all_vc->{vendors}   } } );
 
 194   return { id     => \%by_id,
 
 195            number => \%by_number,
 
 200 sub init_vc_counts_by {
 
 205   $vc_counts_by->{number}->{customers}->{$_->customernumber}++ for @{ $self->all_vc->{customers} };
 
 206   $vc_counts_by->{number}->{vendors}->  {$_->vendornumber}++   for @{ $self->all_vc->{vendors} };
 
 207   $vc_counts_by->{name}->  {customers}->{$_->name}++           for @{ $self->all_vc->{customers} };
 
 208   $vc_counts_by->{name}->  {vendors}->  {$_->name}++           for @{ $self->all_vc->{vendors} };
 
 209   $vc_counts_by->{gln}->   {customers}->{$_->gln}++            for @{ $self->all_vc->{customers} };
 
 210   $vc_counts_by->{gln}->   {vendors}->  {$_->gln}++            for @{ $self->all_vc->{vendors} };
 
 212   return $vc_counts_by;
 
 216   my ($self, $entry, $id_column) = @_;
 
 218   if ($entry->{object}->$id_column) {
 
 219     $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
 
 223   if (!$entry->{object}->$id_column) {
 
 224     my $vc = $entry->{raw_data}->{customernumber} && $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} };
 
 225     if ($vc && $self->vc_counts_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} } > 1) {
 
 229     $vc ||= $entry->{raw_data}->{vendornumber} && $self->vc_by->{number}->{vendors}->{ $entry->{raw_data}->{vendornumber} };
 
 230     if ($vc && $self->vc_counts_by->{number}->{vendors}->{ $entry->{raw_data}->{vendornumber} } > 1) {
 
 235     $entry->{object}->$id_column($vc->id) if $vc;
 
 238   if (!$entry->{object}->$id_column) {
 
 239     my $vc = $entry->{raw_data}->{customer} && $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} };
 
 240     if ($vc && $self->vc_counts_by->{name}->{customers}->{ $entry->{raw_data}->{customer} } > 1) {
 
 244     $vc ||= $entry->{raw_data}->{vendor} && $self->vc_by->{name}->{vendors}->{ $entry->{raw_data}->{vendor} };
 
 245     if ($vc && $self->vc_counts_by->{name}->{vendors}->{ $entry->{raw_data}->{vendor} } > 1) {
 
 250     $entry->{object}->$id_column($vc->id) if $vc;
 
 253   if (!$entry->{object}->$id_column) {
 
 254     my $vc = $entry->{raw_data}->{customer_gln} && $self->vc_by->{gln}->{customers}->{ $entry->{raw_data}->{customer_gln} };
 
 255     if ($vc && $self->vc_counts_by->{gln}->{customers}->{ $entry->{raw_data}->{customer_gln} } > 1) {
 
 259     $vc ||= $entry->{raw_data}->{vendor_gln} && $self->vc_by->{gln}->{vendors}->{ $entry->{raw_data}->{vendor_gln} };
 
 260     if ($vc && $self->vc_counts_by->{gln}->{vendors}->{ $entry->{raw_data}->{vendor_gln} } > 1) {
 
 265     $entry->{object}->$id_column($vc->id) if $vc;
 
 268   if ($entry->{object}->$id_column) {
 
 269     $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
 
 272       push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor is ambiguous');
 
 274       push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
 
 280   my ($self, $entry) = @_;
 
 282   my %type_to_column = ( text      => 'text_value',
 
 283                          textfield => 'text_value',
 
 284                          select    => 'text_value',
 
 285                          date      => 'timestamp_value_as_date',
 
 286                          timestamp => 'timestamp_value_as_date',
 
 287                          number    => 'number_value_as_number',
 
 288                          bool      => 'bool_value' );
 
 292   foreach my $config (@{ $self->all_cvar_configs }) {
 
 293     next unless exists $entry->{raw_data}->{ "cvar_" . $config->name };
 
 294     my $value  = $entry->{raw_data}->{ "cvar_" . $config->name };
 
 295     my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
 
 297     my $new_cvar = SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
 
 299     push @cvars, $new_cvar;
 
 300     $changed_cvars{$config->name} = $new_cvar;
 
 303   # merge existing with new cvars. swap every existing with the imported one, push the rest
 
 305     my @orig_cvars = ($entry->{object_to_save} || $entry->{object})->custom_variables;
 
 307       $_ = $changed_cvars{ $_->config->name } if $changed_cvars{ $_->config->name };
 
 308       delete $changed_cvars{ $_->config->name };
 
 310     push @orig_cvars, values %changed_cvars;
 
 312     $entry->{object}->custom_variables(\@orig_cvars);
 
 319   eval "require " . $self->class;
 
 321   my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
 
 322   delete $unwanted{$_} for ($self->force_allow_columns);
 
 325   for my $col ($self->class->meta->columns) {
 
 326     next if $unwanted{$col};
 
 328     my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric')   ? "$col\_as_number"
 
 329       :        $col->isa('Rose::DB::Object::Metadata::Column::Date')      ? "$col\_as_date"
 
 330       :        $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
 
 333     $profile{$col} = $name;
 
 336   $profile{ 'cvar_' . $_->name } = '' for @{ $self->all_cvar_configs };
 
 341 sub add_displayable_columns {
 
 342   my ($self, @columns) = @_;
 
 344   my @cols       = @{ $self->controller->displayable_columns || [] };
 
 345   my %ex_col_map = map { $_->{name} => $_ } @cols;
 
 347   foreach my $column (@columns) {
 
 348     if ($ex_col_map{ $column->{name} }) {
 
 349       @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
 
 355   $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
 
 358 sub setup_displayable_columns {
 
 361   $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
 
 364 sub add_cvar_columns_to_displayable_columns {
 
 367   $self->add_displayable_columns(map { { name        => 'cvar_' . $_->name,
 
 368                                          description => $::locale->text('#1 (custom variable)', $_->description) } }
 
 369                                      @{ $self->all_cvar_configs });
 
 372 sub init_existing_objects {
 
 375   eval "require " . $self->class;
 
 376   $self->existing_objects($self->manager_class->get_all);
 
 383 sub init_manager_class {
 
 386   $self->class =~ m/^SL::DB::(.+)/;
 
 387   $self->manager_class("SL::DB::Manager::" . $1);
 
 390 sub is_multiplexed { 0 }
 
 395 sub check_duplicates {
 
 399   $::auth->assert('config');
 
 402 sub check_std_duplicates {
 
 407   my $all_fields = $self->get_duplicate_check_fields();
 
 409   foreach my $key (keys(%{ $all_fields })) {
 
 410     if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} )  ) {
 
 411       $duplicates->{$key} = {};
 
 415   my @duplicates_keys = keys(%{ $duplicates });
 
 417   if ( !scalar(@duplicates_keys) ) {
 
 421   if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
 
 422     foreach my $object (@{ $self->existing_objects }) {
 
 423       foreach my $key (@duplicates_keys) {
 
 424         my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
 
 425         $duplicates->{$key}->{$value} = 'db';
 
 430   foreach my $entry (@{ $self->controller->data }) {
 
 431     if ( @{ $entry->{errors} } ) {
 
 435     my $object = $entry->{object};
 
 437     foreach my $key (@duplicates_keys) {
 
 438       my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
 
 440       if ( exists($duplicates->{$key}->{$value}) ) {
 
 441         push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
 
 444         $duplicates->{$key}->{$value} = 'csv';
 
 452 sub get_duplicate_check_fields {
 
 457   my ($self, $entry) = @_;
 
 459   my $object = $entry->{object};
 
 461   # Check whether or not payment ID is valid.
 
 462   if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
 
 463     push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
 
 467   # Map name to ID if given.
 
 468   if (!$object->payment_id && $entry->{raw_data}->{payment}) {
 
 469     my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
 
 472       push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
 
 476     $object->payment_id($terms->id);
 
 478     # register payment_id for method copying later
 
 479     $self->clone_methods->{payment_id} = 1;
 
 485 sub check_delivery_term {
 
 486   my ($self, $entry) = @_;
 
 488   my $object = $entry->{object};
 
 490   # Check whether or not delivery term ID is valid.
 
 491   if ($object->delivery_term_id && !$self->delivery_terms_by->{id}->{ $object->delivery_term_id }) {
 
 492     push @{ $entry->{errors} }, $::locale->text('Error: Invalid delivery terms');
 
 496   # Map name to ID if given.
 
 497   if (!$object->delivery_term_id && $entry->{raw_data}->{delivery_term}) {
 
 498     my $terms = $self->delivery_terms_by->{description}->{ $entry->{raw_data}->{delivery_term} };
 
 501       push @{ $entry->{errors} }, $::locale->text('Error: Invalid delivery terms');
 
 505     $object->delivery_term_id($terms->id);
 
 507     # register delivery_term_id for method copying later
 
 508     $self->clone_methods->{delivery_term_id} = 1;
 
 515   my ($self, %params) = @_;
 
 517   my $data = $params{data} || $self->controller->data;
 
 519   return unless $data->[0];
 
 520   return unless $data->[0]{object};
 
 522   $self->controller->track_progress(phase => 'saving data', progress => 0); # scale from 45..95%;
 
 524   my $last_index = $#$data;
 
 525   my $chunk_size = 100;      # one transaction and progress update every 100 objects
 
 527   for my $chunk (0 .. $last_index / $chunk_size) {
 
 528     $self->controller->track_progress(progress => ($chunk_size * $chunk)/scalar(@$data) * 100); # scale from 45..95%;
 
 529     SL::DB->client->with_transaction(sub {
 
 530       foreach my $entry_index ($chunk_size * $chunk .. min( $last_index, $chunk_size * ($chunk + 1) - 1 )) {
 
 531         my $entry = $data->[$entry_index];
 
 532         next if @{ $entry->{errors} };
 
 534         my $object = $entry->{object_to_save} || $entry->{object};
 
 537         if (!eval { $ret = $object->save(cascade => !!$self->save_with_cascade()); 1 }) {
 
 538           push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $EVAL_ERROR);
 
 540           push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $object->db->error);
 
 542           $self->_save_history($object);
 
 543           $self->controller->num_imported($self->controller->num_imported + 1);
 
 547     }) or do { die SL::DB->client->error };
 
 549   $self->controller->track_progress(progress => 100);
 
 555   return map { $_->name => $_->length } grep { $_->type eq 'varchar' } @{$self->class->meta->columns};
 
 558 sub fix_field_lengths {
 
 561   my %field_lengths = $self->field_lengths;
 
 562   foreach my $entry (@{ $self->controller->data }) {
 
 563     next unless @{ $entry->{errors} };
 
 564     map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;
 
 569   my ($self, $illegal_chars, $object, @fields) = @_;
 
 572   foreach my $field (grep { $object->can($_) } @fields) {
 
 573     my $value = $object->$field;
 
 575     next unless defined($value) && ($value =~ s/$illegal_chars/ /g);
 
 577     $object->$field($value);
 
 578     push @cleaned_fields, $field;
 
 581   return @cleaned_fields;
 
 585   my ($self, $object) = @_;
 
 587   if (any { $self->controller->{type} && $_ eq $self->controller->{type} } qw(parts customers_vendors orders ar_transactions)) {
 
 588     my $snumbers = $self->controller->{type} eq 'parts'             ? 'partnumber_' . $object->partnumber
 
 589                  : $self->controller->{type} eq 'customers_vendors' ?
 
 590                      ($self->table eq 'customer' ? 'customernumber_' . $object->customernumber : 'vendornumber_' . $object->vendornumber)
 
 591                  : $self->controller->{type} eq 'orders'            ? 'ordnumber_' . $object->ordnumber
 
 592                  : $self->controller->{type} eq 'ar_transactions'   ? 'invnumber_' . $object->invnumber
 
 595     my $what_done = $self->controller->{type} eq 'orders' ? 'sales_order'
 
 598     SL::DB::History->new(
 
 599       trans_id    => $object->id,
 
 600       snumbers    => $snumbers,
 
 601       employee_id => $self->controller->{employee_id},
 
 603       what_done   => $what_done,