SL/Controller/CsvImport/Base.pm

   1 package SL::Controller::CsvImport::Base;
   2
   3 use strict;
   4
   5 use List::MoreUtils qw(pairwise any);
   6
   7 use SL::Helper::Csv;
   8 use SL::DB::Currency;
   9 use SL::DB::Customer;
  10 use SL::DB::Language;
  11 use SL::DB::PaymentTerm;
  12 use SL::DB::Vendor;
  13 use SL::DB::Contact;
  14 use SL::DB::History;
  15
  16 use parent qw(Rose::Object);
  17
  18 use Rose::Object::MakeMethods::Generic
  19 (
  20  scalar                  => [ qw(controller file csv test_run save_with_cascade) ],
  21  'scalar --get_set_init' => [ qw(profile displayable_columns existing_objects class manager_class cvar_columns all_cvar_configs all_languages payment_terms_by all_currencies default_currency_id all_vc vc_by) ],
  22 );
  23
  24 sub run {
  25   my ($self, %params) = @_;
  26
  27   $self->test_run($params{test_run});
  28
  29   $self->controller->track_progress(phase => 'parsing csv', progress => 0);
  30
  31   my $profile = $self->profile;
  32   $self->csv(SL::Helper::Csv->new(file                   => $self->file->file_name,
  33                                   encoding               => $self->controller->profile->get('charset'),
  34                                   class                  => $self->class,
  35                                   profile                => $profile,
  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_all_currencies {
 145   my ($self) = @_;
 146
 147   return SL::DB::Manager::Currency->get_all;
 148 }
 149
 150 sub init_default_currency_id {
 151   my ($self) = @_;
 152
 153   return SL::DB::Default->get->currency_id;
 154 }
 155
 156 sub init_payment_terms_by {
 157   my ($self) = @_;
 158
 159   my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
 160   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
 161 }
 162
 163 sub init_all_vc {
 164   my ($self) = @_;
 165
 166   return { customers => SL::DB::Manager::Customer->get_all,
 167            vendors   => SL::DB::Manager::Vendor->get_all };
 168 }
 169
 170 sub force_allow_columns {
 171   return ();
 172 }
 173
 174 sub init_vc_by {
 175   my ($self)    = @_;
 176
 177   my %by_id     = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
 178   my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
 179                     vendors   => { map { ( $_->vendornumber   => $_ ) } @{ $self->all_vc->{vendors}   } } );
 180   my %by_name   = ( customers => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{customers} } },
 181                     vendors   => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{vendors}   } } );
 182
 183   return { id     => \%by_id,
 184            number => \%by_number,
 185            name   => \%by_name,   };
 186 }
 187
 188 sub check_vc {
 189   my ($self, $entry, $id_column) = @_;
 190
 191   if ($entry->{object}->$id_column) {
 192     $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
 193   }
 194
 195   if (!$entry->{object}->$id_column) {
 196     my $vc = $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} }
 197           || $self->vc_by->{number}->{vendors}->{   $entry->{raw_data}->{vendornumber}   };
 198     $entry->{object}->$id_column($vc->id) if $vc;
 199   }
 200
 201   if (!$entry->{object}->$id_column) {
 202     my $vc = $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} }
 203           || $self->vc_by->{name}->{vendors}->{   $entry->{raw_data}->{vendor}   };
 204     $entry->{object}->$id_column($vc->id) if $vc;
 205   }
 206
 207   if ($entry->{object}->$id_column) {
 208     $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
 209   } else {
 210     push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
 211   }
 212 }
 213
 214 sub handle_cvars {
 215   my ($self, $entry) = @_;
 216
 217   my %type_to_column = ( text      => 'text_value',
 218                          textfield => 'text_value',
 219                          select    => 'text_value',
 220                          date      => 'timestamp_value_as_date',
 221                          timestamp => 'timestamp_value_as_date',
 222                          number    => 'number_value_as_number',
 223                          bool      => 'bool_value' );
 224
 225   my @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     push @cvars, SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
 232   }
 233
 234   $entry->{object}->custom_variables(\@cvars);
 235 }
 236
 237 sub init_profile {
 238   my ($self) = @_;
 239
 240   eval "require " . $self->class;
 241
 242   my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
 243   delete $unwanted{$_} for ($self->force_allow_columns);
 244
 245   my %profile;
 246   for my $col ($self->class->meta->columns) {
 247     next if $unwanted{$col};
 248
 249     my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric')   ? "$col\_as_number"
 250       :        $col->isa('Rose::DB::Object::Metadata::Column::Date')      ? "$col\_as_date"
 251       :        $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
 252       :                                                                     $col->name;
 253
 254     $profile{$col} = $name;
 255   }
 256
 257   $profile{ 'cvar_' . $_->name } = '' for @{ $self->all_cvar_configs };
 258
 259   \%profile;
 260 }
 261
 262 sub add_displayable_columns {
 263   my ($self, @columns) = @_;
 264
 265   my @cols       = @{ $self->controller->displayable_columns || [] };
 266   my %ex_col_map = map { $_->{name} => $_ } @cols;
 267
 268   foreach my $column (@columns) {
 269     if ($ex_col_map{ $column->{name} }) {
 270       @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
 271     } else {
 272       push @cols, $column;
 273     }
 274   }
 275
 276   $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
 277 }
 278
 279 sub setup_displayable_columns {
 280   my ($self) = @_;
 281
 282   $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
 283 }
 284
 285 sub add_cvar_columns_to_displayable_columns {
 286   my ($self) = @_;
 287
 288   $self->add_displayable_columns(map { { name        => 'cvar_' . $_->name,
 289                                          description => $::locale->text('#1 (custom variable)', $_->description) } }
 290                                      @{ $self->all_cvar_configs });
 291 }
 292
 293 sub init_existing_objects {
 294   my ($self) = @_;
 295
 296   eval "require " . $self->class;
 297   $self->existing_objects($self->manager_class->get_all);
 298 }
 299
 300 sub init_class {
 301   die "class not set";
 302 }
 303
 304 sub init_manager_class {
 305   my ($self) = @_;
 306
 307   $self->class =~ m/^SL::DB::(.+)/;
 308   $self->manager_class("SL::DB::Manager::" . $1);
 309 }
 310
 311 sub check_objects {
 312 }
 313
 314 sub check_duplicates {
 315 }
 316
 317 sub check_std_duplicates {
 318   my $self = shift;
 319
 320   my $duplicates = {};
 321
 322   my $all_fields = $self->get_duplicate_check_fields();
 323
 324   foreach my $key (keys(%{ $all_fields })) {
 325     if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} )  ) {
 326       $duplicates->{$key} = {};
 327     }
 328   }
 329
 330   my @duplicates_keys = keys(%{ $duplicates });
 331
 332   if ( !scalar(@duplicates_keys) ) {
 333     return;
 334   }
 335
 336   if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
 337     foreach my $object (@{ $self->existing_objects }) {
 338       foreach my $key (@duplicates_keys) {
 339         my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
 340         $duplicates->{$key}->{$value} = 'db';
 341       }
 342     }
 343   }
 344
 345   foreach my $entry (@{ $self->controller->data }) {
 346     if ( @{ $entry->{errors} } ) {
 347       next;
 348     }
 349
 350     my $object = $entry->{object};
 351
 352     foreach my $key (@duplicates_keys) {
 353       my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
 354
 355       if ( exists($duplicates->{$key}->{$value}) ) {
 356         push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
 357         last;
 358       } else {
 359         $duplicates->{$key}->{$value} = 'csv';
 360       }
 361
 362     }
 363   }
 364
 365 }
 366
 367 sub get_duplicate_check_fields {
 368   return {};
 369 }
 370
 371 sub check_payment {
 372   my ($self, $entry) = @_;
 373
 374   my $object = $entry->{object};
 375
 376   # Check whether or not payment ID is valid.
 377   if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
 378     push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
 379     return 0;
 380   }
 381
 382   # Map name to ID if given.
 383   if (!$object->payment_id && $entry->{raw_data}->{payment}) {
 384     my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
 385
 386     if (!$terms) {
 387       push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
 388       return 0;
 389     }
 390
 391     $object->payment_id($terms->id);
 392   }
 393
 394   return 1;
 395 }
 396
 397 sub save_objects {
 398   my ($self, %params) = @_;
 399
 400   my $data = $params{data} || $self->controller->data;
 401
 402   return unless $data->[0];
 403   return unless $data->[0]{object};
 404
 405   $self->controller->track_progress(phase => 'saving data', progress => 0); # scale from 45..95%;
 406
 407   my $dbh = $data->[0]{object}->db;
 408
 409   $dbh->begin_work;
 410   foreach my $entry_index (0 .. $#$data) {
 411     my $entry = $data->[$entry_index];
 412     next if @{ $entry->{errors} };
 413
 414     my $object = $entry->{object_to_save} || $entry->{object};
 415
 416     if ( !$object->save(cascade => !!$self->save_with_cascade()) ) {
 417       push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $entry->{object}->db->error);
 418     } else {
 419       $self->_save_history($object);
 420       $self->controller->num_imported($self->controller->num_imported + 1);
 421     }
 422   } continue {
 423     if ($entry_index % 100 == 0) {
 424       $dbh->commit;
 425       $self->controller->track_progress(progress => $entry_index/scalar(@$data) * 100); # scale from 45..95%;
 426       $dbh->begin_work;
 427     }
 428   }
 429   $dbh->commit;
 430 }
 431
 432 sub field_lengths {
 433   return ();
 434 }
 435
 436 sub fix_field_lengths {
 437   my ($self) = @_;
 438
 439   my %field_lengths = $self->field_lengths;
 440   foreach my $entry (@{ $self->controller->data }) {
 441     next unless @{ $entry->{errors} };
 442     map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;
 443   }
 444 }
 445
 446 sub clean_fields {
 447   my ($self, $illegal_chars, $object, @fields) = @_;
 448
 449   my @cleaned_fields;
 450   foreach my $field (grep { $object->can($_) } @fields) {
 451     my $value = $object->$field;
 452
 453     next unless defined($value) && ($value =~ s/$illegal_chars/ /g);
 454
 455     $object->$field($value);
 456     push @cleaned_fields, $field;
 457   }
 458
 459   return @cleaned_fields;
 460 }
 461
 462 sub _save_history {
 463   my ($self, $object) = @_;
 464
 465   if (any { $_ eq $self->controller->{type} } qw(parts customers_vendors)) {
 466     my $snumbers = $self->controller->{type} eq 'parts'             ? 'partnumber_' . $object->partnumber
 467                  : $self->controller->{type} eq 'customers_vendors' ?
 468                      ($self->table eq 'customer' ? 'customernumber_' . $object->customernumber : 'vendornumber_' . $object->vendornumber)
 469                  : '';
 470
 471     SL::DB::History->new(
 472       trans_id    => $object->id,
 473       snumbers    => $snumbers,
 474       employee_id => $self->controller->{employee_id},
 475       addition    => 'SAVED',
 476     )->save();
 477   }
 478 }
 479
 480 1;