1 package SL::Controller::CsvImport::Order;
6 use List::MoreUtils qw(any);
10 use SL::DB::OrderItem;
12 use SL::DB::PaymentTerm;
14 use SL::DB::Department;
15 use SL::DB::PriceFactor;
16 use SL::DB::Pricegroup;
22 use parent qw(SL::Controller::CsvImport::BaseMulti);
25 use Rose::Object::MakeMethods::Generic
27 'scalar --get_set_init' => [ qw(settings languages_by parts_by contacts_by departments_by projects_by ct_shiptos_by taxzones_by price_factors_by pricegroups_by) ],
33 $self->class(['SL::DB::Order', 'SL::DB::OrderItem']);
40 return { map { ( $_ => $self->controller->profile->get($_) ) } qw(order_column item_column max_amount_diff) };
47 my $profile = $self->SUPER::init_profile;
49 # SUPER::init_profile sets row_ident to the translated class name
50 # overwrite it with the user specified settings
51 foreach my $p (@{ $profile }) {
52 if ($p->{row_ident} eq $::locale->text('Order')) {
53 $p->{row_ident} = $self->settings->{'order_column'};
55 if ($p->{row_ident} eq $::locale->text('OrderItem')) {
56 $p->{row_ident} = $self->settings->{'item_column'};
60 foreach my $p (@{ $profile }) {
61 my $prof = $p->{profile};
62 if ($p->{row_ident} eq $self->settings->{'order_column'}) {
64 delete @{$prof}{qw(delivery_customer_id delivery_vendor_id proforma quotation amount netamount)};
66 if ($p->{row_ident} eq $self->settings->{'item_column'}) {
68 delete @{$prof}{qw(trans_id)};
76 sub setup_displayable_columns {
79 $self->SUPER::setup_displayable_columns;
81 $self->add_displayable_columns($self->settings->{'order_column'},
82 { name => 'datatype', description => $self->settings->{'order_column'} },
83 { name => 'closed', description => $::locale->text('Closed') },
84 { name => 'curr', description => $::locale->text('Currency') },
85 { name => 'cusordnumber', description => $::locale->text('Customer Order Number') },
86 { name => 'delivered', description => $::locale->text('Delivered') },
87 { name => 'employee_id', description => $::locale->text('Employee (database ID)') },
88 { name => 'intnotes', description => $::locale->text('Internal Notes') },
89 { name => 'marge_percent', description => $::locale->text('Margepercent') },
90 { name => 'marge_total', description => $::locale->text('Margetotal') },
91 { name => 'notes', description => $::locale->text('Notes') },
92 { name => 'ordnumber', description => $::locale->text('Order Number') },
93 { name => 'quonumber', description => $::locale->text('Quotation Number') },
94 { name => 'reqdate', description => $::locale->text('Reqdate') },
95 { name => 'salesman_id', description => $::locale->text('Salesman (database ID)') },
96 { name => 'shippingpoint', description => $::locale->text('Shipping Point') },
97 { name => 'shipvia', description => $::locale->text('Ship via') },
98 { name => 'transaction_description', description => $::locale->text('Transaction description') },
99 { name => 'transdate', description => $::locale->text('Order Date') },
100 { name => 'verify_amount', description => $::locale->text('Amount (for verification)') },
101 { name => 'verify_netamount', description => $::locale->text('Net amount (for verification)') },
102 { name => 'taxincluded', description => $::locale->text('Tax Included') },
103 { name => 'customer', description => $::locale->text('Customer (name)') },
104 { name => 'customernumber', description => $::locale->text('Customer Number') },
105 { name => 'customer_id', description => $::locale->text('Customer (database ID)') },
106 { name => 'vendor', description => $::locale->text('Vendor (name)') },
107 { name => 'vendornumber', description => $::locale->text('Vendor Number') },
108 { name => 'vendor_id', description => $::locale->text('Vendor (database ID)') },
109 { name => 'language_id', description => $::locale->text('Language (database ID)') },
110 { name => 'language', description => $::locale->text('Language (name)') },
111 { name => 'payment_id', description => $::locale->text('Payment terms (database ID)') },
112 { name => 'payment', description => $::locale->text('Payment terms (name)') },
113 { name => 'taxzone_id', description => $::locale->text('Steuersatz (database ID') },
114 { name => 'taxzone', description => $::locale->text('Steuersatz (description)') },
115 { name => 'cp_id', description => $::locale->text('Contact Person (database ID)') },
116 { name => 'contact', description => $::locale->text('Contact Person (name)') },
117 { name => 'department_id', description => $::locale->text('Department (database ID)') },
118 { name => 'department', description => $::locale->text('Department (description)') },
119 { name => 'globalproject_id', description => $::locale->text('Document Project (database ID)') },
120 { name => 'globalprojectnumber', description => $::locale->text('Document Project (number)') },
121 { name => 'globalproject', description => $::locale->text('Document Project (description)') },
122 { name => 'shipto_id', description => $::locale->text('Ship to (database ID)') },
125 $self->add_displayable_columns($self->settings->{'item_column'},
126 { name => 'datatype', description => $self->settings->{'item_column'} },
127 { name => 'cusordnumber', description => $::locale->text('Customer Order Number') },
128 { name => 'description', description => $::locale->text('Description') },
129 { name => 'discount', description => $::locale->text('Discount') },
130 { name => 'lastcost', description => $::locale->text('Lastcost') },
131 { name => 'longdescription', description => $::locale->text('Long Description') },
132 { name => 'marge_percent', description => $::locale->text('Margepercent') },
133 { name => 'marge_total', description => $::locale->text('Margetotal') },
134 { name => 'ordnumber', description => $::locale->text('Order Number') },
135 { name => 'parts_id', description => $::locale->text('Part (database ID)') },
136 { name => 'partnumber', description => $::locale->text('Part Number') },
137 { name => 'project_id', description => $::locale->text('Project (database ID)') },
138 { name => 'projectnumber', description => $::locale->text('Project (number)') },
139 { name => 'project', description => $::locale->text('Project (description)') },
140 { name => 'price_factor_id', description => $::locale->text('Price factor (database ID)') },
141 { name => 'price_factor', description => $::locale->text('Price factor (name)') },
142 { name => 'pricegroup_id', description => $::locale->text('Price group (database ID)') },
143 { name => 'pricegroup', description => $::locale->text('Price group (name)') },
144 { name => 'qty', description => $::locale->text('Quantity') },
145 { name => 'reqdate', description => $::locale->text('Reqdate') },
146 { name => 'sellprice', description => $::locale->text('Sellprice') },
147 { name => 'serialnumber', description => $::locale->text('Serial No.') },
148 { name => 'subtotal', description => $::locale->text('Subtotal') },
149 { name => 'unit', description => $::locale->text('Unit') },
154 sub init_languages_by {
157 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $self->all_languages } } ) } qw(id description article_code) };
163 my $all_parts = SL::DB::Manager::Part->get_all;
164 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_parts } } ) } qw(id partnumber ean description) };
167 sub init_contacts_by {
170 my $all_contacts = SL::DB::Manager::Contact->get_all;
173 # by customer/vendor id _and_ contact person id
174 $cby->{'cp_cv_id+cp_id'} = { map { ( $_->cp_cv_id . '+' . $_->cp_id => $_ ) } @{ $all_contacts } };
175 # by customer/vendor id _and_ contact person name
176 $cby->{'cp_cv_id+cp_name'} = { map { ( $_->cp_cv_id . '+' . $_->cp_name => $_ ) } @{ $all_contacts } };
181 sub init_departments_by {
184 my $all_departments = SL::DB::Manager::Department->get_all;
185 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_departments } } ) } qw(id description) };
188 sub init_projects_by {
191 my $all_projects = SL::DB::Manager::Project->get_all;
192 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_projects } } ) } qw(id projectnumber description) };
195 sub init_ct_shiptos_by {
198 my $all_ct_shiptos = SL::DB::Manager::Shipto->get_all(query => [module => 'CT']);
201 # by trans_id _and_ shipto_id
202 $sby->{'trans_id+shipto_id'} = { map { ( $_->trans_id . '+' . $_->shipto_id => $_ ) } @{ $all_ct_shiptos } };
207 sub init_taxzones_by {
210 my $all_taxzones = SL::DB::Manager::TaxZone->get_all;
211 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_taxzones } } ) } qw(id description) };
214 sub init_price_factors_by {
217 my $all_price_factors = SL::DB::Manager::PriceFactor->get_all;
218 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_price_factors } } ) } qw(id description) };
221 sub init_pricegroups_by {
224 my $all_pricegroups = SL::DB::Manager::Pricegroup->get_all;
225 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_pricegroups } } ) } qw(id pricegroup) };
231 $self->controller->track_progress(phase => 'building data', progress => 0);
234 my $num_data = scalar @{ $self->controller->data };
235 foreach my $entry (@{ $self->controller->data }) {
236 $self->controller->track_progress(progress => $i/$num_data * 100) if $i % 100 == 0;
238 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
241 if (any { $entry->{raw_data}->{$_} } qw(customer customernumber customer_id)) {
242 $self->check_vc($entry, 'customer_id');
243 $vc_obj = SL::DB::Customer->new(id => $entry->{object}->customer_id)->load if $entry->{object}->customer_id;
244 } elsif (any { $entry->{raw_data}->{$_} } qw(vendor vendornumber vendor_id)) {
245 $self->check_vc($entry, 'vendor_id');
246 $vc_obj = SL::DB::Vendor->new(id => $entry->{object}->vendor_id)->load if $entry->{object}->vendor_id;
248 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor missing');
251 $self->check_contact($entry);
252 $self->check_language($entry);
253 $self->check_payment($entry);
254 $self->check_department($entry);
255 $self->check_project($entry, global => 1);
256 $self->check_ct_shipto($entry);
257 $self->check_taxzone($entry);
260 # copy from customer if not given
261 foreach (qw(payment_id language_id taxzone_id)) {
262 $entry->{object}->$_($vc_obj->$_) unless $entry->{object}->$_;
266 # ToDo: salesman and emloyee by name
267 # salesman from customer or login if not given
268 if (!$entry->{object}->salesman) {
269 if ($vc_obj && $vc_obj->salesman_id) {
270 $entry->{object}->salesman(SL::DB::Manager::Employee->find_by(id => $vc_obj->salesman_id));
272 $entry->{object}->salesman(SL::DB::Manager::Employee->find_by(login => $::myconfig{login}));
276 # employee from login if not given
277 if (!$entry->{object}->employee_id) {
278 $entry->{object}->employee_id(SL::DB::Manager::Employee->find_by(login => $::myconfig{login})->id);
284 $self->add_info_columns($self->settings->{'order_column'},
285 { header => $::locale->text('Customer/Vendor'), method => 'vc_name' });
286 # Todo: access via ->[0] ok? Better: search first order column and use this
287 $self->add_columns($self->settings->{'order_column'},
288 map { "${_}_id" } grep { exists $self->controller->data->[0]->{raw_data}->{$_} } qw(payment language department globalproject taxzone cp));
289 $self->add_columns($self->settings->{'order_column'}, 'globalproject_id') if exists $self->controller->data->[0]->{raw_data}->{globalprojectnumber};
290 $self->add_columns($self->settings->{'order_column'}, 'cp_id') if exists $self->controller->data->[0]->{raw_data}->{contact};
292 foreach my $entry (@{ $self->controller->data }) {
293 if ($entry->{raw_data}->{datatype} eq $self->settings->{'item_column'} && $entry->{object}->can('part')) {
295 next if !$self->check_part($entry);
297 my $part_obj = SL::DB::Part->new(id => $entry->{object}->parts_id)->load;
299 # copy from part if not given
300 $entry->{object}->description($part_obj->description) unless $entry->{object}->description;
301 $entry->{object}->longdescription($part_obj->notes) unless $entry->{object}->longdescription;
302 $entry->{object}->unit($part_obj->unit) unless $entry->{object}->unit;
304 # set to 0 if not given
305 $entry->{object}->discount(0) unless $entry->{object}->discount;
306 $entry->{object}->ship(0) unless $entry->{object}->ship;
308 $self->check_project($entry, global => 0);
309 $self->check_price_factor($entry);
310 $self->check_pricegroup($entry);
314 $self->add_info_columns($self->settings->{'item_column'},
315 { header => $::locale->text('Part Number'), method => 'partnumber' });
316 # Todo: access via ->[1] ok? Better: search first item column and use this
317 $self->add_columns($self->settings->{'item_column'},
318 map { "${_}_id" } grep { exists $self->controller->data->[1]->{raw_data}->{$_} } qw(project price_factor pricegroup));
319 $self->add_columns($self->settings->{'item_column'}, 'project_id') if exists $self->controller->data->[1]->{raw_data}->{projectnumber};
321 # add orderitems to order
324 foreach my $entry (@{ $self->controller->data }) {
326 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
328 # new order entry: add collected orderitems to the last one
329 if (defined $order_entry) {
330 $order_entry->{object}->orderitems(@orderitems);
334 $order_entry = $entry;
336 } elsif ( defined $order_entry && $entry->{raw_data}->{datatype} eq $self->settings->{'item_column'} ) {
337 # collect orderitems to add to order (if they have no errors)
338 # ( add_orderitems does not work here if we want to call
339 # calculate_prices_and_taxes afterwards ...
340 # so collect orderitems and add them at once)
341 if (scalar @{ $entry->{errors} } == 0) {
342 push @orderitems, $entry->{object};
346 # add last collected orderitems to last order
348 $order_entry->{object}->orderitems(@orderitems);
351 # calculate prices and taxes
352 foreach my $entry (@{ $self->controller->data }) {
353 next if @{ $entry->{errors} };
355 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
357 $entry->{object}->calculate_prices_and_taxes;
359 $entry->{info_data}->{calc_amount} = $entry->{object}->amount_as_number;
360 $entry->{info_data}->{calc_netamount} = $entry->{object}->netamount_as_number;
364 # If amounts are given, show calculated amounts as info and given amounts (verify_xxx).
365 # And throw an error if the differences are too big.
366 my @to_verify = ( { column => 'amount',
367 raw_column => 'verify_amount',
368 info_header => 'Calc. Amount',
369 info_method => 'calc_amount',
370 err_msg => 'Amounts differ too much',
372 { column => 'netamount',
373 raw_column => 'verify_netamount',
374 info_header => 'Calc. Net amount',
375 info_method => 'calc_netamount',
376 err_msg => 'Net amounts differ too much',
379 foreach my $tv (@to_verify) {
380 # Todo: access via ->[0] ok? Better: search first order column and use this
381 if (exists $self->controller->data->[0]->{raw_data}->{ $tv->{raw_column} }) {
382 $self->add_raw_data_columns($self->settings->{'order_column'}, $tv->{raw_column});
383 $self->add_info_columns($self->settings->{'order_column'},
384 { header => $::locale->text($tv->{info_header}), method => $tv->{info_method} });
388 foreach my $entry (@{ $self->controller->data }) {
389 next if @{ $entry->{errors} };
390 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
391 next if !$entry->{raw_data}->{ $tv->{raw_column} };
392 my $parsed_value = $::form->parse_amount(\%::myconfig, $entry->{raw_data}->{ $tv->{raw_column} });
393 if (abs($entry->{object}->${ \$tv->{column} } - $parsed_value) > $self->settings->{'max_amount_diff'}) {
394 push @{ $entry->{errors} }, $::locale->text($tv->{err_msg});
400 # If order has errors set error for orderitems as well
401 $order_entry = undef;
402 foreach my $entry (@{ $self->controller->data }) {
404 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
405 $order_entry = $entry;
406 } elsif ( defined $order_entry
407 && $entry->{raw_data}->{datatype} eq $self->settings->{'item_column'}
408 && scalar @{ $order_entry->{errors} } > 0 ) {
409 push @{ $entry->{errors} }, $::locale->text('order not valid for this orderitem!');
417 my ($self, $entry) = @_;
419 my $object = $entry->{object};
421 # Check whether or not language ID is valid.
422 if ($object->language_id && !$self->languages_by->{id}->{ $object->language_id }) {
423 push @{ $entry->{errors} }, $::locale->text('Error: Invalid language');
427 # Map name to ID if given.
428 if (!$object->language_id && $entry->{raw_data}->{language}) {
429 my $language = $self->languages_by->{description}->{ $entry->{raw_data}->{language} }
430 || $self->languages_by->{article_code}->{ $entry->{raw_data}->{language} };
433 push @{ $entry->{errors} }, $::locale->text('Error: Invalid language');
437 $object->language_id($language->id);
440 if ($object->language_id) {
441 $entry->{info_data}->{language} = $self->languages_by->{id}->{ $object->language_id }->description;
448 my ($self, $entry) = @_;
450 my $object = $entry->{object};
452 # Check wether or non part ID is valid.
453 if ($object->parts_id && !$self->parts_by->{id}->{ $object->parts_id }) {
454 push @{ $entry->{errors} }, $::locale->text('Error: Invalid part');
458 # Map number to ID if given.
459 if (!$object->parts_id && $entry->{raw_data}->{partnumber}) {
460 my $part = $self->parts_by->{partnumber}->{ $entry->{raw_data}->{partnumber} };
462 push @{ $entry->{errors} }, $::locale->text('Error: Invalid part');
466 $object->parts_id($part->id);
469 if ($object->parts_id) {
470 $entry->{info_data}->{partnumber} = $self->parts_by->{id}->{ $object->parts_id }->partnumber;
472 push @{ $entry->{errors} }, $::locale->text('Error: Part not found');
480 my ($self, $entry) = @_;
482 my $object = $entry->{object};
484 my $cp_cv_id = $object->customer_id || $object->vendor_id;
485 return 0 unless $cp_cv_id;
487 # Check wether or not contact ID is valid.
488 if ($object->cp_id && !$self->contacts_by->{'cp_cv_id+cp_id'}->{ $cp_cv_id . '+' . $object->cp_id }) {
489 push @{ $entry->{errors} }, $::locale->text('Error: Invalid contact');
493 # Map name to ID if given.
494 if (!$object->cp_id && $entry->{raw_data}->{contact}) {
495 my $cp = $self->contacts_by->{'cp_cv_id+cp_name'}->{ $cp_cv_id . '+' . $entry->{raw_data}->{contact} };
497 push @{ $entry->{errors} }, $::locale->text('Error: Invalid contact');
501 $object->cp_id($cp->cp_id);
504 if ($object->cp_id) {
505 $entry->{info_data}->{contact} = $self->contacts_by->{'cp_cv_id+cp_id'}->{ $cp_cv_id . '+' . $object->cp_id }->cp_name;
511 sub check_department {
512 my ($self, $entry) = @_;
514 my $object = $entry->{object};
516 # Check wether or not department ID is valid.
517 if ($object->department_id && !$self->departments_by->{id}->{ $object->department_id }) {
518 push @{ $entry->{errors} }, $::locale->text('Error: Invalid department');
522 # Map description to ID if given.
523 if (!$object->department_id && $entry->{raw_data}->{department}) {
524 my $dep = $self->departments_by->{description}->{ $entry->{raw_data}->{department} };
526 push @{ $entry->{errors} }, $::locale->text('Error: Invalid department');
530 $object->department_id($dep->id);
537 my ($self, $entry, %params) = @_;
539 my $id_column = ($params{global} ? 'global' : '') . 'project_id';
540 my $number_column = ($params{global} ? 'global' : '') . 'projectnumber';
541 my $description_column = ($params{global} ? 'global' : '') . 'project';
543 my $object = $entry->{object};
545 # Check wether or not projetc ID is valid.
546 if ($object->$id_column && !$self->projects_by->{id}->{ $object->$id_column }) {
547 push @{ $entry->{errors} }, $::locale->text('Error: Invalid project');
551 # Map number to ID if given.
552 if (!$object->$id_column && $entry->{raw_data}->{$number_column}) {
553 my $proj = $self->projects_by->{projectnumber}->{ $entry->{raw_data}->{$number_column} };
555 push @{ $entry->{errors} }, $::locale->text('Error: Invalid project');
559 $object->$id_column($proj->id);
562 # Map description to ID if given.
563 if (!$object->$id_column && $entry->{raw_data}->{$description_column}) {
564 my $proj = $self->projects_by->{description}->{ $entry->{raw_data}->{$description_column} };
566 push @{ $entry->{errors} }, $::locale->text('Error: Invalid project');
570 $object->$id_column($proj->id);
576 sub check_ct_shipto {
577 my ($self, $entry) = @_;
579 my $object = $entry->{object};
581 my $trans_id = $object->customer_id || $object->vendor_id;
582 return 0 unless $trans_id;
584 # Check wether or not shipto ID is valid.
585 if ($object->shipto_id && !$self->ct_shiptos_by->{'trans_id+shipto_id'}->{ $trans_id . '+' . $object->shipto_id }) {
586 push @{ $entry->{errors} }, $::locale->text('Error: Invalid shipto');
594 my ($self, $entry) = @_;
596 my $object = $entry->{object};
598 # Check wether or not taxzone ID is valid.
599 if ($object->taxzone_id && !$self->taxzones_by->{id}->{ $object->taxzone_id }) {
600 push @{ $entry->{errors} }, $::locale->text('Error: Invalid taxzone');
604 # Map description to ID if given.
605 if (!$object->taxzone_id && $entry->{raw_data}->{taxzone}) {
606 my $taxzone = $self->taxzones_by->{description}->{ $entry->{raw_data}->{taxzone} };
608 push @{ $entry->{errors} }, $::locale->text('Error: Invalid taxzone');
612 $object->taxzone_id($taxzone->id);
619 sub check_price_factor {
620 my ($self, $entry) = @_;
622 my $object = $entry->{object};
624 # Check wether or not price_factor ID is valid.
625 if ($object->price_factor_id && !$self->price_factors_by->{id}->{ $object->price_factor_id }) {
626 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price factor');
630 # Map description to ID if given.
631 if (!$object->price_factor_id && $entry->{raw_data}->{price_factor}) {
632 my $price_factor = $self->price_factors_by->{description}->{ $entry->{raw_data}->{price_factor} };
633 if (!$price_factor) {
634 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price factor');
638 $object->price_factor_id($price_factor->id);
644 sub check_pricegroup {
645 my ($self, $entry) = @_;
647 my $object = $entry->{object};
649 # Check wether or not pricegroup ID is valid.
650 if ($object->pricegroup_id && !$self->pricegroups_by->{id}->{ $object->pricegroup_id }) {
651 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price group');
655 # Map pricegroup to ID if given.
656 if (!$object->pricegroup_id && $entry->{raw_data}->{pricegroup}) {
657 my $pricegroup = $self->pricegroups_by->{pricegroup}->{ $entry->{raw_data}->{pricegroup} };
659 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price group');
663 $object->pricegroup_id($pricegroup->id);
671 my ($self, %params) = @_;
673 # set order number and collect to save
675 foreach my $entry (@{ $self->controller->data }) {
676 next if @{ $entry->{errors} };
678 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'} && !$entry->{object}->ordnumber) {
679 my $number = SL::TransNumber->new(type => 'sales_order',
681 $entry->{object}->ordnumber($number->create_unique());
684 push @{ $objects_to_save }, $entry;
687 $self->SUPER::save_objects(data => $objects_to_save);