1 package SL::Controller::CsvImport::Base;
5 use List::MoreUtils qw(pairwise any);
11 use SL::DB::PaymentTerm;
16 use parent qw(Rose::Object);
18 use Rose::Object::MakeMethods::Generic
20 scalar => [ qw(controller file csv test_run save_with_cascade) ],
21 'scalar --get_set_init' => [ qw(is_multiplexed 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) ],
25 my ($self, %params) = @_;
27 $self->test_run($params{test_run});
29 $self->controller->track_progress(phase => 'parsing csv', progress => 0);
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 profile => [{ profile => $profile, class => $self->class }],
35 ignore_unknown_columns => 1,
37 case_insensitive_header => 1,
38 map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
41 $self->controller->track_progress(progress => 10);
43 my $old_numberformat = $::myconfig{numberformat};
44 $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
48 $self->controller->track_progress(progress => 50);
50 if ($self->csv->is_multiplexed) {
51 die "controller for multiplex data is not implemented yet";
54 $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
56 return if ( !$self->csv->header || $self->csv->errors );
58 my $headers = { headers => [ grep { $profile->{$_} } @{ $self->csv->header->[0] } ] };
59 $headers->{methods} = [ map { $profile->{$_} } @{ $headers->{headers} } ];
60 $headers->{used} = { map { ($_ => 1) } @{ $headers->{headers} } };
61 $self->controller->headers($headers);
62 $self->controller->raw_data_headers({ used => { }, headers => [ ] });
63 $self->controller->info_headers({ used => { }, headers => [ ] });
65 my @objects = $self->csv->get_objects;
67 $self->controller->track_progress(progress => 70);
69 my @raw_data = @{ $self->csv->get_data };
71 $self->controller->track_progress(progress => 80);
73 $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @objects, @raw_data ]);
75 $self->controller->track_progress(progress => 90);
78 if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
79 $self->check_std_duplicates();
80 $self->check_duplicates();
82 $self->fix_field_lengths;
84 $self->controller->track_progress(progress => 100);
86 $::myconfig{numberformat} = $old_numberformat;
90 my ($self, @columns) = @_;
92 my $h = $self->controller->headers;
94 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
95 $h->{used}->{$column} = 1;
96 push @{ $h->{methods} }, $column;
97 push @{ $h->{headers} }, $column;
101 sub add_info_columns {
102 my ($self, @columns) = @_;
104 my $h = $self->controller->info_headers;
106 foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
107 $h->{used}->{ $column->{method} } = 1;
108 push @{ $h->{methods} }, $column->{method};
109 push @{ $h->{headers} }, $column->{header};
113 sub add_raw_data_columns {
114 my ($self, @columns) = @_;
116 my $h = $self->controller->raw_data_headers;
118 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
119 $h->{used}->{$column} = 1;
120 push @{ $h->{headers} }, $column;
124 sub add_cvar_raw_data_columns {
127 map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
130 sub init_all_cvar_configs {
131 # Must be overridden by derived specialized importer classes.
135 sub init_cvar_columns {
138 return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
141 sub init_all_languages {
144 return SL::DB::Manager::Language->get_all;
147 sub init_all_currencies {
150 return SL::DB::Manager::Currency->get_all;
153 sub init_default_currency_id {
156 return SL::DB::Default->get->currency_id;
159 sub init_payment_terms_by {
162 my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
163 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
169 return { customers => SL::DB::Manager::Customer->get_all,
170 vendors => SL::DB::Manager::Vendor->get_all };
173 sub force_allow_columns {
180 my %by_id = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
181 my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
182 vendors => { map { ( $_->vendornumber => $_ ) } @{ $self->all_vc->{vendors} } } );
183 my %by_name = ( customers => { map { ( $_->name => $_ ) } @{ $self->all_vc->{customers} } },
184 vendors => { map { ( $_->name => $_ ) } @{ $self->all_vc->{vendors} } } );
186 return { id => \%by_id,
187 number => \%by_number,
188 name => \%by_name, };
192 my ($self, $entry, $id_column) = @_;
194 if ($entry->{object}->$id_column) {
195 $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
198 if (!$entry->{object}->$id_column) {
199 my $vc = $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} }
200 || $self->vc_by->{number}->{vendors}->{ $entry->{raw_data}->{vendornumber} };
201 $entry->{object}->$id_column($vc->id) if $vc;
204 if (!$entry->{object}->$id_column) {
205 my $vc = $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} }
206 || $self->vc_by->{name}->{vendors}->{ $entry->{raw_data}->{vendor} };
207 $entry->{object}->$id_column($vc->id) if $vc;
210 if ($entry->{object}->$id_column) {
211 $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
213 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
218 my ($self, $entry) = @_;
220 my %type_to_column = ( text => 'text_value',
221 textfield => 'text_value',
222 select => 'text_value',
223 date => 'timestamp_value_as_date',
224 timestamp => 'timestamp_value_as_date',
225 number => 'number_value_as_number',
226 bool => 'bool_value' );
229 foreach my $config (@{ $self->all_cvar_configs }) {
230 next unless exists $entry->{raw_data}->{ "cvar_" . $config->name };
231 my $value = $entry->{raw_data}->{ "cvar_" . $config->name };
232 my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
234 push @cvars, SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
237 $entry->{object}->custom_variables(\@cvars);
243 eval "require " . $self->class;
245 my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
246 delete $unwanted{$_} for ($self->force_allow_columns);
249 for my $col ($self->class->meta->columns) {
250 next if $unwanted{$col};
252 my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric') ? "$col\_as_number"
253 : $col->isa('Rose::DB::Object::Metadata::Column::Date') ? "$col\_as_date"
254 : $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
257 $profile{$col} = $name;
260 $profile{ 'cvar_' . $_->name } = '' for @{ $self->all_cvar_configs };
265 sub add_displayable_columns {
266 my ($self, @columns) = @_;
268 my @cols = @{ $self->controller->displayable_columns || [] };
269 my %ex_col_map = map { $_->{name} => $_ } @cols;
271 foreach my $column (@columns) {
272 if ($ex_col_map{ $column->{name} }) {
273 @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
279 $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
282 sub setup_displayable_columns {
285 $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
288 sub add_cvar_columns_to_displayable_columns {
291 $self->add_displayable_columns(map { { name => 'cvar_' . $_->name,
292 description => $::locale->text('#1 (custom variable)', $_->description) } }
293 @{ $self->all_cvar_configs });
296 sub init_existing_objects {
299 eval "require " . $self->class;
300 $self->existing_objects($self->manager_class->get_all);
307 sub init_manager_class {
310 $self->class =~ m/^SL::DB::(.+)/;
311 $self->manager_class("SL::DB::Manager::" . $1);
314 sub init_is_multiplexed {
317 $self->is_multiplexed('ARRAY' eq ref ($self->class) && scalar @{ $self->class } > 1);
323 sub check_duplicates {
326 sub check_std_duplicates {
331 my $all_fields = $self->get_duplicate_check_fields();
333 foreach my $key (keys(%{ $all_fields })) {
334 if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} ) ) {
335 $duplicates->{$key} = {};
339 my @duplicates_keys = keys(%{ $duplicates });
341 if ( !scalar(@duplicates_keys) ) {
345 if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
346 foreach my $object (@{ $self->existing_objects }) {
347 foreach my $key (@duplicates_keys) {
348 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
349 $duplicates->{$key}->{$value} = 'db';
354 foreach my $entry (@{ $self->controller->data }) {
355 if ( @{ $entry->{errors} } ) {
359 my $object = $entry->{object};
361 foreach my $key (@duplicates_keys) {
362 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
364 if ( exists($duplicates->{$key}->{$value}) ) {
365 push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
368 $duplicates->{$key}->{$value} = 'csv';
376 sub get_duplicate_check_fields {
381 my ($self, $entry) = @_;
383 my $object = $entry->{object};
385 # Check whether or not payment ID is valid.
386 if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
387 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
391 # Map name to ID if given.
392 if (!$object->payment_id && $entry->{raw_data}->{payment}) {
393 my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
396 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
400 $object->payment_id($terms->id);
407 my ($self, %params) = @_;
409 my $data = $params{data} || $self->controller->data;
411 return unless $data->[0];
412 return unless $data->[0]{object};
414 $self->controller->track_progress(phase => 'saving data', progress => 0); # scale from 45..95%;
416 my $dbh = $data->[0]{object}->db;
419 foreach my $entry_index (0 .. $#$data) {
420 my $entry = $data->[$entry_index];
421 next if @{ $entry->{errors} };
423 my $object = $entry->{object_to_save} || $entry->{object};
426 if (!eval { $ret = $object->save(cascade => !!$self->save_with_cascade()); 1 }) {
427 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $@);
429 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $entry->{object}->db->error);
431 $self->_save_history($object);
432 $self->controller->num_imported($self->controller->num_imported + 1);
435 if ($entry_index % 100 == 0) {
437 $self->controller->track_progress(progress => $entry_index/scalar(@$data) * 100); # scale from 45..95%;
448 sub fix_field_lengths {
451 my %field_lengths = $self->field_lengths;
452 foreach my $entry (@{ $self->controller->data }) {
453 next unless @{ $entry->{errors} };
454 map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;
459 my ($self, $illegal_chars, $object, @fields) = @_;
462 foreach my $field (grep { $object->can($_) } @fields) {
463 my $value = $object->$field;
465 next unless defined($value) && ($value =~ s/$illegal_chars/ /g);
467 $object->$field($value);
468 push @cleaned_fields, $field;
471 return @cleaned_fields;
475 my ($self, $object) = @_;
477 if (any { $_ eq $self->controller->{type} } qw(parts customers_vendors)) {
478 my $snumbers = $self->controller->{type} eq 'parts' ? 'partnumber_' . $object->partnumber
479 : $self->controller->{type} eq 'customers_vendors' ?
480 ($self->table eq 'customer' ? 'customernumber_' . $object->customernumber : 'vendornumber_' . $object->vendornumber)
483 SL::DB::History->new(
484 trans_id => $object->id,
485 snumbers => $snumbers,
486 employee_id => $self->controller->{employee_id},