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 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) ],
25 $self->controller->track_progress(phase => 'parsing csv', progress => 0);
27 my $profile = $self->profile;
28 $self->csv(SL::Helper::Csv->new(file => $self->file->file_name,
29 encoding => $self->controller->profile->get('charset'),
30 class => $self->class,
32 ignore_unknown_columns => 1,
34 case_insensitive_header => 1,
35 map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
38 $self->controller->track_progress(progress => 10);
40 my $old_numberformat = $::myconfig{numberformat};
41 $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
45 $self->controller->track_progress(progress => 50);
47 $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
49 return if ( !$self->csv->header || $self->csv->errors );
51 my $headers = { headers => [ grep { $profile->{$_} } @{ $self->csv->header } ] };
52 $headers->{methods} = [ map { $profile->{$_} } @{ $headers->{headers} } ];
53 $headers->{used} = { map { ($_ => 1) } @{ $headers->{headers} } };
54 $self->controller->headers($headers);
55 $self->controller->raw_data_headers({ used => { }, headers => [ ] });
56 $self->controller->info_headers({ used => { }, headers => [ ] });
58 my @objects = $self->csv->get_objects;
60 $self->controller->track_progress(progress => 70);
62 my @raw_data = @{ $self->csv->get_data };
64 $self->controller->track_progress(progress => 80);
66 $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @objects, @raw_data ]);
68 $self->controller->track_progress(progress => 90);
71 if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
72 $self->check_std_duplicates();
73 $self->check_duplicates();
75 $self->fix_field_lengths;
77 $self->controller->track_progress(progress => 100);
79 $::myconfig{numberformat} = $old_numberformat;
83 my ($self, @columns) = @_;
85 my $h = $self->controller->headers;
87 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
88 $h->{used}->{$column} = 1;
89 push @{ $h->{methods} }, $column;
90 push @{ $h->{headers} }, $column;
94 sub add_info_columns {
95 my ($self, @columns) = @_;
97 my $h = $self->controller->info_headers;
99 foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
100 $h->{used}->{ $column->{method} } = 1;
101 push @{ $h->{methods} }, $column->{method};
102 push @{ $h->{headers} }, $column->{header};
106 sub add_raw_data_columns {
107 my ($self, @columns) = @_;
109 my $h = $self->controller->raw_data_headers;
111 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
112 $h->{used}->{$column} = 1;
113 push @{ $h->{headers} }, $column;
117 sub add_cvar_raw_data_columns {
120 map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
123 sub init_cvar_columns {
126 return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
129 sub init_all_languages {
132 return SL::DB::Manager::Language->get_all;
135 sub init_payment_terms_by {
138 my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
139 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
145 return { customers => SL::DB::Manager::Customer->get_all,
146 vendors => SL::DB::Manager::Vendor->get_all };
152 my %by_id = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
153 my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
154 vendors => { map { ( $_->vendornumber => $_ ) } @{ $self->all_vc->{vendors} } } );
155 my %by_name = ( customers => { map { ( $_->name => $_ ) } @{ $self->all_vc->{customers} } },
156 vendors => { map { ( $_->name => $_ ) } @{ $self->all_vc->{vendors} } } );
158 return { id => \%by_id,
159 number => \%by_number,
160 name => \%by_name, };
164 my ($self, $entry, $id_column) = @_;
166 if ($entry->{object}->$id_column) {
167 $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
170 if (!$entry->{object}->$id_column) {
171 my $vc = $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} }
172 || $self->vc_by->{number}->{vendors}->{ $entry->{raw_data}->{vendornumber} };
173 $entry->{object}->$id_column($vc->id) if $vc;
176 if (!$entry->{object}->$id_column) {
177 my $vc = $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} }
178 || $self->vc_by->{name}->{vendors}->{ $entry->{raw_data}->{vendor} };
179 $entry->{object}->$id_column($vc->id) if $vc;
182 if ($entry->{object}->$id_column) {
183 $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
185 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
190 my ($self, $entry) = @_;
192 return unless $self->can('all_cvar_configs');
194 my %type_to_column = ( text => 'text_value',
195 textfield => 'text_value',
196 select => 'text_value',
197 date => 'timestamp_value_as_date',
198 timestamp => 'timestamp_value_as_date',
199 number => 'number_value_as_number',
200 bool => 'bool_value' );
203 foreach my $config (@{ $self->all_cvar_configs }) {
204 next unless exists $entry->{raw_data}->{ "cvar_" . $config->name };
205 my $value = $entry->{raw_data}->{ "cvar_" . $config->name };
206 my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
208 push @cvars, SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
211 $entry->{object}->custom_variables(\@cvars);
217 eval "require " . $self->class;
219 my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
221 for my $col ($self->class->meta->columns) {
222 next if $unwanted{$col};
224 my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric') ? "$col\_as_number"
225 : $col->isa('Rose::DB::Object::Metadata::Column::Date') ? "$col\_as_date"
226 : $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
229 $profile{$col} = $name;
232 if ($self->can('all_cvar_configs')) {
233 for (@{ $self->all_cvar_configs }) {
234 $profile{ 'cvar_' . $_->name } = '';
238 $self->profile(\%profile);
241 sub add_displayable_columns {
242 my ($self, @columns) = @_;
244 my @cols = @{ $self->controller->displayable_columns || [] };
245 my %ex_col_map = map { $_->{name} => $_ } @cols;
247 foreach my $column (@columns) {
248 if ($ex_col_map{ $column->{name} }) {
249 @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
255 $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
258 sub setup_displayable_columns {
261 $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
264 sub add_cvar_columns_to_displayable_columns {
267 return unless $self->can('all_cvar_configs');
269 $self->add_displayable_columns(map { { name => 'cvar_' . $_->name,
270 description => $::locale->text('#1 (custom variable)', $_->description) } }
271 @{ $self->all_cvar_configs });
274 sub init_existing_objects {
277 eval "require " . $self->class;
278 $self->existing_objects($self->manager_class->get_all);
285 sub init_manager_class {
288 $self->class =~ m/^SL::DB::(.+)/;
289 $self->manager_class("SL::DB::Manager::" . $1);
295 sub check_duplicates {
298 sub check_std_duplicates {
303 my $all_fields = $self->get_duplicate_check_fields();
305 foreach my $key (keys(%{ $all_fields })) {
306 if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} ) ) {
307 $duplicates->{$key} = {};
311 my @duplicates_keys = keys(%{ $duplicates });
313 if ( !scalar(@duplicates_keys) ) {
317 if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
318 foreach my $object (@{ $self->existing_objects }) {
319 foreach my $key (@duplicates_keys) {
320 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
321 $duplicates->{$key}->{$value} = 'db';
326 foreach my $entry (@{ $self->controller->data }) {
327 if ( @{ $entry->{errors} } ) {
331 my $object = $entry->{object};
333 foreach my $key (@duplicates_keys) {
334 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
336 if ( exists($duplicates->{$key}->{$value}) ) {
337 push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
340 $duplicates->{$key}->{$value} = 'csv';
348 sub get_duplicate_check_fields {
353 my ($self, $entry) = @_;
355 my $object = $entry->{object};
357 # Check whether or not payment ID is valid.
358 if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
359 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
363 # Map name to ID if given.
364 if (!$object->payment_id && $entry->{raw_data}->{payment}) {
365 my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
368 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
372 $object->payment_id($terms->id);
379 my ($self, %params) = @_;
381 my $data = $params{data} || $self->controller->data;
383 return unless $data->[0];
384 return unless $data->[0]{object};
386 $self->controller->track_progress(phase => 'saving objects', progress => 0); # scale from 45..95%;
388 my $dbh = $data->[0]{object}->db;
391 foreach my $entry_index (0 .. $#$data) {
392 my $entry = $data->[$entry_index];
393 next if @{ $entry->{errors} };
395 my $object = $entry->{object_to_save} || $entry->{object};
397 if ( !$object->save(cascade => !!$self->save_with_cascade()) ) {
398 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $entry->{object}->db->error);
400 $self->controller->num_imported($self->controller->num_imported + 1);
403 if ($entry_index % 100 == 0) {
405 $self->controller->track_progress(progress => $entry_index/scalar(@$data) * 100); # scale from 45..95%;
416 sub fix_field_lengths {
419 my %field_lengths = $self->field_lengths;
420 foreach my $entry (@{ $self->controller->data }) {
421 next unless @{ $entry->{errors} };
422 map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;