1 package SL::Controller::CsvImport::Base;
5 use List::MoreUtils qw(pairwise);
10 use SL::DB::PaymentTerm;
14 use parent qw(Rose::Object);
16 use Rose::Object::MakeMethods::Generic
18 scalar => [ qw(controller file csv test_run 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) ],
23 my ($self, %params) = @_;
25 $self->test_run($params{test_run});
27 $self->controller->track_progress(phase => 'parsing csv', progress => 0);
29 my $profile = $self->profile;
30 $self->csv(SL::Helper::Csv->new(file => $self->file->file_name,
31 encoding => $self->controller->profile->get('charset'),
32 class => $self->class,
34 ignore_unknown_columns => 1,
36 case_insensitive_header => 1,
37 map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
40 $self->controller->track_progress(progress => 10);
42 my $old_numberformat = $::myconfig{numberformat};
43 $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
47 $self->controller->track_progress(progress => 50);
49 $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
51 return if ( !$self->csv->header || $self->csv->errors );
53 my $headers = { headers => [ grep { $profile->{$_} } @{ $self->csv->header } ] };
54 $headers->{methods} = [ map { $profile->{$_} } @{ $headers->{headers} } ];
55 $headers->{used} = { map { ($_ => 1) } @{ $headers->{headers} } };
56 $self->controller->headers($headers);
57 $self->controller->raw_data_headers({ used => { }, headers => [ ] });
58 $self->controller->info_headers({ used => { }, headers => [ ] });
60 my @objects = $self->csv->get_objects;
62 $self->controller->track_progress(progress => 70);
64 my @raw_data = @{ $self->csv->get_data };
66 $self->controller->track_progress(progress => 80);
68 $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @objects, @raw_data ]);
70 $self->controller->track_progress(progress => 90);
73 if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
74 $self->check_std_duplicates();
75 $self->check_duplicates();
77 $self->fix_field_lengths;
79 $self->controller->track_progress(progress => 100);
81 $::myconfig{numberformat} = $old_numberformat;
85 my ($self, @columns) = @_;
87 my $h = $self->controller->headers;
89 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
90 $h->{used}->{$column} = 1;
91 push @{ $h->{methods} }, $column;
92 push @{ $h->{headers} }, $column;
96 sub add_info_columns {
97 my ($self, @columns) = @_;
99 my $h = $self->controller->info_headers;
101 foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
102 $h->{used}->{ $column->{method} } = 1;
103 push @{ $h->{methods} }, $column->{method};
104 push @{ $h->{headers} }, $column->{header};
108 sub add_raw_data_columns {
109 my ($self, @columns) = @_;
111 my $h = $self->controller->raw_data_headers;
113 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
114 $h->{used}->{$column} = 1;
115 push @{ $h->{headers} }, $column;
119 sub add_cvar_raw_data_columns {
122 map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
125 sub init_all_cvar_configs {
126 # Must be overridden by derived specialized importer classes.
130 sub init_cvar_columns {
133 return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
136 sub init_all_languages {
139 return SL::DB::Manager::Language->get_all;
142 sub init_payment_terms_by {
145 my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
146 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
152 return { customers => SL::DB::Manager::Customer->get_all,
153 vendors => SL::DB::Manager::Vendor->get_all };
156 sub force_allow_columns {
163 my %by_id = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
164 my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
165 vendors => { map { ( $_->vendornumber => $_ ) } @{ $self->all_vc->{vendors} } } );
166 my %by_name = ( customers => { map { ( $_->name => $_ ) } @{ $self->all_vc->{customers} } },
167 vendors => { map { ( $_->name => $_ ) } @{ $self->all_vc->{vendors} } } );
169 return { id => \%by_id,
170 number => \%by_number,
171 name => \%by_name, };
175 my ($self, $entry, $id_column) = @_;
177 if ($entry->{object}->$id_column) {
178 $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
181 if (!$entry->{object}->$id_column) {
182 my $vc = $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} }
183 || $self->vc_by->{number}->{vendors}->{ $entry->{raw_data}->{vendornumber} };
184 $entry->{object}->$id_column($vc->id) if $vc;
187 if (!$entry->{object}->$id_column) {
188 my $vc = $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} }
189 || $self->vc_by->{name}->{vendors}->{ $entry->{raw_data}->{vendor} };
190 $entry->{object}->$id_column($vc->id) if $vc;
193 if ($entry->{object}->$id_column) {
194 $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
196 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
201 my ($self, $entry) = @_;
203 my %type_to_column = ( text => 'text_value',
204 textfield => 'text_value',
205 select => 'text_value',
206 date => 'timestamp_value_as_date',
207 timestamp => 'timestamp_value_as_date',
208 number => 'number_value_as_number',
209 bool => 'bool_value' );
212 foreach my $config (@{ $self->all_cvar_configs }) {
213 next unless exists $entry->{raw_data}->{ "cvar_" . $config->name };
214 my $value = $entry->{raw_data}->{ "cvar_" . $config->name };
215 my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
217 push @cvars, SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
220 $entry->{object}->custom_variables(\@cvars);
226 eval "require " . $self->class;
228 my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
229 delete $unwanted{$_} for ($self->force_allow_columns);
232 for my $col ($self->class->meta->columns) {
233 next if $unwanted{$col};
235 my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric') ? "$col\_as_number"
236 : $col->isa('Rose::DB::Object::Metadata::Column::Date') ? "$col\_as_date"
237 : $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
240 $profile{$col} = $name;
243 $profile{ 'cvar_' . $_->name } = '' for @{ $self->all_cvar_configs };
248 sub add_displayable_columns {
249 my ($self, @columns) = @_;
251 my @cols = @{ $self->controller->displayable_columns || [] };
252 my %ex_col_map = map { $_->{name} => $_ } @cols;
254 foreach my $column (@columns) {
255 if ($ex_col_map{ $column->{name} }) {
256 @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
262 $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
265 sub setup_displayable_columns {
268 $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
271 sub add_cvar_columns_to_displayable_columns {
274 $self->add_displayable_columns(map { { name => 'cvar_' . $_->name,
275 description => $::locale->text('#1 (custom variable)', $_->description) } }
276 @{ $self->all_cvar_configs });
279 sub init_existing_objects {
282 eval "require " . $self->class;
283 $self->existing_objects($self->manager_class->get_all);
290 sub init_manager_class {
293 $self->class =~ m/^SL::DB::(.+)/;
294 $self->manager_class("SL::DB::Manager::" . $1);
300 sub check_duplicates {
303 sub check_std_duplicates {
308 my $all_fields = $self->get_duplicate_check_fields();
310 foreach my $key (keys(%{ $all_fields })) {
311 if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} ) ) {
312 $duplicates->{$key} = {};
316 my @duplicates_keys = keys(%{ $duplicates });
318 if ( !scalar(@duplicates_keys) ) {
322 if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
323 foreach my $object (@{ $self->existing_objects }) {
324 foreach my $key (@duplicates_keys) {
325 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
326 $duplicates->{$key}->{$value} = 'db';
331 foreach my $entry (@{ $self->controller->data }) {
332 if ( @{ $entry->{errors} } ) {
336 my $object = $entry->{object};
338 foreach my $key (@duplicates_keys) {
339 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
341 if ( exists($duplicates->{$key}->{$value}) ) {
342 push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
345 $duplicates->{$key}->{$value} = 'csv';
353 sub get_duplicate_check_fields {
358 my ($self, $entry) = @_;
360 my $object = $entry->{object};
362 # Check whether or not payment ID is valid.
363 if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
364 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
368 # Map name to ID if given.
369 if (!$object->payment_id && $entry->{raw_data}->{payment}) {
370 my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
373 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
377 $object->payment_id($terms->id);
384 my ($self, %params) = @_;
386 my $data = $params{data} || $self->controller->data;
388 return unless $data->[0];
389 return unless $data->[0]{object};
391 $self->controller->track_progress(phase => 'saving data', progress => 0); # scale from 45..95%;
393 my $dbh = $data->[0]{object}->db;
396 foreach my $entry_index (0 .. $#$data) {
397 my $entry = $data->[$entry_index];
398 next if @{ $entry->{errors} };
400 my $object = $entry->{object_to_save} || $entry->{object};
402 if ( !$object->save(cascade => !!$self->save_with_cascade()) ) {
403 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $entry->{object}->db->error);
405 $self->controller->num_imported($self->controller->num_imported + 1);
408 if ($entry_index % 100 == 0) {
410 $self->controller->track_progress(progress => $entry_index/scalar(@$data) * 100); # scale from 45..95%;
421 sub fix_field_lengths {
424 my %field_lengths = $self->field_lengths;
425 foreach my $entry (@{ $self->controller->data }) {
426 next unless @{ $entry->{errors} };
427 map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;
432 my ($self, $illegal_chars, $object, @fields) = @_;
435 foreach my $field (grep { $object->can($_) } @fields) {
436 my $value = $object->$field;
438 next unless defined($value) && ($value =~ s/$illegal_chars/ /g);
440 $object->$field($value);
441 push @cleaned_fields, $field;
444 return @cleaned_fields;