SL/Controller/CsvImport/Base.pm

   1 package SL::Controller::CsvImport::Base;
   2
   3 use strict;
   4
   5 use List::MoreUtils qw(pairwise);
   6
   7 use SL::Helper::Csv;
   8 use SL::DB::Customer;
   9 use SL::DB::Language;
  10 use SL::DB::PaymentTerm;
  11 use SL::DB::Vendor;
  12 use SL::DB::Contact;
  13
  14 use parent qw(Rose::Object);
  15
  16 use Rose::Object::MakeMethods::Generic
  17 (
  18  scalar                  => [ qw(controller file csv save_with_cascade) ],
  19  '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) ],
  20 );
  21
  22 sub run {
  23   my ($self) = @_;
  24
  25   my $profile = $self->profile;
  26   $self->csv(SL::Helper::Csv->new(file                   => $self->file->file_name,
  27                                   encoding               => $self->controller->profile->get('charset'),
  28                                   class                  => $self->class,
  29                                   profile                => $profile,
  30                                   ignore_unknown_columns => 1,
  31                                   strict_profile         => 1,
  32                                   map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
  33                                  ));
  34
  35   my $old_numberformat      = $::myconfig{numberformat};
  36   $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
  37
  38   $self->csv->parse;
  39
  40   $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
  41
  42   return unless $self->csv->header;
  43
  44   my $headers         = { headers => [ grep { $profile->{$_} } @{ $self->csv->header } ] };
  45   $headers->{methods} = [ map { $profile->{$_} } @{ $headers->{headers} } ];
  46   $headers->{used}    = { map { ($_ => 1) }      @{ $headers->{headers} } };
  47   $self->controller->headers($headers);
  48   $self->controller->raw_data_headers({ used => { }, headers => [ ] });
  49   $self->controller->info_headers({ used => { }, headers => [ ] });
  50
  51   my @objects  = $self->csv->get_objects;
  52   my @raw_data = @{ $self->csv->get_data };
  53   $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @objects, @raw_data ]);
  54
  55   $self->check_objects;
  56   $self->check_duplicates if $self->controller->profile->get('duplicates', 'no_check') ne 'no_check';
  57   $self->fix_field_lengths;
  58
  59   $::myconfig{numberformat} = $old_numberformat;
  60 }
  61
  62 sub add_columns {
  63   my ($self, @columns) = @_;
  64
  65   my $h = $self->controller->headers;
  66
  67   foreach my $column (grep { !$h->{used}->{$_} } @columns) {
  68     $h->{used}->{$column} = 1;
  69     push @{ $h->{methods} }, $column;
  70     push @{ $h->{headers} }, $column;
  71   }
  72 }
  73
  74 sub add_info_columns {
  75   my ($self, @columns) = @_;
  76
  77   my $h = $self->controller->info_headers;
  78
  79   foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
  80     $h->{used}->{ $column->{method} } = 1;
  81     push @{ $h->{methods} }, $column->{method};
  82     push @{ $h->{headers} }, $column->{header};
  83   }
  84 }
  85
  86 sub add_raw_data_columns {
  87   my ($self, @columns) = @_;
  88
  89   my $h = $self->controller->raw_data_headers;
  90
  91   foreach my $column (grep { !$h->{used}->{$_} } @columns) {
  92     $h->{used}->{$column} = 1;
  93     push @{ $h->{headers} }, $column;
  94   }
  95 }
  96
  97 sub add_cvar_raw_data_columns {
  98   my ($self) = @_;
  99
 100   map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
 101 }
 102
 103 sub init_cvar_columns {
 104   my ($self) = @_;
 105
 106   return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
 107 }
 108
 109 sub init_all_languages {
 110   my ($self) = @_;
 111
 112   return SL::DB::Manager::Language->get_all;
 113 }
 114
 115 sub init_payment_terms_by {
 116   my ($self) = @_;
 117
 118   my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
 119   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
 120 }
 121
 122 sub init_all_vc {
 123   my ($self) = @_;
 124
 125   return { customers => SL::DB::Manager::Customer->get_all,
 126            vendors   => SL::DB::Manager::Vendor->get_all };
 127 }
 128
 129 sub init_vc_by {
 130   my ($self)    = @_;
 131
 132   my %by_id     = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
 133   my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
 134                     vendors   => { map { ( $_->vendornumber   => $_ ) } @{ $self->all_vc->{vendors}   } } );
 135   my %by_name   = ( customers => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{customers} } },
 136                     vendors   => { map { ( $_->name           => $_ ) } @{ $self->all_vc->{vendors}   } } );
 137
 138   return { id     => \%by_id,
 139            number => \%by_number,
 140            name   => \%by_name,   };
 141 }
 142
 143 sub check_vc {
 144   my ($self, $entry, $id_column) = @_;
 145
 146   if ($entry->{object}->$id_column) {
 147     $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
 148   }
 149
 150   if (!$entry->{object}->$id_column) {
 151     my $vc = $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} }
 152           || $self->vc_by->{number}->{vendors}->{   $entry->{raw_data}->{vendornumber}   };
 153     $entry->{object}->$id_column($vc->id) if $vc;
 154   }
 155
 156   if (!$entry->{object}->$id_column) {
 157     my $vc = $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} }
 158           || $self->vc_by->{name}->{vendors}->{   $entry->{raw_data}->{vendor}   };
 159     $entry->{object}->$id_column($vc->id) if $vc;
 160   }
 161
 162   if ($entry->{object}->$id_column) {
 163     $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
 164   } else {
 165     push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
 166   }
 167 }
 168
 169 sub handle_cvars {
 170   my ($self, $entry) = @_;
 171
 172   return unless $self->can('all_cvar_configs');
 173
 174   my %type_to_column = ( text      => 'text_value',
 175                          textfield => 'text_value',
 176                          select    => 'text_value',
 177                          date      => 'timestamp_value_as_date',
 178                          timestamp => 'timestamp_value_as_date',
 179                          number    => 'number_value_as_number',
 180                          bool      => 'bool_value' );
 181
 182   my @cvars;
 183   foreach my $config (@{ $self->all_cvar_configs }) {
 184     next unless exists $entry->{raw_data}->{ "cvar_" . $config->name };
 185     my $value  = $entry->{raw_data}->{ "cvar_" . $config->name };
 186     my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
 187
 188     push @cvars, SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
 189   }
 190
 191   $entry->{object}->custom_variables(\@cvars);
 192 }
 193
 194 sub init_profile {
 195   my ($self) = @_;
 196
 197   eval "require " . $self->class;
 198
 199   my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
 200   my %profile;
 201   for my $col ($self->class->meta->columns) {
 202     next if $unwanted{$col};
 203
 204     my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric')   ? "$col\_as_number"
 205       :        $col->isa('Rose::DB::Object::Metadata::Column::Date')      ? "$col\_as_date"
 206       :        $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
 207       :                                                                     $col->name;
 208
 209     $profile{$col} = $name;
 210   }
 211
 212   $self->profile(\%profile);
 213 }
 214
 215 sub add_displayable_columns {
 216   my ($self, @columns) = @_;
 217
 218   my @cols       = @{ $self->controller->displayable_columns || [] };
 219   my %ex_col_map = map { $_->{name} => $_ } @cols;
 220
 221   foreach my $column (@columns) {
 222     if ($ex_col_map{ $column->{name} }) {
 223       @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
 224     } else {
 225       push @cols, $column;
 226     }
 227   }
 228
 229   $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
 230 }
 231
 232 sub setup_displayable_columns {
 233   my ($self) = @_;
 234
 235   $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
 236 }
 237
 238 sub add_cvar_columns_to_displayable_columns {
 239   my ($self) = @_;
 240
 241   return unless $self->can('all_cvar_configs');
 242
 243   $self->add_displayable_columns(map { { name        => 'cvar_' . $_->name,
 244                                          description => $::locale->text('#1 (custom variable)', $_->description) } }
 245                                      @{ $self->all_cvar_configs });
 246 }
 247
 248 sub init_existing_objects {
 249   my ($self) = @_;
 250
 251   eval "require " . $self->class;
 252   $self->existing_objects($self->manager_class->get_all);
 253 }
 254
 255 sub init_class {
 256   die "class not set";
 257 }
 258
 259 sub init_manager_class {
 260   my ($self) = @_;
 261
 262   $self->class =~ m/^SL::DB::(.+)/;
 263   $self->manager_class("SL::DB::Manager::" . $1);
 264 }
 265
 266 sub check_objects {
 267 }
 268
 269 sub check_duplicates {
 270 }
 271
 272 sub check_payment {
 273   my ($self, $entry) = @_;
 274
 275   my $object = $entry->{object};
 276
 277   # Check whether or not payment ID is valid.
 278   if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
 279     push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
 280     return 0;
 281   }
 282
 283   # Map name to ID if given.
 284   if (!$object->payment_id && $entry->{raw_data}->{payment}) {
 285     my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
 286
 287     if (!$terms) {
 288       push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
 289       return 0;
 290     }
 291
 292     $object->payment_id($terms->id);
 293   }
 294
 295   return 1;
 296 }
 297
 298 sub save_objects {
 299   my ($self, %params) = @_;
 300
 301   my $data = $params{data} || $self->controller->data;
 302
 303   foreach my $entry (@{ $data }) {
 304     next if @{ $entry->{errors} };
 305
 306     my $object = $entry->{object_to_save} || $entry->{object};
 307
 308     if ( !$object->save(cascade => !!$self->save_with_cascade()) ) {
 309       push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $entry->{object}->db->error);
 310     } else {
 311       $self->controller->num_imported($self->controller->num_imported + 1);
 312     }
 313   }
 314 }
 315
 316 sub field_lengths {
 317   return ();
 318 }
 319
 320 sub fix_field_lengths {
 321   my ($self) = @_;
 322
 323   my %field_lengths = $self->field_lengths;
 324   foreach my $entry (@{ $self->controller->data }) {
 325     next unless @{ $entry->{errors} };
 326     map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;
 327   }
 328 }
 329
 330 1;