CsvImport: Feldlängen aus den Metadaten auslesen, nicht fest codieren.
[kivitendo-erp.git] / SL / Controller / CsvImport / CustomerVendor.pm
1 package SL::Controller::CsvImport::CustomerVendor;
2
3 use strict;
4
5 use SL::Helper::Csv;
6 use SL::Controller::CsvImport::Helper::Consistency;
7 use SL::DB::Business;
8 use SL::DB::CustomVariable;
9 use SL::DB::CustomVariableConfig;
10 use SL::DB::PaymentTerm;
11 use SL::TransNumber;
12
13 use parent qw(SL::Controller::CsvImport::Base);
14
15 use Rose::Object::MakeMethods::Generic
16 (
17  'scalar --get_set_init' => [ qw(table languages_by businesses_by) ],
18 );
19
20 sub init_table {
21   my ($self) = @_;
22   $self->table($self->controller->profile->get('table') eq 'customer' ? 'customer' : 'vendor');
23 }
24
25 sub init_class {
26   my ($self) = @_;
27   $self->class('SL::DB::' . ucfirst($self->table));
28 }
29
30 sub init_all_cvar_configs {
31   my ($self) = @_;
32
33   return SL::DB::Manager::CustomVariableConfig->get_all(where => [ module => 'CT' ]);
34 }
35
36 sub init_businesses_by {
37   my ($self) = @_;
38
39   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ SL::DB::Manager::Business->get_all } } ) } qw(id description) };
40 }
41
42 sub init_languages_by {
43   my ($self) = @_;
44
45   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $self->all_languages } } ) } qw(id description article_code) };
46 }
47
48 sub check_objects {
49   my ($self) = @_;
50
51   $self->controller->track_progress(phase => 'building data', progress => 0);
52
53   my $vc            = $self->controller->profile->get('table');
54   my $update_policy = $self->controller->profile->get('update_policy') || 'update_existing';
55   my $numbercolumn  = "${vc}number";
56   my %vcs_by_number = map { ( $_->$numbercolumn => $_ ) } @{ $self->existing_objects };
57   my $methods       = $self->controller->headers->{methods};
58
59   my $i;
60   my $num_data = scalar @{ $self->controller->data };
61   foreach my $entry (@{ $self->controller->data }) {
62     $self->controller->track_progress(progress => $i/$num_data * 100) if $i % 100 == 0;
63     my $object = $entry->{object};
64
65     $self->check_name($entry);
66     $self->check_language($entry);
67     $self->check_business($entry);
68     $self->check_payment($entry);
69     $self->check_delivery_term($entry);
70     $self->check_currency($entry, take_default => 1);
71     $self->handle_cvars($entry);
72
73     next if @{ $entry->{errors} };
74
75     my @cleaned_fields = $self->clean_fields(qr{[\r\n]}, $object, qw(name department_1 department_2 street zipcode city country contact phone fax homepage email cc bcc
76                                                                      taxnumber account_number bank_code bank username greeting));
77
78     push @{ $entry->{information} }, $::locale->text('Illegal characters have been removed from the following fields: #1', join(', ', @cleaned_fields))
79       if @cleaned_fields;
80
81     my $existing_vc = $vcs_by_number{ $object->$numbercolumn };
82     if (!$existing_vc) {
83       $vcs_by_number{ $object->$numbercolumn } = $object if $object->$numbercolumn;
84
85     } elsif ($update_policy eq 'skip') {
86       push(@{$entry->{errors}}, $::locale->text('Skipping due to existing entry in database'));
87
88     } elsif ($update_policy eq 'update_existing') {
89       # Update existing customer/vendor records.
90       $entry->{object_to_save} = $existing_vc;
91
92       $existing_vc->$_( $entry->{object}->$_ ) for @{ $methods }, keys %{ $self->clone_methods };
93
94       push @{ $entry->{information} }, $::locale->text('Updating existing entry in database');
95
96     } else {
97       $object->$numbercolumn('####');
98     }
99   } continue {
100     $i++;
101   }
102
103   $self->add_columns(map { "${_}_id" } grep { exists $self->controller->data->[0]->{raw_data}->{$_} } qw(language business payment delivery_term));
104   $self->add_cvar_raw_data_columns;
105 }
106
107 sub get_duplicate_check_fields {
108   return {
109     name => {
110       label     => $::locale->text('Customer Name'),
111       default   => 1,
112       maker     => sub {
113         my $name = shift->name;
114         $name =~ s/[\s,\.\-]//g;
115         return $name;
116       }
117     },
118   };
119 }
120
121 sub check_name {
122   my ($self, $entry) = @_;
123
124   my $name =  $entry->{object}->name;
125   $name    =~ s/^\s+//;
126   $name    =~ s/\s+$//;
127
128   return 1 if $name;
129
130   push @{ $entry->{errors} }, $::locale->text('Error: Name missing');
131   return 0;
132 }
133
134 sub check_language {
135   my ($self, $entry) = @_;
136
137   my $object = $entry->{object};
138
139   # Check whether or not language ID is valid.
140   if ($object->language_id && !$self->languages_by->{id}->{ $object->language_id }) {
141     push @{ $entry->{errors} }, $::locale->text('Error: Invalid language');
142     return 0;
143   }
144
145   # Map name to ID if given.
146   if (!$object->language_id && $entry->{raw_data}->{language}) {
147     my $language = $self->languages_by->{description}->{  $entry->{raw_data}->{language} }
148                 || $self->languages_by->{article_code}->{ $entry->{raw_data}->{language} };
149
150     if (!$language) {
151       push @{ $entry->{errors} }, $::locale->text('Error: Invalid language');
152       return 0;
153     }
154
155     $object->language_id($language->id);
156
157     # register language_id for method copying later
158     $self->clone_methods->{language_id} = 1;
159   }
160
161   return 1;
162 }
163
164 sub check_business {
165   my ($self, $entry) = @_;
166
167   my $object = $entry->{object};
168
169   # Check whether or not business ID is valid.
170   if ($object->business_id && !$self->businesses_by->{id}->{ $object->business_id }) {
171     push @{ $entry->{errors} }, $::locale->text('Error: Invalid business');
172     return 0;
173   }
174
175   # Map name to ID if given.
176   if (!$object->business_id && $entry->{raw_data}->{business}) {
177     my $business = $self->businesses_by->{description}->{ $entry->{raw_data}->{business} };
178
179     if (!$business) {
180       push @{ $entry->{errors} }, $::locale->text('Error: Invalid business');
181       return 0;
182     }
183
184     $object->business_id($business->id);
185
186     # register business_id for method copying later
187     $self->clone_methods->{business_id} = 1;
188   }
189
190   return 1;
191 }
192
193 sub save_objects {
194   my ($self, %params) = @_;
195
196   my $numbercolumn   = $self->table . 'number';
197   my $with_number    = [ grep { $_->{object}->$numbercolumn ne '####' } @{ $self->controller->data } ];
198   my $without_number = [ grep { $_->{object}->$numbercolumn eq '####' } @{ $self->controller->data } ];
199
200   foreach my $entry (@{$with_number}, @{$without_number}) {
201     my $object = $entry->{object};
202
203     my $number = SL::TransNumber->new(type        => $self->table(),
204                                       number      => $object->$numbercolumn(),
205                                       business_id => $object->business_id(),
206                                       save        => 1);
207
208     if ( $object->$numbercolumn eq '####' || !$number->is_unique() ) {
209       $object->$numbercolumn($number->create_unique());
210     }
211   }
212
213   $self->SUPER::save_objects(data => $with_number);
214   $self->SUPER::save_objects(data => $without_number);
215 }
216
217 sub init_profile {
218   my ($self) = @_;
219
220   my $profile = $self->SUPER::init_profile;
221   delete @{$profile}{qw(business datevexport language payment delivery_term salesman salesman_id taxincluded terms)};
222
223   return $profile;
224 }
225
226 sub setup_displayable_columns {
227   my ($self) = @_;
228
229   $self->SUPER::setup_displayable_columns;
230   $self->add_cvar_columns_to_displayable_columns;
231
232   $self->add_displayable_columns({ name => 'account_number',    description => $::locale->text('Account Number')                  },
233                                  { name => 'bank',              description => $::locale->text('Bank')                            },
234                                  { name => 'bank_code',         description => $::locale->text('Bank Code')                       },
235                                  { name => 'bcc',               description => $::locale->text('Bcc')                             },
236                                  { name => 'bic',               description => $::locale->text('BIC')                             },
237                                  { name => 'business_id',       description => $::locale->text('Business type (database ID)')     },
238                                  { name => 'business',          description => $::locale->text('Business type (name)')            },
239                                  { name => 'c_vendor_id',       description => $::locale->text('our vendor number at customer')   },
240                                  { name => 'cc',                description => $::locale->text('Cc')                              },
241                                  { name => 'city',              description => $::locale->text('City')                            },
242                                  { name => 'contact',           description => $::locale->text('Contact')                         },
243                                  { name => 'country',           description => $::locale->text('Country')                         },
244                                  { name => 'creditlimit',       description => $::locale->text('Credit Limit')                    },
245                                  { name => 'currency',          description => $::locale->text('Currency')                        },
246                                  { name => 'currency_id',       description => $::locale->text('Currency (database ID)')          },
247                                  { name => 'customernumber',    description => $::locale->text('Customer Number')                 },
248                                  { name => 'department_1',      description => $::locale->text('Department 1')                    },
249                                  { name => 'department_2',      description => $::locale->text('Department 2')                    },
250                                  { name => 'delivery_term_id',  description => $::locale->text('Delivery terms (database ID)')    },
251                                  { name => 'delivery_term',     description => $::locale->text('Delivery terms (name)')           },
252                                  { name => 'direct_debit',      description => $::locale->text('direct debit')                    },
253                                  { name => 'discount',          description => $::locale->text('Discount')                        },
254                                  { name => 'email',             description => $::locale->text('E-mail')                          },
255                                  { name => 'fax',               description => $::locale->text('Fax')                             },
256                                  { name => 'greeting',          description => $::locale->text('Greeting')                        },
257                                  { name => 'homepage',          description => $::locale->text('Homepage')                        },
258                                  { name => 'iban',              description => $::locale->text('IBAN')                            },
259                                  { name => 'klass',             description => $::locale->text('Preisklasse')                     },
260                                  { name => 'language_id',       description => $::locale->text('Language (database ID)')          },
261                                  { name => 'language',          description => $::locale->text('Language (name)')                 },
262                                  { name => 'name',              description => $::locale->text('Name')                            },
263                                  { name => 'notes',             description => $::locale->text('Notes')                           },
264                                  { name => 'obsolete',          description => $::locale->text('Obsolete')                        },
265                                  { name => 'payment_id',        description => $::locale->text('Payment terms (database ID)')     },
266                                  { name => 'payment',           description => $::locale->text('Payment terms (name)')            },
267                                  { name => 'phone',             description => $::locale->text('Phone')                           },
268                                  { name => 'street',            description => $::locale->text('Street')                          },
269                                  { name => 'taxnumber',         description => $::locale->text('Tax Number / SSN')                },
270                                  { name => 'taxzone_id',        description => $::locale->text('Steuersatz')                      },
271                                  { name => 'user_password',     description => $::locale->text('Password')                        },
272                                  { name => 'username',          description => $::locale->text('Username')                        },
273                                  { name => 'ustid',             description => $::locale->text('sales tax identification number') },
274                                  { name => 'zipcode',           description => $::locale->text('Zipcode')                         },
275                                 );
276 }
277
278 # TODO:
279 # salesman_id -- Kunden mit Typ 'Verkäufer', falls Vertreter-Modus an ist, ansonsten Employees
280
281 1;