1 package SL::Controller::CsvImport::Base;
5 use English qw(-no_match_vars);
6 use List::Util qw(min);
7 use List::MoreUtils qw(pairwise any);
12 use SL::DB::BankAccount;
15 use SL::DB::PaymentTerm;
16 use SL::DB::DeliveryTerm;
21 use parent qw(Rose::Object);
23 use Rose::Object::MakeMethods::Generic
25 scalar => [ qw(controller file csv test_run save_with_cascade) ],
26 '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_bank_accounts all_vc vc_by vc_counts_by clone_methods) ],
30 my ($self, %params) = @_;
32 $self->test_run($params{test});
34 $self->controller->track_progress(phase => 'parsing csv', progress => 0);
36 my $profile = $self->profile;
37 $self->csv(SL::Helper::Csv->new(file => ('SCALAR' eq ref $self->file)? $self->file: $self->file->file_name,
38 encoding => $self->controller->profile->get('charset'),
39 profile => [{ profile => $profile, class => $self->class, mapping => $self->controller->mappings_for_profile }],
40 ignore_unknown_columns => 1,
42 case_insensitive_header => 1,
43 map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
46 $self->controller->track_progress(progress => 10);
48 local $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
49 local $::myconfig{dateformat} = $self->controller->profile->get('dateformat');
53 $self->controller->track_progress(progress => 50);
55 $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
57 return if ( !$self->csv->header || $self->csv->errors );
59 my $headers = { headers => [ grep { $self->csv->dispatcher->is_known($_, 0) } @{ $self->csv->header } ] };
60 $headers->{methods} = [ map { $_->{path} } @{ $self->csv->specs->[0] } ];
61 $headers->{used} = { map { ($_ => 1) } @{ $headers->{headers} } };
62 $self->controller->headers($headers);
63 $self->controller->raw_data_headers({ used => { }, headers => [ ] });
64 $self->controller->info_headers({ used => { }, headers => [ ] });
66 my $objects = $self->csv->get_objects;
68 $self->controller->track_progress(progress => 70);
70 my @raw_data = @{ $self->csv->get_data };
72 $self->controller->track_progress(progress => 80);
74 $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @$objects, @raw_data ]);
76 $self->controller->track_progress(progress => 90);
79 if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
80 $self->check_std_duplicates();
81 $self->check_duplicates();
83 $self->fix_field_lengths;
85 $self->controller->track_progress(progress => 100);
89 my ($self, @columns) = @_;
91 my $h = $self->controller->headers;
93 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
94 $h->{used}->{$column} = 1;
95 push @{ $h->{methods} }, $column;
96 push @{ $h->{headers} }, $column;
100 sub add_info_columns {
101 my ($self, @columns) = @_;
103 my $h = $self->controller->info_headers;
105 foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
106 $h->{used}->{ $column->{method} } = 1;
107 push @{ $h->{methods} }, $column->{method};
108 push @{ $h->{headers} }, $column->{header};
112 sub add_raw_data_columns {
113 my ($self, @columns) = @_;
115 my $h = $self->controller->raw_data_headers;
117 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
118 $h->{used}->{$column} = 1;
119 push @{ $h->{headers} }, $column;
123 sub add_cvar_raw_data_columns {
126 map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
129 sub init_all_cvar_configs {
130 # Must be overridden by derived specialized importer classes.
134 sub init_cvar_columns {
137 return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
140 sub init_all_languages {
143 return SL::DB::Manager::Language->get_all;
146 sub init_all_bank_accounts {
149 return SL::DB::Manager::BankAccount->get_all_sorted( query => [ obsolete => 0 ] );
152 sub init_payment_terms_by {
155 my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
156 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
159 sub init_delivery_terms_by {
162 my $all_delivery_terms = SL::DB::Manager::DeliveryTerm->get_all;
163 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_delivery_terms } } ) } qw(id description) };
169 return { customers => SL::DB::Manager::Customer->get_all,
170 vendors => SL::DB::Manager::Vendor->get_all };
173 sub init_clone_methods {
177 sub force_allow_columns {
184 my %by_id = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
185 my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
186 vendors => { map { ( $_->vendornumber => $_ ) } @{ $self->all_vc->{vendors} } } );
187 my %by_name = ( customers => { map { ( $_->name => $_ ) } @{ $self->all_vc->{customers} } },
188 vendors => { map { ( $_->name => $_ ) } @{ $self->all_vc->{vendors} } } );
189 my %by_gln = ( customers => { map { ( $_->gln => $_ ) } grep $_->gln, @{ $self->all_vc->{customers} } },
190 vendors => { map { ( $_->gln => $_ ) } grep $_->gln, @{ $self->all_vc->{vendors} } } );
192 return { id => \%by_id,
193 number => \%by_number,
198 sub init_vc_counts_by {
201 my $vc_counts_by = {};
203 $vc_counts_by->{number}->{customers}->{$_->customernumber}++ for @{ $self->all_vc->{customers} };
204 $vc_counts_by->{number}->{vendors}-> {$_->vendornumber}++ for @{ $self->all_vc->{vendors} };
205 $vc_counts_by->{name}-> {customers}->{$_->name}++ for @{ $self->all_vc->{customers} };
206 $vc_counts_by->{name}-> {vendors}-> {$_->name}++ for @{ $self->all_vc->{vendors} };
207 $vc_counts_by->{gln}-> {customers}->{$_->gln}++ for grep $_->gln, @{ $self->all_vc->{customers} };
208 $vc_counts_by->{gln}-> {vendors}-> {$_->gln}++ for grep $_->gln, @{ $self->all_vc->{vendors} };
210 return $vc_counts_by;
214 my ($self, $entry, $id_column) = @_;
216 if ($entry->{object}->$id_column) {
217 $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
221 if (!$entry->{object}->$id_column) {
223 if ($entry->{raw_data}->{customernumber}) {
224 $vc = $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} };
225 if ($vc && $self->vc_counts_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} } > 1) {
229 } elsif ($entry->{raw_data}->{vendornumber}) {
230 $vc = $self->vc_by->{number}->{vendors}->{ $entry->{raw_data}->{vendornumber} };
231 if ($vc && $self->vc_counts_by->{number}->{vendors}->{ $entry->{raw_data}->{vendornumber} } > 1) {
237 $entry->{object}->$id_column($vc->id) if $vc;
240 if (!$entry->{object}->$id_column) {
242 if ($entry->{raw_data}->{customer}) {
243 $vc = $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} };
244 if ($vc && $self->vc_counts_by->{name}->{customers}->{ $entry->{raw_data}->{customer} } > 1) {
248 } elsif ($entry->{raw_data}->{vendor}) {
249 $vc = $self->vc_by->{name}->{vendors}->{ $entry->{raw_data}->{vendor} };
250 if ($vc && $self->vc_counts_by->{name}->{vendors}->{ $entry->{raw_data}->{vendor} } > 1) {
256 $entry->{object}->$id_column($vc->id) if $vc;
259 if (!$entry->{object}->$id_column) {
261 if ($entry->{raw_data}->{customer_gln}) {
262 $vc = $self->vc_by->{gln}->{customers}->{ $entry->{raw_data}->{customer_gln} };
263 if ($vc && $self->vc_counts_by->{gln}->{customers}->{ $entry->{raw_data}->{customer_gln} } > 1) {
267 } elsif ($entry->{raw_data}->{vendor_gln}) {
268 $vc = $self->vc_by->{gln}->{vendors}->{ $entry->{raw_data}->{vendor_gln} };
269 if ($vc && $self->vc_counts_by->{gln}->{vendors}->{ $entry->{raw_data}->{vendor_gln} } > 1) {
274 $entry->{object}->$id_column($vc->id) if $vc;
277 if ($entry->{object}->$id_column) {
278 $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
281 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor is ambiguous');
283 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
289 my ($self, $entry) = @_;
291 my $object = $entry->{object_to_save} || $entry->{object};
292 return unless $object->can('cvars_by_config');
294 my %type_to_column = ( text => 'text_value',
295 textfield => 'text_value',
296 htmlfield => 'text_value',
297 select => 'text_value',
298 date => 'timestamp_value_as_date',
299 timestamp => 'timestamp_value_as_date',
300 number => 'number_value_as_number',
301 bool => 'bool_value' );
303 # autovivify all cvars (cvars_by_config will do that for us)
306 foreach my $config (@{ $self->all_cvar_configs }) {
307 next unless exists $entry->{raw_data}->{ "cvar_" . $config->name };
308 my $value = $entry->{raw_data}->{ "cvar_" . $config->name };
309 my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
311 my $new_cvar = SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
313 push @cvars, $new_cvar;
314 $changed_cvars{$config->name} = $new_cvar;
317 # merge existing with new cvars. swap every existing with the imported one, push the rest
318 my @orig_cvars = @{ $object->cvars_by_config };
320 $_ = $changed_cvars{ $_->config->name } if $changed_cvars{ $_->config->name };
321 delete $changed_cvars{ $_->config->name };
323 push @orig_cvars, values %changed_cvars;
324 $object->custom_variables(\@orig_cvars);
330 eval "require " . $self->class;
332 my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
333 delete $unwanted{$_} for ($self->force_allow_columns);
336 for my $col ($self->class->meta->columns) {
337 next if $unwanted{$col};
339 my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric') ? "$col\_as_number"
340 : $col->isa('Rose::DB::Object::Metadata::Column::Date') ? "$col\_as_date"
341 : $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
344 $profile{$col} = $name;
347 $profile{ 'cvar_' . $_->name } = '' for @{ $self->all_cvar_configs };
352 sub add_displayable_columns {
353 my ($self, @columns) = @_;
355 my @cols = @{ $self->controller->displayable_columns || [] };
356 my %ex_col_map = map { $_->{name} => $_ } @cols;
358 foreach my $column (@columns) {
359 if ($ex_col_map{ $column->{name} }) {
360 @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
366 $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
369 sub setup_displayable_columns {
372 $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
375 sub add_cvar_columns_to_displayable_columns {
378 $self->add_displayable_columns(map { { name => 'cvar_' . $_->name,
379 description => $::locale->text('#1 (custom variable)', $_->description) } }
380 @{ $self->all_cvar_configs });
383 sub init_existing_objects {
386 eval "require " . $self->class;
387 $self->existing_objects($self->manager_class->get_all);
394 sub init_manager_class {
397 $self->class =~ m/^SL::DB::(.+)/;
398 $self->manager_class("SL::DB::Manager::" . $1);
401 sub is_multiplexed { 0 }
406 sub check_duplicates {
410 $::auth->assert('config');
413 sub check_std_duplicates {
418 my $all_fields = $self->get_duplicate_check_fields();
420 foreach my $key (keys(%{ $all_fields })) {
421 if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} ) ) {
422 $duplicates->{$key} = {};
426 my @duplicates_keys = keys(%{ $duplicates });
428 if ( !scalar(@duplicates_keys) ) {
432 if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
433 foreach my $object (@{ $self->existing_objects }) {
434 foreach my $key (@duplicates_keys) {
435 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
436 $duplicates->{$key}->{$value} = 'db';
441 foreach my $entry (@{ $self->controller->data }) {
442 if ( @{ $entry->{errors} } ) {
446 my $object = $entry->{object};
448 foreach my $key (@duplicates_keys) {
449 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
451 if ( exists($duplicates->{$key}->{$value}) ) {
452 push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
455 $duplicates->{$key}->{$value} = 'csv';
463 sub get_duplicate_check_fields {
468 my ($self, $entry) = @_;
470 my $object = $entry->{object};
472 # Check whether or not payment ID is valid.
473 if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
474 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
478 # Map name to ID if given.
479 if (!$object->payment_id && $entry->{raw_data}->{payment}) {
480 my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
483 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
487 $object->payment_id($terms->id);
489 # register payment_id for method copying later
490 $self->clone_methods->{payment_id} = 1;
496 sub check_delivery_term {
497 my ($self, $entry) = @_;
499 my $object = $entry->{object};
501 # Check whether or not delivery term ID is valid.
502 if ($object->delivery_term_id && !$self->delivery_terms_by->{id}->{ $object->delivery_term_id }) {
503 push @{ $entry->{errors} }, $::locale->text('Error: Invalid delivery terms');
507 # Map name to ID if given.
508 if (!$object->delivery_term_id && $entry->{raw_data}->{delivery_term}) {
509 my $terms = $self->delivery_terms_by->{description}->{ $entry->{raw_data}->{delivery_term} };
512 push @{ $entry->{errors} }, $::locale->text('Error: Invalid delivery terms');
516 $object->delivery_term_id($terms->id);
518 # register delivery_term_id for method copying later
519 $self->clone_methods->{delivery_term_id} = 1;
526 my ($self, %params) = @_;
528 my $data = $params{data} || $self->controller->data;
530 return unless $data->[0];
531 return unless $data->[0]{object};
533 $self->controller->track_progress(phase => 'saving data', progress => 0); # scale from 45..95%;
535 my $last_index = $#$data;
536 my $chunk_size = 100; # one transaction and progress update every 100 objects
538 for my $chunk (0 .. $last_index / $chunk_size) {
539 $self->controller->track_progress(progress => ($chunk_size * $chunk)/scalar(@$data) * 100); # scale from 45..95%;
540 SL::DB->client->with_transaction(sub {
541 foreach my $entry_index ($chunk_size * $chunk .. min( $last_index, $chunk_size * ($chunk + 1) - 1 )) {
542 my $entry = $data->[$entry_index];
544 my $object = $entry->{object_to_save} || $entry->{object};
545 $self->save_additions_always($object);
547 next if @{ $entry->{errors} };
550 if (!eval { $ret = $object->save(cascade => !!$self->save_with_cascade()); 1 }) {
551 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $EVAL_ERROR);
553 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $object->db->error);
555 $self->_save_history($object);
556 $self->save_additions($object);
557 $self->controller->num_imported($self->controller->num_imported + 1);
561 }) or do { die SL::DB->client->error };
563 $self->controller->track_progress(progress => 100);
569 return map { $_->name => $_->length } grep { $_->type eq 'varchar' } @{$self->class->meta->columns};
572 sub fix_field_lengths {
575 my %field_lengths = $self->field_lengths;
576 foreach my $entry (@{ $self->controller->data }) {
577 next unless @{ $entry->{errors} };
578 map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;
583 my ($self, $illegal_chars, $object, @fields) = @_;
586 foreach my $field (grep { $object->can($_) } @fields) {
587 my $value = $object->$field;
589 next unless defined($value) && ($value =~ s/$illegal_chars/ /g);
591 $object->$field($value);
592 push @cleaned_fields, $field;
595 return @cleaned_fields;
599 my ($self, $object) = @_;
601 # Can be overridden by derived specialized importer classes to save
602 # additional tables (e.g. record links).
603 # This sub is called after the object is saved successfully in an transaction.
608 sub save_additions_always {
609 my ($self, $object) = @_;
611 # Can be overridden by derived specialized importer classes to save
612 # additional tables always.
613 # This sub is called before the object is saved. Therefore this
614 # hook will always be executed whether or not the import entry can be saved successfully.
621 my ($self, $object) = @_;
623 if (any { $self->controller->{type} && $_ eq $self->controller->{type} } qw(parts customers_vendors orders delivery_orders ar_transactions)) {
624 my $snumbers = $self->controller->{type} eq 'parts' ? 'partnumber_' . $object->partnumber
625 : $self->controller->{type} eq 'customers_vendors' ?
626 ($self->table eq 'customer' ? 'customernumber_' . $object->customernumber : 'vendornumber_' . $object->vendornumber)
627 : $self->controller->{type} eq 'orders' ? 'ordnumber_' . $object->ordnumber
628 : $self->controller->{type} eq 'delivery_orders' ? 'donumber_' . $object->donumber
629 : $self->controller->{type} eq 'ar_transactions' ? 'invnumber_' . $object->invnumber
633 if ($self->controller->{type} eq 'orders') {
634 $what_done = $object->customer_id ? 'sales_order' : 'purchase_order';
636 if ($self->controller->{type} eq 'delivery_orders') {
637 $what_done = $object->customer_id ? 'sales_delivery_order' : 'purchase_delivery_order';
640 SL::DB::History->new(
641 trans_id => $object->id,
642 snumbers => $snumbers,
643 employee_id => $self->controller->{employee_id},
645 what_done => $what_done,