1 package SL::Controller::CsvImport::Base;
5 use English qw(-no_match_vars);
6 use List::MoreUtils qw(pairwise any);
11 use SL::DB::PaymentTerm;
12 use SL::DB::DeliveryTerm;
17 use parent qw(Rose::Object);
19 use Rose::Object::MakeMethods::Generic
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) ],
26 my ($self, %params) = @_;
28 $self->test_run($params{test});
30 $self->controller->track_progress(phase => 'parsing csv', progress => 0);
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,
38 case_insensitive_header => 1,
39 map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
42 $self->controller->track_progress(progress => 10);
44 my $old_numberformat = $::myconfig{numberformat};
45 $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
49 $self->controller->track_progress(progress => 50);
51 $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
53 return if ( !$self->csv->header || $self->csv->errors );
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 => [ ] });
62 my $objects = $self->csv->get_objects;
64 $self->controller->track_progress(progress => 70);
66 my @raw_data = @{ $self->csv->get_data };
68 $self->controller->track_progress(progress => 80);
70 $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @$objects, @raw_data ]);
72 $self->controller->track_progress(progress => 90);
75 if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
76 $self->check_std_duplicates();
77 $self->check_duplicates();
79 $self->fix_field_lengths;
81 $self->controller->track_progress(progress => 100);
83 $::myconfig{numberformat} = $old_numberformat;
87 my ($self, @columns) = @_;
89 my $h = $self->controller->headers;
91 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
92 $h->{used}->{$column} = 1;
93 push @{ $h->{methods} }, $column;
94 push @{ $h->{headers} }, $column;
98 sub add_info_columns {
99 my ($self, @columns) = @_;
101 my $h = $self->controller->info_headers;
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};
110 sub add_raw_data_columns {
111 my ($self, @columns) = @_;
113 my $h = $self->controller->raw_data_headers;
115 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
116 $h->{used}->{$column} = 1;
117 push @{ $h->{headers} }, $column;
121 sub add_cvar_raw_data_columns {
124 map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
127 sub init_all_cvar_configs {
128 # Must be overridden by derived specialized importer classes.
132 sub init_cvar_columns {
135 return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
138 sub init_all_languages {
141 return SL::DB::Manager::Language->get_all;
144 sub init_payment_terms_by {
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) };
151 sub init_delivery_terms_by {
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) };
161 return { customers => SL::DB::Manager::Customer->get_all,
162 vendors => SL::DB::Manager::Vendor->get_all };
165 sub init_clone_methods {
169 sub force_allow_columns {
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} } } );
182 return { id => \%by_id,
183 number => \%by_number,
184 name => \%by_name, };
188 my ($self, $entry, $id_column) = @_;
190 if ($entry->{object}->$id_column) {
191 $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
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;
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;
206 if ($entry->{object}->$id_column) {
207 $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
209 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
214 my ($self, $entry) = @_;
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' );
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";
231 my $new_cvar = SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
233 push @cvars, $new_cvar;
234 $changed_cvars{$config->name} = $new_cvar;
237 # merge existing with new cvars. swap every existing with the imported one, push the rest
239 my @orig_cvars = ($entry->{object_to_save} || $entry->{object})->custom_variables;
241 $_ = $changed_cvars{ $_->config->name } if $changed_cvars{ $_->config->name };
242 delete $changed_cvars{ $_->config->name };
244 push @orig_cvars, values %changed_cvars;
246 $entry->{object}->custom_variables(\@orig_cvars);
253 eval "require " . $self->class;
255 my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
256 delete $unwanted{$_} for ($self->force_allow_columns);
259 for my $col ($self->class->meta->columns) {
260 next if $unwanted{$col};
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"
267 $profile{$col} = $name;
270 $profile{ 'cvar_' . $_->name } = '' for @{ $self->all_cvar_configs };
275 sub add_displayable_columns {
276 my ($self, @columns) = @_;
278 my @cols = @{ $self->controller->displayable_columns || [] };
279 my %ex_col_map = map { $_->{name} => $_ } @cols;
281 foreach my $column (@columns) {
282 if ($ex_col_map{ $column->{name} }) {
283 @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
289 $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
292 sub setup_displayable_columns {
295 $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
298 sub add_cvar_columns_to_displayable_columns {
301 $self->add_displayable_columns(map { { name => 'cvar_' . $_->name,
302 description => $::locale->text('#1 (custom variable)', $_->description) } }
303 @{ $self->all_cvar_configs });
306 sub init_existing_objects {
309 eval "require " . $self->class;
310 $self->existing_objects($self->manager_class->get_all);
317 sub init_manager_class {
320 $self->class =~ m/^SL::DB::(.+)/;
321 $self->manager_class("SL::DB::Manager::" . $1);
324 sub is_multiplexed { 0 }
329 sub check_duplicates {
332 sub check_std_duplicates {
337 my $all_fields = $self->get_duplicate_check_fields();
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} = {};
345 my @duplicates_keys = keys(%{ $duplicates });
347 if ( !scalar(@duplicates_keys) ) {
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';
360 foreach my $entry (@{ $self->controller->data }) {
361 if ( @{ $entry->{errors} } ) {
365 my $object = $entry->{object};
367 foreach my $key (@duplicates_keys) {
368 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
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'));
374 $duplicates->{$key}->{$value} = 'csv';
382 sub get_duplicate_check_fields {
387 my ($self, $entry) = @_;
389 my $object = $entry->{object};
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');
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} };
402 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
406 $object->payment_id($terms->id);
408 # register payment_id for method copying later
409 $self->clone_methods->{payment_id} = 1;
415 sub check_delivery_term {
416 my ($self, $entry) = @_;
418 my $object = $entry->{object};
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');
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} };
431 push @{ $entry->{errors} }, $::locale->text('Error: Invalid delivery terms');
435 $object->delivery_term_id($terms->id);
437 # register delivery_term_id for method copying later
438 $self->clone_methods->{delivery_term_id} = 1;
445 my ($self, %params) = @_;
447 my $data = $params{data} || $self->controller->data;
449 return unless $data->[0];
450 return unless $data->[0]{object};
452 $self->controller->track_progress(phase => 'saving data', progress => 0); # scale from 45..95%;
454 my $dbh = $data->[0]{object}->db;
457 foreach my $entry_index (0 .. $#$data) {
458 my $entry = $data->[$entry_index];
459 next if @{ $entry->{errors} };
461 my $object = $entry->{object_to_save} || $entry->{object};
464 if (!eval { $ret = $object->save(cascade => !!$self->save_with_cascade()); 1 }) {
465 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $EVAL_ERROR);
467 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $object->db->error);
469 $self->_save_history($object);
470 $self->controller->num_imported($self->controller->num_imported + 1);
473 if ($entry_index % 100 == 0) {
475 $self->controller->track_progress(progress => $entry_index/scalar(@$data) * 100); # scale from 45..95%;
485 return map { $_->name => $_->length } grep { $_->type eq 'varchar' } @{$self->class->meta->columns};
488 sub fix_field_lengths {
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;
499 my ($self, $illegal_chars, $object, @fields) = @_;
502 foreach my $field (grep { $object->can($_) } @fields) {
503 my $value = $object->$field;
505 next unless defined($value) && ($value =~ s/$illegal_chars/ /g);
507 $object->$field($value);
508 push @cleaned_fields, $field;
511 return @cleaned_fields;
515 my ($self, $object) = @_;
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
524 my $what_done = $self->controller->{type} eq 'orders' ? 'sales_order'
527 SL::DB::History->new(
528 trans_id => $object->id,
529 snumbers => $snumbers,
530 employee_id => $self->controller->{employee_id},
532 what_done => $what_done,