4f1278ac47b07c65fe500166ab2f1f8610520805
[kivitendo-erp.git] / SL / Controller / CsvImport / Part.pm
1 package SL::Controller::CsvImport::Part;
2
3 use strict;
4
5 use SL::Helper::Csv;
6
7 use SL::DB::Buchungsgruppe;
8 use SL::DB::CustomVariable;
9 use SL::DB::CustomVariableConfig;
10 use SL::DB::PartsGroup;
11 use SL::DB::PaymentTerm;
12 use SL::DB::PriceFactor;
13 use SL::DB::Translation;
14 use SL::DB::Unit;
15
16 use parent qw(SL::Controller::CsvImport::Base);
17
18 use Rose::Object::MakeMethods::Generic
19 (
20  scalar                  => [ qw(table) ],
21  'scalar --get_set_init' => [ qw(bg_by settings parts_by price_factors_by units_by packing_types_by partsgroups_by
22                                  translation_columns) ],
23 );
24
25 sub init_class {
26   my ($self) = @_;
27   $self->class('SL::DB::Part');
28 }
29
30 sub init_bg_by {
31   my ($self) = @_;
32
33   my $all_bg = SL::DB::Manager::Buchungsgruppe->get_all;
34   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_bg } } ) } qw(id description) };
35 }
36
37 sub init_price_factors_by {
38   my ($self) = @_;
39
40   my $all_price_factors = SL::DB::Manager::PriceFactor->get_all;
41   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_price_factors } } ) } qw(id description) };
42 }
43
44 sub init_packing_types_by {
45   my ($self) = @_;
46
47   my $all_packing_types = SL::DB::Manager::PackingType->get_all;
48   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_packing_types } } ) } qw(id description) };
49 }
50
51 sub init_partsgroups_by {
52   my ($self) = @_;
53
54   my $all_partsgroups = SL::DB::Manager::PartsGroup->get_all;
55   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_partsgroups } } ) } qw(id partsgroup) };
56 }
57
58 sub init_units_by {
59   my ($self) = @_;
60
61   my $all_units = SL::DB::Manager::Unit->get_all;
62   return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_units } } ) } qw(name) };
63 }
64
65 sub init_parts_by {
66   my ($self) = @_;
67
68   my $parts_by = { id         => { map { ( $_->id => $_ ) } grep { !$_->assembly } @{ $self->existing_objects } },
69                    partnumber => { part    => { },
70                                    service => { } } };
71
72   foreach my $part (@{ $self->existing_objects }) {
73     next if $part->assembly;
74     $parts_by->{partnumber}->{ $part->type }->{ $part->partnumber } = $part;
75   }
76
77   return $parts_by;
78 }
79
80 sub init_settings {
81   my ($self) = @_;
82
83   return { map { ( $_ => $self->controller->profile->get($_) ) } qw(apply_buchungsgruppe default_buchungsgruppe article_number_policy
84                                                                     sellprice_places sellprice_adjustment sellprice_adjustment_type
85                                                                     shoparticle_if_missing parts_type) };
86 }
87
88 sub init_all_cvar_configs {
89   my ($self) = @_;
90
91   return SL::DB::Manager::CustomVariableConfig->get_all(where => [ module => 'IC' ]);
92 }
93
94 sub init_translation_columns {
95   my ($self) = @_;
96
97   return [ map { ("description_" . $_->article_code, "notes_" . $_->article_code) } (@{ $self->all_languages }) ];
98 }
99
100 sub check_objects {
101   my ($self) = @_;
102
103   return unless @{ $self->controller->data };
104
105   foreach my $entry (@{ $self->controller->data }) {
106     $self->check_buchungsgruppe($entry);
107     $self->check_type($entry);
108     $self->check_unit($entry);
109     $self->check_price_factor($entry);
110     $self->check_payment($entry);
111     $self->check_packing_type($entry);
112     $self->check_partsgroup($entry);
113     $self->check_existing($entry) unless @{ $entry->{errors} };
114     $self->handle_prices($entry) if $self->settings->{sellprice_adjustment};
115     $self->handle_shoparticle($entry);
116     $self->handle_translations($entry);
117     $self->handle_cvars($entry);
118     $self->set_various_fields($entry);
119   }
120
121   $self->add_columns(qw(type)) if $self->settings->{parts_type} eq 'mixed';
122   $self->add_columns(qw(buchungsgruppen_id unit));
123   $self->add_columns(map { "${_}_id" } grep { exists $self->controller->data->[0]->{raw_data}->{$_} } qw (price_factor payment packing_type partsgroup));
124   $self->add_columns(qw(shop)) if $self->settings->{shoparticle_if_missing};
125   $self->add_cvar_raw_data_columns;
126   map { $self->add_raw_data_columns($_) if exists $self->controller->data->[0]->{raw_data}->{$_} } @{ $self->translation_columns };
127 }
128
129 sub check_duplicates {
130   my ($self, %params) = @_;
131
132   my $normalizer = sub { my $name = $_[0]; $name =~ s/[\s,\.\-]//g; return $name; };
133   my $name_maker = sub { return $normalizer->($_[0]->description) };
134
135   my %by_name;
136   if ('check_db' eq $self->controller->profile->get('duplicates')) {
137     %by_name = map { ( $name_maker->($_) => 'db' ) } @{ $self->existing_objects };
138   }
139
140   foreach my $entry (@{ $self->controller->data }) {
141     next if @{ $entry->{errors} };
142
143     my $name = $name_maker->($entry->{object});
144
145     if (!$by_name{ $name }) {
146       $by_name{ $name } = 'csv';
147
148     } else {
149       push @{ $entry->{errors} }, $by_name{ $name } eq 'db' ? $::locale->text('Duplicate in database') : $::locale->text('Duplicate in CSV file');
150     }
151   }
152 }
153
154 sub check_buchungsgruppe {
155   my ($self, $entry) = @_;
156
157   my $object = $entry->{object};
158
159   # Check Buchungsgruppe
160
161   # Store and verify default ID.
162   my $default_id = $self->settings->{default_buchungsgruppe};
163   $default_id    = undef unless $self->bg_by->{id}->{ $default_id };
164
165   # 1. Use default ID if enforced.
166   $object->buchungsgruppen_id($default_id) if $default_id && ($self->settings->{apply_buchungsgruppe} eq 'all');
167
168   # 2. Use supplied ID if valid
169   $object->buchungsgruppen_id(undef) if $object->buchungsgruppen_id && !$self->bg_by->{id}->{ $object->buchungsgruppen_id };
170
171   # 3. Look up name if supplied.
172   if (!$object->buchungsgruppen_id) {
173     my $bg = $self->bg_by->{description}->{ $entry->{raw_data}->{buchungsgruppe} };
174     $object->buchungsgruppen_id($bg->id) if $bg;
175   }
176
177   # 4. Use default ID if not valid.
178   $object->buchungsgruppen_id($default_id) if !$object->buchungsgruppen_id && $default_id && ($self->settings->{apply_buchungsgruppe} eq 'missing');
179
180   return 1 if $object->buchungsgruppen_id;
181
182   push @{ $entry->{errors} }, $::locale->text('Error: Buchungsgruppe missing or invalid');
183   return 0;
184 }
185
186 sub check_existing {
187   my ($self, $entry) = @_;
188
189   my $object = $entry->{object};
190
191   $entry->{part} = $self->parts_by->{partnumber}->{ $object->type }->{ $object->partnumber };
192
193   if ($self->settings->{article_number_policy} eq 'update_prices') {
194     if ($entry->{part}) {
195       map { $object->$_( $entry->{part}->$_ ) } qw(sellprice listprice lastcost);
196       push @{ $entry->{information} }, $::locale->text('Updating prices of existing entry in database');
197       $entry->{object_to_save} = $entry->{part};
198     }
199
200   } else {
201     $object->partnumber('####') if $entry->{part};
202   }
203 }
204
205 sub handle_prices {
206   my ($self, $entry) = @_;
207
208   foreach my $column (qw(sellprice listprice lastcost)) {
209     next unless $self->controller->headers->{used}->{ $column };
210
211     my $adjustment = $self->settings->{sellprice_adjustment};
212     my $value      = $entry->{object}->$column;
213
214     $value = $self->settings->{sellprice_adjustment_type} eq 'percent' ? $value * (100 + $adjustment) / 100 : $value + $adjustment;
215     $entry->{object}->$column($::form->round_amount($value, $self->settings->{sellprice_places}));
216   }
217 }
218
219 sub handle_shoparticle {
220   my ($self, $entry) = @_;
221
222   $entry->{object}->shop(1) if $self->settings->{shoparticle_if_missing} && !$self->controller->headers->{used}->{shop};
223 }
224
225 sub check_type {
226   my ($self, $entry) = @_;
227
228   my $bg = $self->bg_by->{id}->{ $entry->{object}->buchungsgruppen_id };
229   $bg  ||= SL::DB::Buchungsgruppe->new(inventory_accno_id => 1, income_accno_id_0 => 1, expense_accno_id_0 => 1);
230
231   my $type = $self->settings->{parts_type};
232   if ($type eq 'mixed') {
233     $type = $entry->{raw_data}->{type} =~ m/^p/i ? 'part'
234           : $entry->{raw_data}->{type} =~ m/^s/i ? 'service'
235           :                                        undef;
236   }
237
238   $entry->{object}->income_accno_id(  $bg->income_accno_id_0 );
239   $entry->{object}->expense_accno_id( $bg->expense_accno_id_0 );
240
241   if ($type eq 'part') {
242     $entry->{object}->inventory_accno_id( $bg->inventory_accno_id );
243
244   } elsif ($type ne 'service') {
245     push @{ $entry->{errors} }, $::locale->text('Error: Invalid part type');
246     return 0;
247   }
248
249   return 1;
250 }
251
252 sub check_price_factor {
253   my ($self, $entry) = @_;
254
255   my $object = $entry->{object};
256
257   # Check whether or not price factor ID is valid.
258   if ($object->price_factor_id && !$self->price_factors_by->{id}->{ $object->price_factor_id }) {
259     push @{ $entry->{errors} }, $::locale->text('Error: Invalid price factor');
260     return 0;
261   }
262
263   # Map name to ID if given.
264   if (!$object->price_factor_id && $entry->{raw_data}->{price_factor}) {
265     my $pf = $self->price_factors_by->{description}->{ $entry->{raw_data}->{price_factor} };
266
267     if (!$pf) {
268       push @{ $entry->{errors} }, $::locale->text('Error: Invalid price factor');
269       return 0;
270     }
271
272     $object->price_factor_id($pf->id);
273   }
274
275   return 1;
276 }
277
278 sub check_packing_type {
279   my ($self, $entry) = @_;
280
281   my $object = $entry->{object};
282
283   # Check whether or not packing type ID is valid.
284   if ($object->packing_type_id && !$self->packing_types_by->{id}->{ $object->packing_type_id }) {
285     push @{ $entry->{errors} }, $::locale->text('Error: Invalid packing type');
286     return 0;
287   }
288
289   # Map name to ID if given.
290   if (!$object->packing_type_id && $entry->{raw_data}->{packing_type}) {
291     my $type = $self->packing_types_by->{description}->{ $entry->{raw_data}->{packing_type} };
292
293     if (!$type) {
294       push @{ $entry->{errors} }, $::locale->text('Error: Invalid packing type');
295       return 0;
296     }
297
298     $object->packing_type_id($type->id);
299   }
300
301   return 1;
302 }
303
304 sub check_partsgroup {
305   my ($self, $entry) = @_;
306
307   my $object = $entry->{object};
308
309   # Check whether or not part group ID is valid.
310   if ($object->partsgroup_id && !$self->partsgroups_by->{id}->{ $object->partsgroup_id }) {
311     push @{ $entry->{errors} }, $::locale->text('Error: Invalid parts group');
312     return 0;
313   }
314
315   # Map name to ID if given.
316   if (!$object->partsgroup_id && $entry->{raw_data}->{partsgroup}) {
317     my $pg = $self->partsgroups_by->{partsgroup}->{ $entry->{raw_data}->{partsgroup} };
318
319     if (!$pg) {
320       push @{ $entry->{errors} }, $::locale->text('Error: Invalid parts group');
321       return 0;
322     }
323
324     $object->partsgroup_id($pg->id);
325   }
326
327   return 1;
328 }
329
330 sub check_unit {
331   my ($self, $entry) = @_;
332
333   my $object = $entry->{object};
334
335   # Check whether or unit is valid.
336   if (!$self->units_by->{name}->{ $object->unit }) {
337     push @{ $entry->{errors} }, $::locale->text('Error: Unit missing or invalid');
338     return 0;
339   }
340
341   return 1;
342 }
343
344 sub handle_translations {
345   my ($self, $entry) = @_;
346
347   my @translations;
348   foreach my $language (@{ $self->all_languages }) {
349     my ($desc, $notes) = @{ $entry->{raw_data} }{ "description_" . $language->article_code, "notes_" . $language->article_code };
350     next unless $desc || $notes;
351
352     push @translations, SL::DB::Translation->new(language_id     => $language->id,
353                                                  translation     => $desc,
354                                                  longdescription => $notes);
355   }
356
357   $entry->{object}->translations(\@translations);
358 }
359
360 sub set_various_fields {
361   my ($self, $entry) = @_;
362
363   $entry->{object}->priceupdate(DateTime->now_local);
364 }
365
366 sub init_profile {
367   my ($self) = @_;
368
369   my $profile = $self->SUPER::init_profile;
370   delete @{$profile}{qw(alternate assembly bom expense_accno_id income_accno_id inventory_accno_id makemodel priceupdate stockable type)};
371
372   return $profile;
373 }
374
375 sub save_objects {
376   my ($self, %params) = @_;
377
378   my $with_number    = [ grep { $_->{object}->partnumber ne '####' } @{ $self->controller->data } ];
379   my $without_number = [ grep { $_->{object}->partnumber eq '####' } @{ $self->controller->data } ];
380
381   map { $_->{object}->partnumber('') } @{ $without_number };
382
383   $self->SUPER::save_objects(data => $with_number);
384   $self->SUPER::save_objects(data => $without_number);
385 }
386
387 sub setup_displayable_columns {
388   my ($self) = @_;
389
390   $self->SUPER::setup_displayable_columns;
391   $self->add_cvar_columns_to_displayable_columns;
392
393   $self->add_displayable_columns({ name => 'bin',                description => $::locale->text('Bin')                          },
394                                  { name => 'binding_max_qty',    description => $::locale->text('Binding Max Qty')              },
395                                  { name => 'buchungsgruppen_id', description => $::locale->text('Buchungsgruppe (database ID)') },
396                                  { name => 'buchungsgruppe',     description => $::locale->text('Buchungsgruppe (name)')        },
397                                  { name => 'description',        description => $::locale->text('Description')                  },
398                                  { name => 'drawing',            description => $::locale->text('Drawing')                      },
399                                  { name => 'ean',                description => $::locale->text('EAN')                          },
400                                  { name => 'formel',             description => $::locale->text('Formula')                      },
401                                  { name => 'gv',                 description => $::locale->text('Business Volume')              },
402                                  { name => 'has_sernumber',      description => $::locale->text('Has serial number')            },
403                                  { name => 'image',              description => $::locale->text('Image')                        },
404                                  { name => 'lastcost',           description => $::locale->text('Last Cost')                    },
405                                  { name => 'listprice',          description => $::locale->text('List Price')                   },
406                                  { name => 'microfiche',         description => $::locale->text('Microfiche')                   },
407                                  { name => 'min_sellprice',      description => $::locale->text('Minimum Sell Price')           },
408                                  { name => 'not_discountable',   description => $::locale->text('Not Discountable')             },
409                                  { name => 'notes',              description => $::locale->text('Notes')                        },
410                                  { name => 'obsolete',           description => $::locale->text('Obsolete')                     },
411                                  { name => 'onhand',             description => $::locale->text('On Hand')                      },
412                                  { name => 'packing_type_id',    description => $::locale->text('Packing type (database ID)')   },
413                                  { name => 'packing_type',       description => $::locale->text('Packing type (name)')          },
414                                  { name => 'partnumber',         description => $::locale->text('Part Number')                  },
415                                  { name => 'partsgroup_id',      description => $::locale->text('Partsgroup (database ID)')     },
416                                  { name => 'partsgroup',         description => $::locale->text('Partsgroup (name)')            },
417                                  { name => 'payment_id',         description => $::locale->text('Payment terms (database ID)')  },
418                                  { name => 'payment',            description => $::locale->text('Payment terms (name)')         },
419                                  { name => 'price_factor_id',    description => $::locale->text('Price factor (database ID)')   },
420                                  { name => 'price_factor',       description => $::locale->text('Price factor (name)')          },
421                                  { name => 'rop',                description => $::locale->text('ROP')                          },
422                                  { name => 'sellprice',          description => $::locale->text('Sellprice')                    },
423                                  { name => 'shop',               description => $::locale->text('Shopartikel')                  },
424                                  { name => 'unit',               description => $::locale->text('Unit')                         },
425                                  { name => 've',                 description => $::locale->text('Verrechnungseinheit')          },
426                                  { name => 'weight',             description => $::locale->text('Weight')                       },
427                                 );
428
429   foreach my $language (@{ $self->all_languages }) {
430     $self->add_displayable_columns({ name        => 'description_' . $language->article_code,
431                                      description => $::locale->text('Description (translation for #1)', $language->description) },
432                                    { name        => 'notes_' . $language->article_code,
433                                      description => $::locale->text('Notes (translation for #1)', $language->description) });
434   }
435 }
436
437 # TODO:
438 # Preisgruppen
439 # Preisaktualisierung
440
441 1;