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 my $profile = $self->profile;
26 $self->csv(SL::Helper::Csv->new(file => $self->file->file_name,
27 encoding => $self->controller->profile->get('charset'),
28 class => $self->class,
30 ignore_unknown_columns => 1,
32 map { ( $_ => $self->controller->profile->get($_) ) } qw(sep_char escape_char quote_char),
35 my $old_numberformat = $::myconfig{numberformat};
36 $::myconfig{numberformat} = $self->controller->profile->get('numberformat');
40 $self->controller->errors([ $self->csv->errors ]) if $self->csv->errors;
42 return if ( !$self->csv->header || $self->csv->errors );
44 my $headers = { headers => [ grep { $profile->{$_} } @{ $self->csv->header } ] };
45 $headers->{methods} = [ map { $profile->{$_} } @{ $headers->{headers} } ];
46 $headers->{used} = { map { ($_ => 1) } @{ $headers->{headers} } };
47 $self->controller->headers($headers);
48 $self->controller->raw_data_headers({ used => { }, headers => [ ] });
49 $self->controller->info_headers({ used => { }, headers => [ ] });
51 my @objects = $self->csv->get_objects;
52 my @raw_data = @{ $self->csv->get_data };
53 $self->controller->data([ pairwise { { object => $a, raw_data => $b, errors => [], information => [], info_data => {} } } @objects, @raw_data ]);
56 if ( $self->controller->profile->get('duplicates', 'no_check') ne 'no_check' ) {
57 $self->check_std_duplicates();
58 $self->check_duplicates();
60 $self->fix_field_lengths;
62 $::myconfig{numberformat} = $old_numberformat;
66 my ($self, @columns) = @_;
68 my $h = $self->controller->headers;
70 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
71 $h->{used}->{$column} = 1;
72 push @{ $h->{methods} }, $column;
73 push @{ $h->{headers} }, $column;
77 sub add_info_columns {
78 my ($self, @columns) = @_;
80 my $h = $self->controller->info_headers;
82 foreach my $column (grep { !$h->{used}->{ $_->{method} } } map { ref $_ eq 'HASH' ? $_ : { method => $_, header => $_ } } @columns) {
83 $h->{used}->{ $column->{method} } = 1;
84 push @{ $h->{methods} }, $column->{method};
85 push @{ $h->{headers} }, $column->{header};
89 sub add_raw_data_columns {
90 my ($self, @columns) = @_;
92 my $h = $self->controller->raw_data_headers;
94 foreach my $column (grep { !$h->{used}->{$_} } @columns) {
95 $h->{used}->{$column} = 1;
96 push @{ $h->{headers} }, $column;
100 sub add_cvar_raw_data_columns {
103 map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->cvar_columns };
106 sub init_cvar_columns {
109 return [ map { "cvar_" . $_->name } (@{ $self->all_cvar_configs }) ];
112 sub init_all_languages {
115 return SL::DB::Manager::Language->get_all;
118 sub init_payment_terms_by {
121 my $all_payment_terms = SL::DB::Manager::PaymentTerm->get_all;
122 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_payment_terms } } ) } qw(id description) };
128 return { customers => SL::DB::Manager::Customer->get_all,
129 vendors => SL::DB::Manager::Vendor->get_all };
135 my %by_id = map { ( $_->id => $_ ) } @{ $self->all_vc->{customers} }, @{ $self->all_vc->{vendors} };
136 my %by_number = ( customers => { map { ( $_->customernumber => $_ ) } @{ $self->all_vc->{customers} } },
137 vendors => { map { ( $_->vendornumber => $_ ) } @{ $self->all_vc->{vendors} } } );
138 my %by_name = ( customers => { map { ( $_->name => $_ ) } @{ $self->all_vc->{customers} } },
139 vendors => { map { ( $_->name => $_ ) } @{ $self->all_vc->{vendors} } } );
141 return { id => \%by_id,
142 number => \%by_number,
143 name => \%by_name, };
147 my ($self, $entry, $id_column) = @_;
149 if ($entry->{object}->$id_column) {
150 $entry->{object}->$id_column(undef) if !$self->vc_by->{id}->{ $entry->{object}->$id_column };
153 if (!$entry->{object}->$id_column) {
154 my $vc = $self->vc_by->{number}->{customers}->{ $entry->{raw_data}->{customernumber} }
155 || $self->vc_by->{number}->{vendors}->{ $entry->{raw_data}->{vendornumber} };
156 $entry->{object}->$id_column($vc->id) if $vc;
159 if (!$entry->{object}->$id_column) {
160 my $vc = $self->vc_by->{name}->{customers}->{ $entry->{raw_data}->{customer} }
161 || $self->vc_by->{name}->{vendors}->{ $entry->{raw_data}->{vendor} };
162 $entry->{object}->$id_column($vc->id) if $vc;
165 if ($entry->{object}->$id_column) {
166 $entry->{info_data}->{vc_name} = $self->vc_by->{id}->{ $entry->{object}->$id_column }->name;
168 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor not found');
173 my ($self, $entry) = @_;
175 return unless $self->can('all_cvar_configs');
177 my %type_to_column = ( text => 'text_value',
178 textfield => 'text_value',
179 select => 'text_value',
180 date => 'timestamp_value_as_date',
181 timestamp => 'timestamp_value_as_date',
182 number => 'number_value_as_number',
183 bool => 'bool_value' );
186 foreach my $config (@{ $self->all_cvar_configs }) {
187 next unless exists $entry->{raw_data}->{ "cvar_" . $config->name };
188 my $value = $entry->{raw_data}->{ "cvar_" . $config->name };
189 my $column = $type_to_column{ $config->type } || die "Program logic error: unknown custom variable storage type";
191 push @cvars, SL::DB::CustomVariable->new(config_id => $config->id, $column => $value, sub_module => '');
194 $entry->{object}->custom_variables(\@cvars);
200 eval "require " . $self->class;
202 my %unwanted = map { ( $_ => 1 ) } (qw(itime mtime), map { $_->name } @{ $self->class->meta->primary_key_columns });
204 for my $col ($self->class->meta->columns) {
205 next if $unwanted{$col};
207 my $name = $col->isa('Rose::DB::Object::Metadata::Column::Numeric') ? "$col\_as_number"
208 : $col->isa('Rose::DB::Object::Metadata::Column::Date') ? "$col\_as_date"
209 : $col->isa('Rose::DB::Object::Metadata::Column::Timestamp') ? "$col\_as_date"
212 $profile{$col} = $name;
215 $self->profile(\%profile);
218 sub add_displayable_columns {
219 my ($self, @columns) = @_;
221 my @cols = @{ $self->controller->displayable_columns || [] };
222 my %ex_col_map = map { $_->{name} => $_ } @cols;
224 foreach my $column (@columns) {
225 if ($ex_col_map{ $column->{name} }) {
226 @{ $ex_col_map{ $column->{name} } }{ keys %{ $column } } = @{ $column }{ keys %{ $column } };
232 $self->controller->displayable_columns([ sort { $a->{name} cmp $b->{name} } @cols ]);
235 sub setup_displayable_columns {
238 $self->add_displayable_columns(map { { name => $_ } } keys %{ $self->profile });
241 sub add_cvar_columns_to_displayable_columns {
244 return unless $self->can('all_cvar_configs');
246 $self->add_displayable_columns(map { { name => 'cvar_' . $_->name,
247 description => $::locale->text('#1 (custom variable)', $_->description) } }
248 @{ $self->all_cvar_configs });
251 sub init_existing_objects {
254 eval "require " . $self->class;
255 $self->existing_objects($self->manager_class->get_all);
262 sub init_manager_class {
265 $self->class =~ m/^SL::DB::(.+)/;
266 $self->manager_class("SL::DB::Manager::" . $1);
272 sub check_duplicates {
275 sub check_std_duplicates {
280 my $all_fields = $self->get_duplicate_check_fields();
282 foreach my $key (keys(%{ $all_fields })) {
283 if ( $self->controller->profile->get('duplicates_'. $key) && (!exists($all_fields->{$key}->{std_check}) || $all_fields->{$key}->{std_check} ) ) {
284 $duplicates->{$key} = {};
288 my @duplicates_keys = keys(%{ $duplicates });
290 if ( !scalar(@duplicates_keys) ) {
294 if ( $self->controller->profile->get('duplicates') eq 'check_db' ) {
295 foreach my $object (@{ $self->existing_objects }) {
296 foreach my $key (@duplicates_keys) {
297 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
298 $duplicates->{$key}->{$value} = 'db';
303 foreach my $entry (@{ $self->controller->data }) {
304 if ( @{ $entry->{errors} } ) {
308 my $object = $entry->{object};
310 foreach my $key (@duplicates_keys) {
311 my $value = exists($all_fields->{$key}->{maker}) ? $all_fields->{$key}->{maker}->($object, $self) : $object->$key;
313 if ( exists($duplicates->{$key}->{$value}) ) {
314 push(@{ $entry->{errors} }, $duplicates->{$key}->{$value} eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file'));
317 $duplicates->{$key}->{$value} = 'csv';
325 sub get_duplicate_check_fields {
330 my ($self, $entry) = @_;
332 my $object = $entry->{object};
334 # Check whether or not payment ID is valid.
335 if ($object->payment_id && !$self->payment_terms_by->{id}->{ $object->payment_id }) {
336 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
340 # Map name to ID if given.
341 if (!$object->payment_id && $entry->{raw_data}->{payment}) {
342 my $terms = $self->payment_terms_by->{description}->{ $entry->{raw_data}->{payment} };
345 push @{ $entry->{errors} }, $::locale->text('Error: Invalid payment terms');
349 $object->payment_id($terms->id);
356 my ($self, %params) = @_;
358 my $data = $params{data} || $self->controller->data;
360 foreach my $entry (@{ $data }) {
361 next if @{ $entry->{errors} };
363 my $object = $entry->{object_to_save} || $entry->{object};
365 if ( !$object->save(cascade => !!$self->save_with_cascade()) ) {
366 push @{ $entry->{errors} }, $::locale->text('Error when saving: #1', $entry->{object}->db->error);
368 $self->controller->num_imported($self->controller->num_imported + 1);
377 sub fix_field_lengths {
380 my %field_lengths = $self->field_lengths;
381 foreach my $entry (@{ $self->controller->data }) {
382 next unless @{ $entry->{errors} };
383 map { $entry->{object}->$_(substr($entry->{object}->$_, 0, $field_lengths{$_})) if $entry->{object}->$_ } keys %field_lengths;