SL/Controller/CsvImport/Base.pm

   1 package SL::Controller::CsvImport::Base;
   2
   3 use strict;
   4
   5 use English qw(-no_match_vars);
   6 use List::MoreUtils qw(pairwise any);
   7
   8 use SL::Helper::Csv;
   9 use SL::DB::Customer;
  10 use SL::DB::Language;
  11 use SL::DB::PaymentTerm;
  12 use SL::DB::DeliveryTerm;
  13 use SL::DB::Vendor;
  14 use SL::DB::Contact;
  15 use SL::DB::History;
  16
  17 use parent qw(Rose::Object);
  18
  19 use Rose::Object::MakeMethods::Generic
  20 (
  21  scalar                  => [ qw(controller file csv test_run save_with_cascade) ],
  22  '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 clone_methods) ],
  23 );
  24
  25 sub run {
  26   my ($self, %params) = @_;
  27
  28   $self->test_run($params{test});
  29
  30   $self->controller->track_progress(phase => 'parsing csv', progress => 0);
  31
  32   my $profile = $self->profile;
  33   $self->csv(SL::Helper::Csv->new(file                   => $self->file->file_name,
  34                                   encoding               => $self->controller->profile->get('charset'),
  35                                   profile                => [{ profile => $profile, class => $self->class }],
  36                                   ignore_unknown_columns => 1,
  37                                   strict_profile         => 1,
  38                                   case_insensitive_header => 1,
  39                                   map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
  40                                  ));
  41
  42   $self->controller->track_progress(progress => 10);
  43
  44   my $old_numberformat      = $::myconfig{numberformat};
  45   $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
  46
  47   $self->csv->parse;
  48
  49   $self->controller->track_progress(progress => 50);
  50
  51   $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
  52
  53   return if ( !$self->csv->header || $self->csv->errors );
  54
  55   my $headers         = { headers => [ grep { $profile->{$_} } @{ $self->csv->header } ] };
  56   $headers->{methods} = [ map { $profile->{$_} } @{ $headers->{headers} } ];
  57   $headers->{used}    = { map { ($_ => 1) }      @{ $headers->{headers} } };
  58   $self->controller->headers($headers);
  59   $self->controller->raw_data_headers({ used => { }, headers => [ ] });
  60   $self->controller->info_headers({ used => { }, headers => [ ] });
  61
  62   my @objects  = $self->csv->get_objects;
  63
  64   $self->controller->track_progress(progress => 70);
  65
  66   my @raw_data = @{ $self->csv->get_data };
  67
  68   $self->controller->track_progress(progress => 80);
  69
  70   $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @objects, @raw_data ]);
  71
  72   $self->controller->track_progress(progress => 90);
  73
  74   $self->check_objects;
  75   if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
  76     $self->check_std_duplicates();
  77     $self->check_duplicates();
  78   }
  79   $self->fix_field_lengths;
  80
  81   $self->controller->track_progress(progress => 100);
  82
  83   $::myconfig{numberformat} = $old_numberformat;
  84 }
  85
  86 sub add_columns {
  87   my ($self, @columns) = @_;
  88
  89   my $h = $self->controller->headers;
  90
  91   foreach my $column (grep { !$h->{used}->{$_} } @columns) {
  92     $h->{used}->{$column} = 1;
  93     push @{ $h->{methods} }, $column;
  94     push @{ $h->{headers} }, $column;
  95   }
  96 }
  97
  98 sub add_info_columns {
  99   my ($self, @columns) = @_;
 100
 101   my $h = $self->controller->info_headers;
 102
 103   foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
 104     $h->{used}->{ $column->{method} } = 1;
 105     push @{ $h->{methods} }, $column->{method};
 106     push @{ $h->{headers} }, $column->{header};
 107   }
 108 }
 109
 110 sub add_raw_data_columns {
 111   my ($self, @columns) = @_;
 112
 113   my $h = $self->controller->raw_data_headers;
 114
 115   foreach my $column (grep { !$h->{used}->{$_} } @columns) {
 116     $h->{used}->{$column} = 1;
 117     push @{ $h->{headers} }, $column;
 118   }
 119 }
 120
 121 sub add_cvar_raw_data_columns {
 122   my ($self) = @_;
 123
 124   map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
 125 }
 126
 127 sub init_all_cvar_configs {
 128   # Must be overridden by derived specialized importer classes.
 129   return [];
 130 }
 131
 132 sub init_cvar_columns {
 133   my ($self) = @_;
 134
 135   return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
 136 }
 137
 138 sub init_all_languages {
 139   my ($self) = @_;
 140
 141   return SL::DB::Manager::Language->get_all;
 142 }
 143
 144 sub init_payment_terms_by {
 145   my ($self) = @_;
 146
 147   my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
 148   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
 149 }
 150
 151 sub init_delivery_terms_by {
 152   my ($self) = @_;
 153
 154   my $all_delivery_terms = SL::DB::Manager::DeliveryTerm->get_all;
 155   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_delivery_terms } } ) } qw(id description) };
 156 }
 157
 158 sub init_all_vc {
 159   my ($self) = @_;
 160
 161   return { customers => SL::DB::Manager::Customer->get_all,
 162            vendors   => SL::DB::Manager::Vendor->get_all };
 163 }
 164
 165 sub init_clone_methods {
 166   {}
 167 }
 168
 169 sub force_allow_columns {
 170   return ();
 171 }
 172
 173 sub init_vc_by {
 174   my ($self)    = @_;
 175
 176   my %by_id     = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
 177   my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
 178                     vendors   => { map { ( $_->vendornumber   => $_ ) } @{ $self->all_vc->{vendors}   } } );
 179   my %by_name   = ( customers => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{customers} } },
 180                     vendors   => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{vendors}   } } );
 181
 182   return { id     => \%by_id,
 183            number => \%by_number,
 184            name   => \%by_name,   };
 185 }
 186
 187 sub check_vc {
 188   my ($self, $entry, $id_column) = @_;
 189
 190   if ($entry->{object}->$id_column) {
 191     $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
 192   }
 193
 194   if (!$entry->{object}->$id_column) {
 195     my $vc = $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} }
 196           || $self->vc_by->{number}->{vendors}->{   $entry->{raw_data}->{vendornumber}   };
 197     $entry->{object}->$id_column($vc->id) if $vc;
 198   }
 199
 200   if (!$entry->{object}->$id_column) {
 201     my $vc = $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} }
 202           || $self->vc_by->{name}->{vendors}->{   $entry->{raw_data}->{vendor}   };
 203     $entry->{object}->$id_column($vc->id) if $vc;
 204   }
 205
 206   if ($entry->{object}->$id_column) {
 207     $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
 208   } else {
 209     push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
 210   }
 211 }
 212
 213 sub handle_cvars {
 214   my ($self, $entry) = @_;
 215
 216   my %type_to_column = ( text      => 'text_value',
 217                          textfield => 'text_value',
 218                          select    => 'text_value',
 219                          date      => 'timestamp_value_as_date',
 220                          timestamp => 'timestamp_value_as_date',
 221                          number    => 'number_value_as_number',
 222                          bool      => 'bool_value' );
 223
 224   my @cvars;
 225   my %changed_cvars;
 226   foreach my $config (@{ $self->all_cvar_configs }) {
 227     next unless exists $entry->{raw_data}->{ "cvar_" . $config->name };
 228     my $value  = $entry->{raw_data}->{ "cvar_" . $config->name };
 229     my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
 230
 231     my $new_cvar = SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
 232
 233     push @cvars, $new_cvar;
 234     $changed_cvars{$config->name} = $new_cvar;
 235   }
 236
 237   # merge existing with new cvars. swap every existing with the imported one, push the rest
 238   if (@cvars) {
 239     my @orig_cvars = ($entry->{object_to_save} || $entry->{object})->custom_variables;
 240     for (@orig_cvars) {
 241       $_ = $changed_cvars{ $_->config->name } if $changed_cvars{ $_->config->name };
 242       delete $changed_cvars{ $_->config->name };
 243     }
 244     push @orig_cvars, values %changed_cvars;
 245
 246     $entry->{object}->custom_variables(\@orig_cvars);
 247   }
 248 }
 249
 250 sub init_profile {
 251   my ($self) = @_;
 252
 253   eval "require " . $self->class;
 254
 255   my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
 256   delete $unwanted{$_} for ($self->force_allow_columns);
 257
 258   my %profile;
 259   for my $col ($self->class->meta->columns) {
 260     next if $unwanted{$col};
 261
 262     my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric')   ? "$col\_as_number"
 263       :        $col->isa('Rose::DB::Object::Metadata::Column::Date')      ? "$col\_as_date"
 264       :        $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
 265       :                                                                     $col->name;
 266
 267     $profile{$col} = $name;
 268   }
 269
 270   $profile{ 'cvar_' . $_->name } = '' for @{ $self->all_cvar_configs };
 271
 272   \%profile;
 273 }
 274
 275 sub add_displayable_columns {
 276   my ($self, @columns) = @_;
 277
 278   my @cols       = @{ $self->controller->displayable_columns || [] };
 279   my %ex_col_map = map { $_->{name} => $_ } @cols;
 280
 281   foreach my $column (@columns) {
 282     if ($ex_col_map{ $column->{name} }) {
 283       @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
 284     } else {
 285       push @cols, $column;
 286     }
 287   }
 288
 289   $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
 290 }
 291
 292 sub setup_displayable_columns {
 293   my ($self) = @_;
 294
 295   $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
 296 }
 297
 298 sub add_cvar_columns_to_displayable_columns {
 299   my ($self) = @_;
 300
 301   $self->add_displayable_columns(map { { name        => 'cvar_' . $_->name,
 302                                          description => $::locale->text('#1 (custom variable)', $_->description) } }
 303                                      @{ $self->all_cvar_configs });
 304 }
 305
 306 sub init_existing_objects {
 307   my ($self) = @_;
 308
 309   eval "require " . $self->class;
 310   $self->existing_objects($self->manager_class->get_all);
 311 }
 312
 313 sub init_class {
 314   die "class not set";
 315 }
 316
 317 sub init_manager_class {
 318   my ($self) = @_;
 319
 320   $self->class =~ m/^SL::DB::(.+)/;
 321   $self->manager_class("SL::DB::Manager::" . $1);
 322 }
 323
 324 sub is_multiplexed { 0 }
 325
 326 sub check_objects {
 327 }
 328
 329 sub check_duplicates {
 330 }
 331
 332 sub check_std_duplicates {
 333   my $self = shift;
 334
 335   my $duplicates = {};
 336
 337   my $all_fields = $self->get_duplicate_check_fields();
 338
 339   foreach my $key (keys(%{ $all_fields })) {
 340     if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} )  ) {
 341       $duplicates->{$key} = {};
 342     }
 343   }
 344
 345   my @duplicates_keys = keys(%{ $duplicates });
 346
 347   if ( !scalar(@duplicates_keys) ) {
 348     return;
 349   }
 350
 351   if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
 352     foreach my $object (@{ $self->existing_objects }) {
 353       foreach my $key (@duplicates_keys) {
 354         my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
 355         $duplicates->{$key}->{$value} = 'db';
 356       }
 357     }
 358   }
 359
 360   foreach my $entry (@{ $self->controller->data }) {
 361     if ( @{ $entry->{errors} } ) {
 362       next;
 363     }
 364
 365     my $object = $entry->{object};
 366
 367     foreach my $key (@duplicates_keys) {
 368       my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
 369
 370       if ( exists($duplicates->{$key}->{$value}) ) {
 371         push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
 372         last;
 373       } else {
 374         $duplicates->{$key}->{$value} = 'csv';
 375       }
 376
 377     }
 378   }
 379
 380 }
 381
 382 sub get_duplicate_check_fields {
 383   return {};
 384 }
 385
 386 sub check_payment {
 387   my ($self, $entry) = @_;
 388
 389   my $object = $entry->{object};
 390
 391   # Check whether or not payment ID is valid.
 392   if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
 393     push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
 394     return 0;
 395   }
 396
 397   # Map name to ID if given.
 398   if (!$object->payment_id && $entry->{raw_data}->{payment}) {
 399     my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
 400
 401     if (!$terms) {
 402       push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
 403       return 0;
 404     }
 405
 406     $object->payment_id($terms->id);
 407
 408     # register payment_id for method copying later
 409     $self->clone_methods->{payment_id} = 1;
 410   }
 411
 412   return 1;
 413 }
 414
 415 sub check_delivery_term {
 416   my ($self, $entry) = @_;
 417
 418   my $object = $entry->{object};
 419
 420   # Check whether or not delivery term ID is valid.
 421   if ($object->delivery_term_id && !$self->delivery_terms_by->{id}->{ $object->delivery_term_id }) {
 422     push @{ $entry->{errors} }, $::locale->text('Error: Invalid delivery terms');
 423     return 0;
 424   }
 425
 426   # Map name to ID if given.
 427   if (!$object->delivery_term_id && $entry->{raw_data}->{delivery_term}) {
 428     my $terms = $self->delivery_terms_by->{description}->{ $entry->{raw_data}->{delivery_term} };
 429
 430     if (!$terms) {
 431       push @{ $entry->{errors} }, $::locale->text('Error: Invalid delivery terms');
 432       return 0;
 433     }
 434
 435     $object->delivery_term_id($terms->id);
 436
 437     # register delivery_term_id for method copying later
 438     $self->clone_methods->{delivery_term_id} = 1;
 439   }
 440
 441   return 1;
 442 }
 443
 444 sub save_objects {
 445   my ($self, %params) = @_;
 446
 447   my $data = $params{data} || $self->controller->data;
 448
 449   return unless $data->[0];
 450   return unless $data->[0]{object};
 451
 452   $self->controller->track_progress(phase => 'saving data', progress => 0); # scale from 45..95%;
 453
 454   my $dbh = $data->[0]{object}->db;
 455
 456   $dbh->begin_work;
 457   foreach my $entry_index (0 .. $#$data) {
 458     my $entry = $data->[$entry_index];
 459     next if @{ $entry->{errors} };
 460
 461     my $object = $entry->{object_to_save} || $entry->{object};
 462
 463     my $ret;
 464     if (!eval { $ret = $object->save(cascade => !!$self->save_with_cascade()); 1 }) {
 465       push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $EVAL_ERROR);
 466     } elsif ( !$ret ) {
 467       push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $object->db->error);
 468     } else {
 469       $self->_save_history($object);
 470       $self->controller->num_imported($self->controller->num_imported + 1);
 471     }
 472   } continue {
 473     if ($entry_index % 100 == 0) {
 474       $dbh->commit;
 475       $self->controller->track_progress(progress => $entry_index/scalar(@$data) * 100); # scale from 45..95%;
 476       $dbh->begin_work;
 477     }
 478   }
 479   $dbh->commit;
 480 }
 481
 482 sub field_lengths {
 483   my ($self) = @_;
 484
 485   return map { $_->name => $_->length } grep { $_->type eq 'varchar' } @{$self->class->meta->columns};
 486 }
 487
 488 sub fix_field_lengths {
 489   my ($self) = @_;
 490
 491   my %field_lengths = $self->field_lengths;
 492   foreach my $entry (@{ $self->controller->data }) {
 493     next unless @{ $entry->{errors} };
 494     map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;
 495   }
 496 }
 497
 498 sub clean_fields {
 499   my ($self, $illegal_chars, $object, @fields) = @_;
 500
 501   my @cleaned_fields;
 502   foreach my $field (grep { $object->can($_) } @fields) {
 503     my $value = $object->$field;
 504
 505     next unless defined($value) && ($value =~ s/$illegal_chars/ /g);
 506
 507     $object->$field($value);
 508     push @cleaned_fields, $field;
 509   }
 510
 511   return @cleaned_fields;
 512 }
 513
 514 sub _save_history {
 515   my ($self, $object) = @_;
 516
 517   if (any { $_ eq $self->controller->{type} } qw(parts customers_vendors orders)) {
 518     my $snumbers = $self->controller->{type} eq 'parts'             ? 'partnumber_' . $object->partnumber
 519                  : $self->controller->{type} eq 'customers_vendors' ?
 520                      ($self->table eq 'customer' ? 'customernumber_' . $object->customernumber : 'vendornumber_' . $object->vendornumber)
 521                  : $self->controller->{type} eq 'orders'            ? 'ordnumber_' . $object->ordnumber
 522                  : '';
 523
 524     my $what_done = $self->controller->{type} eq 'orders' ? 'sales_order'
 525                   : '';
 526
 527     SL::DB::History->new(
 528       trans_id    => $object->id,
 529       snumbers    => $snumbers,
 530       employee_id => $self->controller->{employee_id},
 531       addition    => 'SAVED',
 532       what_done   => $what_done,
 533     )->save();
 534   }
 535 }
 536
 537 1;