1 package SL::Controller::CsvImport::Base;
5 use List::MoreUtils qw(pairwise);
11 use SL::DB::PaymentTerm;
15 use parent qw(Rose::Object);
17 use Rose::Object::MakeMethods::Generic
19 scalar => [ qw(controller file csv test_run save_with_cascade) ],
20 '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) ],
24 my ($self, %params) = @_;
26 $self->test_run($params{test_run});
28 $self->controller->track_progress(phase => 'parsing csv', progress => 0);
30 my $profile = $self->profile;
31 $self->csv(SL::Helper::Csv->new(file => $self->file->file_name,
32 encoding => $self->controller->profile->get('charset'),
33 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 $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
52 return if ( !$self->csv->header || $self->csv->errors );
54 my $headers = { headers => [ grep { $profile->{$_} } @{ $self->csv->header } ] };
55 $headers->{methods} = [ map { $profile->{$_} } @{ $headers->{headers} } ];
56 $headers->{used} = { map { ($_ => 1) } @{ $headers->{headers} } };
57 $self->controller->headers($headers);
58 $self->controller->raw_data_headers({ used => { }, headers => [ ] });
59 $self->controller->info_headers({ used => { }, headers => [ ] });
61 my @objects = $self->csv->get_objects;
63 $self->controller->track_progress(progress => 70);
65 my @raw_data = @{ $self->csv->get_data };
67 $self->controller->track_progress(progress => 80);
69 $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @objects, @raw_data ]);
71 $self->controller->track_progress(progress => 90);
74 if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
75 $self->check_std_duplicates();
76 $self->check_duplicates();
78 $self->fix_field_lengths;
80 $self->controller->track_progress(progress => 100);
82 $::myconfig{numberformat} = $old_numberformat;
86 my ($self, @columns) = @_;
88 my $h = $self->controller->headers;
90 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
91 $h->{used}->{$column} = 1;
92 push @{ $h->{methods} }, $column;
93 push @{ $h->{headers} }, $column;
97 sub add_info_columns {
98 my ($self, @columns) = @_;
100 my $h = $self->controller->info_headers;
102 foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
103 $h->{used}->{ $column->{method} } = 1;
104 push @{ $h->{methods} }, $column->{method};
105 push @{ $h->{headers} }, $column->{header};
109 sub add_raw_data_columns {
110 my ($self, @columns) = @_;
112 my $h = $self->controller->raw_data_headers;
114 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
115 $h->{used}->{$column} = 1;
116 push @{ $h->{headers} }, $column;
120 sub add_cvar_raw_data_columns {
123 map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
126 sub init_all_cvar_configs {
127 # Must be overridden by derived specialized importer classes.
131 sub init_cvar_columns {
134 return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
137 sub init_all_languages {
140 return SL::DB::Manager::Language->get_all;
143 sub init_all_currencies {
146 return SL::DB::Manager::Currency->get_all;
149 sub init_default_currency_id {
152 return SL::DB::Default->get->currency_id;
155 sub init_payment_terms_by {
158 my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
159 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
165 return { customers => SL::DB::Manager::Customer->get_all,
166 vendors => SL::DB::Manager::Vendor->get_all };
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' );
225 foreach my $config (@{ $self->all_cvar_configs }) {
226 next unless exists $entry->{raw_data}->{ "cvar_" . $config->name };
227 my $value = $entry->{raw_data}->{ "cvar_" . $config->name };
228 my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
230 push @cvars, SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
233 $entry->{object}->custom_variables(\@cvars);
239 eval "require " . $self->class;
241 my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
242 delete $unwanted{$_} for ($self->force_allow_columns);
245 for my $col ($self->class->meta->columns) {
246 next if $unwanted{$col};
248 my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric') ? "$col\_as_number"
249 : $col->isa('Rose::DB::Object::Metadata::Column::Date') ? "$col\_as_date"
250 : $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
253 $profile{$col} = $name;
256 $profile{ 'cvar_' . $_->name } = '' for @{ $self->all_cvar_configs };
261 sub add_displayable_columns {
262 my ($self, @columns) = @_;
264 my @cols = @{ $self->controller->displayable_columns || [] };
265 my %ex_col_map = map { $_->{name} => $_ } @cols;
267 foreach my $column (@columns) {
268 if ($ex_col_map{ $column->{name} }) {
269 @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
275 $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
278 sub setup_displayable_columns {
281 $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
284 sub add_cvar_columns_to_displayable_columns {
287 $self->add_displayable_columns(map { { name => 'cvar_' . $_->name,
288 description => $::locale->text('#1 (custom variable)', $_->description) } }
289 @{ $self->all_cvar_configs });
292 sub init_existing_objects {
295 eval "require " . $self->class;
296 $self->existing_objects($self->manager_class->get_all);
303 sub init_manager_class {
306 $self->class =~ m/^SL::DB::(.+)/;
307 $self->manager_class("SL::DB::Manager::" . $1);
313 sub check_duplicates {
316 sub check_std_duplicates {
321 my $all_fields = $self->get_duplicate_check_fields();
323 foreach my $key (keys(%{ $all_fields })) {
324 if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} ) ) {
325 $duplicates->{$key} = {};
329 my @duplicates_keys = keys(%{ $duplicates });
331 if ( !scalar(@duplicates_keys) ) {
335 if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
336 foreach my $object (@{ $self->existing_objects }) {
337 foreach my $key (@duplicates_keys) {
338 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
339 $duplicates->{$key}->{$value} = 'db';
344 foreach my $entry (@{ $self->controller->data }) {
345 if ( @{ $entry->{errors} } ) {
349 my $object = $entry->{object};
351 foreach my $key (@duplicates_keys) {
352 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
354 if ( exists($duplicates->{$key}->{$value}) ) {
355 push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
358 $duplicates->{$key}->{$value} = 'csv';
366 sub get_duplicate_check_fields {
371 my ($self, $entry) = @_;
373 my $object = $entry->{object};
375 # Check whether or not payment ID is valid.
376 if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
377 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
381 # Map name to ID if given.
382 if (!$object->payment_id && $entry->{raw_data}->{payment}) {
383 my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
386 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
390 $object->payment_id($terms->id);
397 my ($self, %params) = @_;
399 my $data = $params{data} || $self->controller->data;
401 return unless $data->[0];
402 return unless $data->[0]{object};
404 $self->controller->track_progress(phase => 'saving data', progress => 0); # scale from 45..95%;
406 my $dbh = $data->[0]{object}->db;
409 foreach my $entry_index (0 .. $#$data) {
410 my $entry = $data->[$entry_index];
411 next if @{ $entry->{errors} };
413 my $object = $entry->{object_to_save} || $entry->{object};
415 if ( !$object->save(cascade => !!$self->save_with_cascade()) ) {
416 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $entry->{object}->db->error);
418 $self->controller->num_imported($self->controller->num_imported + 1);
421 if ($entry_index % 100 == 0) {
423 $self->controller->track_progress(progress => $entry_index/scalar(@$data) * 100); # scale from 45..95%;
434 sub fix_field_lengths {
437 my %field_lengths = $self->field_lengths;
438 foreach my $entry (@{ $self->controller->data }) {
439 next unless @{ $entry->{errors} };
440 map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;
445 my ($self, $illegal_chars, $object, @fields) = @_;
448 foreach my $field (grep { $object->can($_) } @fields) {
449 my $value = $object->$field;
451 next unless defined($value) && ($value =~ s/$illegal_chars/ /g);
453 $object->$field($value);
454 push @cleaned_fields, $field;
457 return @cleaned_fields;